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: 39464 $.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.


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

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 = nil
  @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
  @enable_post_connection_check = true
  @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.


997
998
999
# File 'lib/net/http.rb', line 997

def proxy_address
  @proxy_address
end

.proxy_passObject (readonly)

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


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

def proxy_pass
  @proxy_pass
end

.proxy_portObject (readonly)

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


1000
1001
1002
# File 'lib/net/http.rb', line 1000

def proxy_port
  @proxy_port
end

.proxy_userObject (readonly)

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


1003
1004
1005
# File 'lib/net/http.rb', line 1003

def proxy_user
  @proxy_user
end

Instance Attribute Details

#addressObject (readonly)

The DNS host name or IP address to connect to.


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

def address
  @address
end

#ca_fileObject

Sets path of a CA certification file in PEM format.

The file can contain several CA certificates.


791
792
793
# File 'lib/net/http.rb', line 791

def ca_file
  @ca_file
end

#ca_pathObject

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


795
796
797
# File 'lib/net/http.rb', line 795

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


799
800
801
# File 'lib/net/http.rb', line 799

def cert
  @cert
end

#cert_storeObject

Sets the X509::Store to verify peer certificate.


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

def cert_store
  @cert_store
end

#ciphersObject

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


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

def ciphers
  @ciphers
end

#close_on_empty_responseObject

Returns the value of attribute close_on_empty_response


742
743
744
# File 'lib/net/http.rb', line 742

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.


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

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.


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

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


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

def key
  @key
end

#local_hostObject

The local host used to estabilish the connection.


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

def local_host
  @local_host
end

#local_portObject

The local port used to estabilish the connection.


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

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


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

def open_timeout
  @open_timeout
end

#portObject (readonly)

The port number to connect to.


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

def port
  @port
end

#proxy_addressObject Also known as: proxyaddr

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


1030
1031
1032
1033
1034
1035
1036
# File 'lib/net/http.rb', line 1030

def proxy_address
  if @proxy_from_env then
    proxy_uri && 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.


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

def proxy_from_env=(value)
  @proxy_from_env = value
end

#proxy_passObject

The proxy password, if one is configured


1053
1054
1055
# File 'lib/net/http.rb', line 1053

def proxy_pass
  @proxy_pass
end

#proxy_portObject Also known as: proxyport

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


1039
1040
1041
1042
1043
1044
1045
# File 'lib/net/http.rb', line 1039

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

#proxy_userObject

The proxy username, if one is configured


1048
1049
1050
# File 'lib/net/http.rb', line 1048

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


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

def read_timeout
  @read_timeout
end

#ssl_timeoutObject

Sets the SSL timeout seconds.


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

def ssl_timeout
  @ssl_timeout
end

#ssl_versionObject

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


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

def ssl_version
  @ssl_version
end

#verify_callbackObject

Sets the verify callback for the server certification verification.


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

def verify_callback
  @verify_callback
end

#verify_depthObject

Sets the maximum depth for the certificate chain verification.


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

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.


827
828
829
# File 'lib/net/http.rb', line 827

def verify_mode
  @verify_mode
end

Class Method Details

.default_portObject

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


517
518
519
# File 'lib/net/http.rb', line 517

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

453
454
455
# File 'lib/net/http.rb', line 453

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'

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

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

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

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.


522
523
524
# File 'lib/net/http.rb', line 522

def HTTP.http_default_port
  80
end

.https_default_portObject

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


527
528
529
# File 'lib/net/http.rb', line 527

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.


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

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

.newobjObject

:nodoc:


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

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

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

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.


969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
# File 'lib/net/http.rb', line 969

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)

992
993
994
# File 'lib/net/http.rb', line 992

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

.socket_typeObject

:nodoc: obsolete


531
532
533
# File 'lib/net/http.rb', line 531

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.


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

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)

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

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.


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

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)

406
407
408
# File 'lib/net/http.rb', line 406

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.


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

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.


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

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)

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

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

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

1123
1124
1125
1126
1127
1128
1129
1130
# File 'lib/net/http.rb', line 1123

def get(path, initheader = {}, 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']

1145
1146
1147
# File 'lib/net/http.rb', line 1145

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

#inspectObject


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

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.


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

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.


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

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.


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

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.


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

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.


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

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.


830
831
832
833
834
835
# File 'lib/net/http.rb', line 830

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.


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

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.


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

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.


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

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)

1011
1012
1013
1014
1015
1016
1017
# File 'lib/net/http.rb', line 1011

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)

1020
1021
1022
# File 'lib/net/http.rb', line 1020

def proxy_from_env?
  @proxy_from_env
end

#proxy_uriObject

The proxy URI determined from the environment for this connection.


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

def proxy_uri # :nodoc:
  @proxy_uri ||= URI("http://#{address}:#{port}").find_proxy
end

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

:nodoc:


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

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.


1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
# File 'lib/net/http.rb', line 1364

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
}

1276
1277
1278
# File 'lib/net/http.rb', line 1276

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

1290
1291
1292
# File 'lib/net/http.rb', line 1290

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
}

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

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:


1324
1325
1326
# File 'lib/net/http.rb', line 1324

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

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

def send_request(name, path, data = nil, header = nil)
  r = HTTPGenericRequest.new(name,(data ? true : false),true,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
http.set_debug_output $stderr
http.start { .... }

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

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

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

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)

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

def started?
  @started
end

#trace(path, initheader = nil) ⇒ Object

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


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

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.


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

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.


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

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)

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

def use_ssl?
  @use_ssl
end