module Net::HTTPHeader

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

Возвращает строковое значение поля для поля key без учета регистра или nil, если такого ключа нет; см. раздел Поля:

res = Net::HTTP.get_response(hostname, '/todos/1')
res['Connection'] # => "keep-alive"
res['Nosuch']     # => nil

Обратите внимание, что значения некоторых полей можно получить с помощью удобных методов; см. раздел Методы получения.

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

Устанавливает значение для поля key без учета регистра в val, заменяя предыдущее значение, если поле существует; см. раздел Поля:

req = Net::HTTP::Get.new(uri)
req['Accept'] # => "*/*"
req['Accept'] = 'text/html'
req['Accept'] # => "text/html"

Обратите внимание, что значения некоторых полей можно устанавливать с помощью удобных методов; см. раздел Методы установки.

# File lib/net/http/header.rb, line 261
def add_field(key, val)
  stringified_downcased_key = key.downcase.to_s
  if @header.key?(stringified_downcased_key)
    append_field_value(@header[stringified_downcased_key], val)
  else
    set_field(key, val)
  end
end

Добавляет значение val в массив значений поля key, если поле существует; создает поле с заданными key и val, если оно не существует. см. раздел Поля:

req = Net::HTTP::Get.new(uri)
req.add_field('Foo', 'bar')
req['Foo']            # => "bar"
req.add_field('Foo', 'baz')
req['Foo']            # => "bar, baz"
req.add_field('Foo', %w[baz bam])
req['Foo']            # => "bar, baz, baz, bam"
req.get_fields('Foo') # => ["bar", "baz", "baz", "bam"]

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

Устанавливает заголовок 'Authorization' с использованием заданных строк account и password:

req.basic_auth('my_account', 'my_password')
req['Authorization']
# => "Basic bXlfYWNjb3VudDpteV9wYXNzd29yZA=="

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

Возвращает true, если поле 'Transfer-Encoding' существует и имеет значение 'chunked', и false в противном случае; см. заголовок ответа Transfer-Encoding:

res = Net::HTTP.get_response(hostname, '/todos/1')
res['Transfer-Encoding'] # => "chunked"
res.chunked?             # => true

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

Возвращает признак того, что сеанс HTTP следует закрыть.

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

Возвращает признак того, что сеанс HTTP следует поддерживать открытым.

# File lib/net/http/header.rb, line 616
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' в виде целого числа или nil, если такого поля нет; см. заголовок запроса Content-Length:

res = Net::HTTP.get_response(hostname, '/nosuch/1')
res.content_length # => 2
res = Net::HTTP.get_response(hostname, '/todos/1')
res.content_length # => nil

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

Устанавливает значение поля 'Content-Length' в заданное числовое значение; см. заголовок ответа Content-Length:

_uri = uri.dup
hostname = _uri.hostname           # => "jsonplaceholder.typicode.com"
_uri.path = '/posts'               # => "/posts"
req = Net::HTTP::Post.new(_uri)    # => #<Net::HTTP::Post POST>
req.body = '{"title": "foo","body": "bar","userId": 1}'
req.content_length = req.body.size # => 42
req.content_type = 'application/json'
res = Net::HTTP.start(hostname) do |http|
  http.request(req)
end # => #<Net::HTTPCreated 201 Created readbody=true>

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

Возвращает объект Range, представляющий значение поля 'Content-Range', или nil, если такого поля нет; см. заголовок ответа Content-Range:

res = Net::HTTP.get_response(hostname, '/todos/1')
res['Content-Range'] # => nil
res['Content-Range'] = 'bytes 0-499/1000'
res['Content-Range'] # => "bytes 0-499/1000"
res.content_range    # => 0..499

# File lib/net/http/header.rb, line 701
def content_type
  main = main_type()
  return nil unless main

  sub = sub_type()
  if sub
    "#{main}/#{sub}"
  else
    main
  end
end

