Class: Gem::Net::HTTP

Inherits:
Protocol show all
Defined in:
lib/rubygems/vendor/net-http/lib/net/http.rb

Overview

Class Gem::Net::HTTP provides a rich library that implements the client in a client-server model that uses the HTTP request-response protocol. For information about HTTP, see:

About the Examples

:include: doc/net-http/examples.rdoc

Strategies

  • If you will make only a few GET requests, consider using OpenURI.

  • If you will make only a few requests of all kinds, consider using the various singleton convenience methods in this class. Each of the following methods automatically starts and finishes a session that sends a single request:

    # Return string response body.
Gem::Net::HTTP.get(hostname, path)
Gem::Net::HTTP.get(uri)

# Write string response body to $stdout.
Gem::Net::HTTP.get_print(hostname, path)
Gem::Net::HTTP.get_print(uri)

# Return response as Gem::Net::HTTPResponse object.
Gem::Net::HTTP.get_response(hostname, path)
Gem::Net::HTTP.get_response(uri)
data = '{"title": "foo", "body": "bar", "userId": 1}'
Gem::Net::HTTP.post(uri, data)
params = {title: 'foo', body: 'bar', userId: 1}
Gem::Net::HTTP.post_form(uri, params)
data = '{"title": "foo", "body": "bar", "userId": 1}'
Gem::Net::HTTP.put(uri, data)

  • If performance is important, consider using sessions, which lower request overhead. This session has multiple requests for HTTP methods and WebDAV methods:

    Gem::Net::HTTP.start(hostname) do |http|
# Session started automatically before block execution.
http.get(path)
http.head(path)
body = 'Some text'
http.post(path, body)  # Can also have a block.
http.put(path, body)
http.delete(path)
http.options(path)
http.trace(path)
http.patch(path, body) # Can also have a block.
http.copy(path)
http.lock(path, body)
http.mkcol(path, body)
http.move(path)
http.propfind(path, body)
http.proppatch(path, body)
http.unlock(path, body)
# Session finished automatically at block exit.
end

The methods cited above are convenience methods that, via their few arguments, allow minimal control over the requests. For greater control, consider using request objects.

URIs

On the internet, a Gem::URI (Universal Resource Identifier) is a string that identifies a particular resource. It consists of some or all of: scheme, hostname, path, query, and fragment; see Gem::URI syntax.

A Ruby Gem::URI::Generic object represents an internet Gem::URI. It provides, among others, methods scheme, hostname, path, query, and fragment.

Schemes

An internet Gem::URI has a scheme.

The two schemes supported in Gem::Net::HTTP are 'https' and 'http':

uri.scheme                       # => "https"
Gem::URI('http://example.com').scheme # => "http"

Hostnames

A hostname identifies a server (host) to which requests may be sent:

hostname = uri.hostname # => "jsonplaceholder.typicode.com"
Gem::Net::HTTP.start(hostname) do |http|
# Some HTTP stuff.
end

Paths

A host-specific path identifies a resource on the host:

_uri = uri.dup
_uri.path = '/todos/1'
hostname = _uri.hostname
path = _uri.path
Gem::Net::HTTP.get(hostname, path)

Queries

A host-specific query adds name/value pairs to the Gem::URI:

_uri = uri.dup
params = {userId: 1, completed: false}
_uri.query = Gem::URI.encode_www_form(params)
_uri # => #<Gem::URI::HTTPS https://jsonplaceholder.typicode.com?userId=1&completed=false>
Gem::Net::HTTP.get(_uri)

Fragments

A Gem::URI fragment has no effect in Gem::Net::HTTP; the same data is returned, regardless of whether a fragment is included.

Request Headers

Request headers may be used to pass additional information to the host, similar to arguments passed in a method call; each header is a name/value pair.

Each of the Gem::Net::HTTP methods that sends a request to the host has optional argument headers, where the headers are expressed as a hash of field-name/value pairs:

headers = {Accept: 'application/json', Connection: 'Keep-Alive'}
Gem::Net::HTTP.get(uri, headers)

See lists of both standard request fields and common request fields at Request Fields. A host may also accept other custom fields.

HTTP Sessions

A session is a connection between a server (host) and a client that:

  • Is begun by instance method Gem::Net::HTTP#start.
  • May contain any number of requests.
  • Is ended by instance method Gem::Net::HTTP#finish.

See example sessions at Strategies.

Session Using Gem::Net::HTTP.start

If you have many requests to make to a single host (and port), consider using singleton method Gem::Net::HTTP.start with a block; the method handles the session automatically by:

  • Calling #start before block execution.
  • Executing the block.
  • Calling #finish after block execution.

In the block, you can use these instance methods, each of which that sends a single request:

  • HTTP methods:

  • #get, #request_get: GET.

  • #head, #request_head: HEAD.

  • #post, #request_post: POST.

  • #delete: DELETE.

  • #options: OPTIONS.

  • #trace: TRACE.

  • #patch: PATCH.

  • WebDAV methods:

  • #copy: COPY.

  • #lock: LOCK.

  • #mkcol: MKCOL.

  • #move: MOVE.

  • #propfind: PROPFIND.

  • #proppatch: PROPPATCH.

  • #unlock: UNLOCK.

Session Using Gem::Net::HTTP.start and Gem::Net::HTTP.finish

You can manage a session manually using methods #start and #finish:

http = Gem::Net::HTTP.new(hostname)
http.start
http.get('/todos/1')
http.get('/todos/2')
http.delete('/posts/1')
http.finish # Needed to free resources.

Single-Request Session

Certain convenience methods automatically handle a session by:

  • Creating an HTTP object
  • Starting a session.
  • Sending a single request.
  • Finishing the session.
  • Destroying the object.

Such methods that send GET requests:

  • ::get: Returns the string response body.
  • ::get_print: Writes the string response body to $stdout.
  • ::get_response: Returns a Gem::Net::HTTPResponse object.

Such methods that send POST requests:

  • ::post: Posts data to the host.
  • ::post_form: Posts form data to the host.

HTTP Requests and Responses

Many of the methods above are convenience methods, each of which sends a request and returns a string without directly using Gem::Net::HTTPRequest and Gem::Net::HTTPResponse objects.

