Class: Net::HTTP (Ruby 2.7.2)
Description: Class : Net::HTTP - Ruby 2.7.2

### Home Classes Methods

### In Files

- net/http.rb
- net/http/generic_request.rb
- net/http/proxy_delta.rb
- net/http/requests.rb
- net/http/status.rb

### Parent

Protocol

### Namespace

- CLASS Net::HTTP::Copy
- CLASS Net::HTTP::Delete
- CLASS Net::HTTP::Get
- CLASS Net::HTTP::Head
- CLASS Net::HTTP::Lock
- CLASS Net::HTTP::Mkcol
- CLASS Net::HTTP::Move
- CLASS Net::HTTP::Options
- CLASS Net::HTTP::Patch
- CLASS Net::HTTP::Post
- CLASS Net::HTTP::Propfind
- CLASS Net::HTTP::Proppatch
- CLASS Net::HTTP::Put
- CLASS Net::HTTP::Trace
- CLASS Net::HTTP::Unlock

### Methods

- ::Proxy
- ::default_port
- ::get
- ::get_print
- ::get_response
- ::http_default_port
- ::https_default_port
- ::is_version_1_2?
- ::new
- ::new
- ::newobj
- ::post
- ::post_form
- ::proxy_class?
- ::start
- ::version_1_2
- ::version_1_2?
- #active?
- #continue_timeout=
- #copy
- #delete
- #finish
- #get
- #get2
- #head
- #head2
- #inspect
- #ipaddr
- #ipaddr=
- #lock
- #max_retries=
- #mkcol
- #move
- #options
- #patch
- #peer_cert
- #post
- #post2
- #propfind
- #proppatch
- #proxy?
- #proxy_address
- #proxy_from_env?
- #proxy_pass
- #proxy_port
- #proxy_user
- #proxyaddr
- #proxyport
- #read_timeout=
- #request
- #request_get
- #request_head
- #request_post
- #send_request
- #set_debug_output
- #start
- #started?
- #trace
- #unlock
- #use_ssl=
- #use_ssl?
- #write_timeout=

### Class/Module Index

Quicksearch

- EXCEPTION_TYPE
- EXCEPTION_TYPE
- EXCEPTION_TYPE
- EXCEPTION_TYPE
- HTTPClientException
- HTTPGatewayTimeOut
- HTTPMovedTemporarily
- HTTPMultipleChoice
- HTTPRequestEntityTooLarge
- HTTPRequestTimeOut
- HTTPRequestURITooLarge
- HTTPRequestURITooLong
- HTTPRequestURITooLong
- HTTPRequestedRangeNotSatisfiable
- Net
- Net::HTTP
- Net::HTTP::Copy
- Net::HTTP::Delete
- Net::HTTP::Get
- Net::HTTP::Head
- Net::HTTP::Lock
- Net::HTTP::Mkcol
- Net::HTTP::Move
- Net::HTTP::Options
- Net::HTTP::Patch
- Net::HTTP::Post
- Net::HTTP::Propfind
- Net::HTTP::Proppatch
- Net::HTTP::Put
- Net::HTTP::Trace
- Net::HTTP::Unlock
- Net::HTTPAccepted
- Net::HTTPAlreadyReported
- Net::HTTPBadGateway
- Net::HTTPBadRequest
- Net::HTTPClientError
- Net::HTTPConflict
- Net::HTTPContinue
- Net::HTTPCreated
- Net::HTTPEarlyHints
- Net::HTTPError
- Net::HTTPExceptions
- Net::HTTPExpectationFailed
- Net::HTTPFailedDependency
- Net::HTTPFatalError
- Net::HTTPForbidden
- Net::HTTPFound
- Net::HTTPGatewayTimeout
- Net::HTTPGenericRequest
- Net::HTTPGone
- Net::HTTPHeader
- Net::HTTPIMUsed
- Net::HTTPInformation
- Net::HTTPInsufficientStorage
- Net::HTTPInternalServerError
- Net::HTTPLengthRequired
- Net::HTTPLocked
- Net::HTTPLoopDetected
- Net::HTTPMethodNotAllowed
- Net::HTTPMisdirectedRequest
- Net::HTTPMovedPermanently
- Net::HTTPMultiStatus
- Net::HTTPMultipleChoices
- Net::HTTPNetworkAuthenticationRequired
- Net::HTTPNoContent
- Net::HTTPNonAuthoritativeInformation
- Net::HTTPNotAcceptable
- Net::HTTPNotExtended
- Net::HTTPNotFound
- Net::HTTPNotImplemented
- Net::HTTPNotModified
- Net::HTTPOK
- Net::HTTPPartialContent
- Net::HTTPPayloadTooLarge
- Net::HTTPPaymentRequired
- Net::HTTPPermanentRedirect
- Net::HTTPPreconditionFailed
- Net::HTTPPreconditionRequired
- Net::HTTPProcessing
- Net::HTTPProxyAuthenticationRequired
- Net::HTTPRangeNotSatisfiable
- Net::HTTPRedirection
- Net::HTTPRequest
- Net::HTTPRequestHeaderFieldsTooLarge
- Net::HTTPRequestTimeout
- Net::HTTPResetContent
- Net::HTTPResponse
- Net::HTTPRetriableError
- Net::HTTPSeeOther
- Net::HTTPServerError
- Net::HTTPServerException
- Net::HTTPServiceUnavailable
- Net::HTTPSuccess
- Net::HTTPSwitchProtocol
- Net::HTTPTemporaryRedirect
- Net::HTTPTooManyRequests
- Net::HTTPURITooLong
- Net::HTTPUnauthorized
- Net::HTTPUnavailableForLegalReasons
- Net::HTTPUnknownResponse
- Net::HTTPUnprocessableEntity
- Net::HTTPUnsupportedMediaType
- Net::HTTPUpgradeRequired
- Net::HTTPUseProxy
- Net::HTTPVariantAlsoNegotiates
- Net::HTTPVersionNotSupported

