class Net::HTTPSession

# File lib/net/http.rb, line 935
def HTTP.default_port
  http_default_port()
end

Возвращает целое число 80 — порт по умолчанию для HTTP-запросов:

Net::HTTP.default_port # => 80

# File lib/net/http.rb, line 804
def HTTP.get(uri_or_host, path_or_headers = nil, port = nil)
  get_response(uri_or_host, path_or_headers, port).body
end

Отправляет GET-запрос и возвращает тело HTTP-ответа в виде строки.

При строковых аргументах hostname и path:

hostname = 'jsonplaceholder.typicode.com'
path = '/todos/1'
puts Net::HTTP.get(hostname, path)

Вывод:

{
  "userId": 1,
  "id": 1,
  "title": "delectus aut autem",
  "completed": false
}

С объектом URI uri и необязательным аргументом-хешем headers:

uri = URI('https://jsonplaceholder.typicode.com/todos/1')
headers = {'Content-type' => 'application/json; charset=UTF-8'}
Net::HTTP.get(uri, headers)

См. также:

• Net::HTTP::Get: класс запроса для HTTP-метода GET.

• Net::HTTP#get: вспомогательный метод для HTTP-метода GET.

# File lib/net/http.rb, line 763
def HTTP.get_print(uri_or_host, path_or_headers = nil, port = nil)
  get_response(uri_or_host, path_or_headers, port) {|res|
    res.read_body do |chunk|
      $stdout.print chunk
    end
  }
  nil
end

Как Net::HTTP.get, но записывает возвращённое тело в $stdout; возвращает nil.

# File lib/net/http.rb, line 814
def HTTP.get_response(uri_or_host, path_or_headers = nil, port = nil, &block)
  if path_or_headers && !path_or_headers.is_a?(Hash)
    host = uri_or_host
    path = path_or_headers
    new(host, port || HTTP.default_port).start {|http|
      return http.request_get(path, &block)
    }
  else
    uri = uri_or_host
    headers = path_or_headers
    start(uri.hostname, uri.port,
          :use_ssl => uri.scheme == 'https') {|http|
      return http.request_get(uri, headers, &block)
    }
  end
end

Как Net::HTTP.get, но возвращает объект Net::HTTPResponse вместо строки тела.

# File lib/net/http.rb, line 943
def HTTP.http_default_port
  80
end

Возвращает целое число 80 — порт по умолчанию для HTTP-запросов:

Net::HTTP.http_default_port # => 80

# File lib/net/http.rb, line 951
def HTTP.https_default_port
  443
end

Возвращает целое число 443 — порт по умолчанию для HTTPS-запросов:

Net::HTTP.https_default_port # => 443

# File lib/net/http.rb, line 1100
def HTTP.new(address, port = nil, p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil, p_no_proxy = nil, p_use_ssl = nil)
  http = super address, port

  if proxy_class? then # from Net::HTTP::Proxy()
    http.proxy_from_env = @proxy_from_env
    http.proxy_address  = @proxy_address
    http.proxy_port     = @proxy_port
    http.proxy_user     = @proxy_user
    http.proxy_pass     = @proxy_pass
    http.proxy_use_ssl  = @proxy_use_ssl
  elsif p_addr == :ENV then
    http.proxy_from_env = true
  else
    if p_addr && p_no_proxy && !URI::Generic.use_proxy?(address, address, port, p_no_proxy)
      p_addr = nil
      p_port = nil
    end
    http.proxy_address = p_addr
    http.proxy_port    = p_port || default_port
    http.proxy_user    = p_user
    http.proxy_pass    = p_pass
    http.proxy_use_ssl = p_use_ssl
  end

  http
end

Возвращает новый объект Net::HTTP http (но не открывает TCP-соединение или HTTP-сеанс).

Если указан только строковый аргумент address (а ENV['http_proxy'] не задан или равен nil), возвращаемый http:

• Имеет указанный адрес.

• Имеет номер порта по умолчанию — Net::HTTP.default_port (80).

• Не использует прокси.

Пример:

http = Net::HTTP.new(hostname)
# => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
http.address # => "jsonplaceholder.typicode.com"
http.port    # => 80
http.proxy?  # => false

Если также указан целочисленный аргумент port, возвращаемый http имеет указанный порт:

http = Net::HTTP.new(hostname, 8000)
# => #<Net::HTTP jsonplaceholder.typicode.com:8000 open=false>
http.port # => 8000

Сведения об аргументах p_addr–p_no_proxy, задающих прокси, см. в разделе Прокси-сервер.

