net-http 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83d503ad3cfa67ad617fbfe5f168b22759f54eba460aceedba49245dd09d36d0
-  data.tar.gz: 57ae006e8c77d3d1bac46a6693e6377ad38e0d690669b9f1a2a447926e2a626b
+  metadata.gz: 76efd58d8b7892a8c7cd99b94ba163b3e7af2c7c213710d09d4f0ff5751fb01c
+  data.tar.gz: 69b629454de4153eac43b49c1e622889a69a90b8b574be7a91af0668240c7b72
 SHA512:
-  metadata.gz: 131cb53d9b3ae85db640cf78f1a43f660908cfd8f753cd41f5bea7179a92e5efd328e2f91fced1bc4e8cc69152ca9d95bc32544031cc79654c157f4573506a86
-  data.tar.gz: 3753128576e206b26a75f2828b5502cfc341854273f385a0771a988dfa69a6482351767f607d4bee211dbdac94937980b69c10c57e1cf69df41147a31621f2ce
+  metadata.gz: bf1fe9f92f33a2b2c32ae4ca1c896076ab22df06551b7e669a21c616a2c89d36942a18a3520d3ecb3fd5db387481ac44abbd7c70dc8b39bce4987a681819ce1f
+  data.tar.gz: 143b8dc3a5f8788c552e17ac45ee20ed0313e16bccb16de94d9a22d96b69a23e24d264c2978388b2b01e7f43d84834d027c65c901e3ed6d8fd668763eb422375

data/.gitignore

@@ -2,7 +2,6 @@
 /.yardoc
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/

data/doc/net-http/examples.rdoc

@@ -0,0 +1,30 @@
+Examples here assume that <tt>net/http</tt> has been required
+(which also requires +uri+):
+
+  require 'net/http'
+
+Many code examples here use these example websites:
+
+- https://jsonplaceholder.typicode.com.
+- http://example.com.
+
+Some examples also assume these variables:
+
+  uri = URI('https://jsonplaceholder.typicode.com')
+  uri.freeze # Examples may not modify.
+  hostname = uri.hostname # => "jsonplaceholder.typicode.com"
+  port = uri.port         # => 443
+
+So that example requests may be written as:
+
+  Net::HTTP.get(uri)
+  Net::HTTP.get(hostname, '/index.html')
+  Net::HTTP.start(hostname) do |http|
+    http.get('/todos/1')
+    http.get('/todos/2')
+  end
+
+An example that needs a modified URI first duplicates +uri+, then modifies the duplicate:
+
+  _uri = uri.dup
+  _uri.path = '/todos/1'

data/lib/net/http/header.rb

@@ -1,16 +1,186 @@
 # frozen_string_literal: false
-# The HTTPHeader module defines methods for reading and writing
-# HTTP headers.
 #
