On this page
class Net::HTTP
An HTTP client API for Ruby.
Net::HTTP provides a rich library which can be used to build HTTP user-agents. For more details about HTTP see [RFC2616](www.ietf.org/rfc/rfc2616.txt)
Net::HTTP is designed to work closely with URI. URI::Generic#host, URI::Generic#port and URI::HTTP#request_uri are designed to work with Net::HTTP.
If you are only performing a few GET requests you should try OpenURI.
Simple Examples
All examples assume you have loaded Net::HTTP with:
require 'net/http'
This will also require 'uri' so you don't need to require it separately.
The Net::HTTP methods in the following section do not persist connections. They are not recommended if you are performing many HTTP requests.
GET
Net::HTTP.get('example.com', '/index.html') # => String
GET by URI
uri = URI('http://example.com/index.html?count=10')
Net::HTTP.get(uri) # => String
GET with Dynamic Parameters
uri = URI('http://example.com/index.html')
params = { :limit => 10, :page => 3 }
uri.query = URI.encode_www_form(params)
res = Net::HTTP.get_response(uri)
puts res.body if res.is_a?(Net::HTTPSuccess)
POST
uri = URI('http://www.example.com/search.cgi')
res = Net::HTTP.post_form(uri, 'q' => 'ruby', 'max' => '50')
puts res.body
POST with Multiple Values
uri = URI('http://www.example.com/search.cgi')
res = Net::HTTP.post_form(uri, 'q' => ['ruby', 'perl'], 'max' => '50')
puts res.body
How to use Net::HTTP
The following example code can be used as the basis of a HTTP user-agent which can perform a variety of request types using persistent connections.
uri = URI('http://example.com/some_path?query=string')
Net::HTTP.start(uri.host, uri.port) do |http|
  request = Net::HTTP::Get.new uri
  response = http.request request # Net::HTTPResponse object
end
::start immediately creates a connection to an HTTP server which is kept open for the duration of the block. The connection will remain open for multiple requests in the block if the server indicates it supports persistent connections.
The request types Net::HTTP supports are listed below in the section “HTTP Request Classes”.
If you wish to re-use a connection across multiple HTTP requests without automatically closing it you can use ::new instead of ::start. request will automatically open a connection to the server if one is not currently open. You can manually close the connection with finish.
For all the Net::HTTP request objects and shortcut request methods you may supply either a String for the request path or a URI from which Net::HTTP will extract the request path.
Response
uri = URI('http://example.com/index.html')
res = Net::HTTP.get_response(uri)
# Headers
res['Set-Cookie']            # => String
res.get_fields('set-cookie') # => Array
res.to_hash['set-cookie']    # => Array
puts "Headers: #{res.to_hash.inspect}"
# Status
puts res.code       # => '200'
puts res.message    # => 'OK'
puts res.class.name # => 'HTTPOK'
# Body
puts res.body if res.response_body_permitted?
Following Redirection
Each Net::HTTPResponse object belongs to a class for its response code.
For example, all 2XX responses are instances of a Net::HTTPSuccess subclass, a 3XX response is an instance of a Net::HTTPRedirection subclass and a 200 response is an instance of the Net::HTTPOK class. For details of response classes, see the section “HTTP Response Classes” below.
Using a case statement you can handle various types of responses properly:
def fetch(uri_str, limit = 10)
  # You should choose a better exception.
  raise ArgumentError, 'too many HTTP redirects' if limit == 0
  response = Net::HTTP.get_response(URI(uri_str))
  case response
  when Net::HTTPSuccess then
    response
  when Net::HTTPRedirection then
    location = response['location']
    warn "redirected to #{location}"
    fetch(location, limit - 1)
  else
    response.value
  end
end
print fetch('http://www.ruby-lang.org')
POST
A POST can be made using the Net::HTTP::Post request class. This example creates a urlencoded POST body:
uri = URI('http://www.example.com/todo.cgi')
req = Net::HTTP::Post.new(uri)
req.set_form_data('from' => '2005-01-01', 'to' => '2005-03-31')
res = Net::HTTP.start(uri.hostname, uri.port) do |http|
  http.request(req)
