Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOC] Header doc #104

Merged
merged 4 commits into from
Jan 19, 2023
Merged

[DOC] Header doc #104

merged 4 commits into from
Jan 19, 2023

Conversation

BurdetteLamar
Copy link
Member

Treats:

  • #basic_auth
  • #proxy_basic_auth
  • #connection_close?
  • #connection_keep_alive?

@BurdetteLamar BurdetteLamar added the documentation Improvements or additions to documentation label Jan 18, 2023
@BurdetteLamar
Copy link
Member Author

Out-of-scope for this PR, but I don't think #set_form_data and #set_form belong in Net::HTTPHeader. They have much greater effects than merely modifying header entries. Should they be moved to a more appropriate class/module?

@peterzhu2118
Copy link
Member

It might be a bit difficult to move these methods since they're tested as part of the spec. The class that includes the Net::HTTPHeader module is expected to have a body attribute that can be written to.

https://github.com/ruby/spec/blob/master/library/net/http/httpheader/shared/set_form_data.rb
https://github.com/ruby/spec/blob/master/library/net/http/httpheader/fixtures/classes.rb

peterzhu2118
peterzhu2118 reviewed Jan 19, 2023
View reviewed changes
lib/net/http/header.rb Outdated Show resolved Hide resolved
lib/net/http/header.rb Outdated Show resolved Hide resolved
peterzhu2118
peterzhu2118 reviewed Jan 19, 2023
View reviewed changes
lib/net/http/header.rb Outdated
# +account+ and +password+ strings:
#
# req.basic_auth('my_account', 'my_password')
# req['Authorization'] # => ["Basic bXlfYWNjb3VudDpteV9wYXNzd29yZA=="]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This returns a string, not an array.

Suggested change
# req['Authorization'] # => ["Basic bXlfYWNjb3VudDpteV9wYXNzd29yZA=="]
# req['Authorization'] # => "Basic bXlfYWNjb3VudDpteV9wYXNzd29yZA=="

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed. (This was slovenly work on my part.)

lib/net/http/header.rb Outdated
# +account+ and +password+ strings:
#
# req.proxy_basic_auth('my_account', 'my_password')
# req['Proxy-Authorization'] # => ["Basic bXlfYWNjb3VudDpteV9wYXNzd29yZA=="]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