-# It is used as a mixin by other classes, to provide hash-like
-# access to HTTP header values. Unlike raw hash access, HTTPHeader
-# provides access via case-insensitive keys. It also provides
-# methods for accessing commonly-used HTTP header values in more
-# convenient formats.
+# The \HTTPHeader module provides access to \HTTP headers.
+#
+# The module is included in:
+#
+# - Net::HTTPGenericRequest (and therefore Net::HTTPRequest).
+# - Net::HTTPResponse.
+#
+# The headers are a hash-like collection of key/value pairs called _fields_.
+#
+# == Request and Response Fields
+#
+# Headers may be included in:
+#
+# - A Net::HTTPRequest object:
+#   the object's headers will be sent with the request.
+#   Any fields may be defined in the request;
+#   see {Setters}[rdoc-ref:Net::HTTPHeader@Setters].
+# - A Net::HTTPResponse object:
+#   the objects headers are usually those returned from the host.
+#   Fields may be retrieved from the object;
+#   see {Getters}[rdoc-ref:Net::HTTPHeader@Getters]
+#   and {Iterators}[rdoc-ref:Net::HTTPHeader@Iterators].
+#
+# Exactly which fields should be sent or expected depends on the host;
+# see:
+#
+# - {Request fields}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Request_fields].
+# - {Response fields}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Response_fields].
+#
+# == About the Examples
+#
+# :include: doc/net-http/examples.rdoc
+#
+# == Fields
+#
+# A header field is a key/value pair.
+#
+# === Field Keys
+#
+# A field key may be:
+#
+# - A string: Key <tt>'Accept'</tt> is treated as if it were
+#   <tt>'Accept'.downcase</tt>;  i.e., <tt>'accept'</tt>.
+# - A symbol: Key <tt>:Accept</tt> is treated as if it were
+#   <tt>:Accept.to_s.downcase</tt>;  i.e., <tt>'accept'</tt>.
+#
+# Examples:
+#
+#   req = Net::HTTP::Get.new(uri)
+#   req[:accept]  # => "*/*"
+#   req['Accept'] # => "*/*"
+#   req['ACCEPT'] # => "*/*"
+#
+#   req['accept'] = 'text/html'
+#   req[:accept] = 'text/html'
+#   req['ACCEPT'] = 'text/html'
+#
+# === Field Values
+#
+# A field value may be returned as an array of strings or as a string:
+#
+# - These methods return field values as arrays:
+#
+#   - #get_fields: Returns the array value for the given key,
+#     or +nil+ if it does not exist.
+#   - #to_hash: Returns a hash of all header fields:
+#     each key is a field name; its value is the array value for the field.
+#
+# - These methods return field values as string;
+#   the string value for a field is equivalent to
+#   <tt>self[key.downcase.to_s].join(', '))</tt>:
+#
+#   - #[]: Returns the string value for the given key,
+#     or +nil+ if it does not exist.
+#   - #fetch: Like #[], but accepts a default value
+#     to be returned if the key does not exist.
+#
+# The field value may be set:
+#
+# - #[]=: Sets the value for the given key;
+#   the given value may be a string, a symbol, an array, or a hash.
+# - #add_field: Adds a given value to a value for the given key
+#   (not overwriting the existing value).
+# - #delete: Deletes the field for the given key.
+#
+# Example field values:
+#
+# - \String:
+#
+#     req['Accept'] = 'text/html' # => "text/html"
+#     req['Accept']               # => "text/html"
+#     req.get_fields('Accept')    # => ["text/html"]
+#
+# - \Symbol:
+#
+#     req['Accept'] = :text    # => :text
+#     req['Accept']            # => "text"
+#     req.get_fields('Accept') # => ["text"]
+#
+# - Simple array:
+#
+#     req[:foo] = %w[bar baz bat]
+#     req[:foo]            # => "bar, baz, bat"
+#     req.get_fields(:foo) # => ["bar", "baz", "bat"]
+#
+# - Simple hash:
+#
+#     req[:foo] = {bar: 0, baz: 1, bat: 2}
+#     req[:foo]            # => "bar, 0, baz, 1, bat, 2"
+#     req.get_fields(:foo) # => ["bar", "0", "baz", "1", "bat", "2"]
+#
+# - Nested:
+#
+#     req[:foo] = [%w[bar baz], {bat: 0, bam: 1}]
+#     req[:foo]            # => "bar, baz, bat, 0, bam, 1"
+#     req.get_fields(:foo) # => ["bar", "baz", "bat", "0", "bam", "1"]
+#
+#     req[:foo] = {bar: %w[baz bat], bam: {bah: 0, bad: 1}}
+#     req[:foo]            # => "bar, baz, bat, bam, bah, 0, bad, 1"
+#     req.get_fields(:foo) # => ["bar", "baz", "bat", "bam", "bah", "0", "bad", "1"]
+#
+# == Convenience Methods
+#
+# Various convenience methods retrieve values, set values, query values,
+# set form values, or iterate over fields.
+#
+# === Setters
+#
+# \Method #[]= can set any field, but does little to validate the new value;
+# some of the other setter methods provide some validation:
+#
+# - #[]=: Sets the string or array value for the given key.
+# - #add_field: Creates or adds to the array value for the given key.
+# - #basic_auth: Sets the string authorization header for <tt>'Authorization'</tt>.
+# - #content_length=: Sets the integer length for field <tt>'Content-Length</tt>.
+# - #content_type=: Sets the string value for field <tt>'Content-Type'</tt>.
+# - #proxy_basic_auth: Sets the string authorization header for <tt>'Proxy-Authorization'</tt>.
+# - #set_range: Sets the value for field <tt>'Range'</tt>.
+#
+# === Form Setters
+#
+# - #set_form: Sets an HTML form data set.
+# - #set_form_data: Sets header fields and a body from HTML form data.
+#
+# === Getters
+#
+# \Method #[] can retrieve the value of any field that exists,
+# but always as a string;
+# some of the other getter methods return something different
+# from the simple string value:
+#
+# - #[]: Returns the string field value for the given key.
+# - #content_length: Returns the integer value of field <tt>'Content-Length'</tt>.
+# - #content_range: Returns the Range value of field <tt>'Content-Range'</tt>.
+# - #content_type: Returns the string value of field <tt>'Content-Type'</tt>.
+# - #fetch: Returns the string field value for the given key.
+# - #get_fields: Returns the array field value for the given +key+.
+# - #main_type: Returns first part of the string value of field <tt>'Content-Type'</tt>.
+# - #sub_type: Returns second part of the string value of field <tt>'Content-Type'</tt>.
+# - #range: Returns an array of Range objects of field <tt>'Range'</tt>, or +nil+.
+# - #range_length: Returns the integer length of the range given in field <tt>'Content-Range'</tt>.
+# - #type_params: Returns the string parameters for <tt>'Content-Type'</tt>.
+#
+# === Queries
+#
+# - #chunked?: Returns whether field <tt>'Transfer-Encoding'</tt> is set to <tt>'chunked'</tt>.
+# - #connection_close?: Returns whether field <tt>'Connection'</tt> is set to <tt>'close'</tt>.
+# - #connection_keep_alive?: Returns whether field <tt>'Connection'</tt> is set to <tt>'keep-alive'</tt>.
+# - #key?: Returns whether a given key exists.
+#
+# === Iterators
+#
+# - #each_capitalized: Passes each field capitalized-name/value pair to the block.
+# - #each_capitalized_name: Passes each capitalized field name to the block.
+# - #each_header: Passes each field name/value pair to the block.
+# - #each_name: Passes each field name to the block.
+# - #each_value: Passes each string field value to the block.
 #
 module Net::HTTPHeader
 