end
case res
when Net::HTTPSuccess, Net::HTTPRedirection
  # OK
else
  res.value
end
At this time Net::HTTP does not support multipart/form-data. To send multipart/form-data use Net::HTTPGenericRequest#body= and Net::HTTPRequest#content_type=:
req = Net::HTTP::Post.new(uri)
req.body = multipart_data
req.content_type = 'multipart/form-data'
Other requests that can contain a body such as PUT can be created in the same way using the corresponding request class (Net::HTTP::Put).
Setting Headers
The following example performs a conditional GET using the If-Modified-Since header. If the files has not been modified since the time in the header a Not Modified response will be returned. See RFC 2616 section 9.3 for further details.
uri = URI('http://example.com/cached_response')
file = File.stat 'cached_response'
req = Net::HTTP::Get.new(uri)
req['If-Modified-Since'] = file.mtime.rfc2822
res = Net::HTTP.start(uri.hostname, uri.port) {|http|
  http.request(req)
}
open 'cached_response', 'w' do |io|
  io.write res.body
end if res.is_a?(Net::HTTPSuccess)
Basic Authentication
Basic authentication is performed according to [RFC2617](www.ietf.org/rfc/rfc2617.txt)
uri = URI('http://example.com/index.html?key=value')
req = Net::HTTP::Get.new(uri)
req.basic_auth 'user', 'pass'
res = Net::HTTP.start(uri.hostname, uri.port) {|http|
  http.request(req)
}
puts res.body
Streaming Response Bodies
By default Net::HTTP reads an entire response into memory. If you are handling large files or wish to implement a progress bar you can instead stream the body directly to an IO.
uri = URI('http://example.com/large_file')
Net::HTTP.start(uri.host, uri.port) do |http|
  request = Net::HTTP::Get.new uri
  http.request request do |response|
    open 'large_file', 'w' do |io|
      response.read_body do |chunk|
        io.write chunk
      end
    end
  end
end
HTTPS
HTTPS is enabled for an HTTP connection by #use_ssl=.
uri = URI('https://secure.example.com/some_path?query=string')
Net::HTTP.start(uri.host, uri.port,
  :use_ssl => uri.scheme == 'https') do |http|
  request = Net::HTTP::Get.new uri
  response = http.request request # Net::HTTPResponse object
end
In previous versions of Ruby you would need to require 'net/https' to use HTTPS. This is no longer true.
Proxies
Net::HTTP will automatically create a proxy from the http_proxy environment variable if it is present. To disable use of http_proxy, pass nil for the proxy address.
You may also create a custom proxy:
proxy_addr = 'your.proxy.host'
proxy_port = 8080
Net::HTTP.new('example.com', nil, proxy_addr, proxy_port).start { |http|
  # always proxy via your.proxy.addr:8080
}
See ::new for further details and examples such as proxies that require a username and password.
Compression
Net::HTTP automatically adds Accept-Encoding for compression of response bodies and automatically decompresses gzip and deflate responses unless a Range header was sent.
Compression can be disabled through the Accept-Encoding: identity header.
HTTP Request Classes
Here is the HTTP request class hierarchy.
HTTP Response Classes
Here is HTTP response class hierarchy. All classes are defined in Net module and are subclasses of Net::HTTPResponse.
- HTTPUnknownResponse
- 
     For unhandled HTTP extensions 
- HTTPInformation
- 
     1xx 
- HTTPContinue
- 
     100 
- HTTPSwitchProtocol
- 
     101 
- HTTPSuccess
- 
     2xx 
- HTTPOK
- 
     200 
- HTTPCreated
- 
     201 
- HTTPAccepted
- 
     202 
- HTTPNonAuthoritativeInformation
- 
     203 
- HTTPNoContent
- 
     204 
- HTTPResetContent
- 
     205 
- HTTPPartialContent
- 
     206 
- HTTPMultiStatus
- 
     207 
- HTTPIMUsed
- 
     226 
- HTTPRedirection
- 
     3xx 
- HTTPMultipleChoices
- 
     300 
- HTTPMovedPermanently
- 
     301 