Возвращает тип мультимедиа из значения поля 'Content-Type' или nil, если такого поля нет; см. заголовок ответа Content-Type:

res = Net::HTTP.get_response(hostname, '/todos/1')
res['content-type'] # => "application/json; charset=utf-8"
res.content_type    # => "application/json"

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

Удаляет заголовок для заданного key без учета регистра (см. раздел Поля); возвращает удаленное значение или nil, если такого поля нет:

req = Net::HTTP::Get.new(uri)
req.delete('Accept') # => ["*/*"]
req.delete('Nosuch') # => nil

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

Подобно each_header, но ключи возвращаются с заглавными буквами.

Net::HTTPHeader#canonical_each — это псевдоним для Net::HTTPHeader#each_capitalized.

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

Вызывает блок для каждого имени поля, преобразованного в форму с заглавными буквами:

res = Net::HTTP.get_response(hostname, '/todos/1')
res.each_capitalized_name do |key|
  p key if key.start_with?('C')
end

Вывод:

"Content-Type"
"Connection"
"Cache-Control"
"Cf-Cache-Status"
"Cf-Ray"

Преобразование регистра зависит от системы; см. Преобразование регистра.

Если блок не задан, возвращает перечислитель.

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

Вызывает блок для каждой пары ключ/значение:

res = Net::HTTP.get_response(hostname, '/todos/1')
res.each_header do |key, value|
  p [key, value] if key.start_with?('c')
end

Вывод:

["content-type", "application/json; charset=utf-8"]
["connection", "keep-alive"]
["cache-control", "max-age=43200"]
["cf-cache-status", "HIT"]
["cf-ray", "771d17e9bc542cf5-ORD"]

Если блок не задан, возвращает перечислитель.

Net::HTTPHeader#each — это псевдоним для Net::HTTPHeader#each_header.

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

Вызывает блок для каждого ключа поля:

res = Net::HTTP.get_response(hostname, '/todos/1')
res.each_key do |key|
  p key if key.start_with?('c')
end

Вывод:

"content-type"
"connection"
"cache-control"
"cf-cache-status"
"cf-ray"

Если блок не задан, возвращает перечислитель.

Net::HTTPHeader#each_name — это псевдоним для Net::HTTPHeader#each_key.

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

Вызывает блок для каждого строкового значения поля:

res = Net::HTTP.get_response(hostname, '/todos/1')
res.each_value do |value|
  p value if value.start_with?('c')
end

Вывод:

"chunked"
"cf-q-config;dur=6.0000002122251e-06"
"cloudflare"

Если блок не задан, возвращает перечислитель.

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

Если задан блок, возвращает строковое значение для key, если оно существует; в противном случае возвращает значение блока; аргумент default_val игнорируется; см. раздел Поля:

res = Net::HTTP.get_response(hostname, '/todos/1')

# Field exists; block not called.
res.fetch('Connection') do |value|
  fail 'Cannot happen'
end # => "keep-alive"

# Field does not exist; block called.
res.fetch('Nosuch') do |value|
  value.downcase
end # => "nosuch"

Если блок не задан, возвращает строковое значение для key, если оно существует; в противном случае возвращает default_val, если оно было задано; иначе вызывает исключение:

res.fetch('Connection', 'Foo') # => "keep-alive"
res.fetch('Nosuch', 'Foo')     # => "Foo"
res.fetch('Nosuch')            # Raises KeyError.

# File lib/net/http/header.rb, line 306
def get_fields(key)
  stringified_downcased_key = key.downcase.to_s
  return nil unless @header[stringified_downcased_key]
  @header[stringified_downcased_key].dup
end

Возвращает значение поля в виде массива для заданного key или nil, если такого поля нет; см. раздел Поля:

res = Net::HTTP.get_response(hostname, '/todos/1')
res.get_fields('Connection') # => ["keep-alive"]
res.get_fields('Nosuch')     # => nil

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

