Net::HTTPHeader

module Net::HTTPHeader

HTTPHeader 模块定义了读写HTTP头的方法。

它被其他类用作mixin，以提供对HTTP头值的散列式访问。与原始哈希访问不同，HTTPHeader通过不区分大小写的密钥提供访问。它还提供了以更方便的格式访问常用HTTP头值的方法。

公共实例方法

Show source

返回对应于不区分大小写的键的标题字段。例如，“Content-Type”键可能会返回“text / html”

# File lib/net/http/header.rb, line 33
def [](key)
  a = @header[key.downcase] or return nil
  a.join(', ')
end

[]=(key, val) Show source

设置与不区分大小写的键相对应的标题字段。

# File lib/net/http/header.rb, line 39
def []=(key, val)
  unless val
    @header.delete key.downcase
    return val
  end
  @header[key.downcase] = [val]
end

add_field(key, val) Show source

Ruby 1.8.3

将值添加到指定的标题字段，而不是替换其值。第二个参数val必须是一个String。另见[] =，[]和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 lib/net/http/header.rb, line 62
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) Show source

为“基本”授权设置授权：标头。

# File lib/net/http/header.rb, line 433
def basic_auth(account, password)
  @header['authorization'] = [basic_encode(account, password)]
end

canonical_each()

Alias for: each_capitalized

chunked?() Show source

如果“传输编码”标题存在并设置为“分块”，则返回“true”。这是一项HTTP / 1.1功能，允许内容以“块”形式发送，而不必一开始就说明整个内容的长度。

# File lib/net/http/header.rb, line 294
def chunked?
  return false unless @header['transfer-encoding']
  field = self['Transfer-Encoding']
  (/(?:\A|[^\-\w])chunked(?![\-\w])/i =~ field) ? true : false
end

connection_close?() Show source

# File lib/net/http/header.rb, line 447
def connection_close?
  token = /(?:\A|,)\s*close\s*(?:\z|,)/i
  @header['connection']&.grep(token) {return true}
  @header['proxy-connection']&.grep(token) {return true}
  false
end

connection_keep_alive?() Show source

# File lib/net/http/header.rb, line 454
def connection_keep_alive?
  token = /(?:\A|,)\s*keep-alive\s*(?:\z|,)/i
  @header['connection']&.grep(token) {return true}
  @header['proxy-connection']&.grep(token) {return true}
  false
end

content_length() Show source

返回表示HTTP Content-Length：头字段的Integer对象，或者nil未提供该字段。

# File lib/net/http/header.rb, line 275
def content_length
  return nil unless key?('Content-Length')
  len = self['Content-Length'].slice(/\d+/) or
      raise Net::HTTPHeaderSyntaxError, 'wrong Content-Length format'
  len.to_i
end

content_length=(len) Show source

# File lib/net/http/header.rb, line 282
def content_length=(len)
  unless len
    @header.delete 'content-length'
    return nil
  end
  @header['content-length'] = [len.to_i.to_s]
end

content_range() Show source

返回表示Content-Range：标题字段值的Range对象。对于部分实体主体，这表示这个片段在整个实体主体内的位置，作为字节偏移的范围。

# File lib/net/http/header.rb, line 304
def content_range
  return nil unless @header['content-range']
  m = %r<bytes\s+(\d+)-(\d+)/(\d+|\*)>i.match(self['Content-Range']) or
      raise Net::HTTPHeaderSyntaxError, 'wrong Content-Range format'
  m[1].to_i .. m[2].to_i
end

content_type() Show source

返回一个内容类型字符串，如“text / html”。如果Content-Type：头字段不存在，则此方法返回nil。

# File lib/net/http/header.rb, line 319
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 = {})

Alias for: set_content_type

delete(key) Show source

删除由不区分大小写的键指定的标题字段。

# File lib/net/http/header.rb, line 151
def delete(key)
  @header.delete(key.downcase)
end

each()

别名为：each_header

each_capitalized() { |capitalize(k), join(', ')| ... } Show source

至于each_header，除了以大写形式提供密钥外。

请注意，标题名称是系统化的大写; 大写可能与远程HTTP服务器在响应中使用的大小不匹配。

如果没有给出块，则返回一个枚举器。

# File lib/net/http/header.rb, line 176
def each_capitalized
  block_given? or return enum_for(__method__) { @header.size }
  @header.each do |k,v|
    yield capitalize(k), v.join(', ')
  end
end

另外别名为：canonical_each

each_capitalized_name() { |key| ... } Show source

迭代头部中的头部名称，将大写的头部名称传递给代码块。

请注意，标题名称是系统化的大写; 大写可能与远程HTTP服务器在响应中使用的大小不匹配。

如果没有给出块，则返回一个枚举器。

# File lib/net/http/header.rb, line 132
def each_capitalized_name  #:yield: +key+
  block_given? or return enum_for(__method__) { @header.size }
  @header.each_key do |k|
    yield capitalize(k)
  end
end

each_header() { |key| ... } Show source