- HTTPFound
- 
     302 
- HTTPSeeOther
- 
     303 
- HTTPNotModified
- 
     304 
- HTTPUseProxy
- 
     305 
- HTTPTemporaryRedirect
- 
     307 
- HTTPClientError
- 
     4xx 
- HTTPBadRequest
- 
     400 
- HTTPUnauthorized
- 
     401 
- HTTPPaymentRequired
- 
     402 
- HTTPForbidden
- 
     403 
- HTTPNotFound
- 
     404 
- HTTPMethodNotAllowed
- 
     405 
- HTTPNotAcceptable
- 
     406 
- HTTPProxyAuthenticationRequired
- 
     407 
- HTTPRequestTimeOut
- 
     408 
- HTTPConflict
- 
     409 
- HTTPGone
- 
     410 
- HTTPLengthRequired
- 
     411 
- HTTPPreconditionFailed
- 
     412 
- HTTPRequestEntityTooLarge
- 
     413 
- HTTPRequestURITooLong
- 
     414 
- HTTPUnsupportedMediaType
- 
     415 
- HTTPRequestedRangeNotSatisfiable
- 
     416 
- HTTPExpectationFailed
- 
     417 
- HTTPUnprocessableEntity
- 
     422 
- HTTPLocked
- 
     423 
- HTTPFailedDependency
- 
     424 
- HTTPUpgradeRequired
- 
     426 
- HTTPPreconditionRequired
- 
     428 
- HTTPTooManyRequests
- 
     429 
- HTTPRequestHeaderFieldsTooLarge
- 
     431 
- HTTPServerError
- 
     5xx 
- HTTPInternalServerError
- 
     500 
- HTTPNotImplemented
- 
     501 
- HTTPBadGateway
- 
     502 
- HTTPServiceUnavailable
- 
     503 
- HTTPGatewayTimeOut
- 
     504 
- HTTPVersionNotSupported
- 
     505 
- HTTPInsufficientStorage
- 
     507 
- HTTPNetworkAuthenticationRequired
- 
     511 