# File lib/net/http.rb, line 857
def HTTP.post(url, data, header = nil)
  start(url.hostname, url.port,
        :use_ssl => url.scheme == 'https' ) {|http|
    http.post(url, data, header)
  }
end

Отправляет данные на хост; возвращает объект Net::HTTPResponse.

Аргумент url должен быть URL-адресом; аргумент data должен быть строкой:

_uri = uri.dup
_uri.path = '/posts'
data = '{"title": "foo", "body": "bar", "userId": 1}'
headers = {'content-type': 'application/json'}
res = Net::HTTP.post(_uri, data, headers) # => #<Net::HTTPCreated 201 Created readbody=true>
puts res.body

Вывод:

{
  "title": "foo",
  "body": "bar",
  "userId": 1,
  "id": 101
}

См. также:

• Net::HTTP::Post: класс запроса для HTTP-метода POST.

• Net::HTTP#post: вспомогательный метод для HTTP-метода POST.

# File lib/net/http.rb, line 884
def HTTP.post_form(url, params)
  req = Post.new(url)
  req.form_data = params
  req.basic_auth url.user, url.password if url.user
  start(url.hostname, url.port,
        :use_ssl => url.scheme == 'https' ) {|http|
    http.request(req)
  }
end

Отправляет данные на хост; возвращает объект Net::HTTPResponse.

Аргумент url должен быть объектом URI; аргумент data должен быть хешем:

_uri = uri.dup
_uri.path = '/posts'
data = {title: 'foo', body: 'bar', userId: 1}
res = Net::HTTP.post_form(_uri, data) # => #<Net::HTTPCreated 201 Created readbody=true>
puts res.body

Вывод:

{
  "title": "foo",
  "body": "bar",
  "userId": "1",
  "id": 101
}

# File lib/net/http.rb, line 1826
def proxy_class?
  defined?(@is_proxy_class) ? @is_proxy_class : false
end

Возвращает true, если self — класс, созданный HTTP::Proxy.

# File lib/net/http.rb, line 920
def HTTP.put(url, data, header = nil)
  start(url.hostname, url.port,
        :use_ssl => url.scheme == 'https' ) {|http|
    http.put(url, data, header)
  }
end

Отправляет PUT-запрос серверу; возвращает объект Net::HTTPResponse.

Аргумент url должен быть URL-адресом; аргумент data должен быть строкой:

_uri = uri.dup
_uri.path = '/posts'
data = '{"title": "foo", "body": "bar", "userId": 1}'
headers = {'content-type': 'application/json'}
res = Net::HTTP.put(_uri, data, headers) # => #<Net::HTTPCreated 201 Created readbody=true>
puts res.body

Вывод:

{
  "title": "foo",
  "body": "bar",
  "userId": 1,
  "id": 101
}

См. также:

• Net::HTTP::Put: класс запроса для HTTP-метода PUT.

• Net::HTTP#put: вспомогательный метод для HTTP-метода PUT.

# File lib/net/http.rb, line 1045
def HTTP.start(address, *arg, &block) # :yield: +http+
  arg.pop if opt = Hash.try_convert(arg[-1])
  port, p_addr, p_port, p_user, p_pass = *arg
  p_addr = :ENV if arg.size < 2
  port = https_default_port if !port && opt && opt[:use_ssl]
  http = new(address, port, p_addr, p_port, p_user, p_pass)
  http.ipaddr = opt[:ipaddr] if opt && opt[:ipaddr]

  if opt
    if opt[:use_ssl]
      opt = {verify_mode: OpenSSL::SSL::VERIFY_PEER}.update(opt)
    end
    http.methods.grep(/\A(\w+)=\z/) do |meth|
      key = $1.to_sym
      opt.key?(key) or next
      http.__send__(meth, opt[key])
    end
  end

  http.start(&block)
end

Создаёт новый объект Net::HTTP http с помощью Net::HTTP.new:

• Сведения об аргументах address и port см. в описании Net::HTTP.new.

• Сведения об аргументах p_addr–p_pass, задающих прокси, см. в разделе Прокси-сервер.

• Сведения об аргументе opts см. ниже.

Если блок не задан:

• Вызывает http.start без блока (см. start), который открывает TCP-соединение и HTTP-сеанс.

• Возвращает http.

• Вызывающая сторона должна вызвать finish, чтобы закрыть сеанс:

  http = Net::HTTP.start(hostname)
  http.started? # => true
  http.finish
  http.started? # => false
  

Если блок задан:

• Вызывает http.start с блоком (см. start), который:

  • Открывает TCP-соединение и HTTP-сеанс.

  • Вызывает блок, в котором может быть выполнено любое количество запросов к хосту.

  • Закрывает HTTP-сеанс и TCP-соединение при выходе из блока.

  • Возвращает значение блока object.

• Возвращает object.

Пример:

hostname = 'jsonplaceholder.typicode.com'
Net::HTTP.start(hostname) do |http|
  puts http.get('/todos/1').body
  puts http.get('/todos/2').body
end

Вывод:

{
  "userId": 1,
  "id": 1,
  "title": "delectus aut autem",
  "completed": false
}
{
  "userId": 1,
  "id": 2,
  "title": "quis ut nam facilis et officia qui",
  "completed": false
}

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

Ключи могут включать:

• ca_file

• ca_path

• cert

• cert_store

• ciphers

• close_on_empty_response

• ipaddr (вызывает ipaddr=)

• keep_alive_timeout

• key

• open_timeout

• read_timeout

• ssl_timeout

• ssl_version

• use_ssl (вызывает use_ssl=)

• verify_callback

• verify_depth

• verify_mode

• write_timeout

Примечание: если port равно nil, а opts[:use_ssl] — истинное значение, в new передаётся Net::HTTP.https_default_port, а не port.

# File lib/net/http.rb, line 738
def HTTP.version_1_2
  true
end

Возвращает true; метод сохранён для обеспечения совместимости.

# File lib/net/http.rb, line 743
def HTTP.version_1_2?
  true
end

Возвращает true; метод сохранён для обеспечения совместимости.

# File lib/net/http.rb, line 1451
def continue_timeout=(sec)
  @socket.continue_timeout = sec if @socket
  @continue_timeout = sec
end

Задаёт значение тайм-аута ожидания продолжения — количество секунд ожидания ожидаемого ответа 100 Continue. Если объект HTTP не получает ответ в течение этого времени, он отправляет тело запроса.

# File lib/net/http.rb, line 2195
def copy(path, initheader = nil)
  request(Copy.new(path, initheader))
end

Отправляет серверу запрос COPY; возвращает экземпляр подкласса Net::HTTPResponse.

Запрос основан на объекте Net::HTTP::Copy, созданном из строки path и хеша начальных заголовков initheader.

http = Net::HTTP.new(hostname)
http.copy('/todos/1')

# File lib/net/http.rb, line 2169
def delete(path, initheader = {'Depth' => 'Infinity'})
  request(Delete.new(path, initheader))
end

Отправляет серверу запрос DELETE; возвращает экземпляр подкласса Net::HTTPResponse.

Запрос основан на объекте Net::HTTP::Delete, созданном из строки path и хеша начальных заголовков initheader.

http = Net::HTTP.new(hostname)
http.delete('/todos/1')

# File lib/net/http.rb, line 1770
def finish
  raise IOError, 'HTTP session not yet started' unless started?
  do_finish
end

Завершает сеанс HTTP:

http = Net::HTTP.new(hostname)
http.start
http.started? # => true
http.finish   # => nil
http.started? # => false

Вызывает IOError, если сеанс не активен.

# File lib/net/http.rb, line 1981
def get(path, initheader = nil, dest = nil, &block) # :yield: +body_segment+
  res = nil

  request(Get.new(path, initheader)) {|r|
    r.read_body dest, &block
    res = r
  }
  res
end

Отправляет серверу запрос GET; возвращает экземпляр подкласса Net::HTTPResponse.

Запрос основан на объекте Net::HTTP::Get, созданном из строки path и хеша начальных заголовков initheader.

Если передан блок, вызывает его с телом ответа:

http = Net::HTTP.new(hostname)
http.get('/todos/1') do |res|
  p res
end # => #<Net::HTTPOK 200 OK readbody=true>

Вывод:

"{\n  \"userId\": 1,\n  \"id\": 1,\n  \"title\": \"delectus aut autem\",\n  \"completed\": false\n}"

Если блок не передан, просто возвращает объект ответа:

http.get('/') # => #<Net::HTTPOK 200 OK readbody=true>

См. также:

• Net::HTTP::Get: класс запроса для метода HTTP GET.

• Net::HTTP.get: отправляет запрос GET и возвращает тело ответа.

# File lib/net/http.rb, line 2005
def head(path, initheader = nil)
  request(Head.new(path, initheader))
end

Отправляет серверу запрос HEAD; возвращает экземпляр подкласса Net::HTTPResponse.

