Class: Net::HTTP

Inherits:
Protocol 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

Revision =

:stopdoc:

%q$Revision$.split[1]
HTTPVersion =
'1.1'
SSL_IVNAMES =
[
  :@ca_file,
  :@ca_path,
  :@cert,
  :@cert_store,
  :@ciphers,
  :@key,
  :@ssl_timeout,
  :@ssl_version,
  :@min_version,
  :@max_version,
  :@verify_callback,
  :@verify_depth,
  :@verify_mode,
]
SSL_ATTRIBUTES =
[
  :ca_file,
  :ca_path,
  :cert,
  :cert_store,
  :ciphers,
  :key,
  :ssl_timeout,
  :ssl_version,
  :min_version,
  :max_version,
  :verify_callback,
  :verify_depth,
  :verify_mode,
]
ENVIRONMENT_VARIABLE_IS_MULTIUSER_SAFE =
false
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.


661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
# File 'lib/net/http.rb', line 661

def initialize(address, port = nil)
  @address = address
  @port    = (port || HTTP.default_port)
  @ipaddr = nil
  @local_host = nil
  @local_port = nil
  @curr_http_version = HTTPVersion
  @keep_alive_timeout = 2
  @last_communicated = nil
  @close_on_empty_response = false
  @socket  = nil
  @started = false
  @open_timeout = 60
  @read_timeout = 60
  @write_timeout = 60
  @continue_timeout = nil
  @max_retries = 1
  @debug_output = nil

  @proxy_from_env = false
  @proxy_uri      = nil
  @proxy_address  = nil
  @proxy_port     = nil
  @proxy_user     = nil
  @proxy_pass     = nil

  @use_ssl = false
  @ssl_context = nil
  @ssl_session = nil
  @sspi_enabled = false
  SSL_IVNAMES.each do |ivname|
    instance_variable_set ivname, nil
  end
end

Class Attribute Details

.proxy_addressObject (readonly)

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


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

def proxy_address
  @proxy_address
end

.proxy_passObject (readonly)

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


1104
1105
1106
# File 'lib/net/http.rb', line 1104

def proxy_pass
  @proxy_pass
end

.proxy_portObject (readonly)

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


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

def proxy_port
  @proxy_port
end

.proxy_userObject (readonly)

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


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

def proxy_user
  @proxy_user
end

Instance Attribute Details

#addressObject (readonly)

The DNS host name or IP address to connect to.


715
716
717
# File 'lib/net/http.rb', line 715

def address
  @address
end

#ca_fileObject

Sets path of a CA certification file in PEM format.

The file can contain several CA certificates.


867
868
869
# File 'lib/net/http.rb', line 867

def ca_file
  @ca_file
end

#ca_pathObject

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


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

def ca_path
  @ca_path
end

#certObject

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


875
876
877
# File 'lib/net/http.rb', line 875

def cert
  @cert
end

#cert_storeObject

Sets the X509::Store to verify peer certificate.


878
879
880
# File 'lib/net/http.rb', line 878

def cert_store
  @cert_store
end

#ciphersObject

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


881
882
883
# File 'lib/net/http.rb', line 881

def ciphers
  @ciphers
end

#close_on_empty_responseObject

Returns the value of attribute close_on_empty_response


814
815
816
# File 'lib/net/http.rb', line 814

def close_on_empty_response
  @close_on_empty_response
end

#continue_timeoutObject

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.


793
794
795
# File 'lib/net/http.rb', line 793

def continue_timeout
  @continue_timeout
end

#keep_alive_timeoutObject

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.


805
806
807
# File 'lib/net/http.rb', line 805

def keep_alive_timeout
  @keep_alive_timeout
end

#keyObject

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


885
886
887
# File 'lib/net/http.rb', line 885

def key
  @key
end

#local_hostObject

The local host used to establish the connection.


721
722
723
# File 'lib/net/http.rb', line 721

def local_host
  @local_host
end

#local_portObject

The local port used to establish the connection.