You can, however, directly create a request object, send the request, and retrieve the response object; see:

  • Gem::Net::HTTPRequest.
  • Gem::Net::HTTPResponse.

Following Redirection

Each returned response is an instance of a subclass of Gem::Net::HTTPResponse. See the response class hierarchy.

In particular, class Gem::Net::HTTPRedirection is the parent of all redirection classes. This allows you to craft a case statement to handle redirections properly:

def fetch(uri, limit = 10)
# You should choose a better exception.
raise ArgumentError, 'Too many HTTP redirects' if limit == 0

res = Gem::Net::HTTP.get_response(Gem::URI(uri))
case res
when Gem::Net::HTTPSuccess     # Any success class.
  res
when Gem::Net::HTTPRedirection # Any redirection class.
  location = res['Location']
  warn "Redirected to #{location}"
  fetch(location, limit - 1)
else                      # Any other class.
  res.value
end
end

fetch(uri)

Basic Authentication

Basic authentication is performed according to RFC2617:

req = Gem::Net::HTTP::Get.new(uri)
req.basic_auth('user', 'pass')
res = Gem::Net::HTTP.start(hostname) do |http|
http.request(req)
end

Streaming Response Bodies

By default Gem::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.

Gem::Net::HTTP.start(hostname) do |http|
req = Gem::Net::HTTP::Get.new(uri)
http.request(req) do |res|
  open('t.tmp', 'w') do |f|
    res.read_body do |chunk|
      f.write chunk
    end
  end
end
end

HTTPS

HTTPS is enabled for an HTTP connection by Gem::Net::HTTP#use_ssl=:

Gem::Net::HTTP.start(hostname, :use_ssl => true) do |http|
req = Gem::Net::HTTP::Get.new(uri)
res = http.request(req)
end

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

uri # => #<Gem::URI::HTTPS https://jsonplaceholder.typicode.com/>
Gem::Net::HTTP.get(uri)

Proxy Server

An HTTP object can have a proxy server.

You can create an HTTP object with a proxy server using method Gem::Net::HTTP.new or method Gem::Net::HTTP.start.

The proxy may be defined either by argument p_addr or by environment variable 'http_proxy'.

Proxy Using Argument p_addr as a String

When argument p_addr is a string hostname, the returned http has the given host as its proxy:

http = Gem::Net::HTTP.new(hostname, nil, 'proxy.example')
http.proxy?          # => true
http.proxy_from_env? # => false
http.proxy_address   # => "proxy.example"
# These use default values.
http.proxy_port      # => 80
http.proxy_user      # => nil
http.proxy_pass      # => nil

The port, username, and password for the proxy may also be given:

http = Gem::Net::HTTP.new(hostname, nil, 'proxy.example', 8000, 'pname', 'ppass')
# => #<Gem::Net::HTTP jsonplaceholder.typicode.com:80 open=false>
http.proxy?          # => true
http.proxy_from_env? # => false
http.proxy_address   # => "proxy.example"
http.proxy_port      # => 8000
http.proxy_user      # => "pname"
http.proxy_pass      # => "ppass"

Proxy Using 'ENV'

When environment variable 'http_proxy' is set to a Gem::URI string, the returned http will have the server at that Gem::URI as its proxy; note that the Gem::URI string must have a protocol such as 'http' or 'https':

ENV['http_proxy'] = 'http://example.com'
http = Gem::Net::HTTP.new(hostname)
http.proxy?          # => true
http.proxy_from_env? # => true
http.proxy_address   # => "example.com"
# These use default values.
http.proxy_port      # => 80
http.proxy_user      # => nil
http.proxy_pass      # => nil

The Gem::URI string may include proxy username, password, and port number:

ENV['http_proxy'] = 'http://pname:[email protected]:8000'
http = Gem::Net::HTTP.new(hostname)
http.proxy?          # => true
http.proxy_from_env? # => true
http.proxy_address   # => "example.com"
http.proxy_port      # => 8000
http.proxy_user      # => "pname"
http.proxy_pass      # => "ppass"

Filtering Proxies

With method Gem::Net::HTTP.new (but not Gem::Net::HTTP.start), you can use argument p_no_proxy to filter proxies:

  • Reject a certain address:

    http = Gem::Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'proxy.example')
http.proxy_address # => nil

  • Reject certain domains or subdomains:

    http = Gem::Net::HTTP.new('example.com', nil, 'my.proxy.example', 8000, 'pname', 'ppass', 'proxy.example')
http.proxy_address # => nil

  • Reject certain addresses and port combinations:

    http = Gem::Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'proxy.example:1234')
http.proxy_address # => "proxy.example"

http = Gem::Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'proxy.example:8000')
http.proxy_address # => nil

  • Reject a list of the types above delimited using a comma:

    http = Gem::Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'my.proxy,proxy.example:8000')
http.proxy_address # => nil

http = Gem::Net::HTTP.new('example.com', nil, 'my.proxy', 8000, 'pname', 'ppass', 'my.proxy,proxy.example:8000')
http.proxy_address # => nil

Compression and Decompression

Gem::Net::HTTP does not compress the body of a request before sending.

By default, Gem::Net::HTTP adds header 'Accept-Encoding' to a new request object:

Gem::Net::HTTP::Get.new(uri)['Accept-Encoding']
# => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3"

This requests the server to zip-encode the response body if there is one; the server is not required to do so.

Gem::Net::HTTP does not automatically decompress a response body if the response has header 'Content-Range'.

Otherwise decompression (or not) depends on the value of header Content-Encoding:

  • 'deflate', 'gzip', or 'x-gzip': decompresses the body and deletes the header.
  • 'none' or 'identity': does not decompress the body, but deletes the header.
  • Any other value: leaves the body and header unchanged.

What's Here

First, what's elsewhere. Class Gem::Net::HTTP:

This is a categorized summary of methods and attributes.

Gem::Net::HTTP Objects

  • ::new: Creates a new instance.
  • #inspect: Returns a string representation of self.

Sessions

  • ::start: Begins a new session in a new Gem::Net::HTTP object.
  • #started?: Returns whether in a session.
  • #finish: Ends an active session.
  • #start: Begins a new session in an existing Gem::Net::HTTP object (+self+).

Connections