-  def initialize_http_header(initheader)
+  def initialize_http_header(initheader) #:nodoc:
     @header = {}
     return unless initheader
     initheader.each do |key, value|
@@ -33,14 +203,34 @@ module Net::HTTPHeader
 
   alias length size   #:nodoc: obsolete
 
-  # Returns the header field corresponding to the case-insensitive key.
-  # For example, a key of "Content-Type" might return "text/html"
+  # Returns the string field value for the case-insensitive field +key+,
+  # or +nil+ if there is no such key;
+  # see {Fields}[rdoc-ref:Net::HTTPHeader@Fields]:
+  #
+  #   res = Net::HTTP.start(hostname) do |http|
+  #     http.get('/todos/1')
+  #   end
+  #   res['Connection'] # => "keep-alive"
+  #   res['Nosuch']     # => nil
+  #
+  # Note that some field values may be retrieved via convenience methods;
+  # see {Getters}[rdoc-ref:Net::HTTPHeader@Getters].
   def [](key)
     a = @header[key.downcase.to_s] or return nil
     a.join(', ')
   end
 
-  # Sets the header field corresponding to the case-insensitive key.
+  # Sets the value for the case-insensitive +key+ to +val+,
+  # overwriting the previous value if the field exists;
+  # see {Fields}[rdoc-ref:Net::HTTPHeader@Fields]:
+  #
+  #   req = Net::HTTP::Get.new(uri)
+  #   req['Accept'] # => "*/*"
+  #   req['Accept'] = 'text/html'
+  #   req['Accept'] # => "text/html"
+  #
+  # Note that some field values may be set via convenience methods;
+  # see {Setters}[rdoc-ref:Net::HTTPHeader@Setters].
   def []=(key, val)
     unless val
       @header.delete key.downcase.to_s