There is also the Net::HTTPBadResponse exception which is raised when there is a protocol error.
Constants
- SSL_ATTRIBUTES
- SSL_IVNAMES
Attributes
Address of proxy host. If Net::HTTP does not use a proxy, nil.
User password for accessing proxy. If Net::HTTP does not use a proxy, nil.
Port number of proxy host. If Net::HTTP does not use a proxy, nil.
User name for accessing proxy. If Net::HTTP does not use a proxy, nil.
The DNS host name or IP address to connect to.
Sets path of a CA certification file in PEM format.
The file can contain several CA certificates.
Sets path of a CA certification directory containing certifications in PEM format.
Sets an OpenSSL::X509::Certificate object as client certificate. (This method is appeared in Michal Rokos's OpenSSL extension).
Sets the X509::Store to verify peer certificate.
Sets the available ciphers. See OpenSSL::SSL::SSLContext#ciphers=
Seconds to wait for 100 Continue response. If the HTTP object does not receive a response in this many seconds it sends the request body. The default value is nil.
Sets an OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object. (This method is appeared in Michal Rokos's OpenSSL extension.)
The local host used to establish the connection.
The local port used to establish the connection.
Number of seconds to wait for the connection to open. Any number may be used, including Floats for fractional seconds. If the HTTP object cannot open a connection in this many seconds, it raises a Net::OpenTimeout exception. The default value is 60 seconds.
The port number to connect to.
Number of seconds to wait for one block to be read (via one read(2) call). Any number may be used, including Floats for fractional seconds. If the HTTP object cannot read data in this many seconds, it raises a Net::ReadTimeout exception. The default value is 60 seconds.
Sets the SSL timeout seconds.
Sets the SSL version. See OpenSSL::SSL::SSLContext#ssl_version=
Sets the verify callback for the server certification verification.
Sets the maximum depth for the certificate chain verification.
Sets the flags for server the certification verification at beginning of SSL/TLS session.
OpenSSL::SSL::VERIFY_NONE or OpenSSL::SSL::VERIFY_PEER are acceptable.
Public Class Methods
# File lib/net/http.rb, line 980
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
  }
endCreates an HTTP proxy class which behaves like Net::HTTP, but performs all access via the specified proxy.
This class is obsolete. You may pass these same parameters directly to ::new. See ::new for details of the arguments.
# File lib/net/http.rb, line 519
def HTTP.default_port
  http_default_port()
endThe default port to use for HTTP requests; defaults to 80.
# File lib/net/http.rb, line 455
def HTTP.get(uri_or_host, path = nil, port = nil)
  get_response(uri_or_host, path, port).body
endSends a GET request to the target and returns the HTTP response as a string. The target can either be specified as (uri), or as (host, path, port = 80); so:
print Net::HTTP.get(URI('http://www.example.com/index.html'))
or:
print Net::HTTP.get('www.example.com', '/index.html')
# File lib/net/http.rb, line 436
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
endGets the body text from the target and outputs it to $stdout. The target can either be specified as (uri), or as (host, path, port = 80); so:
Net::HTTP.get_print URI('http://www.example.com/index.html')
or:
Net::HTTP.get_print 'www.example.com', '/index.html'
# File lib/net/http.rb, line 471
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
endSends a GET request to the target and returns the HTTP response as a Net::HTTPResponse object. The target can either be specified as (uri), or as (host, path, port = 80); so:
res = Net::HTTP.get_response(URI('http://www.example.com/index.html'))
print res.body
or:
res = Net::HTTP.get_response('www.example.com', '/index.html')
print res.body
# File lib/net/http.rb, line 524
def HTTP.http_default_port
  80
endThe default port to use for HTTP requests; defaults to 80.
# File lib/net/http.rb, line 529
def HTTP.https_default_port
  443
endThe default port to use for HTTPS requests; defaults to 443.
# File lib/net/http.rb, line 634
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
  @continue_timeout = nil
  @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
endCreates a new Net::HTTP object for the specified server address, without opening the TCP connection or initializing the HTTP session. The address should be a DNS hostname or IP address.
# File lib/net/http.rb, line 610
def HTTP.new(address, port = nil, p_addr = :ENV, p_port = nil, p_user = nil, p_pass = 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
    http.proxy_address = p_addr
    http.proxy_port    = p_port || default_port
    http.proxy_user    = p_user
    http.proxy_pass    = p_pass
  end
  http
endCreates a new Net::HTTP object without opening a TCP connection or HTTP session.
The address should be a DNS hostname or IP address, the port is the port the server operates on. If no port is given the default port for HTTP or HTTPS is used.
If none of the p_ arguments are given, the proxy host and port are taken from the http_proxy environment variable (or its uppercase equivalent) if present. If the proxy requires authentication you must supply it by hand. See URI::Generic#find_proxy for details of proxy detection from the environment. To disable proxy detection set p_addr to nil.
If you are connecting to a custom proxy, p_addr the DNS name or IP address of the proxy host, p_port the port to use to access the proxy, and p_user and p_pass the username and password if authorization is required to use the proxy.
# File lib/net/http.rb, line 504
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)
  }
endPosts HTML form data to the specified URI object. The form data must be provided as a Hash mapping from String to String. Example:
{ "cmd" => "search", "q" => "ruby", "max" => "50" }
This method also does Basic Authentication iff url.user exists. But userinfo for authentication is deprecated (RFC3986). So this feature will be removed.
Example:
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 1003
def proxy_class?
  defined?(@is_proxy_class) ? @is_proxy_class : false
endreturns true if self is a class which was created by HTTP::Proxy.
# File lib/net/http.rb, line 567
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
  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)
endCreates a new Net::HTTP object, then additionally opens the TCP connection and HTTP session.
Arguments are the following:
- address
- 
        hostname or IP address of the server 
- port
- 
        port of the server 
- p_addr
- 
        address of proxy 
- p_port
- 
        port of proxy 
- p_user
- 
        user of proxy 
- p_pass
- 
        pass of proxy 
- opt
- 
        optional hash 