Requests

  • ::get: Sends a GET request and returns the string response body.
  • ::get_print: Sends a GET request and write the string response body to $stdout.
  • ::get_response: Sends a GET request and returns a response object.
  • ::post_form: Sends a POST request with form data and returns a response object.
  • ::post: Sends a POST request with data and returns a response object.
  • ::put: Sends a PUT request with data and returns a response object.
  • #copy: Sends a COPY request and returns a response object.
  • #delete: Sends a DELETE request and returns a response object.
  • #get: Sends a GET request and returns a response object.
  • #head: Sends a HEAD request and returns a response object.
  • #lock: Sends a LOCK request and returns a response object.
  • #mkcol: Sends a MKCOL request and returns a response object.
  • #move: Sends a MOVE request and returns a response object.
  • #options: Sends a OPTIONS request and returns a response object.
  • #patch: Sends a PATCH request and returns a response object.
  • #post: Sends a POST request and returns a response object.
  • #propfind: Sends a PROPFIND request and returns a response object.
  • #proppatch: Sends a PROPPATCH request and returns a response object.
  • #put: Sends a PUT request and returns a response object.
  • #request: Sends a request and returns a response object.
  • #request_get: Sends a GET request and forms a response object; if a block given, calls the block with the object, otherwise returns the object.
  • #request_head: Sends a HEAD request and forms a response object; if a block given, calls the block with the object, otherwise returns the object.
  • #request_post: Sends a POST request and forms a response object; if a block given, calls the block with the object, otherwise returns the object.
  • #send_request: Sends a request and returns a response object.
  • #trace: Sends a TRACE request and returns a response object.
  • #unlock: Sends an UNLOCK request and returns a response object.

Responses

Proxies

Security

  • :ca_file: Returns the path to a CA certification file.
  • :ca_file=: Sets the path to a CA certification file.
  • :ca_path: Returns the path of to CA directory containing certification files.
  • :ca_path=: Sets the path of to CA directory containing certification files.
  • :cert: Returns the OpenSSL::X509::Certificate object to be used for client certification.
  • :cert=: Sets the OpenSSL::X509::Certificate object to be used for client certification.
  • :cert_store: Returns the X509::Store to be used for verifying peer certificate.
  • :cert_store=: Sets the X509::Store to be used for verifying peer certificate.
  • :ciphers: Returns the available SSL ciphers.
  • :ciphers=: Sets the available SSL ciphers.
  • :extra_chain_cert: Returns the extra X509 certificates to be added to the certificate chain.
  • :extra_chain_cert=: Sets the extra X509 certificates to be added to the certificate chain.
  • :key: Returns the OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object.
  • :key=: Sets the OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object.
  • :max_version: Returns the maximum SSL version.
  • :max_version=: Sets the maximum SSL version.
  • :min_version: Returns the minimum SSL version.
  • :min_version=: Sets the minimum SSL version.
  • #peer_cert: Returns the X509 certificate chain for the session's socket peer.
  • :ssl_version: Returns the SSL version.
  • :ssl_version=: Sets the SSL version.
  • #use_ssl=: Sets whether a new session is to use Transport Layer Security.
  • #use_ssl?: Returns whether self uses SSL.
  • :verify_callback: Returns the callback for the server certification verification.
  • :verify_callback=: Sets the callback for the server certification verification.
  • :verify_depth: Returns the maximum depth for the certificate chain verification.
  • :verify_depth=: Sets the maximum depth for the certificate chain verification.
  • :verify_hostname: Returns the flags for server the certification verification at the beginning of the SSL/TLS session.
  • :verify_hostname=: Sets he flags for server the certification verification at the beginning of the SSL/TLS session.
  • :verify_mode: Returns the flags for server the certification verification at the beginning of the SSL/TLS session.
  • :verify_mode=: Sets the flags for server the certification verification at the beginning of the SSL/TLS session.

Addresses and Ports

  • :address: Returns the string host name or host IP.
  • ::default_port: Returns integer 80, the default port to use for HTTP requests.
  • ::http_default_port: Returns integer 80, the default port to use for HTTP requests.
  • ::https_default_port: Returns integer 443, the default port to use for HTTPS requests.
  • #ipaddr: Returns the IP address for the connection.
  • #ipaddr=: Sets the IP address for the connection.
  • :local_host: Returns the string local host used to establish the connection.
  • :local_host=: Sets the string local host used to establish the connection.
  • :local_port: Returns the integer local port used to establish the connection.
  • :local_port=: Sets the integer local port used to establish the connection.
  • :port: Returns the integer port number.

HTTP Version

Debugging

Defined Under Namespace

Modules: ProxyDelta Classes: Copy, Delete, Get, HTTP, Head, Lock, Mkcol, Move, Options, Patch, Post, Propfind, Proppatch, Put, Trace, Unlock

Constant Summary collapse

VERSION =

:stopdoc:

"0.7.0"
HTTPVersion = 
'1.1'
STATUS_CODES = 
{
  100 => 'Continue',
  101 => 'Switching Protocols',
  102 => 'Processing',
  103 => 'Early Hints',
  200 => 'OK',
  201 => 'Created',
  202 => 'Accepted',
  203 => 'Non-Authoritative Information',
  204 => 'No Content',
  205 => 'Reset Content',
  206 => 'Partial Content',
  207 => 'Multi-Status',
  208 => 'Already Reported',
  226 => 'IM Used',
  300 => 'Multiple Choices',
  301 => 'Moved Permanently',
  302 => 'Found',
  303 => 'See Other',
  304 => 'Not Modified',
  305 => 'Use Proxy',
  307 => 'Temporary Redirect',
  308 => 'Permanent Redirect',
  400 => 'Bad Request',
  401 => 'Unauthorized',
  402 => 'Payment Required',
  403 => 'Forbidden',
  404 => 'Not Found',
  405 => 'Method Not Allowed',
  406 => 'Not Acceptable',
  407 => 'Proxy Authentication Required',
  408 => 'Request Timeout',
  409 => 'Conflict',
  410 => 'Gone',
  411 => 'Length Required',
  412 => 'Precondition Failed',
  413 => 'Content Too Large',
  414 => 'URI Too Long',
  415 => 'Unsupported Media Type',
  416 => 'Range Not Satisfiable',
  417 => 'Expectation Failed',
  421 => 'Misdirected Request',
  422 => 'Unprocessable Content',
  423 => 'Locked',
  424 => 'Failed Dependency',
  425 => 'Too Early',
  426 => 'Upgrade Required',
  428 => 'Precondition Required',
  429 => 'Too Many Requests',
  431 => 'Request Header Fields Too Large',
  451 => 'Unavailable For Legal Reasons',
  500 => 'Internal Server Error',
  501 => 'Not Implemented',
  502 => 'Bad Gateway',
  503 => 'Service Unavailable',
  504 => 'Gateway Timeout',
  505 => 'HTTP Version Not Supported',
  506 => 'Variant Also Negotiates',
  507 => 'Insufficient Storage',
  508 => 'Loop Detected',
  510 => 'Not Extended (OBSOLETED)',
  511 => 'Network Authentication Required',
}
SSL_ATTRIBUTES = 
[
  :ca_file,
  :ca_path,
  :cert,
  :cert_store,
  :ciphers,
  :extra_chain_cert,
  :key,
  :ssl_timeout,
  :ssl_version,
  :min_version,
  :max_version,
  :verify_callback,
  :verify_depth,
  :verify_mode,
  :verify_hostname,
]
SSL_IVNAMES =

