класс Net::HTTP

# File lib/net/http.rb, line 1053
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 539
def HTTP.default_port
  http_default_port()
end

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

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

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

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

или:

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

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

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

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

или:

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

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

Отправляет запрос GET на целевой ресурс и возвращает ответ HTTP в виде объекта Net::HTTPResponse. Цель может быть указана как (uri), или как (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

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

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

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

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

# File lib/net/http.rb, line 632
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 660
def initialize(address, port = nil)
  @address = address
  @port    = (port || HTTP.default_port)
  @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 499
def HTTP.post(url, data, header = nil)
  start(url.hostname, url.port,
        :use_ssl => url.scheme == 'https' ) {|http|
    http.post(url, data, header)
  }
end

Отправляет данные на указанный объект 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 524
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-формы на указанный объект URI. Данные формы должны быть предоставлены в виде отображения Hash от String к String. Пример:

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

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

Пример:

require 'net/http'
require 'uri'

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

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

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

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

  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 устанавливает следующие значения с помощью своего аксессора. Ключи — ca_file, ca_path, cert, cert_store, ciphers, 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 404
def HTTP.version_1_2
  true
end

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

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

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

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

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

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

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

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

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

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

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

# File lib/net/http.rb, line 1226
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 1248
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 1302
def lock(path, body, initheader = nil)
  request(Lock.new(path, initheader), body)
end

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

# File lib/net/http.rb, line 755
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 1344
def mkcol(path, body = nil, initheader = nil)
  request(Mkcol.new(path, initheader), body)
end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

# File lib/net/http.rb, line 1148
def proxy_pass
  if ENVIRONMENT_VARIABLE_IS_MULTIUSER_SAFE && @proxy_from_env
    proxy_uri&.password
  else
    @proxy_pass
  end
end

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

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

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

# File lib/net/http.rb, line 1139
def proxy_user
  if ENVIRONMENT_VARIABLE_IS_MULTIUSER_SAFE && @proxy_from_env
    proxy_uri&.user
  else
    @proxy_user
  end
end

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

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

Установщик для атрибута read_timeout.

# File lib/net/http.rb, line 1468
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 1379
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 1393
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 1423
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 1447
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 707
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 915
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 795
def started?
  @started
end

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

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

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

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

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

# File lib/net/http.rb, line 812
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 804
def use_ssl?
  @use_ssl
end

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

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

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