@@ -49,20 +239,18 @@ module Net::HTTPHeader
     set_field(key, val)
   end
 
-  # [Ruby 1.8.3]
-  # Adds a value to a named header field, instead of replacing its value.
-  # Second argument +val+ must be a String.
-  # See also #[]=, #[] and #get_fields.
+  # Adds value +val+ to the value array for field +key+ if the field exists;
+  # creates the field with the given +key+ and +val+ if it does not exist.
+  # see {Fields}[rdoc-ref:Net::HTTPHeader@Fields]:
   #
-  #   request.add_field 'X-My-Header', 'a'
-  #   p request['X-My-Header']              #=> "a"
-  #   p request.get_fields('X-My-Header')   #=> ["a"]
-  #   request.add_field 'X-My-Header', 'b'
-  #   p request['X-My-Header']              #=> "a, b"
-  #   p request.get_fields('X-My-Header')   #=> ["a", "b"]
-  #   request.add_field 'X-My-Header', 'c'
-  #   p request['X-My-Header']              #=> "a, b, c"
-  #   p request.get_fields('X-My-Header')   #=> ["a", "b", "c"]
+  #   req = Net::HTTP::Get.new(uri)
+  #   req.add_field('Foo', 'bar')
+  #   req['Foo']            # => "bar"
+  #   req.add_field('Foo', 'baz')
+  #   req['Foo']            # => "bar, baz"
+  #   req.add_field('Foo', %w[baz bam])
+  #   req['Foo']            # => "bar, baz, baz, bam"
+  #   req.get_fields('Foo') # => ["bar", "baz", "baz", "bam"]
   #
   def add_field(key, val)
     stringified_downcased_key = key.downcase.to_s
@@ -101,16 +289,15 @@ module Net::HTTPHeader
     end
   end
 
-  # [Ruby 1.8.3]
-  # Returns an array of header field strings corresponding to the
-  # case-insensitive +key+.  This method allows you to get duplicated
-  # header fields without any processing.  See also #[].
+  # Returns the array field value for the given +key+,
+  # or +nil+ if there is no such field;
+  # see {Fields}[rdoc-ref:Net::HTTPHeader@Fields]:
   #
-  #   p response.get_fields('Set-Cookie')
-  #     #=> ["session=al98axx; expires=Fri, 31-Dec-1999 23:58:23",
-  #          "query=rubyscript; expires=Fri, 31-Dec-1999 23:58:23"]
-  #   p response['Set-Cookie']
-  #     #=> "session=al98axx; expires=Fri, 31-Dec-1999 23:58:23, query=rubyscript; expires=Fri, 31-Dec-1999 23:58:23"
+  #   res = Net::HTTP.start(hostname) do |http|
+  #     http.get('/todos/1')
+  #   end
+  #   res.get_fields('Connection') # => ["keep-alive"]
+  #   res.get_fields('Nosuch')     # => nil
   #
   def get_fields(key)
     stringified_downcased_key = key.downcase.to_s
@@ -118,24 +305,62 @@ module Net::HTTPHeader
     @header[stringified_downcased_key].dup
   end
 