724
725
726
# File 'lib/net/http.rb', line 724

def local_port
  @local_port
end

#max_retriesObject

Returns the value of attribute max_retries


776
777
778
# File 'lib/net/http.rb', line 776

def max_retries
  @max_retries
end

#max_versionObject

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


897
898
899
# File 'lib/net/http.rb', line 897

def max_version
  @max_version
end

#min_versionObject

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


894
895
896
# File 'lib/net/http.rb', line 894

def min_version
  @min_version
end

#open_timeoutObject

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.


747
748
749
# File 'lib/net/http.rb', line 747

def open_timeout
  @open_timeout
end

#portObject (readonly)

The port number to connect to.


718
719
720
# File 'lib/net/http.rb', line 718

def port
  @port
end

#proxy_addressObject Also known as: proxyaddr

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


1127
1128
1129
1130
1131
1132
1133
# File 'lib/net/http.rb', line 1127

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.


726
727
728
# File 'lib/net/http.rb', line 726

def proxy_from_env=(value)
  @proxy_from_env = value
end

#proxy_passObject

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


1161
1162
1163
1164
1165
1166
1167
# File 'lib/net/http.rb', line 1161

def proxy_pass
  if ENVIRONMENT_VARIABLE_IS_MULTIUSER_SAFE && @proxy_from_env
    proxy_uri&.password
  else
    @proxy_pass
  end
end

#proxy_portObject Also known as: proxyport

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


1136
1137
1138
1139
1140
1141
1142
# File 'lib/net/http.rb', line 1136

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

#proxy_userObject

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


1152
1153
1154
1155
1156
1157
1158
# File 'lib/net/http.rb', line 1152

def proxy_user
  if ENVIRONMENT_VARIABLE_IS_MULTIUSER_SAFE && @proxy_from_env
    proxy_uri&.user
  else
    @proxy_user
  end
end

#read_timeoutObject

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.


753
754
755
# File 'lib/net/http.rb', line 753

def read_timeout
  @read_timeout
end

#ssl_timeoutObject

Sets the SSL timeout seconds.


888
889
890
# File 'lib/net/http.rb', line 888

def ssl_timeout
  @ssl_timeout
end

#ssl_versionObject

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


891
892
893
# File 'lib/net/http.rb', line 891

def ssl_version
  @ssl_version
end

#verify_callbackObject

Sets the verify callback for the server certification verification.


900
901
902
# File 'lib/net/http.rb', line 900

def verify_callback
  @verify_callback
end

#verify_depthObject

Sets the maximum depth for the certificate chain verification.


903
904
905
# File 'lib/net/http.rb', line 903

def verify_depth
  @verify_depth
end

#verify_modeObject

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.


909
910
911
# File 'lib/net/http.rb', line 909

def verify_mode
  @verify_mode
end

#write_timeoutObject

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.


760
761
762
# File 'lib/net/http.rb', line 760

def write_timeout
  @write_timeout
end

Class Method Details

.default_portObject

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


539
540
541
# File 'lib/net/http.rb', line 539

def HTTP.default_port
  http_default_port()
end

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

Sends a GET request to the target and returns the HTTP response as a string. The target can either be specified as (uri), or as (host, path, port = 80); so:

print Net::HTTP.get(URI('http://www.example.com/index.html'))

or:

print Net::HTTP.get('www.example.com', '/index.html')

457
458
459
# File 'lib/net/http.rb', line 457

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

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

Gets the body text from the target and outputs it to $stdout. The target can either be specified as (uri), or as (host, path, port = 80); so:

Net::HTTP.get_print URI('http://www.example.com/index.html')

or:

Net::HTTP.get_print 'www.example.com', '/index.html'

438
439
440
441
442
443
444
445
# File 'lib/net/http.rb', line 438

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

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

Sends a GET request to the target and returns the HTTP response as a Net::HTTPResponse object. The target can either be specified as (uri), or as (host, path, port = 80); so:

res = Net::HTTP.get_response(URI('http://www.example.com/index.html'))
print res.body

or:

res = Net::HTTP.get_response('www.example.com', '/index.html')
print res.body

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

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

.http_default_portObject

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


544
545
546
# File 'lib/net/http.rb', line 544

def HTTP.http_default_port
  80
end

.https_default_portObject

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


549
550
551
# File 'lib/net/http.rb', line 549

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

Creates a new Net::HTTP object without opening a TCP connection or HTTP session.

The address should be a DNS hostname or IP address, the port is the port the server operates on. If no port is given the default port for HTTP or HTTPS is used.

If none of the p_ arguments are given, the proxy host and port are taken from the http_proxy environment variable (or its uppercase equivalent) if present. If the proxy requires authentication you must supply it by hand. See URI::Generic#find_proxy for details of proxy detection from the environment. To disable proxy detection set p_addr to nil.

If you are connecting to a custom proxy, p_addr specifies the DNS name or IP address of the proxy host, p_port the port to use to access the proxy, p_user and p_pass the username and password if authorization is required to use the proxy, and p_no_proxy hosts which do not use the proxy.


633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
# File 'lib/net/http.rb', line 633

def HTTP.new(address, port = nil, p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil, p_no_proxy = nil)
  http = super address, port

  if proxy_class? then # from Net::HTTP::Proxy()
    http.proxy_from_env = @proxy_from_env
    http.proxy_address  = @proxy_address
    http.proxy_port     = @proxy_port
    http.proxy_user     = @proxy_user
    http.proxy_pass     = @proxy_pass
  elsif p_addr == :ENV then
    http.proxy_from_env = true
  else
    if p_addr && p_no_proxy && !URI::Generic.use_proxy?(p_addr, p_addr, p_port, p_no_proxy)
      p_addr = nil
      p_port = nil
    end
    http.proxy_address = p_addr
    http.proxy_port    = p_port || default_port
    http.proxy_user    = p_user
    http.proxy_pass    = p_pass
  end

  http
end

.newobjObject

:nodoc:


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

alias newobj new

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

Posts data to the specified URI object.

Example:

require 'net/http'
require 'uri'

Net::HTTP.post URI('http://www.example.com/api/search'),
               { "q" => "ruby", "max" => "50" }.to_json,
               "Content-Type" => "application/json"

499
500
501
502
503
504
# File 'lib/net/http.rb', line 499

def HTTP.post(url, data, header = nil)
  start(url.hostname, url.port,
        :use_ssl => url.scheme == 'https' ) {|http|
    http.post(url, data, header)
  }
end

.post_form(url, params) ⇒ Object

Posts HTML form data to the specified URI object. The form data must be provided as a Hash mapping from String to String. Example:

{ "cmd" => "search", "q" => "ruby", "max" => "50" }

This method also does Basic Authentication iff url.user exists. But userinfo for authentication is deprecated (RFC3986). So this feature will be removed.

Example:

require 'net/http'
require 'uri'

Net::HTTP.post_form URI('http://www.example.com/search.cgi'),
                    { "q" => "ruby", "max" => "50" }

524
525
526
527
528
529
530
531
532
# File 'lib/net/http.rb', line 524

def HTTP.post_form(url, params)
  req = Post.new(url)
  req.form_data = params
  req.basic_auth url.user, url.password if url.user
  start(url.hostname, url.port,
        :use_ssl => url.scheme == 'https' ) {|http|
    http.request(req)
  }
end