:nodoc:

SSL_ATTRIBUTES.map { |a| "@#{a}".to_sym }.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(address, port = nil) ⇒ HTTP

Creates a new Gem::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.



1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1147

def initialize(address, port = nil) # :nodoc:
  defaults = {
    keep_alive_timeout: 2,
    close_on_empty_response: false,
    open_timeout: 60,
    read_timeout: 60,
    write_timeout: 60,
    continue_timeout: nil,
    max_retries: 1,
    debug_output: nil,
    response_body_encoding: false,
    ignore_eof: true
  }
  options = defaults.merge(self.class.default_configuration || {})

  @address = address
  @port    = (port || HTTP.default_port)
  @ipaddr = nil
  @local_host = nil
  @local_port = nil
  @curr_http_version = HTTPVersion
  @keep_alive_timeout = options[:keep_alive_timeout]
  @last_communicated = nil
  @close_on_empty_response = options[:close_on_empty_response]
  @socket  = nil
  @started = false
  @open_timeout = options[:open_timeout]
  @read_timeout = options[:read_timeout]
  @write_timeout = options[:write_timeout]
  @continue_timeout = options[:continue_timeout]
  @max_retries = options[:max_retries]
  @debug_output = options[:debug_output]
  @response_body_encoding = options[:response_body_encoding]
  @ignore_eof = options[:ignore_eof]

  @proxy_from_env = false
  @proxy_uri      = nil
  @proxy_address  = nil
  @proxy_port     = nil
  @proxy_user     = nil
  @proxy_pass     = nil
  @proxy_use_ssl  = 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

Instance Attribute Details

#address ⇒ Object (readonly)

Returns the string host name or host IP given as argument address in ::new.



1263
1264
1265
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1263

def address
  @address
end

#ca_file ⇒ Object

Sets or returns the path to a CA certification file in PEM format.



1557
1558
1559
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1557

def ca_file
  @ca_file
end

#ca_path ⇒ Object

Sets or returns the path of to CA directory containing certification files in PEM format.



1561
1562
1563
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1561

def ca_path
  @ca_path
end

#cert ⇒ Object

Sets or returns the OpenSSL::X509::Certificate object to be used for client certification.



1565
1566
1567
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1565

def cert
  @cert
end

#cert_store ⇒ Object

Sets or returns the X509::Store to be used for verifying peer certificate.



1568
1569
1570
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1568

def cert_store
  @cert_store
end

#ciphers ⇒ Object

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



1572
1573
1574
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1572

def ciphers
  @ciphers
end

#close_on_empty_response ⇒ Object

Sets or returns whether to close the connection when the response is empty; initially false.



1491
1492
1493
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1491

def close_on_empty_response
  @close_on_empty_response
end

#continue_timeout ⇒ Object

Returns the continue timeout value; see continue_timeout=.



1444
1445
1446
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1444

def continue_timeout
  @continue_timeout
end

#extra_chain_cert ⇒ Object

Sets or returns the extra X509 certificates to be added to the certificate chain. See OpenSSL::SSL::SSLContext#add_certificate.



1576
1577
1578
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1576

def extra_chain_cert
  @extra_chain_cert
end

#ignore_eof ⇒ Object

Sets or returns whether to ignore end-of-file when reading a response body with Content-Length headers; initially true.



1467
1468
1469
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1467

def ignore_eof
  @ignore_eof
end

#keep_alive_timeout ⇒ Object

Sets or returns the numeric (Integer or Float) number of seconds to keep the connection open after a request is sent; initially 2. If a new request is made during the given interval, the still-open connection is used; otherwise the connection will have been closed and a new connection is opened.



1462
1463
1464
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1462

def keep_alive_timeout
  @keep_alive_timeout
end

#key ⇒ Object

Sets or returns the OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object.



1579
1580
1581
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1579

def key
  @key
end

#local_host ⇒ Object

Sets or returns the string local host used to establish the connection; initially nil.



1270
1271
1272
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1270

def local_host
  @local_host
end

#local_port ⇒ Object

Sets or returns the integer local port used to establish the connection; initially nil.



1274
1275
1276
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1274

def local_port
  @local_port
end

#max_retries ⇒ Object

Returns the maximum number of times to retry an idempotent request; see #max_retries=.



1400
1401
1402
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1400

def max_retries
  @max_retries
end

#max_version ⇒ Object

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



1594
1595
1596
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1594

def max_version
  @max_version
end

#min_version ⇒ Object

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



1590
1591
1592
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1590

def min_version
  @min_version
end

#open_timeout ⇒ Object

Sets or returns the numeric (Integer or Float) number of seconds to wait for a connection to open; initially 60. If the connection is not made in the given interval, an exception is raised.



1366
1367
1368
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1366

def open_timeout
  @open_timeout
end

#port ⇒ Object (readonly)

Returns the integer port number given as argument port in ::new.



1266
1267
1268
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1266

def port
  @port
end

#proxy_address ⇒ Object Also known as: proxyaddr

Returns the address of the proxy server, if defined, nil otherwise; see Proxy Server.



1896
1897
1898
1899
1900
1901
1902
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1896