迭代头部名称和值，将名称和值传递给所提供的代码块。

如果没有给出块，则返回一个枚举器。

例：

response.header.each_header {|key,value| puts "#{key} = #{value}" }

# File lib/net/http/header.rb, line 104
def each_header   #:yield: +key+, +value+
  block_given? or return enum_for(__method__) { @header.size }
  @header.each do |k,va|
    yield k, va.join(', ')
  end
end

还有别名：每个

each_key()

Alias for: each_name

each_name() { |key| ... } Show source

遍历头部中的头部名称，将每个头部名称传递给代码块。

如果没有给出块，则返回一个枚举器。

# File lib/net/http/header.rb, line 117
def each_name(&block)   #:yield: +key+
  block_given? or return enum_for(__method__) { @header.size }
  @header.each_key(&block)
end

Also aliased as: each_key

each_value() { |value| ... } Show source

迭代头部值，将每个值传递给代码块。

如果没有给出块，则返回一个枚举器。

# File lib/net/http/header.rb, line 143
def each_value   #:yield: +value+
  block_given? or return enum_for(__method__) { @header.size }
  @header.each_value do |va|
    yield va.join(', ')
  end
end

fetch(key, *args) { |key| ... } Show source

返回对应于不区分大小写的键的标题字段。返回默认值args或块的结果，或者如果没有名为keySee Hash＃fetch的头字段，则引发IndexError

# File lib/net/http/header.rb, line 90
def fetch(key, *args, &block)   #:yield: +key+
  a = @header.fetch(key.downcase, *args, &block)
  a.kind_of?(Array) ? a.join(', ') : a
end

form_data=(params, sep = '&')

Alias for: set_form_data

get_fields(key) Show source

Ruby 1.8.3

返回对应于大小写不敏感的头字段字符串数组key。这种方法可以让你无需任何处理就可以得到重复的标题字段。也可以看看 []。

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 lib/net/http/header.rb, line 81
def get_fields(key)
  return nil unless @header[key.downcase]
  @header[key.downcase].dup
end

initialize_http_header(initheader) Show source

# File lib/net/http/header.rb, line 12
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
    if value.nil?
      warn "net/http: warning: nil HTTP header: #{key}" if $VERBOSE
    else
      @header[key.downcase] = [value.strip]
    end
  end
end

key?(key) Show source

如果key头存在，则为true 。

# File lib/net/http/header.rb, line 156
def key?(key)
  @header.key?(key.downcase)
end

main_type() Show source

返回一个内容类型字符串，如“text”。如果Content-Type：头字段不存在，则此方法返回nil。

# File lib/net/http/header.rb, line 329
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) Show source

为“基本”授权设置代理授权：标头。

# File lib/net/http/header.rb, line 438
def proxy_basic_auth(account, password)
  @header['proxy-authorization'] = [basic_encode(account, password)]
end

range() Show source

返回表示范围：HTTP标头字段的Range对象数组，或者nil如果没有这样的标头。

# File lib/net/http/header.rb, line 192
def range
  return nil unless @header['range']

  value = self['Range']
  # byte-range-set = *( "," OWS ) ( byte-range-spec / suffix-byte-range-spec )
  #   *( OWS "," [ OWS ( byte-range-spec / suffix-byte-range-spec ) ] )
  # corrected collected ABNF
  # http://tools.ietf.org/html/draft-ietf-httpbis-p5-range-19#section-5.4.1
  # http://tools.ietf.org/html/draft-ietf-httpbis-p5-range-19#appendix-C
  # http://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-19#section-3.2.5
  unless /\Abytes=((?:,[ \t]*)*(?:\d+-\d*|-\d+)(?:[ \t]*,(?:[ \t]*\d+-\d*|-\d+)?)*)\z/ =~ value
    raise Net::HTTPHeaderSyntaxError, "invalid syntax for byte-ranges-specifier: '#{value}'"
  end

  byte_range_set = $1
  result = byte_range_set.split(/,/).map {|spec|
    m = /(\d+)?\s*-\s*(\d+)?/i.match(spec) or
            raise Net::HTTPHeaderSyntaxError, "invalid byte-range-spec: '#{spec}'"
    d1 = m[1].to_i
    d2 = m[2].to_i
    if m[1] and m[2]
      if d1 > d2
        raise Net::HTTPHeaderSyntaxError, "last-byte-pos MUST greater than or equal to first-byte-pos but '#{spec}'"
      end
      d1..d2
    elsif m[1]
      d1..-1
    elsif m[2]
      -d2..-1
    else
      raise Net::HTTPHeaderSyntaxError, 'range is not specified'
    end
  }
  # if result.empty?
  # byte-range-set must include at least one byte-range-spec or suffix-byte-range-spec
  # but above regexp already denies it.
  if result.size == 1 && result[0].begin == 0 && result[0].end == -1
    raise Net::HTTPHeaderSyntaxError, 'only one suffix-byte-range-spec with zero suffix-length'
  end
  result
end

range=(r, e = nil)