Запрос основан на объекте Net::HTTP::Head, созданном из строки path и хеша начальных заголовков initheader:

res = http.head('/todos/1') # => #<Net::HTTPOK 200 OK readbody=true>
res.body                    # => nil
res.to_hash.take(3)
# =>
[["date", ["Wed, 15 Feb 2023 15:25:42 GMT"]],
 ["content-type", ["application/json; charset=utf-8"]],
 ["connection", ["close"]]]

# File lib/net/http.rb, line 1205
def inspect
  "#<#{self.class} #{@address}:#{@port} open=#{started?}>"
end

Возвращает строковое представление self:

Net::HTTP.new(hostname).inspect
# => "#<Net::HTTP jsonplaceholder.typicode.com:80 open=false>"

# File lib/net/http.rb, line 1345
def ipaddr
  started? ?  @socket.io.peeraddr[3] : @ipaddr
end

Возвращает IP-адрес соединения.

Если сеанс не был начат, возвращает значение, заданное методом ipaddr=, или nil, если значение не задано:

http = Net::HTTP.new(hostname)
http.ipaddr # => nil
http.ipaddr = '172.67.155.76'
http.ipaddr # => "172.67.155.76"

Если сеанс был начат, возвращает IP-адрес сокета:

http = Net::HTTP.new(hostname)
http.start
http.ipaddr # => "172.67.155.76"
http.finish

# File lib/net/http.rb, line 1357
def ipaddr=(addr)
  raise IOError, "ipaddr value changed, but session already started" if started?
  @ipaddr = addr
end

Задаёт IP-адрес соединения:

http = Net::HTTP.new(hostname)
http.ipaddr # => nil
http.ipaddr = '172.67.155.76'
http.ipaddr # => "172.67.155.76"

IP-адрес нельзя задать, если сеанс уже начат.

# File lib/net/http.rb, line 2115
def lock(path, body, initheader = nil)
  request(Lock.new(path, initheader), body)
end

Отправляет серверу запрос LOCK; возвращает экземпляр подкласса Net::HTTPResponse.

Запрос основан на объекте Net::HTTP::Lock, созданном из строки path, строки body и хеша начальных заголовков initheader.

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http = Net::HTTP.new(hostname)
http.lock('/todos/1', data)

# File lib/net/http.rb, line 1391
def max_retries=(retries)
  retries = retries.to_int
  if retries < 0
    raise ArgumentError, 'max_retries should be non-negative integer number'
  end
  @max_retries = retries
end

Задаёт максимальное количество повторных попыток для идемпотентного запроса при возникновении Net::ReadTimeout, IOError, EOFError, Errno::ECONNRESET, Errno::ECONNABORTED, Errno::EPIPE, OpenSSL::SSL::SSLError, Timeout::Error. Начальное значение — 1.

Аргумент retries должен быть неотрицательным числовым значением:

http = Net::HTTP.new(hostname)
http.max_retries = 2   # => 2
http.max_retries       # => 2

# File lib/net/http.rb, line 2209
def mkcol(path, body = nil, initheader = nil)
  request(Mkcol.new(path, initheader), body)
end

Отправляет серверу запрос MKCOL; возвращает экземпляр подкласса Net::HTTPResponse.

Запрос основан на объекте Net::HTTP::Mkcol, созданном из строки path, строки body и хеша начальных заголовков initheader.

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http.mkcol('/todos/1', data)
http = Net::HTTP.new(hostname)

# File lib/net/http.rb, line 2182
def move(path, initheader = nil)
  request(Move.new(path, initheader))
end

Отправляет серверу запрос MOVE; возвращает экземпляр подкласса Net::HTTPResponse.

Запрос основан на объекте Net::HTTP::Move, созданном из строки path и хеша начальных заголовков initheader.

http = Net::HTTP.new(hostname)
http.move('/todos/1')

# File lib/net/http.rb, line 2142
def options(path, initheader = nil)
  request(Options.new(path, initheader))
end

Отправляет серверу запрос Options; возвращает экземпляр подкласса Net::HTTPResponse.

Запрос основан на объекте Net::HTTP::Options, созданном из строки path и хеша начальных заголовков initheader.

http = Net::HTTP.new(hostname)
http.options('/')

