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



634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'lib/net/http.rb', line 634

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

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

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

Class Attribute Details

.proxy_address ⇒ Object (readonly)

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



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

def proxy_address
  @proxy_address
end

.proxy_pass ⇒ Object (readonly)

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



1032
1033
1034
 
# File 'lib/net/http.rb', line 1032

def proxy_pass
  @proxy_pass
end

.proxy_port ⇒ Object (readonly)

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



1025
1026
1027
 
# File 'lib/net/http.rb', line 1025

def proxy_port
  @proxy_port
end

.proxy_user ⇒ Object (readonly)

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



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

def proxy_user
  @proxy_user
end

Instance Attribute Details

#address ⇒ Object (readonly)

The DNS host name or IP address to connect to.



685
686
687
 
# File 'lib/net/http.rb', line 685

def address
  @address
end

#ca_file ⇒ Object

Sets path of a CA certification file in PEM format.

The file can contain several CA certificates.



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

def ca_file
  @ca_file
end

#ca_path ⇒ Object

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



797
798
799
 
# File 'lib/net/http.rb', line 797

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



801
802
803
 
# File 'lib/net/http.rb', line 801

def cert
  @cert
end

#cert_store ⇒ Object

Sets the X509::Store to verify peer certificate.



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

def cert_store
  @cert_store
end

#ciphers ⇒ Object

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



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

def ciphers
  @ciphers
end

#close_on_empty_response ⇒ Object

Returns the value of attribute close_on_empty_response



744
745
746
 
# File 'lib/net/http.rb', line 744

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.



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

def continue_timeout
  @continue_timeout
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.



735
736
737
 
# File 'lib/net/http.rb', line 735

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



811
812
813
 
# File 'lib/net/http.rb', line 811

def key
  @key
end

#local_host ⇒ Object

The local host used to establish the connection.



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

def local_host
  @local_host
end

#local_port ⇒ Object

The local port used to establish the connection.



694
695
696
 
# File 'lib/net/http.rb', line 694

def local_port
  @local_port
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.



706
707
708
 
# File 'lib/net/http.rb', line 706

def open_timeout
  @open_timeout
end

#port ⇒ Object (readonly)

The port number to connect to.



688
689
690
 
# File 'lib/net/http.rb', line 688

def port
  @port
end

#proxy_address ⇒ Object Also known as: proxyaddr

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



1057
1058
1059
1060
1061
1062
1063
 
# File 'lib/net/http.rb', line 1057

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.



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

def proxy_from_env=(value)
  @proxy_from_env = value
end

#proxy_pass ⇒ Object

The proxy password, if one is configured



1080
1081
1082
 
# File 'lib/net/http.rb', line 1080

def proxy_pass
  @proxy_pass
end

#proxy_port ⇒ Object Also known as: proxyport

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



1066
1067
1068
1069
1070
1071
1072
 
# File 'lib/net/http.rb', line 1066

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

#proxy_user ⇒ Object

The proxy username, if one is configured



1075
1076
1077
 
# File 'lib/net/http.rb', line 1075

def proxy_user
  @proxy_user
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.



712
713
714
 
# File 'lib/net/http.rb', line 712

def read_timeout
  @read_timeout
end

#ssl_timeout ⇒ Object

Sets the SSL timeout seconds.



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

def ssl_timeout
  @ssl_timeout
end

#ssl_version ⇒ Object

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



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

def ssl_version
  @ssl_version
end

#verify_callback ⇒ Object

Sets the verify callback for the server certification verification.



820
821
822
 
# File 'lib/net/http.rb', line 820

def verify_callback
  @verify_callback
end

#verify_depth ⇒ Object

Sets the maximum depth for the certificate chain verification.



823
824
825
 
# File 'lib/net/http.rb', line 823

def verify_depth
  @verify_depth
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.



829
830
831
 
# File 'lib/net/http.rb', line 829

def verify_mode
  @verify_mode
end

Class Method Details

.default_port ⇒ Object

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



519
520
521
 
# File 'lib/net/http.rb', line 519

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



455
456
457
 
# File 'lib/net/http.rb', line 455

def HTTP.get(uri_or_host, path = nil, port = nil)
  get_response(uri_or_host, path, port).body
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'



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

def HTTP.get_print(uri_or_host, path = nil, port = nil)
  get_response(uri_or_host, path, port) {|res|
    res.read_body do |chunk|
      $stdout.print chunk
    end
  }
  nil
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



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

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

.http_default_port ⇒ Object

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



524
525
526
 
# File 'lib/net/http.rb', line 524

def HTTP.http_default_port
  80