def proxy_address
  if @proxy_from_env then
    proxy_uri&.hostname
  else
    @proxy_address
  end
end

#proxy_from_env=(value) ⇒ Object (writeonly)

Sets whether to determine the proxy from environment variable 'ENV'; see Proxy Using ENV.



1306
1307
1308
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1306

def proxy_from_env=(value)
  @proxy_from_env = value
end

#proxy_pass ⇒ Object

Returns the password of the proxy server, if defined, nil otherwise; see Proxy Server.



1927
1928
1929
1930
1931
1932
1933
1934
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1927

def proxy_pass
  if @proxy_from_env
    pass = proxy_uri&.password
    unescape(pass) if pass
  else
    @proxy_pass
  end
end

#proxy_port ⇒ Object Also known as: proxyport

Returns the port number of the proxy server, if defined, nil otherwise; see Proxy Server.



1906
1907
1908
1909
1910
1911
1912
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1906

def proxy_port
  if @proxy_from_env then
    proxy_uri&.port
  else
    @proxy_port
  end
end

#proxy_use_ssl=(value) ⇒ Object (writeonly)

Sets the attribute proxy_use_ssl

Parameters:

  • value —

    the value to set the attribute proxy_use_ssl to.



1323
1324
1325
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1323

def proxy_use_ssl=(value)
  @proxy_use_ssl = value
end

#proxy_user ⇒ Object

Returns the user name of the proxy server, if defined, nil otherwise; see Proxy Server.



1916
1917
1918
1919
1920
1921
1922
1923
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1916

def proxy_user
  if @proxy_from_env
    user = proxy_uri&.user
    unescape(user) if user
  else
    @proxy_user
  end
end

#read_timeout ⇒ Object

Returns the numeric (Integer or Float) number of seconds to wait for one block to be read (via one read(2) call); see #read_timeout=.



1371
1372
1373
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1371

def read_timeout
  @read_timeout
end

#response_body_encoding ⇒ Object

Returns the encoding to use for the response body; see #response_body_encoding=.



1278
1279
1280
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1278

def response_body_encoding
  @response_body_encoding
end

#ssl_timeout ⇒ Object

Sets or returns the SSL timeout seconds.



1582
1583
1584
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1582

def ssl_timeout
  @ssl_timeout
end

#ssl_version ⇒ Object

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



1586
1587
1588
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1586

def ssl_version
  @ssl_version
end

#verify_callback ⇒ Object

Sets or returns the callback for the server certification verification.



1597
1598
1599
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1597

def verify_callback
  @verify_callback
end

#verify_depth ⇒ Object

Sets or returns the maximum depth for the certificate chain verification.



1600
1601
1602
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1600

def verify_depth
  @verify_depth
end

#verify_hostname ⇒ Object

Sets or returns whether to verify that the server certificate is valid for the hostname. See OpenSSL::SSL::SSLContext#verify_hostname=.



1610
1611
1612
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1610

def verify_hostname
  @verify_hostname
end

#verify_mode ⇒ Object

Sets or returns the flags for server the certification verification at the beginning of the SSL/TLS session. OpenSSL::SSL::VERIFY_NONE or OpenSSL::SSL::VERIFY_PEER are acceptable.



1605
1606
1607
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1605

def verify_mode
  @verify_mode
end

#write_timeout ⇒ Object

Returns the numeric (Integer or Float) number of seconds to wait for one block to be written (via one write(2) call); see #write_timeout=.



1376
1377
1378
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1376

def write_timeout
  @write_timeout
end

Instance Method Details

#copy(path, initheader = nil) ⇒ Object

Sends a COPY request to the server; returns an instance of a subclass of Gem::Net::HTTPResponse.

The request is based on the Gem::Net::HTTP::Copy object created from string path and initial headers hash initheader.

http = Gem::Net::HTTP.new(hostname)
http.copy('/todos/1')


2218
2219
2220
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2218

def copy(path, initheader = nil)
  request(Copy.new(path, initheader))
end

#delete(path, initheader = {'Depth' => 'Infinity'}) ⇒ Object

Sends a DELETE request to the server; returns an instance of a subclass of Gem::Net::HTTPResponse.

The request is based on the Gem::Net::HTTP::Delete object created from string path and initial headers hash initheader.

http = Gem::Net::HTTP.new(hostname)
http.delete('/todos/1')


2192
2193
2194
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2192

def delete(path, initheader = {'Depth' => 'Infinity'})
  request(Delete.new(path, initheader))
end

#finish ⇒ Object

Finishes the HTTP session:

http = Gem::Net::HTTP.new(hostname)
http.start
http.started? # => true
http.finish   # => nil
http.started? # => false

Raises IOError if not in a session.

Raises:

  • (IOError) 


1792
1793
1794
1795
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1792

def finish
  raise IOError, 'HTTP session not yet started' unless started?
  do_finish
end

#get(path, initheader = nil, dest = nil, &block) ⇒ Object

:call-seq:

get(path, initheader = nil) {|res| ... }

Sends a GET request to the server; returns an instance of a subclass of Gem::Net::HTTPResponse.

The request is based on the Gem::Net::HTTP::Get object created from string path and initial headers hash initheader.

With a block given, calls the block with the response body:

http = Gem::Net::HTTP.new(hostname)
http.get('/todos/1') do |res|
p res
end # => #<Gem::Net::HTTPOK 200 OK readbody=true>

Output:

"{\n  \"userId\": 1,\n  \"id\": 1,\n  \"title\": \"delectus aut autem\",\n  \"completed\": false\n}"

With no block given, simply returns the response object:

http.get('/') # => #<Gem::Net::HTTPOK 200 OK readbody=true>

Related:

  • Gem::Net::HTTP::Get: request class for HTTP method GET.
  • Gem::Net::HTTP.get: sends GET request, returns response body.


2004
2005
2006
2007
2008
2009
2010
2011
2012
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2004

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

#head(path, initheader = nil) ⇒ Object

Sends a HEAD request to the server; returns an instance of a subclass of Gem::Net::HTTPResponse.

The request is based on the Gem::Net::HTTP::Head object created from string path and initial headers hash initheader:

res = http.head('/todos/1') # => #<Gem::Net::HTTPOK 200 OK readbody=true>
res.body                    # => nil
res.to_hash.take(3)
# =>
[["date", ["Wed, 15 Feb 2023 15:25:42 GMT"]],
["content-type", ["application/json; charset=utf-8"]],
["connection", ["close"]]]


