Module: Net::HTTPHeader
- Included in:
- HTTPGenericRequest, HTTPResponse
- Defined in:
- lib/net/http.rb
Overview
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.
Instance Method Summary collapse
-
#[](key) ⇒ Object
Returns the header field corresponding to the case-insensitive key.
-
#[]=(key, val) ⇒ Object
Sets the header field corresponding to the case-insensitive key.
-
#add_field(key, val) ⇒ Object
- Ruby 1.8.3
-
Adds header field instead of replace.
-
#basic_auth(account, password) ⇒ Object
Set the Authorization: header for "Basic" authorization.
-
#chunked? ⇒ Boolean
Returns "true" if the "transfer-encoding" header is present and set to "chunked".
-
#content_length ⇒ Object
Returns an Integer object which represents the Content-Length: header field or
nil
if that field is not provided. - #content_length=(len) ⇒ Object
-
#content_range ⇒ Object
Returns a Range object which represents Content-Range: header field.
-
#content_type ⇒ Object
Returns a content type string such as "text/html".
-
#delete(key) ⇒ Object
Removes a header field.
-
#each_capitalized ⇒ Object
(also: #canonical_each)
As for #each_header, except the keys are provided in capitalized form.
-
#each_capitalized_name(&block) ⇒ Object
Iterates for each capitalized header names.
-
#each_header ⇒ Object
(also: #each)
Iterates for each header names and values.
-
#each_name(&block) ⇒ Object
(also: #each_key)
Iterates for each header names.
-
#each_value ⇒ Object
Iterates for each header values.
-
#fetch(key, *args, &block) ⇒ Object
Returns the header field corresponding to the case-insensitive key.
-
#get_fields(key) ⇒ Object
- Ruby 1.8.3
-
Returns an array of header field strings corresponding to the case-insensitive
key
.
- #initialize_http_header(initheader) ⇒ Object
-
#key?(key) ⇒ Boolean
true if
key
header exists. -
#main_type ⇒ Object
Returns a content type string such as "text".
-
#proxy_basic_auth(account, password) ⇒ Object
Set Proxy-Authorization: header for "Basic" authorization.
-
#range ⇒ Object
Returns an Array of Range objects which represents Range: header field, or
nil
if there is no such header. -
#range_length ⇒ Object
The length of the range represented in Content-Range: header.
-
#set_content_type(type, params = {}) ⇒ Object
(also: #content_type=)
Set Content-Type: header field by
type
andparams
. -
#set_form_data(params, sep = '&') ⇒ Object
(also: #form_data=)
Set header fields and a body from HTML form data.
-
#set_range(r, e = nil) ⇒ Object
(also: #range=)
Set Range: header from Range (arg r) or beginning index and length from it (arg idx&len).
-
#size ⇒ Object
(also: #length)
:nodoc: obsolete.
-
#sub_type ⇒ Object
Returns a content type string such as "html".
-
#to_hash ⇒ Object
Returns a Hash consist of header names and values.
-
#type_params ⇒ Object
Returns content type parameters as a Hash as like => "iso-2022-jp".
Instance Method Details
#[](key) ⇒ Object
Returns the header field corresponding to the case-insensitive key. For example, a key of "Content-Type" might return "text/html"
1160 1161 1162 1163 |
# File 'lib/net/http.rb', line 1160 def [](key) a = @header[key.downcase] or return nil a.join(', ') end |
#[]=(key, val) ⇒ Object
Sets the header field corresponding to the case-insensitive key.
1166 1167 1168 1169 1170 1171 1172 |
# File 'lib/net/http.rb', line 1166 def []=(key, val) unless val @header.delete key.downcase return val end @header[key.downcase] = [val] end |
#add_field(key, val) ⇒ Object
- 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'] #=> "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"]
1189 1190 1191 1192 1193 1194 1195 |
# File 'lib/net/http.rb', line 1189 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) ⇒ Object
Set the Authorization: header for "Basic" authorization.
1445 1446 1447 |
# File 'lib/net/http.rb', line 1445 def basic_auth(account, password) @header['authorization'] = [basic_encode(account, password)] end |
#chunked? ⇒ Boolean
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.
1356 1357 1358 1359 1360 |
# File 'lib/net/http.rb', line 1356 def chunked? return false unless @header['transfer-encoding'] field = self['Transfer-Encoding'] (/(?:\A|[^\-\w])chunked(?![\-\w])/i =~ field) ? true : false end |
#content_length ⇒ Object
Returns an Integer object which represents the Content-Length: header field or nil
if that field is not provided.
1337 1338 1339 1340 1341 1342 |
# File 'lib/net/http.rb', line 1337 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) ⇒ Object
1344 1345 1346 1347 1348 1349 1350 |
# File 'lib/net/http.rb', line 1344 def content_length=(len) unless len @header.delete 'content-length' return nil end @header['content-length'] = [len.to_i.to_s] end |
#content_range ⇒ Object
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.
1365 1366 1367 1368 1369 1370 |
# File 'lib/net/http.rb', line 1365 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 end |
#content_type ⇒ Object
Returns a content type string such as "text/html". This method returns nil if Content-Type: header field does not exist.
1380 1381 1382 1383 1384 1385 1386 |
# File 'lib/net/http.rb', line 1380 def content_type return nil unless main_type() if sub_type() then "#{main_type()}/#{sub_type()}" else main_type() end end |
#delete(key) ⇒ Object
Removes a header field.
1252 1253 1254 |
# File 'lib/net/http.rb', line 1252 def delete(key) @header.delete(key.downcase) end |
#each_capitalized ⇒ Object Also known as: canonical_each
As for #each_header, except the keys are provided in capitalized form.
1267 1268 1269 1270 1271 |
# File 'lib/net/http.rb', line 1267 def each_capitalized @header.each do |k,v| yield capitalize(k), v.join(', ') end end |
#each_capitalized_name(&block) ⇒ Object
Iterates for each capitalized header names.
1238 1239 1240 1241 1242 |
# File 'lib/net/http.rb', line 1238 def each_capitalized_name(&block) #:yield: +key+ @header.each_key do |k| yield capitalize(k) end end |
#each_header ⇒ Object Also known as: each
Iterates for each header names and values.
1222 1223 1224 1225 1226 |
# File 'lib/net/http.rb', line 1222 def each_header #:yield: +key+, +value+ @header.each do |k,va| yield k, va.join(', ') end end |
#each_name(&block) ⇒ Object Also known as: each_key
Iterates for each header names.
1231 1232 1233 |
# File 'lib/net/http.rb', line 1231 def each_name(&block) #:yield: +key+ @header.each_key(&block) end |
#each_value ⇒ Object
Iterates for each header values.
1245 1246 1247 1248 1249 |
# File 'lib/net/http.rb', line 1245 def each_value #:yield: +value+ @header.each_value do |va| yield va.join(', ') end end |
#fetch(key, *args, &block) ⇒ Object
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
1216 1217 1218 1219 |
# File 'lib/net/http.rb', line 1216 def fetch(key, *args, &block) #:yield: +key+ a = @header.fetch(key.downcase, *args, &block) a.join(', ') end |
#get_fields(key) ⇒ Object
- 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"
1208 1209 1210 1211 |
# File 'lib/net/http.rb', line 1208 def get_fields(key) return nil unless @header[key.downcase] @header[key.downcase].dup end |
#initialize_http_header(initheader) ⇒ Object
1143 1144 1145 1146 1147 1148 1149 1150 |
# File 'lib/net/http.rb', line 1143 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 |
#key?(key) ⇒ Boolean
true if key
header exists.
1257 1258 1259 |
# File 'lib/net/http.rb', line 1257 def key?(key) @header.key?(key.downcase) end |
#main_type ⇒ Object
Returns a content type string such as "text". This method returns nil if Content-Type: header field does not exist.
1390 1391 1392 1393 |
# File 'lib/net/http.rb', line 1390 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) ⇒ Object
Set Proxy-Authorization: header for "Basic" authorization.
1450 1451 1452 |
# File 'lib/net/http.rb', line 1450 def proxy_basic_auth(account, password) @header['proxy-authorization'] = [basic_encode(account, password)] end |
#range ⇒ Object
Returns an Array of Range objects which represents Range: header field, or nil
if there is no such header.
1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 |
# File 'lib/net/http.rb', line 1282 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_length ⇒ Object
The length of the range represented in Content-Range: header.
1373 1374 1375 1376 |
# File 'lib/net/http.rb', line 1373 def range_length r = content_range() or return nil r.end - r.begin + 1 end |
#set_content_type(type, params = {}) ⇒ Object Also known as: content_type=
Set Content-Type: header field by type
and params
. type
must be a String, params
must be a Hash.
1420 1421 1422 |
# File 'lib/net/http.rb', line 1420 def set_content_type(type, params = {}) @header['content-type'] = [type + params.map{|k,v|"; #{k}=#{v}"}.join('')] end |
#set_form_data(params, sep = '&') ⇒ Object Also known as: form_data=
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.
1432 1433 1434 1435 |
# File 'lib/net/http.rb', line 1432 def set_form_data(params, sep = '&') self.body = params.map {|k,v| "#{urlencode(k.to_s)}=#{urlencode(v.to_s)}" }.join(sep) self.content_type = 'application/x-www-form-urlencoded' end |
#set_range(r, e = nil) ⇒ Object Also known as: range=
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
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'lib/net/http.rb', line 1304 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 |
#size ⇒ Object Also known as: length
:nodoc: obsolete
1152 1153 1154 |
# File 'lib/net/http.rb', line 1152 def size #:nodoc: obsolete @header.size end |
#sub_type ⇒ Object
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").
1398 1399 1400 1401 1402 1403 |
# File 'lib/net/http.rb', line 1398 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 ⇒ Object
Returns a Hash consist of header names and values.
1262 1263 1264 |
# File 'lib/net/http.rb', line 1262 def to_hash @header.dup end |
#type_params ⇒ Object
Returns content type parameters as a Hash as like => "iso-2022-jp".
1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 |
# File 'lib/net/http.rb', line 1407 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 |