Возвращает true, если поле для key без учета регистра существует, и false в противном случае:

req = Net::HTTP::Get.new(uri)
req.key?('Accept') # => true
req.key?('Nosuch') # => false

# File lib/net/http/header.rb, line 723
def main_type
  return nil unless @header['content-type']
  self['Content-Type'].split(';').first.to_s.split('/')[0].to_s.strip
end

Возвращает начальную часть («тип») типа мультимедиа из значения поля 'Content-Type' или nil, если такого поля нет; см. заголовок ответа Content-Type:

res = Net::HTTP.get_response(hostname, '/todos/1')
res['content-type'] # => "application/json; charset=utf-8"
res.main_type       # => "application"

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

Устанавливает заголовок 'Proxy-Authorization' с использованием заданных строк account и password:

req.proxy_basic_auth('my_account', 'my_password')
req['Proxy-Authorization']
# => "Basic bXlfYWNjb3VudDpteV9wYXNzd29yZA=="

# File lib/net/http/header.rb, line 509
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, представляющих значение поля 'Range', или nil, если такого поля нет; см. заголовок запроса Range:

req = Net::HTTP::Get.new(uri)
req['Range'] = 'bytes=0-99,200-299,400-499'
req.range # => [0..99, 200..299, 400..499]
req.delete('Range')
req.range # # => nil

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

Возвращает целое число, представляющее длину значения поля 'Content-Range', или nil, если такого поля нет; см. заголовок ответа Content-Range:

res = Net::HTTP.get_response(hostname, '/todos/1')
res['Content-Range'] # => nil
res['Content-Range'] = 'bytes 0-499/1000'
res.range_length     # => 500

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

Устанавливает значение поля 'Content-Type'; возвращает новое значение; см. заголовок запроса Content-Type:

req = Net::HTTP::Get.new(uri)
req.set_content_type('application/json') # => ["application/json"]

Net::HTTPHeader#content_type= — это псевдоним для Net::HTTPHeader#set_content_type.

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

Сохраняет данные формы для использования в запросе POST или PUT.

Данные формы, переданные в params, состоят из нуля или более полей; каждое поле представляет собой:

• Скалярное значение.

• Пару имя/значение.

• Поток IO, открытый для чтения.

Аргумент params должен быть объектом Enumerable (будет вызван метод params.map); обычно это массив или хеш.

Сначала подготовим запрос:

_uri = uri.dup
_uri.path ='/posts'
req = Net::HTTP::Post.new(_uri)

Аргумент params в виде массива

Если params — это массив, каждый его элемент представляет собой подмассив, определяющий поле; подмассив может содержать:

• Одну строку:

  req.set_form([['foo'], ['bar'], ['baz']])
  

• Две строки:

  req.set_form([%w[foo 0], %w[bar 1], %w[baz 2]])
  

