Class: Net::HTTP

Inherits:
Protocol
  • Object
show all
Defined in:
lib/net/http.rb,
lib/net/http/backward.rb

Overview

:enddoc:

Defined Under Namespace

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

Constant Summary collapse

VERSION =

:stopdoc:

"0.3.2"
Revision = 
%q$Revision$.split[1]
HTTPVersion = 
'1.1'
SSL_IVNAMES = 
[
  :@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_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,
]
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 => 'Payload Too Large',
  414 => 'URI Too Long',
  415 => 'Unsupported Media Type',
  416 => 'Range Not Satisfiable',
  417 => 'Expectation Failed',
  421 => 'Misdirected Request',
  422 => 'Unprocessable Entity',
  423 => 'Locked',
  424 => 'Failed Dependency',
  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',
  511 => 'Network Authentication Required',
}
ProxyMod = 
ProxyDelta

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(address, port = nil) ⇒ HTTP

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.



830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
 
# File 'lib/net/http.rb', line 830

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
  @response_body_encoding = false
  @ignore_eof = true

  @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

Class Attribute Details

.proxy_address ⇒ Object (readonly)

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



1428
1429
1430
 
# File 'lib/net/http.rb', line 1428

def proxy_address
  @proxy_address
end

.proxy_pass ⇒ Object (readonly)

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



1438
1439
1440
 
# File 'lib/net/http.rb', line 1438

def proxy_pass
  @proxy_pass
end

.proxy_port ⇒ Object (readonly)

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



1431
1432
1433
 
# File 'lib/net/http.rb', line 1431

def proxy_port
  @proxy_port
end

.proxy_user ⇒ Object (readonly)

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



1434
1435
1436
 
# File 'lib/net/http.rb', line 1434

def proxy_user
  @proxy_user
end

Instance Attribute Details

#address ⇒ Object (readonly)

The DNS host name or IP address to connect to.



931
932
933
 
# File 'lib/net/http.rb', line 931

def address
  @address
end

#ca_file ⇒ Object

Sets path of a CA certification file in PEM format.

The file can contain several CA certificates.



1164
1165
1166
 
# File 'lib/net/http.rb', line 1164

def ca_file
  @ca_file
end

#ca_path ⇒ Object

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



1168
1169
1170
 
# File 'lib/net/http.rb', line 1168

def ca_path
  @ca_path
end

#cert ⇒ Object

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



1172
1173
1174
 
# File 'lib/net/http.rb', line 1172

def cert
  @cert
end

#cert_store ⇒ Object

Sets the X509::Store to verify peer certificate.



1175
1176
1177
 
# File 'lib/net/http.rb', line 1175

def cert_store
  @cert_store
end

#ciphers ⇒ Object

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



1178
1179
1180
 
# File 'lib/net/http.rb', line 1178

def ciphers
  @ciphers
end

#close_on_empty_response ⇒ Object

Returns the value of attribute close_on_empty_response.



1107
1108
1109
 
# File 'lib/net/http.rb', line 1107

def close_on_empty_response
  @close_on_empty_response
end

#continue_timeout ⇒ Object

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.



1082
1083
1084
 
# File 'lib/net/http.rb', line 1082

def continue_timeout
  @continue_timeout
end

#extra_chain_cert ⇒ Object

Sets the extra X509 certificates to be added to the certificate chain. See OpenSSL::SSL::SSLContext#extra_chain_cert=



1182
1183
1184
 
# File 'lib/net/http.rb', line 1182

def extra_chain_cert
  @extra_chain_cert
end

#ignore_eof ⇒ Object

Whether to ignore EOF when reading response bodies with defined Content-Length headers. For backwards compatibility, the default is true.



1098
1099
1100
 
# File 'lib/net/http.rb', line 1098

def ignore_eof
  @ignore_eof
end

#keep_alive_timeout ⇒ Object

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.



1094
1095
1096
 
# File 'lib/net/http.rb', line 1094

def keep_alive_timeout
  @keep_alive_timeout
end

#key ⇒ Object

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



1186
1187
1188
 
# File 'lib/net/http.rb', line 1186

def key
  @key
end

#local_host ⇒ Object

The local host used to establish the connection.



937
938
939
 
# File 'lib/net/http.rb', line 937

def local_host
  @local_host
end

#local_port ⇒ Object

The local port used to establish the connection.



940
941
942
 
# File 'lib/net/http.rb', line 940

def local_port
  @local_port
end

#max_retries ⇒ Object

Returns the value of attribute max_retries.



