Class: Net::HTTP

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

Overview

-- for backward compatibility

Defined Under Namespace

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

Constant Summary collapse

Revision =

:stopdoc:

%q$Revision: 33089 $.split[1]
HTTPVersion = 
'1.1'
SSL_ATTRIBUTES = 
%w(
ssl_version key cert ca_file ca_path cert_store ciphers
verify_mode verify_callback verify_depth ssl_timeout
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.



575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
 
# File 'lib/net/http.rb', line 575

def initialize(address, port = nil)
  @address = address
  @port    = (port || HTTP.default_port)
  @curr_http_version = HTTPVersion
  @no_keepalive_server = false
  @close_on_empty_response = false
  @socket  = nil
  @started = false
  @open_timeout = nil
  @read_timeout = 60
  @continue_timeout = nil
  @debug_output = nil
  @use_ssl = false
  @ssl_context = nil
  @enable_post_connection_check = true
  @compression = nil
  @sspi_enabled = false
  if defined?(SSL_ATTRIBUTES)
    SSL_ATTRIBUTES.each do |name|
      instance_variable_set "@#{name}", nil
    end
  end
end

Class Attribute Details

.proxy_address ⇒ Object (readonly)

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



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

def proxy_address
  @proxy_address
end

.proxy_pass ⇒ Object (readonly)

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



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

def proxy_pass
  @proxy_pass
end

.proxy_port ⇒ Object (readonly)

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



905
906
907
 
# File 'lib/net/http.rb', line 905

def proxy_port
  @proxy_port
end

.proxy_user ⇒ Object (readonly)

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



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

def proxy_user
  @proxy_user
end

Instance Attribute Details

#address ⇒ Object (readonly)

The DNS host name or IP address to connect to.



618
619
620
 
# File 'lib/net/http.rb', line 618

def address
  @address
end

#ca_file ⇒ Object

Sets path of a CA certification file in PEM format.

The file can contain several CA certificates.



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

def ca_file
  @ca_file
end

#ca_path ⇒ Object

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



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

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



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

def cert
  @cert
end

#cert_store ⇒ Object

Sets the X509::Store to verify peer certificate.



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

def cert_store
  @cert_store
end

#ciphers ⇒ Object

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



699
700
701
 
# File 'lib/net/http.rb', line 699

def ciphers
  @ciphers
end

#close_on_empty_response ⇒ Object

Returns the value of attribute close_on_empty_response



658
659
660
 
# File 'lib/net/http.rb', line 658

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.



643
644
645
 
# File 'lib/net/http.rb', line 643

def continue_timeout
  @continue_timeout
end

#key ⇒ Object

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



703
704
705
 
# File 'lib/net/http.rb', line 703

def key
  @key
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 TimeoutError exception.



627
628
629
 
# File 'lib/net/http.rb', line 627

def open_timeout
  @open_timeout
end

#port ⇒ Object (readonly)

The port number to connect to.



621
622
623
 
# File 'lib/net/http.rb', line 621

def port
  @port
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 TimeoutError exception.



633
634
635
 
# File 'lib/net/http.rb', line 633

def read_timeout
  @read_timeout
end

#ssl_timeout ⇒ Object

Sets the SSL timeout seconds.



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

def ssl_timeout
  @ssl_timeout
end

#ssl_version ⇒ Object

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



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

def ssl_version
  @ssl_version
end

#verify_callback ⇒ Object

Sets the verify callback for the server certification verification.



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

def verify_callback
  @verify_callback
end

#verify_depth ⇒ Object

Sets the maximum depth for the certificate chain verification.



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

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.



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

def verify_mode
  @verify_mode
end

Class Method Details

.default_port ⇒ Object

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



492
493
494
 
# File 'lib/net/http.rb', line 492

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



430
431
432
 
# File 'lib/net/http.rb', line 430

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'



411
412
413
414
415
416
417
418
 
# File 'lib/net/http.rb', line 411

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



446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/net/http.rb', line 446

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
    new(uri.hostname, uri.port).start {|http|
      return http.request_get(uri.request_uri, &block)
    }
  end
end

.http_default_port ⇒ Object

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



497
498
499
 
# File 'lib/net/http.rb', line 497

def HTTP.http_default_port
  80
end

.https_default_port ⇒ Object

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



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

def HTTP.https_default_port
  443
end

.new(address, port = nil, p_addr = nil, 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. If p_addr is given, creates a Net::HTTP object with proxy support.



568
569
570
 
# File 'lib/net/http.rb', line 568

def HTTP.new(address, port = nil, p_addr = nil, p_port = nil, p_user = nil, p_pass = nil)
  Proxy(p_addr, p_port, p_user, p_pass).newobj(address, port)
end

.newobj ⇒ Object 



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

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'

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



478
479
480
481
482
483
484
485
 
# File 'lib/net/http.rb', line 478

def HTTP.post_form(url, params)
  req = Post.new(url.request_uri)
  req.form_data = params
  req.basic_auth url.user, url.password if url.user
  new(url.hostname, url.port).start {|http|
    http.request(req)
  }
end

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

The arguments are the DNS name or IP address of the proxy host, the port to use to access the proxy, and a username and password if authorization is required to use the proxy.

You can replace any use of the Net::HTTP class with use of the proxy class created.

If p_addr is nil, this method returns self (a Net::HTTP object).

# Example
proxy_class = Net::HTTP::Proxy('proxy.example.com', 8080)

proxy_class.start('www.ruby-lang.org') {|http|
  # connecting proxy.foo.org:8080
}

You may use them to work with authorization-enabled proxies:

proxy_host = 'your.proxy.example'
proxy_port = 8080
proxy_user = 'user'
proxy_pass = 'pass'

proxy = Net::HTTP::Proxy(proxy_host, proxy_port, proxy_user, proxy_pass)
proxy.start('www.example.com') { |http|
  # always connect to your.proxy.example:8080 using specified username
  # and password
}

Note that net/http does not use the HTTP_PROXY environment variable. If you want to use a proxy, you must set it explicitly.



879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
 
# File 'lib/net/http.rb', line 879

def HTTP.Proxy(p_addr, p_port = nil, p_user = nil, p_pass = nil)
  return self unless p_addr
  delta = ProxyDelta
  proxyclass = Class.new(self)
  proxyclass.module_eval {
    include delta
    # with proxy
    @is_proxy_class = true
    @proxy_address = p_addr
    @proxy_port    = p_port || default_port()
    @proxy_user    = p_user
    @proxy_pass    = p_pass
  }
  proxyclass
end

.proxy_class? ⇒ Boolean

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

Returns:

  • (Boolean) 


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

def proxy_class?
  @is_proxy_class
end

.socket_type ⇒ Object

:nodoc: obsolete



506
507
508
 
# File 'lib/net/http.rb', line 506

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.



540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/net/http.rb', line 540

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) 


387
388
389
 
# File 'lib/net/http.rb', line 387

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.



377
378
379
 
# File 'lib/net/http.rb', line 377

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) 