-  # Returns the header field corresponding to the case-insensitive key.
-  # Returns the default value +args+, or the result of the block, or
-  # raises an IndexError if there's no header field named +key+
-  # See Hash#fetch
+  # :call-seq
+  #   fetch(key, default_val = nil) {|key| ... } -> object
+  #   fetch(key, default_val = nil) -> value or default_val
+  #
+  # With a block, returns the string value for +key+ if it exists;
+  # otherwise returns the value of the block;
+  # ignores the +default_val+;
+  # see {Fields}[rdoc-ref:Net::HTTPHeader@Fields]:
+  #
+  #   res = Net::HTTP.start(hostname) do |http|
+  #     http.get('/todos/1')
+  #   end
+  #
+  #   # Field exists; block not called.
+  #   res.fetch('Connection') do |value|
+  #     fail 'Cannot happen'
+  #   end # => "keep-alive"
+  #
+  #   # Field does not exist; block called.
+  #   res.fetch('Nosuch') do |value|
+  #     value.downcase
+  #   end # => "nosuch"
+  #
+  # With no block, returns the string value for +key+ if it exists;
+  # otherwise, returns +default_val+ if it was given;
+  # otherwise raises an exception:
+  #
+  #   res.fetch('Connection', 'Foo') # => "keep-alive"
+  #   res.fetch('Nosuch', 'Foo')     # => "Foo"
+  #   res.fetch('Nosuch')            # Raises KeyError.
+  #
   def fetch(key, *args, &block)   #:yield: +key+
     a = @header.fetch(key.downcase.to_s, *args, &block)
     a.kind_of?(Array) ? a.join(', ') : a
   end
 
-  # Iterates through the header names and values, passing in the name
-  # and value to the code block supplied.
+  # Calls the block with each key/value pair:
   #
-  # Returns an enumerator if no block is given.
+  #   res = Net::HTTP.start(hostname) do |http|
+  #     http.get('/todos/1')
+  #   end
+  #   res.each_header do |key, value|
+  #     p [key, value] if key.start_with?('c')
+  #   end
   #
-  # Example:
+  # Output:
+  #
+  #   ["content-type", "application/json; charset=utf-8"]
+  #   ["connection", "keep-alive"]
+  #   ["cache-control", "max-age=43200"]
+  #   ["cf-cache-status", "HIT"]
+  #   ["cf-ray", "771d17e9bc542cf5-ORD"]
   #
-  #     response.header.each_header {|key,value| puts "#{key} = #{value}" }
+  # Returns an enumerator if no block is given.
   #
+  # Net::HTTPHeader#each is an alias for Net::HTTPHeader#each_header.
   def each_header   #:yield: +key+, +value+
     block_given? or return enum_for(__method__) { @header.size }
     @header.each do |k,va|
@@ -145,10 +370,26 @@ module Net::HTTPHeader
 
   alias each each_header
 
-  # Iterates through the header names in the header, passing
-  # each header name to the code block.
+  # Calls the block with each field key:
+  #
+  #   res = Net::HTTP.start(hostname) do |http|
+  #     http.get('/todos/1')
+  #   end
+  #   res.each_key do |key|
+  #     p key if key.start_with?('c')
+  #   end
+  #
+  # Output:
+  #
+  # "content-type"
+  # "connection"
+  # "cache-control"
+  # "cf-cache-status"
+  # "cf-ray"
   #
   # Returns an enumerator if no block is given.
+  #
+  # Net::HTTPHeader#each_name is an alias for Net::HTTPHeader#each_key.
   def each_name(&block)   #:yield: +key+
     block_given? or return enum_for(__method__) { @header.size }
     @header.each_key(&block)
@@ -156,12 +397,25 @@ module Net::HTTPHeader
 
   alias each_key each_name
 
-  # Iterates through the header names in the header, passing
-  # capitalized header names to the code block.
+  # Calls the block with each capitalized field name:
+  #
+  #   res = Net::HTTP.start(hostname) do |http|
+  #     http.get('/todos/1')
+  #   end
+  #   res.each_capitalized_name do |key|
+  #     p key if key.start_with?('C')
+  #   end
   #
