![[+]](../images/find.png "show/hide quicksearch"){kind=small}
Header module.
Provides access to @header in the mixed-into class as a hash-like object, except with case-insensitive keys. Also provides methods for accessing commonly-used header values in a more convenient format.
Returns the header field corresponding to the case-insensitive key. For example, a key of “Content-Type” might return “text/html”
# File net/http.rb, line 1238
def [](key)
a = @header[key.downcase] or return nil
a.join(', ')
end
Sets the header field corresponding to the case-insensitive key.
# File net/http.rb, line 1244
def []=(key, val)
unless val
@header.delete key.downcase
return val
end
@header[key.downcase] = [val]
end
Adds header field instead of replace. Second argument val must
be a String. See also #[]=, #[] and get_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"]
# File net/http.rb, line 1267
def add_field(key, val)
if @header.key?(key.downcase)
@header[key.downcase].push val
else
@header[key.downcase] = [val]
end
end
Set the Authorization: header for “Basic” authorization.
# File net/http.rb, line 1535
def basic_auth(account, password)
@header['authorization'] = [basic_encode(account, password)]
end
Returns “true” if the “transfer-encoding” header is present and set to “chunked”. This is an HTTP/1.1 feature, allowing the the content to be sent in “chunks” without at the outset stating the entire content length.
# File net/http.rb, line 1435
def chunked?
return false unless @header['transfer-encoding']
field = self['Transfer-Encoding']
(/(?:\A|[^\-\w])chunked(?![\-\w])/ =~ field) ? true : false
end
# File net/http.rb, line 1549
def connection_close?
tokens(@header['connection']).include?('close') or
tokens(@header['proxy-connection']).include?('close')
end
# File net/http.rb, line 1554
def connection_keep_alive?
tokens(@header['connection']).include?('keep-alive') or
tokens(@header['proxy-connection']).include?('keep-alive')
end
Returns an Integer object which represents the Content-Length: header field
or nil if that field is not provided.
# File net/http.rb, line 1416
def content_length
return nil unless key?('Content-Length')
len = self['Content-Length'].slice(/\d+/) or
raise HTTPHeaderSyntaxError, 'wrong Content-Length format'
len.to_i
end
# File net/http.rb, line 1423
def content_length=(len)
unless len
@header.delete 'content-length'
return nil
end
@header['content-length'] = [len.to_i.to_s]
end
Returns a Range object which represents Content-Range: header field. This indicates, for a partial entity body, where this fragment fits inside the full entity body, as range of byte offsets.
# File net/http.rb, line 1444
def content_range
return nil unless @header['content-range']
m = %r<bytes\s+(\d+)-(\d+)/(\d+|\*)>.match(self['Content-Range']) or
raise HTTPHeaderSyntaxError, 'wrong Content-Range format'
m[1].to_i .. m[2].to_i + 1
end
Returns a content type string such as “text/html”. This method returns nil if Content-Type: header field does not exist.
# File net/http.rb, line 1459
def content_type
return nil unless main_type()
if sub_type()
then "#{main_type()}/#{sub_type()}"
else main_type()
end
end
Removes a header field.
# File net/http.rb, line 1331
def delete(key)
@header.delete(key.downcase)
end
As for each_header, except the keys are provided in capitalized form.
# File net/http.rb, line 1346
def each_capitalized
@header.each do |k,v|
yield capitalize(k), v.join(', ')
end
end
Iterates for each capitalized header names.
# File net/http.rb, line 1317
def each_capitalized_name(&block) #:yield: +key+
@header.each_key do |k|
yield capitalize(k)
end
end
Iterates for each header names and values.
# File net/http.rb, line 1301
def each_header #:yield: +key+, +value+
@header.each do |k,va|
yield k, va.join(', ')
end
end
Iterates for each header names.
# File net/http.rb, line 1310
def each_name(&block) #:yield: +key+
@header.each_key(&block)
end
Iterates for each header values.
# File net/http.rb, line 1324
def each_value #:yield: +value+
@header.each_value do |va|
yield va.join(', ')
end
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 IndexErrror if there’s no header field named key See
Hash#fetch
# File net/http.rb, line 1295
def fetch(key, *args, &block) #:yield: +key+
a = @header.fetch(key.downcase, *args, &block)
a.kind_of?(Array) ? a.join(', ') : a
end
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 #[].
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"
# File net/http.rb, line 1286
def get_fields(key)
return nil unless @header[key.downcase]
@header[key.downcase].dup
end
# File net/http.rb, line 1221
def initialize_http_header(initheader)
@header = {}
return unless initheader
initheader.each do |key, value|
warn "net/http: warning: duplicated HTTP header: #{key}" if key?(key) and $VERBOSE
@header[key.downcase] = [value.strip]
end
end
true if key header exists.
# File net/http.rb, line 1336
def key?(key)
@header.key?(key.downcase)
end
Returns a content type string such as “text”. This method returns nil if Content-Type: header field does not exist.
# File net/http.rb, line 1469
def main_type
return nil unless @header['content-type']
self['Content-Type'].split(';').first.to_s.split('/')[0].to_s.strip
end
Set Proxy-Authorization: header for “Basic” authorization.
# File net/http.rb, line 1540
def proxy_basic_auth(account, password)
@header['proxy-authorization'] = [basic_encode(account, password)]
end
Returns an Array of Range objects which represents Range: header field, or
nil if there is no such header.
# File net/http.rb, line 1361
def range
return nil unless @header['range']
self['Range'].split(/,/).map {|spec|
m = /bytes\s*=\s*(\d+)?\s*-\s*(\d+)?/.match(spec) or
raise HTTPHeaderSyntaxError, "wrong Range: #{spec}"
d1 = m[1].to_i
d2 = m[2].to_i
if m[1] and m[2] then d1..d2
elsif m[1] then d1..-1
elsif m[2] then -d2..-1
else
raise HTTPHeaderSyntaxError, 'range is not specified'
end
}
end
The length of the range represented in Content-Range: header.
# File net/http.rb, line 1452
def range_length
r = content_range() or return nil
r.end - r.begin
end
Set Content-Type: header field by type and
params. type must be a String,
params must be a Hash.
# File net/http.rb, line 1499
def set_content_type(type, params = {})
@header['content-type'] = [type + params.map{|k,v|"; #{k}=#{v}"}.join('')]
end
Set header fields and a body from HTML form data. params
should be a Hash containing HTML form data. Optional argument
sep means data record separator.
This method also set Content-Type: header field to application/x-www-form-urlencoded.
Example:
http.form_data = {"q" => "ruby", "lang" => "en"} http.form_data = {"q" => ["ruby", "perl"], "lang" => "en"} http.set_form_data({"q" => "ruby", "lang" => "en"}, ';')
# File net/http.rb, line 1517
def set_form_data(params, sep = '&')
self.body = params.map {|k, v| encode_kvpair(k, v) }.flatten.join(sep)
self.content_type = 'application/x-www-form-urlencoded'
end
Set Range: header from Range (arg r) or beginning index and length from it (arg idx&len).
req.range = (0..1023) req.set_range 0, 1023
# File net/http.rb, line 1383
def set_range(r, e = nil)
unless r
@header.delete 'range'
return r
end
r = (r...r+e) if e
case r
when Numeric
n = r.to_i
rangestr = (n > 0 ? "0-#{n-1}" : "-#{-n}")
when Range
first = r.first
last = r.last
last -= 1 if r.exclude_end?
if last == -1
rangestr = (first > 0 ? "#{first}-" : "-#{-first}")
else
raise HTTPHeaderSyntaxError, 'range.first is negative' if first < 0
raise HTTPHeaderSyntaxError, 'range.last is negative' if last < 0
raise HTTPHeaderSyntaxError, 'must be .first < .last' if first > last
rangestr = "#{first}-#{last}"
end
else
raise TypeError, 'Range/Integer is required'
end
@header['range'] = ["bytes=#{rangestr}"]
r
end
Returns a content type string such as “html”. This method returns nil if Content-Type: header field does not exist or sub-type is not given (e.g. “Content-Type: text”).
# File net/http.rb, line 1477
def sub_type
return nil unless @header['content-type']
main, sub = *self['Content-Type'].split(';').first.to_s.split('/')
return nil unless sub
sub.strip
end
Returns a Hash consist of header names and values.
# File net/http.rb, line 1341
def to_hash
@header.dup
end
Returns content type parameters as a Hash as like {“charset” => “iso-2022-jp”}.
# File net/http.rb, line 1486
def type_params
result = {}
list = self['Content-Type'].to_s.split(';')
list.shift
list.each do |param|
k, v = *param.split('=', 2)
result[k.strip] = v.strip
end
result
end
Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.
If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.
If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.
If you want to help improve the Ruby documentation, please see Improve the docs, or visit Documenting-ruby.org.