end

.https_default_port ⇒ Object

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



529
530
531
 
# File 'lib/net/http.rb', line 529

def HTTP.https_default_port
  443
end

.new(address, port = nil, p_addr = :ENV, p_port = nil, p_user = nil, p_pass = 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 the DNS name or IP address of the proxy host, p_port the port to use to access the proxy, and p_user and p_pass the username and password if authorization is required to use the proxy.



610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'lib/net/http.rb', line 610

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

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

  http
end

.newobj ⇒ Object

:nodoc:



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

alias newobj new

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



504
505
506
507
508
509
510
511
512
 
# File 'lib/net/http.rb', line 504

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



994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
 
# File 'lib/net/http.rb', line 994

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) 


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

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

.socket_type ⇒ Object

:nodoc: obsolete



533
534
535
 
# File 'lib/net/http.rb', line 533

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=nil, 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 ca_file, ca_path, cert, cert_store, ciphers, close_on_empty_response, key, open_timeout, read_timeout, ssl_timeout, ssl_version, use_ssl, verify_callback, verify_depth and verify_mode. If you set :use_ssl as true, you can use https and default value of verify_mode is set as OpenSSL::SSL::VERIFY_PEER.

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



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/net/http.rb', line 567

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

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

  http.start(&block)
end

.version_1_1? ⇒ Boolean Also known as: is_version_1_1?

:nodoc:

Returns:

  • (Boolean) 


412
413
414
 
# File 'lib/net/http.rb', line 412

def HTTP.version_1_1?  #:nodoc:
  false
end

.version_1_2 ⇒ Object

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



402
403
404
 
# File 'lib/net/http.rb', line 402

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) 


408
409
410
 
# File 'lib/net/http.rb', line 408

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.



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

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.



1254
1255
1256
 
# File 'lib/net/http.rb', line 1254

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) 


963
964
965
966
 
# File 'lib/net/http.rb', line 963

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
}



1154
1155
1156
1157
1158
1159
1160
1161
 
# File 'lib/net/http.rb', line 1154

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



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

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

#inspect ⇒ Object 



666
667
668
 
# File 'lib/net/http.rb', line 666

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

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

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



1230
1231
1232
 
# File 'lib/net/http.rb', line 1230

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.



1272
1273
1274
 
# File 'lib/net/http.rb', line 1272

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.



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

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.



1242
1243
1244
 
# File 'lib/net/http.rb', line 1242

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.



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

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.



832
833
834
835
836
837
 
# File 'lib/net/http.rb', line 832

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.



1208
1209
1210
 
# File 'lib/net/http.rb', line 1208

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.



1248
1249
1250
 
# File 'lib/net/http.rb', line 1248

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.



1224
1225
1226
 
# File 'lib/net/http.rb', line 1224

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) 


1036
1037
1038
1039
1040
1041
1042
 
# File 'lib/net/http.rb', line 1036

def proxy?
  !!if @proxy_from_env then
    proxy_uri
  else
    @proxy_address
  end
end

#proxy_from_env? ⇒ Boolean

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

Returns:

  • (Boolean) 


1045
1046
1047
 
# File 'lib/net/http.rb', line 1045

def proxy_from_env?
  @proxy_from_env
end

#proxy_uri ⇒ Object

The proxy URI determined from the environment for this connection.



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

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

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

:nodoc:



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

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.



1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
 
# File 'lib/net/http.rb', line 1396

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
}



1307
1308
1309
 
# File 'lib/net/http.rb', line 1307

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



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

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
}



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

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:



1355
1356
1357
 
# File 'lib/net/http.rb', line 1355

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



1375
1376
1377
1378
1379
 
# File 'lib/net/http.rb', line 1375

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



679
680
681
682
 
# File 'lib/net/http.rb', line 679

def set_debug_output(output)
  warn 'Net::HTTP#set_debug_output called after HTTP started' if started?
  @debug_output = output
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) 


848
849
850
851
852
853
854
855
856
857
858
859
860
 
# File 'lib/net/http.rb', line 848

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

#started? ⇒ Boolean Also known as: active?

Returns true if the HTTP session has been started.

Returns:

  • (Boolean) 


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

def started?
  @started
end

#trace(path, initheader = nil) ⇒ Object

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



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

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.



1236
1237
1238
 
# File 'lib/net/http.rb', line 1236

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.



755
756
757
758
759
760
761
 
# File 'lib/net/http.rb', line 755

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

#use_ssl? ⇒ Boolean

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

Returns:

  • (Boolean) 


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

def use_ssl?
  @use_ssl
end