-  # Note that header names are capitalized systematically;
-  # capitalization may not match that used by the remote HTTP
-  # server in its response.
+  # Output:
+  #
+  #   "Content-Type"
+  #   "Connection"
+  #   "Cache-Control"
+  #   "Cf-Cache-Status"
+  #   "Cf-Ray"
+  #
+  # The capitalization is system-dependent;
+  # see {Case Mapping}[https://docs.ruby-lang.org/en/master/case_mapping_rdoc.html].
   #
   # Returns an enumerator if no block is given.
   def each_capitalized_name  #:yield: +key+
@@ -171,8 +425,20 @@ module Net::HTTPHeader
     end
   end
 
-  # Iterates through header values, passing each value to the
-  # code block.
+  # Calls the block with each string field value:
+  #
+  #   res = Net::HTTP.start(hostname) do |http|
+  #     http.get('/todos/1')
+  #   end
+  #   res.each_value do |value|
+  #     p value if value.start_with?('c')
+  #   end
+  #
+  # Output:
+  #
+  #   "chunked"
+  #   "cf-q-config;dur=6.0000002122251e-06"
+  #   "cloudflare"
   #
   # Returns an enumerator if no block is given.
   def each_value   #:yield: +value+
@@ -182,32 +448,45 @@ module Net::HTTPHeader
     end
   end
 
-  # Removes a header field, specified by case-insensitive key.
+  # Removes the header for the given case-insensitive +key+
+  # (see {Fields}[rdoc-ref:Net::HTTPHeader@Fields]);
+  # returns the deleted value, or +nil+ if no such field exists:
+  #
+  #   req = Net::HTTP::Get.new(uri)
+  #   req.delete('Accept') # => ["*/*"]
+  #   req.delete('Nosuch') # => nil
+  #
   def delete(key)
     @header.delete(key.downcase.to_s)
   end
 
-  # true if +key+ header exists.
+  # Returns +true+ if the field for the case-insensitive +key+ exists, +false+ otherwise:
+  #
+  #   req = Net::HTTP::Get.new(uri)
+  #   req.key?('Accept') # => true
+  #   req.key?('Nosuch') # => false
+  #
   def key?(key)
     @header.key?(key.downcase.to_s)
   end
 
-  # Returns a Hash consisting of header names and array of values.
-  # e.g.
-  # {"cache-control" => ["private"],
-  #  "content-type" => ["text/html"],
-  #  "date" => ["Wed, 22 Jun 2005 22:11:50 GMT"]}
+  # Returns a hash of the key/value pairs:
+  #
+  #   req = Net::HTTP::Get.new(uri)
+  #   req.to_hash
+  #   # =>
+  #   {"accept-encoding"=>["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"],
+  #    "accept"=>["*/*"],
+  #    "user-agent"=>["Ruby"],
+  #    "host"=>["jsonplaceholder.typicode.com"]}
+  #
   def to_hash
     @header.dup
   end
 
-  # As for #each_header, except the keys are provided in capitalized form.
-  #
-  # Note that header names are capitalized systematically;
-  # capitalization may not match that used by the remote HTTP
-  # server in its response.
+  # Like #each_header, but the keys are returned in capitalized form.
   #
-  # Returns an enumerator if no block is given.
+  # Net::HTTPHeader#canonical_each is an alias for Net::HTTPHeader#each_capitalized.
   def each_capitalized
     block_given? or return enum_for(__method__) { @header.size }
     @header.each do |k,v|
@@ -222,8 +501,17 @@ module Net::HTTPHeader
   end
   private :capitalize
 
-  # Returns an Array of Range objects which represent the Range:
-  # HTTP header field, or +nil+ if there is no such header.
+  # Returns an array of Range objects that represent
+  # the value of field <tt>'Range'</tt>,
+  # or +nil+ if there is no such field;
+  # see {Range request header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#range-request-header]:
+  #
+  #   req = Net::HTTP::Get.new(uri)
+  #   req['Range'] = 'bytes=0-99,200-299,400-499'
+  #   req.range # => [0..99, 200..299, 400..499]
+  #   req.delete('Range')
+  #   req.range # # => nil
+  #
   def range
     return nil unless @header['range']
 
