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

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"



1154
1155
1156
1157
 
# File 'lib/net/http.rb', line 1154

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.



1160
1161
1162
1163
1164
1165
1166
 
# File 'lib/net/http.rb', line 1160

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"]



1183
1184
1185
1186
1187
1188
1189
 
# File 'lib/net/http.rb', line 1183

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.



1439
1440
1441
 
# File 'lib/net/http.rb', line 1439

def basic_auth(, password)
  @header['authorization'] = [basic_encode(, 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.

Returns:

  • (Boolean) 


1350
1351
1352
1353
1354
 
# File 'lib/net/http.rb', line 1350

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.



1331
1332
1333
1334
1335
1336
 
# File 'lib/net/http.rb', line 1331

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 



1338
1339
1340
1341
1342
1343
1344
 
# File 'lib/net/http.rb', line 1338

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.



1359
1360
1361
1362
1363
1364
 
# File 'lib/net/http.rb', line 1359

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 ⇒ Object

Returns a content type string such as "text/html". This method returns nil if Content-Type: header field does not exist.



1374
1375
1376
1377
1378
1379
1380
 
# File 'lib/net/http.rb', line 1374

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.



1246
1247
1248
 
# File 'lib/net/http.rb', line 1246

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.



1261
1262
1263
1264
1265
 
# File 'lib/net/http.rb', line 1261

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.



1232
1233
1234
1235
1236
 
# File 'lib/net/http.rb', line 1232

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.



1216
1217
1218
1219
1220
 
# File 'lib/net/http.rb', line 1216

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.



1225
1226
1227
 
# File 'lib/net/http.rb', line 1225

def each_name(&block)   #:yield: +key+
  @header.each_key(&block)
end

#each_value ⇒ Object

Iterates for each header values.



1239
1240
1241
1242
1243
 
# File 'lib/net/http.rb', line 1239

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



1210
1211
1212
1213
 
# File 'lib/net/http.rb', line 1210

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"



1202
1203
1204
1205
 
# File 'lib/net/http.rb', line 1202

def get_fields(key)
  return nil unless @header[key.downcase]
  @header[key.downcase].dup
end

#initialize_http_header(initheader) ⇒ Object 



1137
1138
1139
1140
1141
1142
1143
1144
 
# File 'lib/net/http.rb', line 1137

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.

Returns:

  • (Boolean) 


1251
1252
1253
 
# File 'lib/net/http.rb', line 1251

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.



1384
1385
1386
1387
 
# File 'lib/net/http.rb', line 1384

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.



1444
1445
1446
 
# File 'lib/net/http.rb', line 1444

def proxy_basic_auth(, password)
  @header['proxy-authorization'] = [basic_encode(, password)]
end

#range ⇒ Object

Returns an Array of Range objects which represents Range: header field, or nil if there is no such header.



1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File 'lib/net/http.rb', line 1276

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.



1367
1368
1369
1370
 
# File 'lib/net/http.rb', line 1367

def range_length
  r = content_range() or return nil
  r.end - r.begin
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.



1414
1415
1416
 
# File 'lib/net/http.rb', line 1414

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.



1426
1427
1428
1429
 
# File 'lib/net/http.rb', line 1426

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



1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
 
# File 'lib/net/http.rb', line 1298

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



1146
1147
1148
 
# File 'lib/net/http.rb', line 1146

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").



1392
1393
1394
1395
1396
1397
 
# File 'lib/net/http.rb', line 1392

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.



1256
1257
1258
 
# File 'lib/net/http.rb', line 1256

def to_hash
  @header.dup
end

#type_params ⇒ Object

Returns content type parameters as a Hash as like => "iso-2022-jp".



1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
 
# File 'lib/net/http.rb', line 1401

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