opt sets following values by its accessor. The keys are #ca_file, #ca_path, cert, #cert_store, ciphers, #close_on_empty_response, key, #open_timeout, #read_timeout, #ssl_timeout, #ssl_version, use_ssl, #verify_callback, #verify_depth and verify_mode. If you set :use_ssl as true, you can use https and default value of #verify_mode is set as OpenSSL::SSL::VERIFY_PEER.
If the optional block is given, the newly created Net::HTTP object is passed to it and closed when the block finishes. In this case, the return value of this method is the return value of the block. If no block is given, the return value of this method is the newly created Net::HTTP object itself, and the caller is responsible for closing it upon completion using the finish() method.
# File lib/net/http.rb, line 402
def HTTP.version_1_2
  true
endTurns on net/http 1.2 (Ruby 1.8) features. Defaults to ON in Ruby 1.8 or later.
# File lib/net/http.rb, line 408
def HTTP.version_1_2?
  true
endReturns true if net/http is in version 1.2 mode. Defaults to true.
Public Instance Methods
# File lib/net/http.rb, line 726
def continue_timeout=(sec)
  @socket.continue_timeout = sec if @socket
  @continue_timeout = sec
endSetter for the #continue_timeout attribute.
# File lib/net/http.rb, line 1252
def copy(path, initheader = nil)
  request(Copy.new(path, initheader))
endSends a COPY request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 1240
def delete(path, initheader = {'Depth' => 'Infinity'})
  request(Delete.new(path, initheader))
endSends a DELETE request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 1140
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
endRetrieves data from path on the connected-to host which may be an absolute path String or a URI to extract the path from.
initheader must be a Hash like { 'Accept' => '/', … }, and it defaults to an empty hash. If initheader doesn't have the key 'accept-encoding', then a value of “gzip;q=1.0,deflate;q=0.6,identity;q=0.3” is used, so that gzip compression is used in preference to deflate compression, which is used in preference to no compression. Ruby doesn't have libraries to support the compress (Lempel-Ziv) compression, so that is not supported. The intent of this is to reduce bandwidth by default. If this routine sets up compression, then it does the decompression also, removing the header as well to prevent confusion. Otherwise it leaves the body as it found it.
This method returns a Net::HTTPResponse object.
If called with a block, yields each fragment of the entity body in turn as a string as it is read from the socket. Note that in this case, the returned response object will not contain a (meaningful) body.
dest argument is obsolete. It still works but you must not use it.
This method never raises an exception.
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 1162
def head(path, initheader = nil)
  request(Head.new(path, initheader))
endGets only the header from path on the connected-to host. header is a Hash like { 'Accept' => '/', … }.
This method returns a Net::HTTPResponse object.
This method never raises an exception.
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 666
def inspect
  "#<#{self.class} #{@address}:#{@port} open=#{started?}>"
end# File lib/net/http.rb, line 1216
def lock(path, body, initheader = nil)
  request(Lock.new(path, initheader), body)
endSends a LOCK request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 1258
def mkcol(path, body = nil, initheader = nil)
  request(Mkcol.new(path, initheader), body)
endSends a MKCOL request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 1246
def move(path, initheader = nil)
  request(Move.new(path, initheader))
endSends a MOVE request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 1228
def options(path, initheader = nil)
  request(Options.new(path, initheader))