@@ -266,14 +554,31 @@ module Net::HTTPHeader
     result
   end
 
-  # Sets the HTTP Range: header.
-  # Accepts either a Range object as a single argument,
-  # or a beginning index and a length from that index.
-  # Example:
+  # :call-seq:
+  #   set_range(length) -> length
+  #   set_range(offset, length) -> range
+  #   set_range(begin..length) -> range
+  #
+  # Sets the value for field <tt>'Range'</tt>;
+  # see {Range request header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#range-request-header]:
+  #
+  # With argument +length+:
   #
-  #   req.range = (0..1023)
-  #   req.set_range 0, 1023
+  #   req = Net::HTTP::Get.new(uri)
+  #   req.set_range(100)      # => 100
+  #   req['Range']            # => "bytes=0-99"
   #
+  # With arguments +offset+ and +length+:
+  #
+  #   req.set_range(100, 100) # => 100...200
+  #   req['Range']            # => "bytes=100-199"
+  #
+  # With argument +range+:
+  #
+  #   req.set_range(100..199) # => 100..199
+  #   req['Range']            # => "bytes=100-199"
+  #
+  # Net::HTTPHeader#range= is an alias for Net::HTTPHeader#set_range.
   def set_range(r, e = nil)
     unless r
       @header.delete 'range'
@@ -394,7 +699,9 @@ module Net::HTTPHeader
   # Sets the content type in an HTTP header.
   # The +type+ should be a full HTTP content type, e.g. "text/html".
   # The +params+ are an optional Hash of parameters to add after the
-  # content type, e.g. {'charset' => 'iso-8859-1'}
+  # content type, e.g. {'charset' => 'iso-8859-1'}.
+  #
+  # Net::HTTPHeader#content_type= is an alias for Net::HTTPHeader#set_content_type.
   def set_content_type(type, params = {})
     @header['content-type'] = [type + params.map{|k,v|"; #{k}=#{v}"}.join('')]
   end
@@ -414,6 +721,7 @@ module Net::HTTPHeader
   #    http.form_data = {"q" => ["ruby", "perl"], "lang" => "en"}
   #    http.set_form_data({"q" => "ruby", "lang" => "en"}, ';')
   #
+  # Net::HTTPHeader#form_data= is an alias for Net::HTTPHeader#set_form_data.
   def set_form_data(params, sep = '&')
     query = URI.encode_www_form(params)
     query.gsub!(/&/, sep) if sep != '&'

data/lib/net/http/request.rb

@@ -1,8 +1,31 @@
 # frozen_string_literal: false
-# HTTP request class.
-# This class wraps together the request header and the request path.
-# You cannot use this class directly. Instead, you should use one of its
-# subclasses: Net::HTTP::Get, Net::HTTP::Post, Net::HTTP::Head.
+
+# This class is the base class for \Net::HTTP request classes;
+# it wraps together the request path and the request headers.
+#
+# The class should not be used directly;
+# instead you should use its subclasses.
+#
+# Subclasses for HTTP requests:
+#
+# - Net::HTTP::Get
+# - Net::HTTP::Head
+# - Net::HTTP::Post
+# - Net::HTTP::Put
+# - Net::HTTP::Delete
+# - Net::HTTP::Options
+# - Net::HTTP::Trace
+# - Net::HTTP::Patch
+#
+# Subclasses for WebDAV requests:
+#
+# - Net::HTTP::Propfind
+# - Net::HTTP::Proppatch
+# - Net::HTTP::Mkcol
+# - Net::HTTP::Copy
+# - Net::HTTP::Move
+# - Net::HTTP::Lock
+# - Net::HTTP::Unlock
 #
 class Net::HTTPRequest < Net::HTTPGenericRequest
   # Creates an HTTP request object for +path+.
@@ -18,4 +41,3 @@ class Net::HTTPRequest < Net::HTTPGenericRequest
           path, initheader
   end
 end
-