класс Net::HTTP

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

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

# File lib/net/http.rb, line 466
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 602
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 405
def HTTP.version_1_2
  true
end

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

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

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

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

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

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

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

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

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

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

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

# File lib/net/http.rb, line 1268
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 1290
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 748
def ipaddr
  started? ?  @socket.io.peeraddr[3] : @ipaddr
end

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

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

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

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

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

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

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

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

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

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

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

# File lib/net/http.rb, line 1328
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 939
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 1322
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 1362
def propfind(path, body = nil, initheader = {'Depth' => '0'})
  request(Propfind.new(path, initheader), body)
end

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

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

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

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

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

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

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

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

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

# File lib/net/http.rb, line 1190
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 1165
def proxy_port
  if @proxy_from_env then
    proxy_uri&.port
  else
    @proxy_port
  end
end

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

# File lib/net/http.rb, line 1181
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 794
def read_timeout=(sec)
  @socket.read_timeout = sec if @socket
  @read_timeout = sec
end

Установка значения атрибута read_timeout.

# File lib/net/http.rb, line 1510
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 1421
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 1435
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 1465
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 1489
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 724
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 955
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 823
def started?
  @started
end

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

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

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

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

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

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

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

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

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