2028
2029
2030
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2028

def head(path, initheader = nil)
  request(Head.new(path, initheader))
end

#inspect ⇒ Object

Returns a string representation of self:

Gem::Net::HTTP.new(hostname).inspect
# => "#<Gem::Net::HTTP jsonplaceholder.typicode.com:80 open=false>"


1204
1205
1206
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1204

def inspect
  "#<#{self.class} #{@address}:#{@port} open=#{started?}>"
end

#ipaddr ⇒ Object

Returns the IP address for the connection.

If the session has not been started, returns the value set by #ipaddr=, or nil if it has not been set:

http = Gem::Net::HTTP.new(hostname)
http.ipaddr # => nil
http.ipaddr = '172.67.155.76'
http.ipaddr # => "172.67.155.76"

If the session has been started, returns the IP address from the socket:

http = Gem::Net::HTTP.new(hostname)
http.start
http.ipaddr # => "172.67.155.76"
http.finish


1344
1345
1346
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1344

def ipaddr
  started? ?  @socket.io.peeraddr[3] : @ipaddr
end

#ipaddr=(addr) ⇒ Object

Sets the IP address for the connection:

http = Gem::Net::HTTP.new(hostname)
http.ipaddr # => nil
http.ipaddr = '172.67.155.76'
http.ipaddr # => "172.67.155.76"

The IP address may not be set if the session has been started.

Raises:

  • (IOError) 


1356
1357
1358
1359
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1356

def ipaddr=(addr)
  raise IOError, "ipaddr value changed, but session already started" if started?
  @ipaddr = addr
end

#lock(path, body, initheader = nil) ⇒ Object

Sends a LOCK request to the server; returns an instance of a subclass of Gem::Net::HTTPResponse.

The request is based on the Gem::Net::HTTP::Lock object created from string path, string body, and initial headers hash initheader.

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http = Gem::Net::HTTP.new(hostname)
http.lock('/todos/1', data)


2138
2139
2140
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2138

def lock(path, body, initheader = nil)
  request(Lock.new(path, initheader), body)
end

#mkcol(path, body = nil, initheader = nil) ⇒ Object

Sends a MKCOL request to the server; returns an instance of a subclass of Gem::Net::HTTPResponse.

The request is based on the Gem::Net::HTTP::Mkcol object created from string path, string body, and initial headers hash initheader.

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http.mkcol('/todos/1', data)
http = Gem::Net::HTTP.new(hostname)


2232
2233
2234
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2232

def mkcol(path, body = nil, initheader = nil)
  request(Mkcol.new(path, initheader), body)
end

#move(path, initheader = nil) ⇒ Object

Sends a MOVE request to the server; returns an instance of a subclass of Gem::Net::HTTPResponse.

The request is based on the Gem::Net::HTTP::Move object created from string path and initial headers hash initheader.

http = Gem::Net::HTTP.new(hostname)
http.move('/todos/1')


2205
2206
2207
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2205

def move(path, initheader = nil)
  request(Move.new(path, initheader))
end

#options(path, initheader = nil) ⇒ Object

Sends an Options request to the server; returns an instance of a subclass of Gem::Net::HTTPResponse.

The request is based on the Gem::Net::HTTP::Options object created from string path and initial headers hash initheader.

http = Gem::Net::HTTP.new(hostname)
http.options('/')


2165
2166
2167
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2165

def options(path, initheader = nil)
  request(Options.new(path, initheader))
end

#patch(path, data, initheader = nil, dest = nil, &block) ⇒ Object

:call-seq:

patch(path, data, initheader = nil) {|res| ... }

Sends a PATCH request to the server; returns an instance of a subclass of Gem::Net::HTTPResponse.

The request is based on the Gem::Net::HTTP::Patch object created from string path, string data, and initial headers hash initheader.

With a block given, calls the block with the response body:

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http = Gem::Net::HTTP.new(hostname)
http.patch('/todos/1', data) do |res|
p res
end # => #<Gem::Net::HTTPOK 200 OK readbody=true>

Output:

"{\n  \"userId\": 1,\n  \"id\": 1,\n  \"title\": \"delectus aut autem\",\n  \"completed\": false,\n  \"{\\\"userId\\\": 1, \\\"id\\\": 1, \\\"title\\\": \\\"delectus aut autem\\\", \\\"completed\\\": false}\": \"\"\n}"

With no block given, simply returns the response object:

http.patch('/todos/1', data) # => #<Gem::Net::HTTPCreated 201 Created readbody=true>


2091
2092
2093
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2091

def patch(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+
  send_entity(path, data, initheader, dest, Patch, &block)
end

#peer_cert ⇒ Object

Returns the X509 certificate chain (an array of strings) for the session's socket peer, or nil if none.



1615
1616
1617
1618
1619
1620
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1615

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, &block) ⇒ Object

:call-seq:

post(path, data, initheader = nil) {|res| ... }

Sends a POST request to the server; returns an instance of a subclass of Gem::Net::HTTPResponse.

The request is based on the Gem::Net::HTTP::Post object created from string path, string data, and initial headers hash initheader.

With a block given, calls the block with the response body:

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http = Gem::Net::HTTP.new(hostname)
http.post('/todos', data) do |res|
p res
end # => #<Gem::Net::HTTPCreated 201 Created readbody=true>

Output:

"{\n  \"{\\\"userId\\\": 1, \\\"id\\\": 1, \\\"title\\\": \\\"delectus aut autem\\\", \\\"completed\\\": false}\": \"\",\n  \"id\": 201\n}"

With no block given, simply returns the response object:

http.post('/todos', data) # => #<Gem::Net::HTTPCreated 201 Created readbody=true>

Related:

  • Gem::Net::HTTP::Post: request class for HTTP method POST.
  • Gem::Net::HTTP.post: sends POST request, returns response body.


2062
2063
2064
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2062