No matching classes.

# 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::HTTP#host, URI::HTTP#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 an 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.

If you wish to re-use a connection across multiple HTTP requests without automatically closing it you can use ::new and then call start and finish manually.

The request types Net::HTTP supports are listed below in the section “HTTP Request Classes”.

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 Data¶ ↑

    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 URL encoded 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

To send multipart/form-data use Net::HTTPHeader#set_form:

    req = Net::HTTP::Post.new(uri)
    req.set_form([['upload', File.open('foo.bar')]], '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 => true) do |http|
      request = Net::HTTP::Get.new uri
      response = http.request request # Net::HTTPResponse object
    end

Or if you simply want to make a GET request, you may pass in an URI object that has an HTTPS URL. Net::HTTP automatically turns on TLS verification if the URI object has a ‘https’ URI scheme.

    uri = URI('https://example.com/')
    Net::HTTP.get(uri) # => String

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.

- Net::HTTPRequest

  - Net::HTTP::Get

  - Net::HTTP::Head

  - Net::HTTP::Post

  - Net::HTTP::Patch

  - Net::HTTP::Put

  - Net::HTTP::Proppatch

  - Net::HTTP::Lock

  - Net::HTTP::Unlock

  - Net::HTTP::Options

  - Net::HTTP::Propfind

  - Net::HTTP::Delete

  - Net::HTTP::Move

  - Net::HTTP::Copy

  - Net::HTTP::Mkcol

  - Net::HTTP::Trace

## 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

HTTPUnavailableForLegalReasons

  451

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

ENVIRONMENT_VARIABLE_IS_MULTIUSER_SAFE
SSL_ATTRIBUTES
SSL_IVNAMES
STATUS_CODES

### Attributes

proxy_address[R]

Address of proxy host. If Net::HTTP does not use a proxy, nil.

proxy_pass[R]

User password for accessing proxy. If Net::HTTP does not use a proxy, nil.

proxy_port[R]

Port number of proxy host. If Net::HTTP does not use a proxy, nil.

proxy_user[R]

User name for accessing proxy. If Net::HTTP does not use a proxy, nil.

address[R]

The DNS host name or IP address to connect to.

ca_file[RW]

Sets path of a CA certification file in PEM format.

The file can contain several CA certificates.

ca_path[RW]

Sets path of a CA certification directory containing certifications in PEM format.

cert[RW]

Sets an OpenSSL::X509::Certificate object as client certificate. (This method is appeared in Michal Rokos’s OpenSSL extension).

cert_store[RW]

Sets the X509::Store to verify peer certificate.

ciphers[RW]

Sets the available ciphers. See OpenSSL::SSL::SSLContext#ciphers=

close_on_empty_response[RW]
continue_timeout[R]

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`.

keep_alive_timeout[RW]

Seconds to reuse the connection of the previous request. If the idle time is less than this Keep-Alive Timeout, Net::HTTP reuses the TCP/IP socket used by the previous communication. The default value is 2 seconds.

key[RW]

Sets an OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object. (This method is appeared in Michal Rokos’s OpenSSL extension.)

local_host[RW]

The local host used to establish the connection.

local_port[RW]

The local port used to establish the connection.

max_retries[R]
max_version[RW]

Sets the maximum SSL version. See OpenSSL::SSL::SSLContext#max_version=

min_version[RW]

Sets the minimum SSL version. See OpenSSL::SSL::SSLContext#min_version=

open_timeout[RW]

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.

port[R]

The port number to connect to.

proxy_address[W]
proxy_from_env[W]
proxy_pass[W]
proxy_port[W]
proxy_user[W]
read_timeout[R]

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.

ssl_timeout[RW]

Sets the SSL timeout seconds.

ssl_version[RW]

Sets the SSL version. See OpenSSL::SSL::SSLContext#ssl_version=

verify_callback[RW]

Sets the verify callback for the server certification verification.

verify_depth[RW]

Sets the maximum depth for the certificate chain verification.

verify_mode[RW]

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.

write_timeout[R]

Number of seconds to wait for one block to be written (via one write(2) call). Any number may be used, including Floats for fractional seconds. If the HTTP object cannot write data in this many seconds, it raises a Net::WriteTimeout exception. The default value is 60 seconds. Net::WriteTimeout is not raised on Windows.

### Public Class Methods

Proxy(p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil) click to toggle source

Creates 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 net/http.rb, line 1066
    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

default_port() click to toggle source

The default port to use for HTTP requests; defaults to 80.

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

get(uri_or_host, path = nil, port = nil) click to toggle source

Sends 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 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_print(uri_or_host, path = nil, port = nil) click to toggle source

Gets 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 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

get_response(uri_or_host, path = nil, port = nil, &block) click to toggle source

Sends 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 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

http_default_port() click to toggle source

The default port to use for HTTP requests; defaults to 80.

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

https_default_port() click to toggle source

The default port to use for HTTPS requests; defaults to 443.

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

is_version_1_2?() click to toggle source
Alias for: version_1_2?
new(address, port = nil) click to toggle source

Creates 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 net/http.rb, line 661
    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

new(address, port = nil, p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil, p_no_proxy = nil) click to toggle source

Creates 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` specifies the DNS name or IP address of the proxy host, `p_port` the port to use to access the proxy, `p_user` and `p_pass` the username and password if authorization is required to use the proxy, and p_no_proxy hosts which do not use the proxy.

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

Also aliased as: newobj
newobj(address, port = nil, p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil, p_no_proxy = nil) click to toggle source
Alias for: new
post(url, data, header = nil) click to toggle source

Posts data to the specified URI object.

Example:

    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 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

post_form(url, params) click to toggle source

Posts 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 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

proxy_class?() click to toggle source

returns true if self is a class which was created by HTTP::Proxy.

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

start(address, port, p_addr, p_port, p_user, p_pass, &block) click to toggle source
start(address, port=nil, p_addr=:ENV, p_port=nil, p_user=nil, p_pass=nil, opt, &block)

Creates 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 ipaddr, #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 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 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)
      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

version_1_2() click to toggle source

Turns on net/http 1.2 (Ruby 1.8) features. Defaults to ON in Ruby 1.8 or later.

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

version_1_2?() click to toggle source

Returns true if net/http is in version 1.2 mode. Defaults to true.

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

Also aliased as: is_version_1_2?

### Public Instance Methods

active?() click to toggle source
Alias for: started?
continue_timeout=(sec) click to toggle source

Setter for the #continue_timeout attribute.

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

copy(path, initheader = nil) click to toggle source

Sends a COPY request to the `path` and gets a response, as an HTTPResponse object.

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

delete(path, initheader = {'Depth' => 'Infinity'}) click to toggle source

Sends a DELETE request to the `path` and gets a response, as an HTTPResponse object.

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

finish() click to toggle source

Finishes the HTTP session and closes the TCP connection. Raises IOError if the session has not been started.

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

get(path, initheader = nil, dest = nil) click to toggle source

Retrieves 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 net/http.rb, line 1239
    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

get2(path, initheader = nil) click to toggle source
Alias for: request_get
head(path, initheader = nil) click to toggle source

Gets 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 net/http.rb, line 1261
    def head(path, initheader = nil)
      request(Head.new(path, initheader))
    end

head2(path, initheader = nil, &block) click to toggle source
Alias for: request_head
inspect() click to toggle source

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

ipaddr() click to toggle source

The IP address to connect to/used to connect to

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

ipaddr=(addr) click to toggle source

Set the IP address to connect to

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

lock(path, body, initheader = nil) click to toggle source

Sends a LOCK request to the `path` and gets a response, as an HTTPResponse object.

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

max_retries=(retries) click to toggle source

Maximum number of times to retry an idempotent request in case of Net::ReadTimeout, IOError, EOFError, Errno::ECONNRESET, Errno::ECONNABORTED, Errno::EPIPE, OpenSSL::SSL::SSLError, Timeout::Error. Should be a non-negative integer number. Zero means no retries. The default value is 1.

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

mkcol(path, body = nil, initheader = nil) click to toggle source

Sends a MKCOL request to the `path` and gets a response, as an HTTPResponse object.

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

move(path, initheader = nil) click to toggle source

Sends a MOVE request to the `path` and gets a response, as an HTTPResponse object.

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

options(path, initheader = nil) click to toggle source

Sends a OPTIONS request to the `path` and gets a response, as an HTTPResponse object.

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

patch(path, data, initheader = nil, dest = nil) click to toggle source

Sends a PATCH request to the `path` and gets a response, as an HTTPResponse object.

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

peer_cert() click to toggle source

Returns the X.509 certificates the server presented.

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

post(path, data, initheader = nil, dest = nil) click to toggle source

Posts `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 net/http.rb, line 1293
    def post(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+
      send_entity(path, data, initheader, dest, Post, &block)
    end

post2(path, data, initheader = nil) click to toggle source
Alias for: request_post
propfind(path, body = nil, initheader = {'Depth' => '0'}) click to toggle source

Sends a PROPFIND request to the `path` and gets a response, as an HTTPResponse object.

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

proppatch(path, body, initheader = nil) click to toggle source

Sends a PROPPATCH request to the `path` and gets a response, as an HTTPResponse object.

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

proxy?() click to toggle source

True if requests for this connection will be proxied

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

proxy_address() click to toggle source

The address of the proxy server, if one is configured.

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

Also aliased as: proxyaddr
proxy_from_env?() click to toggle source

True if the proxy for this connection is determined from the environment

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

proxy_pass() click to toggle source

The password of the proxy server, if one is configured.

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

proxy_port() click to toggle source

The port of the proxy server, if one is configured.

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

Also aliased as: proxyport
proxy_user() click to toggle source

The username of the proxy server, if one is configured.

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

proxyaddr() click to toggle source
Alias for: proxy_address
proxyport() click to toggle source
Alias for: proxy_port
read_timeout=(sec) click to toggle source

Setter for the #read_timeout attribute.

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

request(req, body = nil) click to toggle source

Sends 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 net/http.rb, line 1481
    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

request_get(path, initheader = nil) click to toggle source

Sends 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 net/http.rb, line 1392
    def request_get(path, initheader = nil, &block) # :yield: +response+
      request(Get.new(path, initheader), &block)
    end

Also aliased as: get2
request_head(path, initheader = nil, &block) click to toggle source

Sends 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 net/http.rb, line 1406
    def request_head(path, initheader = nil, &block)
      request(Head.new(path, initheader), &block)
    end

Also aliased as: head2
request_post(path, data, initheader = nil) click to toggle source

Sends 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 net/http.rb, line 1436
    def request_post(path, data, initheader = nil, &block) # :yield: +response+
      request Post.new(path, initheader), data, &block
    end

Also aliased as: post2
send_request(name, path, data = nil, header = nil) click to toggle source

Sends 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 net/http.rb, line 1460
    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

set_debug_output(output) click to toggle source

WARNING 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 net/http.rb, line 709
    def set_debug_output(output)
      warn 'Net::HTTP#set_debug_output called after HTTP started', uplevel: 1 if started?
      @debug_output = output
    end

start() click to toggle source

Opens 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 net/http.rb, line 928
    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

started?() click to toggle source

Returns true if the HTTP session has been started.

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

Also aliased as: active?
trace(path, initheader = nil) click to toggle source

Sends a TRACE request to the `path` and gets a response, as an HTTPResponse object.

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

unlock(path, body, initheader = nil) click to toggle source

Sends a UNLOCK request to the `path` and gets a response, as an HTTPResponse object.

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

use_ssl=(flag) click to toggle source

Turn 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 net/http.rb, line 825
    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

use_ssl?() click to toggle source

Returns true if SSL/TLS is being used with HTTP.

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

write_timeout=(sec) click to toggle source

Setter for the #write_timeout attribute.

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