[](key)
click to toggle source
Returns the header field corresponding to the case-insensitive key. For
example, a key of “Content-Type” might return “text/html”
def [](key)
a = @header[key.downcase] or return nil
a.join(', ')
end
[]=(key, val)
click to toggle source
Sets the header field corresponding to the case-insensitive key.
def []=(key, val)
unless val
@header.delete key.downcase
return val
end
@header[key.downcase] = [val]
end
add_field(key, val)
click to toggle source
- Ruby 1.8.3
-
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']
p request.get_fields('X-My-Header')
request.add_field 'X-My-Header', 'b'
p request['X-My-Header']
p request.get_fields('X-My-Header')
request.add_field 'X-My-Header', 'c'
p request['X-My-Header']
p request.get_fields('X-My-Header')
def add_field(key, val)
if @header.key?(key.downcase)
@header[key.downcase].push val
else
@header[key.downcase] = [val]
end
end
basic_auth(account, password)
click to toggle source
Set the Authorization: header for “Basic” authorization.
def basic_auth(account, password)
@header['authorization'] = [basic_encode(account, password)]
end
canonical_each()
click to toggle source
chunked?()
click to toggle source
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.
def chunked?
return false unless @header['transfer-encoding']
field = self['Transfer-Encoding']
(/(?:\A|[^\-\w])chunked(?![\-\w])/i =~ field) ? true : false
end
content_length()
click to toggle source
Returns an Integer object which represents the Content-Length: header field
or nil
if that field is not provided.
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
content_length=(len)
click to toggle source
def content_length=(len)
unless len
@header.delete 'content-length'
return nil
end
@header['content-length'] = [len.to_i.to_s]
end
content_range()
click to toggle source
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.
def content_range
return nil unless @header['content-range']
m = %r<bytes\s+(\d+)-(\d+)/(\d+|\*)>i.match(self['Content-Range']) or
raise HTTPHeaderSyntaxError, 'wrong Content-Range format'
m[1].to_i .. m[2].to_i + 1
end
content_type()
click to toggle source
Returns a content type string such as “text/html”. This method returns nil
if Content-Type: header field does not exist.
def content_type
return nil unless main_type()
if sub_type()
then "#{main_type()}/#{sub_type()}"
else main_type()
end
end
content_type=(type, params = {})
click to toggle source
delete(key)
click to toggle source
Removes a header field.
def delete(key)
@header.delete(key.downcase)
end
each()
click to toggle source
each_capitalized()
click to toggle source
As for each_header,
except the keys are provided in capitalized form.
def each_capitalized
@header.each do |k,v|
yield capitalize(k), v.join(', ')
end
end
each_capitalized_name()
click to toggle source
Iterates for each capitalized header names.
def each_capitalized_name(&block)
@header.each_key do |k|
yield capitalize(k)
end
end
each_key()
click to toggle source
each_name()
click to toggle source
Iterates for each header names.
def each_name(&block)
@header.each_key(&block)
end
each_value()
click to toggle source
Iterates for each header values.
def each_value
@header.each_value do |va|
yield va.join(', ')
end
end
fetch(key, *args)
click to toggle source
Returns the header field corresponding to the case-insensitive key. Returns
the default value args
, or the result of the block, or nil, if
there's no header field named key. See Hash#fetch
def fetch(key, *args, &block)
a = @header.fetch(key.downcase, *args, &block)
a.join(', ')
end
get_fields(key)
click to toggle source
- 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 [].
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"
def get_fields(key)
return nil unless @header[key.downcase]
@header[key.downcase].dup
end
key?(key)
click to toggle source
true if key
header exists.
def key?(key)
@header.key?(key.downcase)
end
main_type()
click to toggle source
Returns a content type string such as “text”. This method returns nil if
Content-Type: header field does not exist.
def main_type
return nil unless @header['content-type']
self['Content-Type'].split(';').first.to_s.split('/')[0].to_s.strip
end
proxy_basic_auth(account, password)
click to toggle source
Set Proxy-Authorization: header for “Basic” authorization.
def proxy_basic_auth(account, password)
@header['proxy-authorization'] = [basic_encode(account, password)]
end
range()
click to toggle source
Returns an Array of Range objects which represents Range: header field, or
nil
if there is no such header.
def range
return nil unless @header['range']
self['Range'].split(/,/).map {|spec|
m = /bytes\s*=\s*(\d+)?\s*-\s*(\d+)?/i.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
range=(r, e = nil)
click to toggle source
range_length()
click to toggle source
The length of the range represented in Content-Range: header.
def range_length
r = content_range() or return nil
r.end - r.begin
end
set_content_type(type, params = {})
click to toggle source
Set Content-Type: header field by type
and
params
. type
must be a String,
params
must be a Hash.
def set_content_type(type, params = {})
@header['content-type'] = [type + params.map{|k,v|"; #{k}=#{v}"}.join('')]
end
set_range(r, e = nil)
click to toggle source
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
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
sub_type()
click to toggle source
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”).
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
to_hash()
click to toggle source
Returns a Hash consist of header names and values.
def to_hash
@header.dup
end
type_params()
click to toggle source
Returns content type parameters as a Hash as like {“charset” =>
“iso-2022-jp”}.
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