def post(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+
  send_entity(path, data, initheader, dest, Post, &block)
end

#propfind(path, body = nil, initheader = {'Depth' => '0'}) ⇒ Object

Sends a PROPFIND request to the server; returns an instance of a subclass of Gem::Net::HTTPResponse.

The request is based on the Gem::Net::HTTP::Propfind object created from string path, string body, and initial headers hash initheader.

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http = Gem::Net::HTTP.new(hostname)
http.propfind('/todos/1', data)


2179
2180
2181
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2179

def propfind(path, body = nil, initheader = {'Depth' => '0'})
  request(Propfind.new(path, initheader), body)
end

#proppatch(path, body, initheader = nil) ⇒ Object

Sends a PROPPATCH request to the server; returns an instance of a subclass of Gem::Net::HTTPResponse.

The request is based on the Gem::Net::HTTP::Proppatch object created from string path, string body, and initial headers hash initheader.

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http = Gem::Net::HTTP.new(hostname)
http.proppatch('/todos/1', data)


2124
2125
2126
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2124

def proppatch(path, body, initheader = nil)
  request(Proppatch.new(path, initheader), body)
end

#proxy? ⇒ Boolean

Returns true if a proxy server is defined, false otherwise; see Proxy Server.

Returns:

  • (Boolean) 


1874
1875
1876
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1874

def proxy?
  !!(@proxy_from_env ? proxy_uri : @proxy_address)
end

#proxy_from_env? ⇒ Boolean

Returns true if the proxy server is defined in the environment, false otherwise; see Proxy Server.

Returns:

  • (Boolean) 


1881
1882
1883
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1881

def proxy_from_env?
  @proxy_from_env
end

#proxy_uri ⇒ Object

The proxy Gem::URI determined from the environment for this connection.



1886
1887
1888
1889
1890
1891
1892
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1886

def proxy_uri # :nodoc:
  return if @proxy_uri == false
  @proxy_uri ||= Gem::URI::HTTP.new(
    "http", nil, address, port, nil, nil, nil, nil, nil
  ).find_proxy || false
  @proxy_uri || nil
end

#put(path, data, initheader = nil) ⇒ Object

Sends a PUT request to the server; returns an instance of a subclass of Gem::Net::HTTPResponse.

The request is based on the Gem::Net::HTTP::Put object created from string path, string data, and initial headers hash initheader.

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http = Gem::Net::HTTP.new(hostname)
http.put('/todos/1', data) # => #<Gem::Net::HTTPOK 200 OK readbody=true>

Related:

  • Gem::Net::HTTP::Put: request class for HTTP method PUT.
  • Gem::Net::HTTP.put: sends PUT request, returns response body.


2110
2111
2112
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2110

def put(path, data, initheader = nil)
  request(Put.new(path, initheader), data)
end

#request(req, body = nil, &block) ⇒ Object

Sends the given request req to the server; forms the response into a Gem::Net::HTTPResponse object.

The given req must be an instance of a subclass of Gem::Net::HTTPRequest. Argument body should be given only if needed for the request.

With no block given, returns the response object:

http = Gem::Net::HTTP.new(hostname)

req = Gem::Net::HTTP::Get.new('/todos/1')
http.request(req)
# => #<Gem::Net::HTTPOK 200 OK readbody=true>

req = Gem::Net::HTTP::Post.new('/todos')
http.request(req, 'xyzzy')
# => #<Gem::Net::HTTPCreated 201 Created readbody=true>

With a block given, calls the block with the response and returns the response:

req = Gem::Net::HTTP::Get.new('/todos/1')
http.request(req) do |res|
p res
end # => #<Gem::Net::HTTPOK 200 OK readbody=true>

Output:

#<Gem::Net::HTTPOK 200 OK readbody=false>


2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2390

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, &block) ⇒ Object Also known as: get2

Sends a GET request to the server; forms the response into a Gem::Net::HTTPResponse object.

The request is based on the Gem::Net::HTTP::Get object created from string path and initial headers hash initheader.

With no block given, returns the response object:

http = Gem::Net::HTTP.new(hostname)
http.request_get('/todos') # => #<Gem::Net::HTTPOK 200 OK readbody=true>

With a block given, calls the block with the response object and returns the response object:

http.request_get('/todos') do |res|
p res
end # => #<Gem::Net::HTTPOK 200 OK readbody=true>

Output:

#<Gem::Net::HTTPOK 200 OK readbody=false>


2271
2272
2273
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2271

def request_get(path, initheader = nil, &block) # :yield: +response+
  request(Get.new(path, initheader), &block)
end

#request_head(path, initheader = nil, &block) ⇒ Object Also known as: head2

Sends a HEAD request to the server; returns an instance of a subclass of Gem::Net::HTTPResponse.

The request is based on the Gem::Net::HTTP::Head object created from string path and initial headers hash initheader.

http = Gem::Net::HTTP.new(hostname)
http.head('/todos/1') # => #<Gem::Net::HTTPOK 200 OK readbody=true>


2284
2285
2286
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2284

def request_head(path, initheader = nil, &block)
  request(Head.new(path, initheader), &block)
end

#request_post(path, data, initheader = nil, &block) ⇒ Object Also known as: post2

Sends a POST request to the server; forms the response into a Gem::Net::HTTPResponse object.

The request is based on the Gem::Net::HTTP::Post object created from string path, string data, and initial headers hash initheader.

With no block given, returns the response object:

http = Gem::Net::HTTP.new(hostname)
http.post('/todos', 'xyzzy')
# => #<Gem::Net::HTTPCreated 201 Created readbody=true>

With a block given, calls the block with the response body and returns the response object:

http.post('/todos', 'xyzzy') do |res|
p res
end # => #<Gem::Net::HTTPCreated 201 Created readbody=true>

Output:

"{\n  \"xyzzy\": \"\",\n  \"id\": 201\n}"


2311
2312
2313
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2311

def request_post(path, data, initheader = nil, &block) # :yield: +response+
  request Post.new(path, initheader), data, &block
end

#request_put(path, data, initheader = nil, &block) ⇒ Object Also known as: put2

Sends a PUT request to the server; returns an instance of a subclass of Gem::Net::HTTPResponse.

The request is based on the Gem::Net::HTTP::Put object created from string path, string data, and initial headers hash initheader.

http = Gem::Net::HTTP.new(hostname)
http.put('/todos/1', 'xyzzy')
# => #<Gem::Net::HTTPOK 200 OK readbody=true>


2325
2326
2327
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2325