383
384
385
 
# File 'lib/net/http.rb', line 383

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.



1153
1154
1155
 
# File 'lib/net/http.rb', line 1153

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.



1141
1142
1143
 
# File 'lib/net/http.rb', line 1141

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) 


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

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

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

Gets data from path on the connected-to host. 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
}



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/net/http.rb', line 1016

def get(path, initheader = {}, dest = nil, &block) # :yield: +body_segment+
  res = nil
  if HAVE_ZLIB
    unless  initheader.keys.any?{|k| k.downcase == "accept-encoding"}
      initheader = initheader.merge({
        "accept-encoding" => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3"
      })
      @compression = true
    end
  end
  request(Get.new(path, initheader)) {|r|
    if r.key?("content-encoding") and @compression
      @compression = nil # Clear it till next set.
      the_body = r.read_body dest, &block
      case r["content-encoding"]
      when "gzip"
        r.body= Zlib::GzipReader.new(StringIO.new(the_body), encoding: "ASCII-8BIT").read
        r.delete("content-encoding")
      when "deflate"
        r.body= Zlib::Inflate.inflate(the_body);
        r.delete("content-encoding")
      when "identity"
        ; # nothing needed
      else
        ; # Don't do anything dramatic, unless we need to later
      end
    else
      r.read_body dest, &block
    end
    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']



1063
1064
1065
 
# File 'lib/net/http.rb', line 1063

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

#inspect ⇒ Object 



599
600
601
 
# File 'lib/net/http.rb', line 599

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.



1117
1118
1119
 
# File 'lib/net/http.rb', line 1117

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.



1159
1160
1161
 
# File 'lib/net/http.rb', line 1159

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.



1147
1148
1149
 
# File 'lib/net/http.rb', line 1147

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.



1129
1130
1131
 
# File 'lib/net/http.rb', line 1129

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.



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

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.



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

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.



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

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.



1135
1136
1137
 
# File 'lib/net/http.rb', line 1135

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.



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

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

#proxy? ⇒ Boolean

True if self is a HTTP proxy class.

Returns:

  • (Boolean) 


916
917
918
 
# File 'lib/net/http.rb', line 916

def proxy?
  self.class.proxy_class?
end

#proxy_address ⇒ Object Also known as: proxyaddr

A convenience method for accessing value of proxy_address from Net::HTTP.



921
922
923
 
# File 'lib/net/http.rb', line 921

def proxy_address
  self.class.proxy_address
end

#proxy_pass ⇒ Object

A convenience method for accessing value of proxy_pass from Net::HTTP.



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

def proxy_pass
  self.class.proxy_pass
end

#proxy_port ⇒ Object Also known as: proxyport

A convenience method for accessing value of proxy_port from Net::HTTP.



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

def proxy_port
  self.class.proxy_port
end

#proxy_user ⇒ Object

A convenience method for accessing value of proxy_user from Net::HTTP.



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

def proxy_user
  self.class.proxy_user
end

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

:nodoc:



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

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.



1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
 
# File 'lib/net/http.rb', line 1282

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
}



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

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



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

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
}



1238
1239
1240
 
# File 'lib/net/http.rb', line 1238

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:



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

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



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

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



612
613
614
615
 
# File 'lib/net/http.rb', line 612

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) 


740
741
742
743
744
745
746
747
748
749
750
751
752
 
# File 'lib/net/http.rb', line 740

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) 


652
653
654
 
# File 'lib/net/http.rb', line 652

def started?
  @started
end

#trace(path, initheader = nil) ⇒ Object

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



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

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.



1123
1124
1125
 
# File 'lib/net/http.rb', line 1123

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.



669
670
671
672
673
674
675
 
# File 'lib/net/http.rb', line 669

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) 


661
662
663
 
# File 'lib/net/http.rb', line 661

def use_ssl?
  @use_ssl
end