1051
1052
1053
 
# File 'lib/net/http.rb', line 1051

def max_retries
  @max_retries
end

#max_version ⇒ Object

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



1198
1199
1200
 
# File 'lib/net/http.rb', line 1198

def max_version
  @max_version
end

#min_version ⇒ Object

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



1195
1196
1197
 
# File 'lib/net/http.rb', line 1195

def min_version
  @min_version
end

#open_timeout ⇒ Object

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.



1016
1017
1018
 
# File 'lib/net/http.rb', line 1016

def open_timeout
  @open_timeout
end

#port ⇒ Object (readonly)

The port number to connect to.



934
935
936
 
# File 'lib/net/http.rb', line 934

def port
  @port
end

#proxy_address ⇒ Object Also known as: proxyaddr

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



1461
1462
1463
1464
1465
1466
1467
 
# File 'lib/net/http.rb', line 1461

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

#proxy_from_env=(value) ⇒ Object (writeonly)

Sets the attribute proxy_from_env

Parameters:

  • value —

    the value to set the attribute proxy_from_env to.



970
971
972
 
# File 'lib/net/http.rb', line 970

def proxy_from_env=(value)
  @proxy_from_env = value
end

#proxy_pass ⇒ Object

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



1489
1490
1491
1492
1493
1494
1495
1496
 
# File 'lib/net/http.rb', line 1489

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

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



1470
1471
1472
1473
1474
1475
1476
 
# File 'lib/net/http.rb', line 1470

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

#proxy_user ⇒ Object

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



1479
1480
1481
1482
1483
1484
1485
1486
 
# File 'lib/net/http.rb', line 1479

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

#read_timeout ⇒ Object

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.



1022
1023
1024
 
# File 'lib/net/http.rb', line 1022

def read_timeout
  @read_timeout
end

#response_body_encoding ⇒ Object

The encoding to use for the response body. If Encoding, uses the specified encoding. If other true value, tries to detect the response body encoding.



945
946
947
 
# File 'lib/net/http.rb', line 945

def response_body_encoding
  @response_body_encoding
end

#ssl_timeout ⇒ Object

Sets the SSL timeout seconds.



1189
1190
1191
 
# File 'lib/net/http.rb', line 1189

def ssl_timeout
  @ssl_timeout
end

#ssl_version ⇒ Object

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



1192
1193
1194
 
# File 'lib/net/http.rb', line 1192

def ssl_version
  @ssl_version
end

#verify_callback ⇒ Object

Sets the verify callback for the server certification verification.



1201
1202
1203
 
# File 'lib/net/http.rb', line 1201

def verify_callback
  @verify_callback
end

#verify_depth ⇒ Object

Sets the maximum depth for the certificate chain verification.



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

def verify_depth
  @verify_depth
end

#verify_hostname ⇒ Object

Sets to check the server certificate is valid for the hostname. See OpenSSL::SSL::SSLContext#verify_hostname=



1214
1215
1216
 
# File 'lib/net/http.rb', line 1214

def verify_hostname
  @verify_hostname
end

#verify_mode ⇒ Object

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.



1210
1211
1212
 
# File 'lib/net/http.rb', line 1210

def verify_mode
  @verify_mode
end

#write_timeout ⇒ Object

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.



1029
1030
1031
 
# File 'lib/net/http.rb', line 1029

def write_timeout
  @write_timeout
end

Class Method Details

.default_port ⇒ Object

Returns intger 80, the default port to use for HTTP requests:

Net::HTTP.default_port # => 80



558
559
560
 
# File 'lib/net/http.rb', line 558

def HTTP.default_port
  http_default_port()
end

.get(uri_or_host, path_or_headers = nil, port = nil) ⇒ Object

:call-seq:

Net::HTTP.get(hostname, path, port = 80) -> body
Net::HTTP:get(uri, headers = {}, port = uri.port) -> body

Sends a GET request and returns the HTTP response body as a string.

With string arguments hostname and path:

hostname = 'jsonplaceholder.typicode.com'
path = '/todos/1'
puts Net::HTTP.get(hostname, path)

Output:

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

With URI object uri and optional hash argument headers:

uri = URI('https://jsonplaceholder.typicode.com/todos/1')
headers = {'Content-type' => 'application/json; charset=UTF-8'}
Net::HTTP.get(uri, headers)

Related:

  • Net::HTTP::Get: request class for HTTP method GET.

  • Net::HTTP#get: convenience method for HTTP method GET.



460
461
462
 
# File 'lib/net/http.rb', line 460