.Proxy(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.


1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
# File 'lib/net/http.rb', line 1066

def HTTP.Proxy(p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil)
  return self unless p_addr

  Class.new(self) {
    @is_proxy_class = true

    if p_addr == :ENV then
      @proxy_from_env = true
      @proxy_address = nil
      @proxy_port    = nil
    else
      @proxy_from_env = false
      @proxy_address = p_addr
      @proxy_port    = p_port || default_port
    end

    @proxy_user = p_user
    @proxy_pass = p_pass
  }
end

.proxy_class?Boolean

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

Returns:

  • (Boolean)

1089
1090
1091
# File 'lib/net/http.rb', line 1089

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

.socket_typeObject

:nodoc: obsolete


553
554
555
# File 'lib/net/http.rb', line 553

def HTTP.socket_type   #:nodoc: obsolete
  BufferedIO
end

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

:call-seq:

HTTP.start(address, port, p_addr, p_port, p_user, p_pass, &block)
HTTP.start(address, port=nil, p_addr=:ENV, p_port=nil, p_user=nil, p_pass=nil, opt, &block)

Creates a new Net::HTTP object, then additionally opens the TCP connection and HTTP session.

Arguments are the following:

address

hostname or IP address of the server

port

port of the server

p_addr

address of proxy

p_port

port of proxy

p_user

user of proxy

p_pass

pass of proxy

opt

optional hash

opt sets following values by its accessor. The keys are ipaddr, ca_file, ca_path, cert, cert_store, ciphers, close_on_empty_response, key, open_timeout, read_timeout, write_timeout, ssl_timeout, ssl_version, use_ssl, verify_callback, verify_depth and verify_mode. If you set :use_ssl as true, you can use https and default value of verify_mode is set as OpenSSL::SSL::VERIFY_PEER.

If the optional block is given, the newly created Net::HTTP object is passed to it and closed when the block finishes. In this case, the return value of this method is the return value of the block. If no block is given, the return value of this method is the newly created Net::HTTP object itself, and the caller is responsible for closing it upon completion using the finish() method.


587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
# File 'lib/net/http.rb', line 587

def HTTP.start(address, *arg, &block) # :yield: +http+
  arg.pop if opt = Hash.try_convert(arg[-1])
  port, p_addr, p_port, p_user, p_pass = *arg
  p_addr = :ENV if arg.size < 2
  port = https_default_port if !port && opt && opt[:use_ssl]
  http = new(address, port, p_addr, p_port, p_user, p_pass)
  http.ipaddr = opt[:ipaddr] if opt && opt[:ipaddr]

  if opt
    if opt[:use_ssl]
      opt = {verify_mode: OpenSSL::SSL::VERIFY_PEER}.update(opt)
    end
    http.methods.grep(/\A(\w+)=\z/) do |meth|
      key = $1.to_sym
      opt.key?(key) or next
      http.__send__(meth, opt[key])
    end
  end

  http.start(&block)
end

.version_1_1?Boolean Also known as: is_version_1_1?

:nodoc:

Returns:

  • (Boolean)

414
415
416
# File 'lib/net/http.rb', line 414

def HTTP.version_1_1?  #:nodoc:
  false
end

.version_1_2Object

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


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

def HTTP.version_1_2
  true
end

.version_1_2?Boolean Also known as: is_version_1_2?

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

Returns:

  • (Boolean)

410
411
412
# File 'lib/net/http.rb', line 410

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.


1351
1352
1353
# File 'lib/net/http.rb', line 1351

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.


1339
1340
1341
# File 'lib/net/http.rb', line 1339

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

#finishObject

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

Raises:

  • (IOError)

1035
1036
1037
1038
# File 'lib/net/http.rb', line 1035

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

#get(path, initheader = nil, dest = nil, &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
}

1239
1240
1241
1242
1243
1244
1245
1246
# File 'lib/net/http.rb', line 1239

def get(path, initheader = nil, dest = nil, &block) # :yield: +body_segment+
  res = nil
  request(Get.new(path, initheader)) {|r|
    r.read_body dest, &block
    res = r
  }
  res
end

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

1261
1262
1263
# File 'lib/net/http.rb', line 1261

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

#inspectObject


696
697
698
# File 'lib/net/http.rb', line 696

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

#ipaddrObject

The IP address to connect to/used to connect to


733
734
735
# File 'lib/net/http.rb', line 733

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

#ipaddr=(addr) ⇒ Object

Set the IP address to connect to

Raises:

  • (IOError)

