модуль Net::HTTPHeader

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

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

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

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

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

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

Добавляет значение 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"]

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

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

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

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

Возвращает информацию о том, следует ли закрыть сеанс HTTP.

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

Возвращает значение поля '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

Устанавливает значение поля '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>

Возвращает объект 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

Возвращает тип мультимедиа из значения поля '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"

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

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

Аналогичен each_header, но ключи возвращаются с заглавной буквы.

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

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

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"

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

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

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

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.

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

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.

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

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"

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

Если задан блок, возвращает строковое значение для 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.

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

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

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

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

Возвращает начальную часть («тип») типа мультимедиа из значения поля '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"

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

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

Возвращает массив объектов 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

Возвращает целое число, обозначающее длину значения поля '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

Устанавливает значение поля '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.

Сохраняет данные формы для использования в запросе 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: значением является набор символов для отправки формы. Имена и значения полей, не содержащих файлов, следует кодировать с использованием этого набора символов.

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

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

Аргумент 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.

Устанавливает значение поля '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.

Возвращает конечную часть («подтип») типа мультимедиа из значения поля '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"

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

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

Возвращает конечную часть («параметры») значения поля '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"}