def HTTP.get(uri_or_host, path_or_headers = nil, port = nil)
  get_response(uri_or_host, path_or_headers, port).body
end

.get_print(uri_or_host, path_or_headers = nil, port = nil) ⇒ Object

:call-seq:

Net::HTTP.get_print(hostname, path, port = 80) -> nil
Net::HTTP:get_print(uri, headers = {}, port = uri.port) -> nil

Like Net::HTTP.get, but writes the returned body to $stdout; returns nil.



419
420
421
422
423
424
425
426
 
# File 'lib/net/http.rb', line 419

def HTTP.get_print(uri_or_host, path_or_headers = nil, port = nil)
  get_response(uri_or_host, path_or_headers, port) {|res|
    res.read_body do |chunk|
      $stdout.print chunk
    end
  }
  nil
end

.get_response(uri_or_host, path_or_headers = nil, port = nil, &block) ⇒ Object

:call-seq:

Net::HTTP.get_response(hostname, path, port = 80) -> http_response
Net::HTTP:get_response(uri, headers = {}, port = uri.port) -> http_response

Like Net::HTTP.get, but returns a Net::HTTPResponse object instead of the body string.



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/net/http.rb', line 470

def HTTP.get_response(uri_or_host, path_or_headers = nil, port = nil, &block)
  if path_or_headers && !path_or_headers.is_a?(Hash)
    host = uri_or_host
    path = path_or_headers
    new(host, port || HTTP.default_port).start {|http|
      return http.request_get(path, &block)
    }
  else
    uri = uri_or_host
    headers = path_or_headers
    start(uri.hostname, uri.port,
          :use_ssl => uri.scheme == 'https') {|http|
      return http.request_get(uri, headers, &block)
    }
  end
end

.http_default_port ⇒ Object

Returns integer 80, the default port to use for HTTP requests:

Net::HTTP.http_default_port # => 80



566
567
568
 
# File 'lib/net/http.rb', line 566

def HTTP.http_default_port
  80
end

.https_default_port ⇒ Object

Returns integer 443, the default port to use for HTTPS requests:

Net::HTTP.https_default_port # => 443



574
575
576
 
# File 'lib/net/http.rb', line 574

def HTTP.https_default_port
  443
end

.new(address, port = nil, p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil, p_no_proxy = nil) ⇒ Object

Returns a new Net::HTTP object http (but does not open a TCP connection or HTTP session).

No Proxy

With only string argument hostname given (and ENV['http_proxy'] undefined or nil), the returned http:

  • Has the given address.

  • Has the default port number, Net::HTTP.default_port (80).

  • Has no proxy.

Example:

http = Net::HTTP.new(hostname)
# => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
http.address # => "jsonplaceholder.typicode.com"
http.port    # => 80
http.proxy?  # => false

With integer argument port also given, the returned http has the given port:

http = Net::HTTP.new(hostname, 8000)
# => #<Net::HTTP jsonplaceholder.typicode.com:8000 open=false>
http.port # => 8000

Proxy Using Argument p_addr as a String

When argument p_addr is a string hostname, the returned http has a proxy:

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

Proxy Using ENV['http_proxy']

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

ENV['http_proxy'] = 'http://example.com'
# => "http://example.com"
http = Net::HTTP.new(hostname)
# => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
http.proxy?        # => true
http.address       # => "jsonplaceholder.typicode.com"
http.proxy_address # => "example.com"

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

ENV['http_proxy'] = 'http://pname:[email protected]:8000'
# => "http://pname:[email protected]:8000"
http = Net::HTTP.new(hostname)
# => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
http.proxy_port # => 8000
http.proxy_user # => "pname"
http.proxy_pass # => "ppass"

Argument p_no_proxy

You can use argument p_no_proxy to reject certain proxies:

  • Reject a certain address:

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

  • Reject certain domains or subdomains:

    http = 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 = Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'proxy.example:1234')
http.proxy_address # => "proxy.example"

http = 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 = Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'my.proxy,proxy.example:8000')
http.proxy_address # => nil

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



802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
 
# File 'lib/net/http.rb', line 802

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

.newobj ⇒ Object

:nodoc:



691
 
# File 'lib/net/http.rb', line 691

alias newobj new

.post(url, data, header = nil) ⇒ Object

Posts data to a host; returns a Net::HTTPResponse object.

Argument url must be a URL; argument data must be a string:

_uri = uri.dup
_uri.path = '/posts'
data = '{"title": "foo", "body": "bar", "userId": 1}'
headers = {'content-type': 'application/json'}
res = Net::HTTP.post(_uri, data, headers) # => #<Net::HTTPCreated 201 Created readbody=true>
puts res.body

Output:

{
  "title": "foo",
  "body": "bar",
  "userId": 1,
  "id": 101
}

Related:

  • Net::HTTP::Post: request class for HTTP method POST.

  • Net::HTTP#post: convenience method for HTTP method POST.



513
514
515
516
517
518
 
# File 'lib/net/http.rb', line 513

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

Posts data to a host; returns a Net::HTTPResponse object.

Argument url must be a URI; argument data must be a hash:

_uri = uri.dup
_uri.path = '/posts'
data = {title: 'foo', body: 'bar', userId: 1}
res = Net::HTTP.post_form(_uri, data) # => #<Net::HTTPCreated 201 Created readbody=true>
puts res.body

Output:

{
  "title": "foo",
  "body": "bar",
  "userId": "1",
  "id": 101
}



540
541
542
543
544
545
546
547
548
 
# File 'lib/net/http.rb', line 540

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(p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil) ⇒ Object

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 Net::HTTP.new. See Net::HTTP.new for details of the arguments.



1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
 
# File 'lib/net/http.rb', line 1400

def HTTP.Proxy(p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil) #:nodoc:
  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

.proxy_class? ⇒ Boolean

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

Returns:

  • (Boolean) 


1423
1424
1425
 
# File 'lib/net/http.rb', line 1423

def proxy_class?
  defined?(@is_proxy_class) ? @is_proxy_class : false
end

.socket_type ⇒ Object

:nodoc: obsolete



578
579
580
 
# File 'lib/net/http.rb', line 578

def HTTP.socket_type   #:nodoc: obsolete
  BufferedIO
end

.start(address, *arg, &block) ⇒ Object

:call-seq:

HTTP.start(address, port = nil, p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil, opts) -> http
HTTP.start(address, port = nil, p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil, opts) {|http| ... } -> object

Creates a new Net::HTTP object, http, via Net::HTTP.new:

Net::HTTP.new(address, port, p_addr, p_port, p_user, p_pass)

  • For arguments hostname through p_pass, see Net::HTTP.new.

  • For argument opts, see below.

Note: If port is nil and opts[:use_ssl] is a truthy value, the value passed to new is Net::HTTP.https_default_port, not port.