# File lib/net/http.rb, line 2068
def patch(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+
  send_entity(path, data, initheader, dest, Patch, &block)
end

Отправляет серверу запрос PATCH; возвращает экземпляр подкласса Net::HTTPResponse.

Запрос основан на объекте Net::HTTP::Patch, созданном из строки path, строки data и хеша начальных заголовков initheader.

Если передан блок, вызывает его с телом ответа:

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http = Net::HTTP.new(hostname)
http.patch('/todos/1', data) do |res|
  p res
end # => #<Net::HTTPOK 200 OK readbody=true>

Вывод:

"{\n  \"userId\": 1,\n  \"id\": 1,\n  \"title\": \"delectus aut autem\",\n  \"completed\": false,\n  \"{\\\"userId\\\": 1, \\\"id\\\": 1, \\\"title\\\": \\\"delectus aut autem\\\", \\\"completed\\\": false}\": \"\"\n}"

Если блок не передан, просто возвращает объект ответа:

http.patch('/todos/1', data) # => #<Net::HTTPCreated 201 Created readbody=true>

# File lib/net/http.rb, line 1593
def peer_cert
  if not use_ssl? or not @socket
    return nil
  end
  @socket.io.peer_cert
end

Возвращает цепочку сертификатов X509 (массив строк) для однорангового узла сокета сеанса или nil, если сертификаты отсутствуют.

# File lib/net/http.rb, line 2039
def post(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+
  send_entity(path, data, initheader, dest, Post, &block)
end

Отправляет серверу запрос POST; возвращает экземпляр подкласса Net::HTTPResponse.

Запрос основан на объекте Net::HTTP::Post, созданном из строки path, строки data и хеша начальных заголовков initheader.

Если передан блок, вызывает его с телом ответа:

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http = Net::HTTP.new(hostname)
http.post('/todos', data) do |res|
  p res
end # => #<Net::HTTPCreated 201 Created readbody=true>

Вывод:

"{\n  \"{\\\"userId\\\": 1, \\\"id\\\": 1, \\\"title\\\": \\\"delectus aut autem\\\", \\\"completed\\\": false}\": \"\",\n  \"id\": 201\n}"

Если блок не передан, просто возвращает объект ответа:

http.post('/todos', data) # => #<Net::HTTPCreated 201 Created readbody=true>

См. также:

• Net::HTTP::Post: класс запроса для метода HTTP POST.

• Net::HTTP.post: отправляет запрос POST и возвращает тело ответа.

# File lib/net/http.rb, line 2156
def propfind(path, body = nil, initheader = {'Depth' => '0'})
  request(Propfind.new(path, initheader), body)
end

Отправляет серверу запрос PROPFIND; возвращает экземпляр подкласса Net::HTTPResponse.

Запрос основан на объекте Net::HTTP::Propfind, созданном из строки path, строки body и хеша начальных заголовков initheader.

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http = Net::HTTP.new(hostname)
http.propfind('/todos/1', data)

# File lib/net/http.rb, line 2101
def proppatch(path, body, initheader = nil)
  request(Proppatch.new(path, initheader), body)
end

Отправляет серверу запрос PROPPATCH; возвращает экземпляр подкласса Net::HTTPResponse.

Запрос основан на объекте Net::HTTP::Proppatch, созданном из строки path, строки body и хеша начальных заголовков initheader.

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http = Net::HTTP.new(hostname)
http.proppatch('/todos/1', data)

# File lib/net/http.rb, line 1852
def proxy?
  !!(@proxy_from_env ? proxy_uri : @proxy_address)
end

Возвращает true, если задан прокси-сервер, и false в противном случае; см. Прокси-сервер.

# File lib/net/http.rb, line 1874
def proxy_address
  if @proxy_from_env then
    proxy_uri&.hostname
  else
    @proxy_address
  end
end

Возвращает адрес прокси-сервера, если он задан, и nil в противном случае; см. Прокси-сервер.

# File lib/net/http.rb, line 1859
def proxy_from_env?
  @proxy_from_env
end

Возвращает true, если прокси-сервер задан в окружении, и false в противном случае; см. Прокси-сервер.

# File lib/net/http.rb, line 1905
def proxy_pass
  if @proxy_from_env
    pass = proxy_uri&.password
    unescape(pass) if pass
  else
    @proxy_pass
  end
end

Возвращает пароль прокси-сервера, если он задан, и nil в противном случае; см. Прокси-сервер.

# File lib/net/http.rb, line 1884
def proxy_port
  if @proxy_from_env then
    proxy_uri&.port
  else
    @proxy_port
  end
end

Возвращает номер порта прокси-сервера, если он задан, и nil в противном случае; см. Прокси-сервер.

# File lib/net/http.rb, line 1894
def proxy_user
  if @proxy_from_env
    user = proxy_uri&.user
    unescape(user) if user
  else
    @proxy_user
  end
end

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

# File lib/net/http.rb, line 2087
def put(path, data, initheader = nil)
  request(Put.new(path, initheader), data)
end

Отправляет серверу запрос PUT; возвращает экземпляр подкласса Net::HTTPResponse.

Запрос основан на объекте Net::HTTP::Put, созданном из строки path, строки data и хеша начальных заголовков initheader.

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http = Net::HTTP.new(hostname)
http.put('/todos/1', data) # => #<Net::HTTPOK 200 OK readbody=true>

См. также:

• Net::HTTP::Put: класс запроса для метода HTTP PUT.

• Net::HTTP.put: отправляет запрос PUT и возвращает тело ответа.

# File lib/net/http.rb, line 1414
def read_timeout=(sec)
  @socket.read_timeout = sec if @socket
  @read_timeout = sec
end

Задаёт время ожидания чтения в секундах для self как целое число sec; начальное значение — 60.

Аргумент sec должен быть неотрицательным числовым значением:

http = Net::HTTP.new(hostname)
http.read_timeout # => 60
http.get('/todos/1') # => #<Net::HTTPOK 200 OK readbody=true>
http.read_timeout = 0
http.get('/todos/1') # Raises Net::ReadTimeout.

# File lib/net/http.rb, line 2367
def request(req, body = nil, &block)  # :yield: +response+
  unless started?
    start {
      req['connection'] ||= 'close'
      return request(req, body, &block)
    }
  end
  if proxy_user()
    req.proxy_basic_auth proxy_user(), proxy_pass() unless use_ssl?
  end
  req.set_body_internal body
  res = transport_request(req, &block)
  if sspi_auth?(res)
    sspi_auth(req)
    res = transport_request(req, &block)
  end
  res
end

Отправляет серверу заданный запрос req; формирует ответ в виде объекта Net::HTTPResponse.

Заданный req должен быть экземпляром подкласса Net::HTTPRequest. Аргумент body следует указывать только в том случае, если он необходим для запроса.

Если блок не передан, возвращает объект ответа:

http = Net::HTTP.new(hostname)

req = Net::HTTP::Get.new('/todos/1')
http.request(req)
# => #<Net::HTTPOK 200 OK readbody=true>

req = Net::HTTP::Post.new('/todos')
http.request(req, 'xyzzy')
# => #<Net::HTTPCreated 201 Created readbody=true>

Если передан блок, вызывает его с объектом ответа и возвращает ответ:

req = Net::HTTP::Get.new('/todos/1')
http.request(req) do |res|
  p res
end # => #<Net::HTTPOK 200 OK readbody=true>

Вывод:

#<Net::HTTPOK 200 OK readbody=false>

# File lib/net/http.rb, line 2248
def request_get(path, initheader = nil, &block) # :yield: +response+
  request(Get.new(path, initheader), &block)
end

Отправляет серверу запрос GET; формирует ответ в виде объекта Net::HTTPResponse.

Запрос основан на объекте Net::HTTP::Get, созданном из строки path и хеша начальных заголовков initheader.

Если блок не передан, возвращает объект ответа:

http = Net::HTTP.new(hostname)
http.request_get('/todos') # => #<Net::HTTPOK 200 OK readbody=true>

Если передан блок, вызывает его с объектом ответа и возвращает объект ответа:

http.request_get('/todos') do |res|
  p res
end # => #<Net::HTTPOK 200 OK readbody=true>

Вывод:

#<Net::HTTPOK 200 OK readbody=false>

# File lib/net/http.rb, line 2261
def request_head(path, initheader = nil, &block)
  request(Head.new(path, initheader), &block)
end

Отправляет серверу запрос HEAD; возвращает экземпляр подкласса Net::HTTPResponse.

Запрос основан на объекте Net::HTTP::Head, созданном из строки path и хеша начальных заголовков initheader.

http = Net::HTTP.new(hostname)
http.head('/todos/1') # => #<Net::HTTPOK 200 OK readbody=true>

# File lib/net/http.rb, line 2288
def request_post(path, data, initheader = nil, &block) # :yield: +response+
  request Post.new(path, initheader), data, &block
end

Отправляет серверу запрос POST; формирует ответ в виде объекта Net::HTTPResponse.

Запрос основан на объекте Net::HTTP::Post, созданном из строки path, строки data и хеша начальных заголовков initheader.

Если блок не передан, возвращает объект ответа:

http = Net::HTTP.new(hostname)
http.post('/todos', 'xyzzy')
# => #<Net::HTTPCreated 201 Created readbody=true>

Если передан блок, вызывает его с телом ответа и возвращает объект ответа:

http.post('/todos', 'xyzzy') do |res|
  p res
end # => #<Net::HTTPCreated 201 Created readbody=true>

Вывод:

"{\n  \"xyzzy\": \"\",\n  \"id\": 201\n}"

# File lib/net/http.rb, line 1299
def response_body_encoding=(value)
  value = Encoding.find(value) if value.is_a?(String)
  @response_body_encoding = value
end

Задаёт кодировку тела ответа; возвращает кодировку.

Заданное значение value может быть:

• Объектом Encoding.

• Название кодировки.

• Псевдоним названия кодировки.

См. Encoding.

Примеры:

http = Net::HTTP.new(hostname)
http.response_body_encoding = Encoding::US_ASCII # => #<Encoding:US-ASCII>
http.response_body_encoding = 'US-ASCII'         # => "US-ASCII"
http.response_body_encoding = 'ASCII'            # => "ASCII"

# File lib/net/http.rb, line 2331
def send_request(name, path, data = nil, header = nil)
  has_response_body = name != 'HEAD'
  r = HTTPGenericRequest.new(name,(data ? true : false),has_response_body,path,header)
  request r, data
end

Отправляет серверу HTTP-запрос; возвращает экземпляр подкласса Net::HTTPResponse.

Запрос основан на объекте Net::HTTPRequest, созданном из строки path, строки data и хеша начальных заголовков header. Этот объект является экземпляром подкласса Net::HTTPRequest, соответствующего заданной строке name в верхнем регистре. Она должна быть методом HTTP-запроса или методом запроса WebDAV.

Примеры:

http = Net::HTTP.new(hostname)
http.send_request('GET', '/todos/1')
# => #<Net::HTTPOK 200 OK readbody=true>
http.send_request('POST', '/todos', 'xyzzy')
# => #<Net::HTTPCreated 201 Created readbody=true>

# File lib/net/http.rb, line 1258
def set_debug_output(output)
  warn 'Net::HTTP#set_debug_output called after HTTP started', uplevel: 1 if started?
  @debug_output = output
end

ПРЕДУПРЕЖДЕНИЕ Этот метод создаёт серьёзную уязвимость. Никогда не используйте его в производственном коде.

Задаёт поток вывода для отладки:

http = Net::HTTP.new(hostname)
File.open('t.tmp', 'w') do |file|
  http.set_debug_output(file)
  http.start
  http.get('/nosuch/1')
  http.finish
end
puts File.read('t.tmp')

Вывод:

opening connection to jsonplaceholder.typicode.com:80...
opened
<- "GET /nosuch/1 HTTP/1.1\r\nAccept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3\r\nAccept: */*\r\nUser-Agent: Ruby\r\nHost: jsonplaceholder.typicode.com\r\n\r\n"
-> "HTTP/1.1 404 Not Found\r\n"
-> "Date: Mon, 12 Dec 2022 21:14:11 GMT\r\n"
-> "Content-Type: application/json; charset=utf-8\r\n"
-> "Content-Length: 2\r\n"
-> "Connection: keep-alive\r\n"
-> "X-Powered-By: Express\r\n"
-> "X-Ratelimit-Limit: 1000\r\n"
-> "X-Ratelimit-Remaining: 999\r\n"
-> "X-Ratelimit-Reset: 1670879660\r\n"
-> "Vary: Origin, Accept-Encoding\r\n"
-> "Access-Control-Allow-Credentials: true\r\n"
-> "Cache-Control: max-age=43200\r\n"
-> "Pragma: no-cache\r\n"
-> "Expires: -1\r\n"
-> "X-Content-Type-Options: nosniff\r\n"
-> "Etag: W/\"2-vyGp6PvFo4RvsFtPoIWeCReyIC8\"\r\n"
-> "Via: 1.1 vegur\r\n"
-> "CF-Cache-Status: MISS\r\n"
-> "Server-Timing: cf-q-config;dur=1.3000000762986e-05\r\n"
-> "Report-To: {\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=yOr40jo%2BwS1KHzhTlVpl54beJ5Wx2FcG4gGV0XVrh3X9OlR5q4drUn2dkt5DGO4GDcE%2BVXT7CNgJvGs%2BZleIyMu8CLieFiDIvOviOY3EhHg94m0ZNZgrEdpKD0S85S507l1vsEwEHkoTm%2Ff19SiO\"}],\"group\":\"cf-nel\",\"max_age\":604800}\r\n"
-> "NEL: {\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}\r\n"
-> "Server: cloudflare\r\n"
-> "CF-RAY: 778977dc484ce591-DFW\r\n"
-> "alt-svc: h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400\r\n"
-> "\r\n"
reading 2 bytes...
-> "{}"
read 2 bytes
Conn keep-alive

# File lib/net/http.rb, line 1621
def start  # :yield: http
  raise IOError, 'HTTP session already opened' if @started
  if block_given?
    begin
      do_start
      return yield(self)
    ensure
      do_finish
    end
  end
  do_start
  self
end

Начинает сеанс HTTP.

Если блок не передан, возвращает self:

http = Net::HTTP.new(hostname)
# => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
http.start
# => #<Net::HTTP jsonplaceholder.typicode.com:80 open=true>
http.started? # => true
http.finish

Если блок передан, вызывает его с self, завершает сеанс после выхода из блока и возвращает значение блока:

http.start do |http|
  http
end
# => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
http.started? # => false

# File lib/net/http.rb, line 1484
def started?
  @started
end

Возвращает true, если сеанс HTTP был начат:

http = Net::HTTP.new(hostname)
http.started? # => false
http.start
http.started? # => true
http.finish # => nil
http.started? # => false

Net::HTTP.start(hostname) do |http|
  http.started?
end # => true
http.started? # => false

# File lib/net/http.rb, line 2222
def trace(path, initheader = nil)
  request(Trace.new(path, initheader))
end

Отправляет серверу запрос TRACE; возвращает экземпляр подкласса Net::HTTPResponse.

Запрос основан на объекте Net::HTTP::Trace, созданном из строки path и хеша начальных заголовков initheader.

http = Net::HTTP.new(hostname)
http.trace('/todos/1')

# File lib/net/http.rb, line 2129
def unlock(path, body, initheader = nil)
  request(Unlock.new(path, initheader), body)
end

Отправляет серверу запрос UNLOCK; возвращает экземпляр подкласса Net::HTTPResponse.

Запрос формируется на основе объекта Net::HTTP::Unlock, созданного из строки path, строки body и хеша начальных заголовков initheader.

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http = Net::HTTP.new(hostname)
http.unlock('/todos/1', data)

# File lib/net/http.rb, line 1506
def use_ssl=(flag)
  flag = flag ? true : false
  if started? and @use_ssl != flag
    raise IOError, "use_ssl value changed, but session already started"
  end
  @use_ssl = flag
end

Задаёт, будет ли новый сеанс использовать протокол защиты транспортного уровня:

Вызывает исключение IOError при попытке изменить значение во время сеанса.

Вызывает исключение OpenSSL::SSL::SSLError, если порт не является портом HTTPS.

# File lib/net/http.rb, line 1496
def use_ssl?
  @use_ssl
end

Возвращает true, если self использует SSL, и false в противном случае. См. Net::HTTP#use_ssl=.

# File lib/net/http.rb, line 1438
def write_timeout=(sec)
  @socket.write_timeout = sec if @socket
  @write_timeout = sec
end

Задаёт время ожидания записи в секундах для self, равное целому числу sec; начальное значение — 60.

Аргумент sec должен быть неотрицательным числовым значением:

_uri = uri.dup
_uri.path = '/posts'
body = 'bar' * 200000
data = <<EOF
{"title": "foo", "body": "#{body}", "userId": "1"}
EOF
headers = {'content-type': 'application/json'}
http = Net::HTTP.new(hostname)
http.write_timeout # => 60
http.post(_uri.path, data, headers)
# => #<Net::HTTPCreated 201 Created readbody=true>
http.write_timeout = 0
http.post(_uri.path, data, headers) # Raises Net::WriteTimeout.

# File lib/net/http.rb, line 2539
def addr_port
  addr = address
  addr = "[#{addr}]" if addr.include?(":")
  default_port = use_ssl? ? HTTP.https_default_port : HTTP.http_default_port
  default_port == port ? addr : "#{addr}:#{port}"
end

утилиты

# File lib/net/http.rb, line 2547
def debug(msg)
  return unless @debug_output
  @debug_output << msg
  @debug_output << "\n"
end

Добавляет сообщение в отладочный вывод

# File lib/net/http.rb, line 2390
def send_entity(path, data, initheader, dest, type, &block)
  res = nil
  request(type.new(path, initheader), data) {|r|
    r.read_body dest, &block
    res = r
  }
  res
end

Выполняет запрос, использующий представление, и возвращает его тело.