738
739
740
741
# File 'lib/net/http.rb', line 738

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

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

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


1315
1316
1317
# File 'lib/net/http.rb', line 1315

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.


1357
1358
1359
# File 'lib/net/http.rb', line 1357

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.


1345
1346
1347
# File 'lib/net/http.rb', line 1345

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.


1327
1328
1329
# File 'lib/net/http.rb', line 1327

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.


1299
1300
1301
# File 'lib/net/http.rb', line 1299

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

#peer_certObject

Returns the X.509 certificates the server presented.


912
913
914
915
916
917
# File 'lib/net/http.rb', line 912

def peer_cert
  if not use_ssl? or not @socket
    return nil
  end
  @socket.io.peer_cert
end

#post(path, data, initheader = nil, dest = nil, &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.


1293
1294
1295
# File 'lib/net/http.rb', line 1293

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

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

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


1333
1334
1335
# File 'lib/net/http.rb', line 1333

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

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

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


1309
1310
1311
# File 'lib/net/http.rb', line 1309

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)

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

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)

1113
1114
1115
# File 'lib/net/http.rb', line 1113

def proxy_from_env?
  @proxy_from_env
end

#proxy_uriObject

The proxy URI determined from the environment for this connection.


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

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:


1303
1304
1305
# File 'lib/net/http.rb', line 1303

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.


1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
# File 'lib/net/http.rb', line 1481

def request(req, body = nil, &block)  # :yield: +response+
  unless started?
    start {
      req['connection'] ||= 'close'
      return request(req, body, &block)
    }
  end
  if proxy_user()
    req.proxy_basic_auth proxy_user(), proxy_pass() unless use_ssl?
  end
  req.set_body_internal body
  res = transport_request(req, &block)
  if sspi_auth?(res)
    sspi_auth(req)
    res = transport_request(req, &block)
  end
  res
end

#request_get(path, initheader = nil, &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
}

1392
1393
1394
# File 'lib/net/http.rb', line 1392

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

1406
1407
1408
# File 'lib/net/http.rb', line 1406

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
}

1436
1437
1438
# File 'lib/net/http.rb', line 1436

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:


1440
1441
1442
# File 'lib/net/http.rb', line 1440

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

1460
1461
1462
1463
1464
# File 'lib/net/http.rb', line 1460

def send_request(name, path, data = nil, header = nil)
  has_response_body = name != 'HEAD'
  r = HTTPGenericRequest.new(name,(data ? true : false),has_response_body,path,header)
  request r, data
end

#set_debug_output(output) ⇒ Object

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

Sets an output stream for debugging.

http = Net::HTTP.new(hostname)
http.set_debug_output $stderr
http.start { .... }

709
710
711
712
# File 'lib/net/http.rb', line 709

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

#startObject

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)

928
929
930
931
932
933
934
935
936
937
938
939
940
# File 'lib/net/http.rb', line 928

def start  # :yield: http
  raise IOError, 'HTTP session already opened' if @started
  if block_given?
    begin
      do_start
      return yield(self)
    ensure
      do_finish
    end
  end
  do_start
  self
end

#started?Boolean Also known as: active?

Returns true if the HTTP session has been started.

Returns:

  • (Boolean)

808
809
810
# File 'lib/net/http.rb', line 808

def started?
  @started
end

#trace(path, initheader = nil) ⇒ Object

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


1363
1364
1365
# File 'lib/net/http.rb', line 1363

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.


1321
1322
1323
# File 'lib/net/http.rb', line 1321

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.


825
826
827
828
829
830
831
# File 'lib/net/http.rb', line 825

def use_ssl=(flag)
  flag = flag ? true : false
  if started? and @use_ssl != flag
    raise IOError, "use_ssl value changed, but session already started"
  end
  @use_ssl = flag
end

#use_ssl?Boolean

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

Returns:

  • (Boolean)

817
818
819
# File 'lib/net/http.rb', line 817

def use_ssl?
  @use_ssl
end