With no block given:

  • Calls http.start with no block (see #start), which opens a TCP connection and HTTP session.

  • Returns http.

  • The caller should call #finish to close the session:

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

With a block given:

  • Calls http.start with the block (see #start), which:

    • Opens a TCP connection and HTTP session.

    • Calls the block, which may make any number of requests to the host.

    • Closes the HTTP session and TCP connection on block exit.

    • Returns the block’s value object.

  • Returns object.

Example:

hostname = 'jsonplaceholder.typicode.com'
Net::HTTP.start(hostname) do |http|
  puts http.get('/todos/1').body
  puts http.get('/todos/2').body
end

Output:

{
  "userId": 1,
  "id": 1,
  "title": "delectus aut autem",
  "completed": false
}
{
  "userId": 1,
  "id": 2,
  "title": "quis ut nam facilis et officia qui",
  "completed": false
}

If the last argument given is a hash, it is the opts hash, where each key is a method or accessor to be called, and its value is the value to be set.

The keys may include:

  • #ca_file

  • #ca_path

  • #cert

  • #cert_store

  • #ciphers

  • #close_on_empty_response

  • ipaddr (calls #ipaddr=)

  • #keep_alive_timeout

  • #key

  • #open_timeout

  • #read_timeout

  • #ssl_timeout

  • #ssl_version

  • use_ssl (calls #use_ssl=)

  • #verify_callback

  • #verify_depth

  • #verify_mode

  • #write_timeout



668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
 
# File 'lib/net/http.rb', line 668

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

Returns false; retained for compatibility.

Returns:

  • (Boolean) 


404
405
406
 
# File 'lib/net/http.rb', line 404

def HTTP.version_1_1?  #:nodoc:
  false
end

.version_1_2 ⇒ Object

Returns true; retained for compatibility.



394
395
396
 
# File 'lib/net/http.rb', line 394

def HTTP.version_1_2
  true
end

.version_1_2? ⇒ Boolean Also known as: is_version_1_2?

Returns true; retained for compatibility.

Returns:

  • (Boolean) 


399
400
401
 
# File 'lib/net/http.rb', line 399

def HTTP.version_1_2?
  true
end

Instance Method Details

#copy(path, initheader = nil) ⇒ Object

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



1685
1686
1687
 
# File 'lib/net/http.rb', line 1685

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

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

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



1673
1674
1675
 
# File 'lib/net/http.rb', line 1673

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

#finish ⇒ Object

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

Raises:

  • (IOError) 


1369
1370
1371
1372
 
# File 'lib/net/http.rb', line 1369

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

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

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
}



1573
1574
1575
1576
1577
1578
1579
1580
 
# File 'lib/net/http.rb', line 1573

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

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



1595
1596
1597
 
# File 'lib/net/http.rb', line 1595

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

#inspect ⇒ Object

Returns a string representation of self:

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



872
873
874
 
# File 'lib/net/http.rb', line 872

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 = 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 = Net::HTTP.new(hostname)
http.start
http.ipaddr # => "172.67.155.76"
http.finish



995
996
997
 
# File 'lib/net/http.rb', line 995

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

#ipaddr=(addr) ⇒ Object

Sets the IP address for the connection:

http = 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) 


1007
1008
1009
1010
 
# File 'lib/net/http.rb', line 1007

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 path and gets a response, as an HTTPResponse object.



1649
1650
1651
 
# File 'lib/net/http.rb', line 1649

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 path and gets a response, as an HTTPResponse object.



1691
1692
1693
 
# File 'lib/net/http.rb', line 1691

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 path and gets a response, as an HTTPResponse object.



1679
1680
1681
 
# File 'lib/net/http.rb', line 1679

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

#options(path, initheader = nil) ⇒ Object

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



1661
1662
1663
 
# File 'lib/net/http.rb', line 1661

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

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

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



1633
1634
1635
 
# File 'lib/net/http.rb', line 1633

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 X.509 certificates the server presented.



1217
1218
1219
1220
1221
1222
 
# File 'lib/net/http.rb', line 1217

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

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.



1627
1628
1629
 
# File 'lib/net/http.rb', line 1627

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 path and gets a response, as an HTTPResponse object.



1667
1668
1669
 
# File 'lib/net/http.rb', line 1667

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 path and gets a response, as an HTTPResponse object.



1643
1644
1645
 
# File 'lib/net/http.rb', line 1643

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

#proxy? ⇒ Boolean

True if requests for this connection will be proxied

Returns:

  • (Boolean) 


1442
1443
1444
 
# File 'lib/net/http.rb', line 1442

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

#proxy_from_env? ⇒ Boolean

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

Returns:

  • (Boolean) 


1447
1448
1449
 
# File 'lib/net/http.rb', line 1447

def proxy_from_env?
  @proxy_from_env
end

#proxy_uri ⇒ Object

The proxy URI determined from the environment for this connection.



1452
1453
1454
1455
1456
1457
1458
 
# File 'lib/net/http.rb', line 1452

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

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

:nodoc:



1637
1638
1639
 
# File 'lib/net/http.rb', line 1637

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

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

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 HTTPResponse#read_body, if desired.

This method never raises Net::* exceptions.



1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
 
# File 'lib/net/http.rb', line 1815

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



1726
1727
1728
 
# File 'lib/net/http.rb', line 1726

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



1740
1741
1742
 
# File 'lib/net/http.rb', line 1740

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



1770
1771
1772
 
# File 'lib/net/http.rb', line 1770

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

:nodoc:



1774
1775
1776
 
# File 'lib/net/http.rb', line 1774

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



1794
1795
1796
1797
1798
 
# File 'lib/net/http.rb', line 1794

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



925
926
927
928
 
# File 'lib/net/http.rb', line 925

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

#start ⇒ Object

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.

Raises:

  • (IOError) 


1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
 
# File 'lib/net/http.rb', line 1233

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.

Returns:

  • (Boolean) 


1101
1102
1103
 
# File 'lib/net/http.rb', line 1101

def started?
  @started
end

#trace(path, initheader = nil) ⇒ Object

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



1697
1698
1699
 
# File 'lib/net/http.rb', line 1697

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

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

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



1655
1656
1657
 
# File 'lib/net/http.rb', line 1655

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

#use_ssl=(flag) ⇒ Object

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.



1118
1119
1120
1121
1122
1123
1124
 
# File 'lib/net/http.rb', line 1118

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 SSL/TLS is being used with HTTP.

Returns:

  • (Boolean) 


1110
1111
1112
 
# File 'lib/net/http.rb', line 1110

def use_ssl?
  @use_ssl
end