@peterzhu2118 peterzhu2118 merged commit 3308362 into ruby:master Jan 19, 2023
matzbot pushed a commit to ruby/ruby that referenced this pull request Jan 19, 2023
@BurdetteLamar @matzbot
[ruby/net-http] [DOC] Header doc
401aa9d 
(ruby/net-http#104)

ruby/net-http@3308362d9b
nagachika added a commit to nagachika/ruby that referenced this pull request Dec 16, 2023
@nagachika
merge revision(s) 35aba09,8c8645f57895d97f5f3da06759c10853ba705a22,8f…
9e4b0c4 
…678d61a597fc2871031d7a38698f3dd63d8c29,44b7fd8d4fa842523813195dfb7255ce33fdf9ca,308942920f4e200468673be03c646f0645a84263,401aa9ddd1091f5b517dce37cd002bc2c37f5ac1,8250b4679453c095eab2f60d9147ca2fe4da32c6,fe7d4eed2511ff64f263d9f29cbf0dcbd4c3a026,d92289f6330c57b0fe970a654dbf33314bfd6203,3ebc80314cf1ce727dcc2ba4192ff5265d348206,5a9e2f142d9debfb44d7d23f6821b810607d9d15,3e5a77f1ae73f4a6bf7b2b868be674ab8c714c7a,faa4c2279aa018a2bb9bc09107adf8a8fcf5fd3d,6db79aefec27035583c5b236d98425748b428c49,06195e76037b500eac219b58506e34f0d852b472,a641f6422c97a72640dc295f6b1b3ec2b9da739e,2c7fe9c0a6a2cea1243dcb30e684bf8c016f1192,bc6e587e86a4a4a46af3b1c2fbe1ff3b399735a6,3c7d5ccdce5707d7964f01f974db505d5add590f,847a0df058a4adb60266213cb8db7bb537c1d09e,a49bc73e1f33e8a0e40ff0c3fef6c6fe749f8179,899fad907c32b533bb73206d5e19204e526621ba,4edb2a29f67957fc7027eaad0c08e8003cfde609,7c47c2617a091e2a7abaeff329fdef47d1f3f3f5,05f016cdad84481c084543c6fa8b32205c19431f,6e6992e5db49a238baf290d9b9b521f6b6be5a19:

	[ruby/net-http] Adding links to references

	ruby/net-http@b85530e6b8
	---
	 lib/net/http/responses.rb | 206 ++++++++++++++++++++++++++++++++++++++++------
	 1 file changed, 180 insertions(+), 26 deletions(-)

	[ruby/net-http] [DOC] Adding links to references
	 (ruby/net-http#97)

	ruby/net-http@768115167a
	---
	 lib/net/http/responses.rb | 83 ++++++++++++++++++++++++++++++++++++++++-------
	 1 file changed, 72 insertions(+), 11 deletions(-)

	[ruby/net-http] Adding links to references

	ruby/net-http@1c8151aaf3
	---
	 lib/net/http/responses.rb | 16 ++++++++++++++++
	 1 file changed, 16 insertions(+)

	[ruby/net-http] Enhanced RDoc for HTTPHeader

	ruby/net-http@6a282eccdd
	---
	 lib/net/http/header.rb | 39 +++++++++++++++++++++++++++++----------
	 1 file changed, 29 insertions(+), 10 deletions(-)

	[ruby/net-http] [DOC] Enhanced RDoc for set_form
	 (ruby/net-http#103)

	ruby/net-http@f6506ff889
	---
	 lib/net/http/header.rb | 152 +++++++++++++++++++++++++++++++++----------------
	 1 file changed, 102 insertions(+), 50 deletions(-)

	[ruby/net-http] [DOC] Header doc
	 (ruby/net-http#104)

	ruby/net-http@3308362d9b
	---
	 lib/net/http/header.rb | 18 ++++++++++++++++--
	 1 file changed, 16 insertions(+), 2 deletions(-)

	[ruby/net-http] Correct doc error

	ruby/net-http@dc006d8419
	---
	 lib/net/http/response.rb | 2 +-
	 1 file changed, 1 insertion(+), 1 deletion(-)

	Manually merged ruby/net-http#106

	Co-authored-by: Peter Zhu <peter@peterzhu.ca>
	Co-authored-by: BurdetteLamar <burdettelamar@yahoo.com>
	---
	 lib/net/http.rb | 109 +++++++++++++++++++++++++++-----------------------------
	 1 file changed, 52 insertions(+), 57 deletions(-)

	[ruby/net-http] [DOC] Enhanced RDoc for Net::HTTP
	 (ruby/net-http#110)

	ruby/net-http@b098caa5e4
	---
	 doc/net-http/examples.rdoc |   3 +-
	 lib/net/http.rb            | 166 +++++++++++++++++++++------------------------
	 2 files changed, 78 insertions(+), 91 deletions(-)

	[ruby/net-http] Redirection revision

	ruby/net-http@9a4e2d3a2a
	---
	 lib/net/http.rb | 62 ++++++++++++++++++++++++++++-----------------------------
	 1 file changed, 30 insertions(+), 32 deletions(-)

	[ruby/net-http] [DOC] Enhanced RDoc for HTTPGenericRequest
	 (ruby/net-http#113)

	ruby/net-http@14c8405702
	---
	 lib/net/http/generic_request.rb | 92 +++++++++++++++++++++++++++++++++++++----
	 1 file changed, 84 insertions(+), 8 deletions(-)

	[ruby/net-http] Remarks on inclusions

	ruby/net-http@dfd060c583
	---
	 doc/net-http/included_getters.rdoc |   3 +
	 doc/net-http/included_setters.rdoc |   3 +
	 lib/net/http/requests.rb           |  30 ++++++++++
	 lib/net/http/responses.rb          | 120 +++++++++++++++++++++++++++++++++++++
	 4 files changed, 156 insertions(+)
	 create mode 100644 doc/net-http/included_getters.rdoc
	 create mode 100644 doc/net-http/included_setters.rdoc

	[ruby/net-http] [DOC] Enhanced RDoc for write_timeout
	 (ruby/net-http#115)

	ruby/net-http@6da39b0461
	---
	 lib/net/http.rb | 17 +++++++++++++++--
	 1 file changed, 15 insertions(+), 2 deletions(-)

	[ruby/net-http] [DOC] Enhanced RDoc for Net::HTTP
	 (ruby/net-http#116)

	ruby/net-http@22c0d34002
	---
	 lib/net/http.rb | 78 +++++++++++++++++++++++++++++++++++++++++++--------------
	 1 file changed, 59 insertions(+), 19 deletions(-)

	* remove trailing spaces. [ci skip]

	---
	 lib/net/http.rb | 2 +-
	 1 file changed, 1 insertion(+), 1 deletion(-)

	[ruby/net-http] [DOC] Reorganize doc for proxy server
	 (ruby/net-http#117)

	ruby/net-http@f8b6b76cba
	---
	 lib/net/http.rb | 198 ++++++++++++++++++++++++++++----------------------------
	 1 file changed, 100 insertions(+), 98 deletions(-)

	[ruby/net-http] Enhanced RDoc for Net::HTTP

	ruby/net-http@e65a3d9f11
	---
	 lib/net/http.rb | 19 +++++++++++++------
	 1 file changed, 13 insertions(+), 6 deletions(-)

	[ruby/net-http] Enhanced RDoc for Compression

	ruby/net-http@cff88acd70
	---
	 lib/net/http.rb | 28 +++++++++++++++++++++++-----
	 1 file changed, 23 insertions(+), 5 deletions(-)

	[ruby/net-http] [DOC] Enhanced RDoc for request headers
	 (ruby/net-http#120)

	ruby/net-http@b4eb8a7932
	---
	 doc/net-http/included_setters.rdoc |  3 ---
	 lib/net/http/request.rb            | 53 +++++++++++++++++++++++++++++++++++---
	 lib/net/http/requests.rb           | 30 ++++++++++-----------
	 3 files changed, 64 insertions(+), 22 deletions(-)
	 delete mode 100644 doc/net-http/included_setters.rdoc

	[ruby/net-http] [DOC] Enhanced RDoc for Net::HTTP#get
	 (ruby/net-http#121)

	ruby/net-http@51b9af1eed
	---
	 lib/net/http.rb | 53 +++++++++++++++++++++++------------------------------
	 1 file changed, 23 insertions(+), 30 deletions(-)

	[ruby/net-http] [DOC] Enhanced RDoc for Net::HTTP
	 (ruby/net-http#122)

	ruby/net-http@06f79cda87
	---
	 lib/net/http.rb | 91 ++++++++++++++++++++++++++++++++++++---------------------
	 1 file changed, 57 insertions(+), 34 deletions(-)

	[ruby/net-http] [DOC] Enhanced RDoc for Net::HTTP
	 (ruby/net-http#123)

	ruby/net-http@220ff3f741
	---
	 lib/net/http.rb | 118 +++++++++++++++++++++++++++++++++++++++++++++-----------
	 1 file changed, 96 insertions(+), 22 deletions(-)

	[ruby/net-http] [DOC] Enhanced RDoc for Net:HTTP
	 (ruby/net-http#124)

	ruby/net-http@aaf26b21d6
	---
	 lib/net/http.rb | 35 ++++++++++++++++-------------------
	 1 file changed, 16 insertions(+), 19 deletions(-)

	[ruby/net-http] [DOC] Enhanced RDoc for Net::HTTP
	 (ruby/net-http#125)

	ruby/net-http@2ea20380fc
	---
	 lib/net/http.rb | 130 +++++++++++++++++++++++++++++++++++++-------------------
	 1 file changed, 87 insertions(+), 43 deletions(-)

	[ruby/net-http] [DOC] Enhanced RDoc for Net::HTTP
	 (ruby/net-http#126)

	ruby/net-http@4700d0660b
	---
	 lib/net/http.rb        | 87 +++++++++++++++++++++++++++++++-------------------
	 lib/net/http/status.rb |  2 +-
	 2 files changed, 55 insertions(+), 34 deletions(-)

	[ruby/net-http] [DOC] Enhanced RDoc for Net::HTTP
	 (ruby/net-http#127)

	ruby/net-http@07b2b88ef5
	---
	 lib/net/http.rb | 65 +++++++++++++++++++++++++++++++--------------------------
	 1 file changed, 35 insertions(+), 30 deletions(-)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@peterzhu2118 peterzhu2118 peterzhu2118 approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@BurdetteLamar @peterzhu2118