класс Net::HTTP

# File lib/net/http.rb, line 1106
def HTTP.Proxy(p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil)
  return self unless p_addr

  Class.new(self) {
    @is_proxy_class = true

    if p_addr == :ENV then
      @proxy_from_env = true
      @proxy_address = nil
      @proxy_port    = nil
    else
      @proxy_from_env = false
      @proxy_address = p_addr
      @proxy_port    = p_port || default_port
    end

    @proxy_user = p_user
    @proxy_pass = p_pass
  }
end

Создаёт класс прокси HTTP, который ведёт себя как Net::HTTP, но выполняет все запросы через указанный прокси.

Этот класс устарел. Вы можете передать эти параметры непосредственно в Net::HTTP.new. Подробности аргументов см. в Net::HTTP.new.

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

Порт по умолчанию для запросов HTTP; по умолчанию 80.

# File lib/net/http.rb, line 473
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 в виде строки. Целевой ресурс можно указать как (uri, headers) или как (host, path, port = 80); например:

print Net::HTTP.get(URI('http://www.example.com/index.html'))

или:

print Net::HTTP.get('www.example.com', '/index.html')

также можно указать заголовки запроса:

Net::HTTP.get(URI('http://www.example.com/index.html'), { 'Accept' => 'text/html' })

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

Получает текст тела от целевого ресурса и выводит его в $stdout. Целевой ресурс можно указать как (uri, headers) или как (host, path, port = 80); например:

Net::HTTP.get_print URI('http://www.example.com/index.html')

или:

Net::HTTP.get_print 'www.example.com', '/index.html'

также можно указать заголовки запроса:

Net::HTTP.get_print URI('http://www.example.com/index.html'), { 'Accept' => 'text/html' }

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

Отправляет GET-запрос на целевой ресурс и возвращает ответ HTTP как объект Net::HTTPResponse. Целевой ресурс можно указать как (uri, headers) или как (host, path, port = 80); например:

res = Net::HTTP.get_response(URI('http://www.example.com/index.html'))
print res.body

или:

res = Net::HTTP.get_response('www.example.com', '/index.html')
print res.body

также можно указать заголовки запроса:

Net::HTTP.get_response(URI('http://www.example.com/index.html'), { 'Accept' => 'text/html' })

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

Порт по умолчанию для запросов HTTP; по умолчанию 80.

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

Порт по умолчанию для запросов HTTPS; по умолчанию 443.