• Если аргумент enctype (см. ниже) задан как 'multipart/form-data':

  • Строковое имя и поток IO, открытый для чтения:

    require 'stringio'
    req.set_form([['file', StringIO.new('Ruby is cool.')]])
    

  • Строковое имя, поток IO, открытый для чтения, и хеш параметров, который может содержать следующие записи:

    • :filename: имя используемого файла.

    • :content_type: тип содержимого загружаемого файла.

    Пример:

    req.set_form([['file', file, {filename: "other-filename.foo"}]]

Можно сочетать различные формы:

req.set_form(['foo', %w[bar 1], ['file', file]])

Аргумент params в виде хеша

Если params — это хеш, каждая его запись представляет собой пару имя/значение, определяющую поле:

• Имя — это строка.

• Значение может быть:

  • nil.

  • Другой строкой.

  • Потоком IO, открытым для чтения (только если аргумент enctype — см. ниже — задан как 'multipart/form-data').

Примеры:

# Nil-valued fields.
req.set_form({'foo' => nil, 'bar' => nil, 'baz' => nil})

# String-valued fields.
req.set_form({'foo' => 0, 'bar' => 1, 'baz' => 2})

# IO-valued field.
require 'stringio'
req.set_form({'file' => StringIO.new('Ruby is cool.')})

# Mixture of fields.
req.set_form({'foo' => nil, 'bar' => 1, 'file' => file})

Необязательный аргумент enctype задает значение для поля 'Content-Type' и должен быть одним из следующих:

• 'application/x-www-form-urlencoded' (по умолчанию).

• 'multipart/form-data'; см. RFC 7578.

Необязательный аргумент formopt — это хеш параметров (применяется только если аргумент enctype равен 'multipart/form-data'), который может содержать следующие записи:

• :boundary: значение — это строка-разделитель для составного сообщения. Если она не задана, используется случайная строка. См. раздел Строка-разделитель.

• :charset: значение задает кодировку отправляемой формы. Имена полей и значения полей, не содержащих файлы, должны быть закодированы с ее использованием.

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

Устанавливает тело запроса в виде строки с кодированием URL, сформированной на основе аргумента params, и задает для поля заголовка запроса 'Content-Type' значение 'application/x-www-form-urlencoded'.

Полученный запрос подходит для запроса HTTP POST или PUT.

Аргумент params должен подходить для использования в качестве аргумента enum метода URI.encode_www_form.

Если задан только аргумент params, тело запроса задается в виде строки с кодированием URL и стандартным разделителем '&':

req = Net::HTTP::Post.new('example.com')

req.set_form_data(q: 'ruby', lang: 'en')
req.body            # => "q=ruby&lang=en"
req['Content-Type'] # => "application/x-www-form-urlencoded"

req.set_form_data([['q', 'ruby'], ['lang', 'en']])
req.body            # => "q=ruby&lang=en"

req.set_form_data(q: ['ruby', 'perl'], lang: 'en')
req.body            # => "q=ruby&q=perl&lang=en"

req.set_form_data([['q', 'ruby'], ['q', 'perl'], ['lang', 'en']])
req.body            # => "q=ruby&q=perl&lang=en"

Если также задан строковый аргумент sep, эта строка используется в качестве разделителя:

req.set_form_data({q: 'ruby', lang: 'en'}, '|')
req.body # => "q=ruby|lang=en"

Net::HTTPHeader#form_data= — это псевдоним для Net::HTTPHeader#set_form_data.

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

Устанавливает значение поля 'Range'; см. заголовок запроса Range:

С аргументом length:

req = Net::HTTP::Get.new(uri)
req.set_range(100)      # => 100
req['Range']            # => "bytes=0-99"

С аргументами offset и length:

req.set_range(100, 100) # => 100...200
req['Range']            # => "bytes=100-199"

С аргументом range:

req.set_range(100..199) # => 100..199
req['Range']            # => "bytes=100-199"

Net::HTTPHeader#range= — это псевдоним для Net::HTTPHeader#set_range.

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

Возвращает конечную часть («подтип») типа мультимедиа из значения поля 'Content-Type' или nil, если такого поля нет; см. заголовок ответа Content-Type:

res = Net::HTTP.get_response(hostname, '/todos/1')
res['content-type'] # => "application/json; charset=utf-8"
res.sub_type        # => "json"

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

Возвращает хеш пар ключ/значение:

req = Net::HTTP::Get.new(uri)
req.to_hash
# =>
{"accept-encoding"=>["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"],
 "accept"=>["*/*"],
 "user-agent"=>["Ruby"],
 "host"=>["jsonplaceholder.typicode.com"]}

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

Возвращает конечную часть («параметры») значения поля 'Content-Type' или nil, если такого поля нет; см. заголовок ответа Content-Type:

res = Net::HTTP.get_response(hostname, '/todos/1')
res['content-type'] # => "application/json; charset=utf-8"
res.type_params     # => {"charset"=>"utf-8"}