endSends a OPTIONS request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 1200
def patch(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+
  send_entity(path, data, initheader, dest, Patch, &block)
endSends a PATCH request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 832
def peer_cert
  if not use_ssl? or not @socket
    return nil
  end
  @socket.io.peer_cert
endReturns the X.509 certificates the server presented.
# File lib/net/http.rb, line 1194
def post(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+
  send_entity(path, data, initheader, dest, Post, &block)
endPosts data (must be a String) to path. header must be a Hash like { 'Accept' => '/', … }.
This method returns a Net::HTTPResponse object.
If called with a block, yields each fragment of the entity body in turn as a string as it is read from the socket. Note that in this case, the returned response object will not contain a (meaningful) body.
dest argument is obsolete. It still works but you must not use it.
This method never raises exception.
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
}
You should set Content-Type: header field for POST. If no Content-Type: field given, this method uses “application/x-www-form-urlencoded” by default.
# File lib/net/http.rb, line 1234
def propfind(path, body = nil, initheader = {'Depth' => '0'})
  request(Propfind.new(path, initheader), body)
endSends a PROPFIND request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 1210
def proppatch(path, body, initheader = nil)
  request(Proppatch.new(path, initheader), body)
endSends a PROPPATCH request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 1022
def proxy?
  !!if @proxy_from_env then
    proxy_uri
  else
    @proxy_address
  end
endTrue if requests for this connection will be proxied
# File lib/net/http.rb, line 1043
def proxy_address
  if @proxy_from_env then
    proxy_uri&.hostname
  else
    @proxy_address
  end
endThe address of the proxy server, if one is configured.
# File lib/net/http.rb, line 1031
def proxy_from_env?
  @proxy_from_env
endTrue if the proxy for this connection is determined from the environment
# File lib/net/http.rb, line 1066
def proxy_pass
  @proxy_pass
endThe proxy password, if one is configured
# File lib/net/http.rb, line 1052
def proxy_port
  if @proxy_from_env then
    proxy_uri&.port
  else
    @proxy_port
  end
endThe port of the proxy server, if one is configured.
# File lib/net/http.rb, line 1061
def proxy_user
  @proxy_user
endThe proxy username, if one is configured
# File lib/net/http.rb, line 715
def read_timeout=(sec)
  @socket.read_timeout = sec if @socket
  @read_timeout = sec
endSetter for the #read_timeout attribute.
# File lib/net/http.rb, line 1382
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
endSends an HTTPRequest object req to the HTTP server.
If req is a Net::HTTP::Post or Net::HTTP::Put request containing data, the data is also sent. Providing data for a Net::HTTP::Head or Net::HTTP::Get request results in an ArgumentError.
Returns an HTTPResponse object.
When called with a block, passes an HTTPResponse object to the block. The body of the response will not have been read yet; the block can process it using Net::HTTPResponse#read_body, if desired.
This method never raises Net::* exceptions.
# File lib/net/http.rb, line 1293
def request_get(path, initheader = nil, &block) # :yield: +response+
  request(Get.new(path, initheader), &block)
endSends a GET request to the path. Returns the response as a Net::HTTPResponse object.
When called with a block, passes an HTTPResponse object to the block. The body of the response will not have been read yet; the block can process it using Net::HTTPResponse#read_body, if desired.
Returns the response.
This method never raises Net::* exceptions.
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 1307
def request_head(path, initheader = nil, &block)
  request(Head.new(path, initheader), &block)
endSends a HEAD request to the path and returns the response as a Net::HTTPResponse object.
Returns the response.
This method never raises Net::* exceptions.
response = http.request_head('/index.html')
p response['content-type']
# File lib/net/http.rb, line 1337
def request_post(path, data, initheader = nil, &block) # :yield: +response+
  request Post.new(path, initheader), data, &block
endSends a POST request to the path.
Returns the response as a Net::HTTPResponse object.
When called with a block, the block is passed an HTTPResponse object. The body of that response will not have been read yet; the block can process it using Net::HTTPResponse#read_body, if desired.
Returns the response.
This method never raises Net::* exceptions.
# 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 1361
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
endSends an HTTP request to the HTTP server. Also sends a DATA string if data is given.
Returns a Net::HTTPResponse object.
This method never raises Net::* exceptions.
response = http.send_request('GET', '/index.html')
puts response.body
# File lib/net/http.rb, line 679
def set_debug_output(output)
  warn 'Net::HTTP#set_debug_output called after HTTP started' if started?
  @debug_output = output
endWARNING This method opens a serious security hole. Never use this method in production code.
Sets an output stream for debugging.
http = Net::HTTP.new(hostname)
http.set_debug_output $stderr
http.start { .... }# File lib/net/http.rb, line 848
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
endOpens a TCP connection and HTTP session.
When this method is called with a block, it passes the Net::HTTP object to the block, and closes the TCP connection and HTTP session after the block has been executed.
When called with a block, it returns the return value of the block; otherwise, it returns self.
# File lib/net/http.rb, line 738
def started?
  @started
endReturns true if the HTTP session has been started.
# File lib/net/http.rb, line 1264
def trace(path, initheader = nil)
  request(Trace.new(path, initheader))
endSends a TRACE request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 1222
def unlock(path, body, initheader = nil)
  request(Unlock.new(path, initheader), body)
endSends a UNLOCK request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 755
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
endTurn on/off SSL. This flag must be set before starting session. If you change use_ssl value after session started, a Net::HTTP object raises IOError.
# File lib/net/http.rb, line 747
def use_ssl?
  @use_ssl
endReturns true if SSL/TLS is being used with HTTP.
Private Instance Methods
# File lib/net/http.rb, line 1551
def D(msg)
  return unless @debug_output
  @debug_output << msg
  @debug_output << "\n"
end# File lib/net/http.rb, line 1543
def addr_port
  if use_ssl?
    address() + (port == HTTP.https_default_port ? '' : ":#{port()}")
  else
    address() + (port == HTTP.http_default_port ? '' : ":#{port()}")
  end
endutils
# File lib/net/http.rb, line 1460
def begin_transport(req)
  if @socket.closed?
    connect
  elsif @last_communicated
    if @last_communicated + @keep_alive_timeout < Process.clock_gettime(Process::CLOCK_MONOTONIC)
      D 'Conn close because of keep_alive_timeout'
      @socket.close
      connect
    elsif @socket.io.to_io.wait_readable(0) && @socket.eof?
      D "Conn close because of EOF"
      @socket.close
      connect
    end
  end
  if not req.response_body_permitted? and @close_on_empty_response
    req['connection'] ||= 'close'
  end
  req.update_uri address, port, use_ssl?
  req['host'] ||= addr_port()
end# File lib/net/http.rb, line 868
def connect
  if proxy? then
    conn_address = proxy_address
    conn_port    = proxy_port
  else
    conn_address = address
    conn_port    = port
  end
  D "opening connection to #{conn_address}:#{conn_port}..."
  s = Timeout.timeout(@open_timeout, Net::OpenTimeout) {
    begin
      TCPSocket.open(conn_address, conn_port, @local_host, @local_port)
    rescue => e
      raise e, "Failed to open TCP connection to " +
        "#{conn_address}:#{conn_port} (#{e.message})"
    end
  }
  s.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
  D "opened"
  if use_ssl?
    ssl_parameters = Hash.new
    iv_list = instance_variables
    SSL_IVNAMES.each_with_index do |ivname, i|
      if iv_list.include?(ivname) and
        value = instance_variable_get(ivname)
        ssl_parameters[SSL_ATTRIBUTES[i]] = value if value
      end
    end
    @ssl_context = OpenSSL::SSL::SSLContext.new
    @ssl_context.set_params(ssl_parameters)
    D "starting SSL for #{conn_address}:#{conn_port}..."
    s = OpenSSL::SSL::SSLSocket.new(s, @ssl_context)
    s.sync_close = true
    D "SSL established"
  end
  @socket = BufferedIO.new(s)
  @socket.read_timeout = @read_timeout
  @socket.continue_timeout = @continue_timeout
  @socket.debug_output = @debug_output
  if use_ssl?
    begin
      if proxy?
        buf = "CONNECT #{@address}:#{@port} HTTP/#{HTTPVersion}\r\n"
        buf << "Host: #{@address}:#{@port}\r\n"
        if proxy_user
          credential = ["#{proxy_user}:#{proxy_pass}"].pack('m')
          credential.delete!("\r\n")
          buf << "Proxy-Authorization: Basic #{credential}\r\n"
        end
        buf << "\r\n"
        @socket.write(buf)
        HTTPResponse.read_new(@socket).value
      end
      # Server Name Indication (SNI) RFC 3546
      s.hostname = @address if s.respond_to? :hostname=
      if @ssl_session and
         Process.clock_gettime(Process::CLOCK_REALTIME) < @ssl_session.time.to_f + @ssl_session.timeout
        s.session = @ssl_session if @ssl_session
      end
      ssl_socket_connect(s, @open_timeout)
      if @ssl_context.verify_mode != OpenSSL::SSL::VERIFY_NONE
        s.post_connection_check(@address)
      end
      @ssl_session = s.session
    rescue => exception
      D "Conn close because of connect error #{exception}"
      @socket.close if @socket and not @socket.closed?
      raise exception
    end
  end
  on_connect
end# File lib/net/http.rb, line 954
def do_finish
  @started = false
  @socket.close if @socket and not @socket.closed?
  @socket = nil
end# File lib/net/http.rb, line 862
def do_start
  connect
  @started = true
end# File lib/net/http.rb, line 1085
def edit_path(path)
  if proxy?
    if path.start_with?("ftp://") || use_ssl?
      path
    else
      "http://#{addr_port}#{path}"
    end
  else
    path
  end
end# File lib/net/http.rb, line 1483
def end_transport(req, res)
  @curr_http_version = res.http_version
  @last_communicated = nil
  if @socket.closed?
    D 'Conn socket closed'
  elsif not res.body and @close_on_empty_response
    D 'Conn close'
    @socket.close
  elsif keep_alive?(req, res)
    D 'Conn keep-alive'
    @last_communicated = Process.clock_gettime(Process::CLOCK_MONOTONIC)
  else
    D 'Conn close'
    @socket.close
  end
end# File lib/net/http.rb, line 1500
def keep_alive?(req, res)
  return false if req.connection_close?
  if @curr_http_version <= '1.0'
    res.connection_keep_alive?
  else   # HTTP/1.1 or later
    not res.connection_close?
  end
end# File lib/net/http.rb, line 943
def on_connect
end# File lib/net/http.rb, line 1405
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
endExecutes a request which uses a representation and returns its body.
# File lib/net/http.rb, line 1524
def sspi_auth(req)
  n = Win32::SSPI::NegotiateAuth.new
  req["Proxy-Authorization"] = "Negotiate #{n.get_initial_token}"
  # Some versions of ISA will close the connection if this isn't present.
  req["Connection"] = "Keep-Alive"
  req["Proxy-Connection"] = "Keep-Alive"
  res = transport_request(req)
  authphrase = res["Proxy-Authenticate"]  or return res
  req["Proxy-Authorization"] = "Negotiate #{n.complete_authentication(authphrase)}"
rescue => err
  raise HTTPAuthenticationError.new('HTTP authentication failed', err)
end# File lib/net/http.rb, line 1509
def sspi_auth?(res)
  return false unless @sspi_enabled
  if res.kind_of?(HTTPProxyAuthenticationRequired) and
      proxy? and res["Proxy-Authenticate"].include?("Negotiate")
    begin
      require 'win32/sspi'
      true
    rescue LoadError
      false
    end
  else
    false
  end
end# File lib/net/http.rb, line 1416
def transport_request(req)
  count = 0
  begin
    begin_transport req
    res = catch(:response) {
      req.exec @socket, @curr_http_version, edit_path(req.path)
      begin
        res = HTTPResponse.read_new(@socket)
        res.decode_content = req.decode_content
      end while res.kind_of?(HTTPInformation)
      res.uri = req.uri
      res
    }
    res.reading_body(@socket, req.response_body_permitted?) {
      yield res if block_given?
    }
  rescue Net::OpenTimeout
    raise
  rescue Net::ReadTimeout, IOError, EOFError,
         Errno::ECONNRESET, Errno::ECONNABORTED, Errno::EPIPE,
         # avoid a dependency on OpenSSL
         defined?(OpenSSL::SSL) ? OpenSSL::SSL::SSLError : IOError,
         Timeout::Error => exception
    if count == 0 && IDEMPOTENT_METHODS_.include?(req.method)
      count += 1
      @socket.close if @socket and not @socket.closed?
      D "Conn close because of error #{exception}, and retry"
      retry
    end
    D "Conn close because of error #{exception}"
    @socket.close if @socket and not @socket.closed?
    raise
  end
  end_transport req, res
  res
rescue => exception
  D "Conn close because of error #{exception}"
  @socket.close if @socket and not @socket.closed?
  raise exception
endRuby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.