# File lib/net/http.rb, line 654
def HTTP.new(address, port = nil, p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil, p_no_proxy = 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
  elsif p_addr == :ENV then
    http.proxy_from_env = true
  else
    if p_addr && p_no_proxy && !URI::Generic.use_proxy?(p_addr, p_addr, p_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
  end

  http
end

Создаёт новый объект Net::HTTP без открытия TCP-соединения или сессии HTTP.

address должен быть именем хоста DNS или IP-адресом, а port — портом работы сервера. Если port не указан, используется порт по умолчанию для HTTP или HTTPS.

Если ни один из аргументов p_ не указан, адрес и порт прокси берутся из переменной окружения http_proxy (или её аналога в верхнем регистре), если она присутствует. При необходимости аутентификации на прокси вы должны указать её вручную. Подробности обнаружения прокси из окружения см. в URI::Generic#find_proxy. Чтобы отключить обнаружение прокси, установите p_addr в nil.

Если вы подключаетесь к пользовательскому прокси, p_addr указывает имя хоста DNS или IP-адрес хоста прокси, p_port — используемый порт для доступа к прокси, p_user и p_pass — имя пользователя и пароль, если требуется авторизация для использования прокси, а p_no_proxy — хосты, которые не используют прокси.

# File lib/net/http.rb, line 682
def initialize(address, port = nil)
  @address = address
  @port    = (port || HTTP.default_port)
  @ipaddr = nil
  @local_host = nil
  @local_port = nil
  @curr_http_version = HTTPVersion
  @keep_alive_timeout = 2
  @last_communicated = nil
  @close_on_empty_response = false
  @socket  = nil
  @started = false
  @open_timeout = 60
  @read_timeout = 60
  @write_timeout = 60
  @continue_timeout = nil
  @max_retries = 1
  @debug_output = nil

  @proxy_from_env = false
  @proxy_uri      = nil
  @proxy_address  = nil
  @proxy_port     = nil
  @proxy_user     = nil
  @proxy_pass     = nil

  @use_ssl = false
  @ssl_context = nil
  @ssl_session = nil
  @sspi_enabled = false
  SSL_IVNAMES.each do |ivname|
    instance_variable_set ivname, nil
  end
end

Создаёт новый объект Net::HTTP для указанного адреса сервера без открытия TCP-соединения или инициализации сессии HTTP. address должен быть именем хоста DNS или IP-адресом.

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

Отправляет данные POST на указанный объект URI.

Пример:

require 'net/http'
require 'uri'

Net::HTTP.post URI('http://www.example.com/api/search'),
               { "q" => "ruby", "max" => "50" }.to_json,
               "Content-Type" => "application/json"

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

Отправляет данные HTML-формы POST на указанный объект URI. Данные формы должны быть представлены как отображение Hash из String в String. Пример:

{ "cmd" => "search", "q" => "ruby", "max" => "50" }

Этот метод также выполняет базовые аутентификации, если и только если существует url.user. Но пользовательская информация для аутентификации устарела (RFC3986). Поэтому эта функция будет удалена.

Пример:

require 'net/http'

Net::HTTP.post_form URI('http://www.example.com/search.cgi'),
                    { "q" => "ruby", "max" => "50" }

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

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

# File lib/net/http.rb, line 608
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, затем дополнительно открывает TCP-соединение и HTTP-сеанс.

Аргументы следующие:

address

имя хоста или IP-адрес сервера

port

порт сервера

p_addr

адрес прокси-сервера

p_port

порт прокси-сервера

p_user

пользователь прокси-сервера

p_pass

пароль прокси-сервера

opt

опциональный хэш

opt устанавливает следующие значения с помощью своего доступа. Ключи — ipaddr, ca_file, ca_path, cert, cert_store, ciphers, keep_alive_timeout, close_on_empty_response, key, open_timeout, read_timeout, write_timeout, ssl_timeout, ssl_version, use_ssl, verify_callback, verify_depth и verify_mode. Если вы установите :use_ssl как true, вы можете использовать https, а значение по умолчанию для verify_mode будет установлено как OpenSSL::SSL::VERIFY_PEER.

Если задан необязательный блок, новый созданный объект Net::HTTP передаётся ему и закрывается, когда блок завершается. В этом случае возвращаемое значение этого метода — возвращаемое значение блока. Если блок не задан, возвращаемое значение этого метода — сам вновь созданный объект Net::HTTP, и вызывающий метод отвечает за его закрытие по завершении с помощью метода finish().

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

Включает возможности net/http 1.2 (Ruby 1.8). По умолчанию включено в Ruby 1.8 и более поздних версиях.

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

Возвращает true, если net/http находится в режиме версии 1.2. По умолчанию — true.

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

Устанавливает значение атрибута continue_timeout.

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

Отправляет запрос COPY на path и получает ответ в виде объекта HTTPResponse.

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

Отправляет запрос DELETE на path и получает ответ в виде объекта HTTPResponse.

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

Завершает сеанс HTTP и закрывает TCP-соединение. Вызывает IOError, если сеанс не был начат.

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

Извлекает данные с path на подключённом хосте, который может быть абсолютным путём String или URI для извлечения пути.

initheader должно быть Hash типа { ‘Accept’ => ‘/’, … }, по умолчанию это пустой массив. Если у initheader нет ключа ‘accept-encoding’, используется значение «gzip;q=1.0,deflate;q=0.6,identity;q=0.3», чтобы gzip-сжатие использовалось вместо deflate-сжатия, которое используется вместо отсутствия сжатия. Ruby не имеет библиотек для поддержки сжатия (Lempel-Ziv), поэтому оно не поддерживается. Цель этого — по умолчанию уменьшить пропускную способность. Если эта функция настраивает сжатие, она также выполняет разархивирование, удаляя заголовок, чтобы избежать путаницы. В противном случае она оставляет тело как есть.

Этот метод возвращает объект Net::HTTPResponse.

Если вызов сделан с блоком, он передаёт каждый фрагмент тела сущности по очереди как строку по мере чтения из сокета. Обратите внимание, что в этом случае возвращаемый объект ответа не будет содержать тело (смысловое).

Аргумент dest устарел. Он всё ещё работает, но вы не должны его использовать.

Этот метод никогда не вызывает исключение.

response = http.get('/index.html')

# using block
File.open('result.txt', 'w') {|f|
  http.get('/~foo/') do |str|
    f.write str
  end
}

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

Получает только заголовок с path на подключённом хосте. header — это Hash типа { ‘Accept’ => ‘/’, … }.

Этот метод возвращает объект Net::HTTPResponse.

Этот метод никогда не вызывает исключение.

response = nil
Net::HTTP.start('some.www.server', 80) {|http|
  response = http.head('/index.html')
}
p response['content-type']

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

IP-адрес для подключения.

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

Устанавливает IP-адрес для подключения.

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

Отправляет запрос LOCK на path и получает ответ в виде объекта HTTPResponse.

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

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

Отправляет запрос MKCOL на path и получает ответ в виде объекта HTTPResponse.

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

Отправляет запрос MOVE на path и получает ответ в виде объекта HTTPResponse.

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

Отправляет запрос OPTIONS на path и получает ответ в виде объекта HTTPResponse.

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

Отправляет запрос PATCH на path и получает ответ в виде объекта HTTPResponse.

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

Возвращает представленные сервером сертификаты X.509.

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

Отправляет data (должно быть String) на path. header должно быть Hash типа { ‘Accept’ => ‘/’, … }.

Этот метод возвращает объект Net::HTTPResponse.

Если вызывается с блоком, то по очереди передаёт каждый фрагмент тела ответа как строку по мере его считывания из сокета. Обратите внимание, что в этом случае возвращаемый объект ответа не будет содержать (осмысленного) тела.

Аргумент dest устарел. Он всё ещё работает, но его использовать не следует.

Этот метод никогда не вызывает исключений.

response = http.post('/cgi-bin/search.rb', 'query=foo')

# using block
File.open('result.txt', 'w') {|f|
  http.post('/cgi-bin/search.rb', 'query=foo') do |str|
    f.write str
  end
}

Вы должны установить заголовок Content-Type: для POST. Если заголовок Content-Type не задан, этот метод использует «application/x-www-form-urlencoded» по умолчанию.

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

Отправляет запрос PROPFIND на path и получает ответ, как объект HTTPResponse.

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

Отправляет запрос PROPPATCH на path и получает ответ, как объект HTTPResponse.

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

Истина, если запросы для этого подключения будут проксироваться

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

Адрес сервера прокси, если он настроен.

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

Истина, если прокси для этого соединения определяется из среды

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

Пароль сервера прокси, если он настроен.

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

Порт сервера прокси, если он настроен.

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

Имя пользователя сервера прокси, если он настроен.

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

Установка атрибута read_timeout.

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

Отправляет объект HTTPRequest req на сервер HTTP.

Если req это запрос Net::HTTP::Post или Net::HTTP::Put содержащий данные, данные также отправляются. Предоставление данных для запроса Net::HTTP::Head или Net::HTTP::Get приводит к ошибке ArgumentError.

Возвращает объект HTTPResponse.

При вызове с блоком, передаёт объект HTTPResponse в блок. Тело ответа ещё не было прочитано; блок может обработать его с помощью HTTPResponse#read_body, если необходимо.

Этот метод никогда не генерирует исключения Net::*.

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

Отправляет запрос GET на path. Возвращает ответ в виде объекта Net::HTTPResponse.

При вызове с блоком, передаёт объект HTTPResponse в блок. Тело ответа ещё не было прочитано; блок может обработать его с помощью HTTPResponse#read_body, если необходимо.

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

Этот метод никогда не генерирует исключения Net::*.

response = http.request_get('/index.html')
# The entity body is already read in this case.
p response['content-type']
puts response.body

# Using a block
http.request_get('/index.html') {|response|
  p response['content-type']
  response.read_body do |str|   # read body now
    print str
  end
}

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

Отправляет запрос HEAD на path и возвращает ответ как объект Net::HTTPResponse.

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

Этот метод никогда не генерирует исключения Net::*.

response = http.request_head('/index.html')
p response['content-type']

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

Отправляет запрос POST на path.

Возвращает ответ в виде объекта Net::HTTPResponse.

При вызове с блоком, блок получает объект HTTPResponse. Тело ответа ещё не было прочитано; блок может обработать его с помощью HTTPResponse#read_body, если необходимо.

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

Этот метод никогда не генерирует исключения Net::*.

# example
response = http.request_post('/cgi-bin/nice.rb', 'datadatadata...')
p response.status
puts response.body          # body is already read in this case

# using block
http.request_post('/cgi-bin/nice.rb', 'datadatadata...') {|response|
  p response.status
  p response['content-type']
  response.read_body do |str|   # read body now
    print str
  end
}

# File lib/net/http.rb, line 1507
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 на сервер HTTP. Также отправляет строку DATA, если data задана.

Возвращает объект Net::HTTPResponse.

Этот метод никогда не генерирует исключения Net::*.

response = http.send_request('GET', '/index.html')
puts response.body

# File lib/net/http.rb, line 730
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)
http.set_debug_output $stderr
http.start { .... }

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

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

Когда этот метод вызывается с блоком, он передаёт объект Net::HTTP в блок и закрывает TCP-соединение и HTTP сеанс после выполнения блока.

При вызове с блоком возвращает значение, возвращаемое блоком; в противном случае возвращает self.

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

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

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

Отправляет запрос TRACE на path и получает ответ в виде объекта HTTPResponse.

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

Отправляет запрос UNLOCK на path и получает ответ в виде объекта HTTPResponse.

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

Включает/выключает SSL. Этот флаг должен быть установлен до начала сеанса. Если вы измените значение use_ssl после начала сеанса, объект Net::HTTP вызывает исключение IOError.

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

Возвращает true, если SSL/TLS используется с HTTP.

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

Сеттер для атрибута write_timeout.