def request_put(path, data, initheader = nil, &block)   #:nodoc:
  request Put.new(path, initheader), data, &block
end

#send_request(name, path, data = nil, header = nil) ⇒ Object

Sends an HTTP request to the server; returns an instance of a subclass of Gem::Net::HTTPResponse.

The request is based on the Gem::Net::HTTPRequest object created from string path, string data, and initial headers hash header. That object is an instance of the subclass of Gem::Net::HTTPRequest, that corresponds to the given uppercase string name, which must be an HTTP request method or a WebDAV request method.

Examples:

http = Gem::Net::HTTP.new(hostname)
http.send_request('GET', '/todos/1')
# => #<Gem::Net::HTTPOK 200 OK readbody=true>
http.send_request('POST', '/todos', 'xyzzy')
# => #<Gem::Net::HTTPCreated 201 Created readbody=true>


2354
2355
2356
2357
2358
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2354

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) ⇒ Object

WARNING This method opens a serious security hole. Never use this method in production code.

Sets the output stream for debugging:

http = Gem::Net::HTTP.new(hostname)
File.open('t.tmp', 'w') do |file|
http.set_debug_output(file)
http.start
http.get('/nosuch/1')
http.finish
end
puts File.read('t.tmp')

Output:

opening connection to jsonplaceholder.typicode.com:80...
opened
<- "GET /nosuch/1 HTTP/1.1\r\nAccept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3\r\nAccept: */*\r\nUser-Agent: Ruby\r\nHost: jsonplaceholder.typicode.com\r\n\r\n"
-> "HTTP/1.1 404 Not Found\r\n"
-> "Date: Mon, 12 Dec 2022 21:14:11 GMT\r\n"
-> "Content-Type: application/json; charset=utf-8\r\n"
-> "Content-Length: 2\r\n"
-> "Connection: keep-alive\r\n"
-> "X-Powered-By: Express\r\n"
-> "X-Ratelimit-Limit: 1000\r\n"
-> "X-Ratelimit-Remaining: 999\r\n"
-> "X-Ratelimit-Reset: 1670879660\r\n"
-> "Vary: Origin, Accept-Encoding\r\n"
-> "Access-Control-Allow-Credentials: true\r\n"
-> "Cache-Control: max-age=43200\r\n"
-> "Pragma: no-cache\r\n"
-> "Expires: -1\r\n"
-> "X-Content-Type-Options: nosniff\r\n"
-> "Etag: W/\"2-vyGp6PvFo4RvsFtPoIWeCReyIC8\"\r\n"
-> "Via: 1.1 vegur\r\n"
-> "CF-Cache-Status: MISS\r\n"
-> "Server-Timing: cf-q-config;dur=1.3000000762986e-05\r\n"
-> "Report-To: {\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=yOr40jo%2BwS1KHzhTlVpl54beJ5Wx2FcG4gGV0XVrh3X9OlR5q4drUn2dkt5DGO4GDcE%2BVXT7CNgJvGs%2BZleIyMu8CLieFiDIvOviOY3EhHg94m0ZNZgrEdpKD0S85S507l1vsEwEHkoTm%2Ff19SiO\"}],\"group\":\"cf-nel\",\"max_age\":604800}\r\n"
-> "NEL: {\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}\r\n"
-> "Server: cloudflare\r\n"
-> "CF-RAY: 778977dc484ce591-DFW\r\n"
-> "alt-svc: h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400\r\n"
-> "\r\n"
reading 2 bytes...
-> "{}"
read 2 bytes
Conn keep-alive


1257
1258
1259
1260
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1257

def set_debug_output(output)
  warn 'Gem::Net::HTTP#set_debug_output called after HTTP started', uplevel: 1 if started?
  @debug_output = output
end

#start ⇒ Object

Starts an HTTP session.

Without a block, returns self:

http = Gem::Net::HTTP.new(hostname)
# => #<Gem::Net::HTTP jsonplaceholder.typicode.com:80 open=false>
http.start
# => #<Gem::Net::HTTP jsonplaceholder.typicode.com:80 open=true>
http.started? # => true
http.finish

With a block, calls the block with self, finishes the session when the block exits, and returns the block's value:

http.start do |http|
http
end
# => #<Gem::Net::HTTP jsonplaceholder.typicode.com:80 open=false>
http.started? # => false

Raises:

  • (IOError) 


1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1643

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? ⇒ Boolean Also known as: active?

Returns true if the HTTP session has been started:

http = Gem::Net::HTTP.new(hostname)
http.started? # => false
http.start
http.started? # => true
http.finish # => nil
http.started? # => false

Gem::Net::HTTP.start(hostname) do |http|
http.started?
end # => true
http.started? # => false

Returns:

  • (Boolean) 


1483
1484
1485
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1483

def started?
  @started
end

#trace(path, initheader = nil) ⇒ Object

Sends a TRACE request to the server; returns an instance of a subclass of Gem::Net::HTTPResponse.

The request is based on the Gem::Net::HTTP::Trace object created from string path and initial headers hash initheader.

http = Gem::Net::HTTP.new(hostname)
http.trace('/todos/1')


2245
2246
2247
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2245

def trace(path, initheader = nil)
  request(Trace.new(path, initheader))
end

#unlock(path, body, initheader = nil) ⇒ Object

Sends an UNLOCK request to the server; returns an instance of a subclass of Gem::Net::HTTPResponse.

The request is based on the Gem::Net::HTTP::Unlock object created from string path, string body, and initial headers hash initheader.

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http = Gem::Net::HTTP.new(hostname)
http.unlock('/todos/1', data)


2152
2153
2154
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 2152

def unlock(path, body, initheader = nil)
  request(Unlock.new(path, initheader), body)
end

#use_ssl=(flag) ⇒ Object

Sets whether a new session is to use Transport Layer Security:

Raises IOError if attempting to change during a session.

Raises OpenSSL::SSL::SSLError if the port is not an HTTPS port.



1505
1506
1507
1508
1509
1510
1511
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1505

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? ⇒ Boolean

Returns true if self uses SSL, false otherwise. See Gem::Net::HTTP#use_ssl=.

Returns:

  • (Boolean) 


1495
1496
1497
 
# File 'lib/rubygems/vendor/net-http/lib/net/http.rb', line 1495

def use_ssl?
  @use_ssl
end