Alias for: set_range

range_length() Show source

Content-Range：表示的范围的长度。

# File lib/net/http/header.rb, line 312
def range_length
  r = content_range() or return nil
  r.end - r.begin + 1
end

set_content_type(type, params = {}) Show source

在HTTP标头中设置内容类型。本type应该是一个完整的HTTP内容类型，如“text / html的”。这params是在内容类型之后添加的可选散列参数，例如{'charset'=>'iso-8859-1'}

# File lib/net/http/header.rb, line 362
def set_content_type(type, params = {})
  @header['content-type'] = [type + params.map{|k,v|"; #{k}=#{v}"}.join('')]
end

Also aliased as: content_type=

set_form(params, enctype='application/x-www-form-urlencoded', formopt={}) Show source

设置一个HTML表单数据集。params是表单数据集; 它是数组或数组的散列+ enctype是用于对表单数据集进行编码的类型。它是application / x-www-form-urlencoded或multipart / form-data。formopt是一个可选的哈希来指定细节。

边界

多部分消息的边界

charset

消息的字符集。所有名称和非文件字段的值都被编码为字符集。

每个参数项都是一个数组，并包含以下项目：

name

该字段的名称

value

字段的值，它应该是一个字符串或文件

opt

一个可选的哈希来指定附加信息

每个项目是文件字段或普通字段。如果value是一个File对象或opt具有一个文件名键，则该项目被视为一个文件字段。

如果Transfer-Encoding设置为分块，则以分块编码方式发送请求。由于分块编码是HTTP / 1.1功能，因此在发送之前必须确认服务器支持HTTP / 1.1。

例：

http.set_form([["q", "ruby"], ["lang", "en"]])

See also RFC 2388, RFC 2616, HTML 4.01, and HTML5

# File lib/net/http/header.rb, line 418
def set_form(params, enctype='application/x-www-form-urlencoded', formopt={})
  @body_data = params
  @body = nil
  @body_stream = nil
  @form_option = formopt
  case enctype
  when /\Aapplication\/x-www-form-urlencoded\z/i,
    /\Amultipart\/form-data\z/i
    self.content_type = enctype
  else
    raise ArgumentError, "invalid enctype: #{enctype}"
  end
end

set_form_data(params, sep = '&') Show source

从HTML表单数据设置标题字段和正文。params应该是包含HTML表单数据的数组或数组。可选参数sep表示数据记录分隔符。

数值根据需要进行了URL编码，内容类型设置为application / x-www-form-urlencoded

例：

http.form_data = {"q" => "ruby", "lang" => "en"}
http.form_data = {"q" => ["ruby", "perl"], "lang" => "en"}
http.set_form_data{"q" => "ruby", "lang" => "en"}, ';')

# File lib/net/http/header.rb, line 381
def set_form_data(params, sep = '&')
  query = URI.encode_www_form(params)
  query.gsub!(/&/, sep) if sep != '&'
  self.body = query
  self.content_type = 'application/x-www-form-urlencoded'
end

Also aliased as: form_data=

set_range(r, e = nil) Show source

设置HTTP范围：标题。接受Range对象作为单个参数，或者从该索引开始的索引和长度。例：

req.range = (0..1023)
req.set_range 0, 1023

# File lib/net/http/header.rb, line 242
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.end
    last -= 1 if r.exclude_end?
    if last == -1
      rangestr = (first > 0 ? "#{first}-" : "-#{-first}")
    else
      raise Net::HTTPHeaderSyntaxError, 'range.first is negative' if first < 0
      raise Net::HTTPHeaderSyntaxError, 'range.last is negative' if last < 0
      raise Net::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

Also aliased as: range=

sub_type() Show source

返回一个内容类型字符串，如“html”。如果Content-Type：头字段不存在或未提供子类型（例如“Content-Type：text”），则此方法返回nil。

# File lib/net/http/header.rb, line 337
def sub_type
  return nil unless @header['content-type']
  _, sub = *self['Content-Type'].split(';').first.to_s.split('/')
  return nil unless sub
  sub.strip
end

to_hash() Show source

返回由标题名称和值数组组成的哈希。例如{“cache-control”=>“private”，

"content-type" => ["text/html"],
"date" => ["Wed, 22 Jun 2005 22:11:50 GMT"]}

# File lib/net/http/header.rb, line 165
def to_hash
  @header.dup
end

type_params() Show source

为内容类型指定的任何参数，作为散列返回。例如，Content-Type：text / html; charset = EUC-JP会导致#type_params返回{'charset'=>'EUC-JP'}

# File lib/net/http/header.rb, line 347
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

私有实例方法

basic_encode(account, password) Show source

# File lib/net/http/header.rb, line 442
def basic_encode(account, password)
  'Basic ' + ["#{account}:#{password}"].pack('m0')
end

capitalize(name) Show source

# File lib/net/http/header.rb, line 185
def capitalize(name)
  name.to_s.split(/-/).map {|s| s.capitalize }.join('-')
end