Class | Net::HTTP |
In: |
lib/net/http.rb
lib/net/https.rb |
Parent: | Protocol |
This library provides your program functions to access WWW documents via HTTP, Hyper Text Transfer Protocol version 1.1. For details of HTTP, refer [RFC2616] (www.ietf.org/rfc/rfc2616.txt).
Example 1: Simple GET+print
require 'net/http' Net::HTTP.get_print 'www.example.com', '/index.html'
Example 2: Simple GET+print by URL
require 'net/http' require 'uri' Net::HTTP.get_print URI.parse('http://www.example.com/index.html')
Example 3: More generic GET+print
require 'net/http' require 'uri' url = URI.parse('http://www.example.com/index.html') res = Net::HTTP.start(url.host, url.port) {|http| http.get('/index.html') } puts res.body
Example 4: More generic GET+print
require 'net/http' url = URI.parse('http://www.example.com/index.html') req = Net::HTTP::Get.new(url.path) res = Net::HTTP.start(url.host, url.port) {|http| http.request(req) } puts res.body
require 'net/http' require 'uri' #1: Simple POST res = Net::HTTP.post_form(URI.parse('http://www.example.com/search.cgi'), {'q'=>'ruby', 'max'=>'50'}) puts res.body #2: POST with basic authentication res = Net::HTTP.post_form(URI.parse('http://jack:pass@www.example.com/todo.cgi'), {'from'=>'2005-01-01', 'to'=>'2005-03-31'}) puts res.body #3: Detailed control url = URI.parse('http://www.example.com/todo.cgi') req = Net::HTTP::Post.new(url.path) req.basic_auth 'jack', 'pass' req.set_form_data({'from'=>'2005-01-01', 'to'=>'2005-03-31'}, ';') res = Net::HTTP.new(url.host, url.port).start {|http| http.request(req) } case res when Net::HTTPSuccess, Net::HTTPRedirection # OK else res.error! end
Net::HTTP.Proxy creates http proxy class. It has same methods of Net::HTTP but its instances always connect to proxy, instead of given host.
require 'net/http' proxy_addr = 'your.proxy.host' proxy_port = 8080 : Net::HTTP::Proxy(proxy_addr, proxy_port).start('www.example.com') {|http| # always connect to your.proxy.addr:8080 : }
Since Net::HTTP.Proxy returns Net::HTTP itself when proxy_addr is nil, there‘s no need to change code if there‘s proxy or not.
There are two additional parameters in Net::HTTP.Proxy which allow to specify proxy user name and password:
Net::HTTP::Proxy(proxy_addr, proxy_port, proxy_user = nil, proxy_pass = nil)
You may use them to work with authorization-enabled proxies:
require 'net/http' require 'uri' proxy_host = 'your.proxy.host' proxy_port = 8080 uri = URI.parse(ENV['http_proxy']) proxy_user, proxy_pass = uri.userinfo.split(/:/) if uri.userinfo Net::HTTP::Proxy(proxy_host, proxy_port, proxy_user, proxy_pass).start('www.example.com') {|http| # always connect to your.proxy.addr:8080 using specified username and password : }
Note that net/http never rely on HTTP_PROXY environment variable. If you want to use proxy, set it explicitly.
require 'net/http' require 'uri' def fetch(uri_str, limit = 10) # You should choose better exception. raise ArgumentError, 'HTTP redirect too deep' if limit == 0 response = Net::HTTP.get_response(URI.parse(uri_str)) case response when Net::HTTPSuccess then response when Net::HTTPRedirection then fetch(response['location'], limit - 1) else response.error! end end print fetch('http://www.ruby-lang.org')
Net::HTTPSuccess and Net::HTTPRedirection is a HTTPResponse class. All HTTPResponse objects belong to its own response class which indicate HTTP result status. For details of response classes, see section "HTTP Response Classes".
require 'net/http' Net::HTTP.start('www.example.com') {|http| req = Net::HTTP::Get.new('/secret-page.html') req.basic_auth 'account', 'password' response = http.request(req) print response.body }
Here is HTTP request class hierarchy.
Net::HTTPRequest Net::HTTP::Get Net::HTTP::Head Net::HTTP::Post Net::HTTP::Put Net::HTTP::Proppatch Net::HTTP::Lock Net::HTTP::Unlock Net::HTTP::Options Net::HTTP::Propfind Net::HTTP::Delete Net::HTTP::Move Net::HTTP::Copy Net::HTTP::Mkcol Net::HTTP::Trace
Here is HTTP response class hierarchy. All classes are defined in Net module.
HTTPResponse HTTPUnknownResponse HTTPInformation # 1xx HTTPContinue # 100 HTTPSwitchProtocl # 101 HTTPSuccess # 2xx HTTPOK # 200 HTTPCreated # 201 HTTPAccepted # 202 HTTPNonAuthoritativeInformation # 203 HTTPNoContent # 204 HTTPResetContent # 205 HTTPPartialContent # 206 HTTPRedirection # 3xx HTTPMultipleChoice # 300 HTTPMovedPermanently # 301 HTTPFound # 302 HTTPSeeOther # 303 HTTPNotModified # 304 HTTPUseProxy # 305 HTTPTemporaryRedirect # 307 HTTPClientError # 4xx HTTPBadRequest # 400 HTTPUnauthorized # 401 HTTPPaymentRequired # 402 HTTPForbidden # 403 HTTPNotFound # 404 HTTPMethodNotAllowed # 405 HTTPNotAcceptable # 406 HTTPProxyAuthenticationRequired # 407 HTTPRequestTimeOut # 408 HTTPConflict # 409 HTTPGone # 410 HTTPLengthRequired # 411 HTTPPreconditionFailed # 412 HTTPRequestEntityTooLarge # 413 HTTPRequestURITooLong # 414 HTTPUnsupportedMediaType # 415 HTTPRequestedRangeNotSatisfiable # 416 HTTPExpectationFailed # 417 HTTPServerError # 5xx HTTPInternalServerError # 500 HTTPNotImplemented # 501 HTTPBadGateway # 502 HTTPServiceUnavailable # 503 HTTPGatewayTimeOut # 504 HTTPVersionNotSupported # 505
You can use net/http.rb 1.1 features (bundled with Ruby 1.6) by calling HTTP.version_1_1. Calling Net::HTTP.version_1_2 allows you to use 1.2 features again.
# example Net::HTTP.start {|http1| ...(http1 has 1.2 features)... } Net::HTTP.version_1_1 Net::HTTP.start {|http2| ...(http2 has 1.1 features)... } Net::HTTP.version_1_2 Net::HTTP.start {|http3| ...(http3 has 1.2 features)... }
This function is NOT thread-safe.
version_1_1? | -> | is_version_1_1? |
version_1_2? | -> | is_version_1_2? |
new | -> | newobj |
request_put | -> | put2 |
address | [R] | The host name to connect to. |
close_on_empty_response | [RW] | |
open_timeout | [RW] | Seconds to wait until connection is opened. If the HTTP object cannot open a connection in this many seconds, it raises a TimeoutError exception. |
port | [R] | The port number to connect to. |
proxy_address | [R] | |
proxy_pass | [R] | |
proxy_port | [R] | |
proxy_user | [R] | |
read_timeout | [R] | Seconds to wait until reading one block (by one read(2) call). If the HTTP object cannot open a connection in this many seconds, it raises a TimeoutError exception. |
Creates an HTTP proxy class. Arguments are address/port of proxy host and username/password if authorization on proxy server is required. You can replace the HTTP class with created proxy class.
If ADDRESS is nil, this method returns self (Net::HTTP).
# Example proxy_class = Net::HTTP::Proxy('proxy.example.com', 8080) : proxy_class.start('www.ruby-lang.org') {|http| # connecting proxy.foo.org:8080 : }
# File lib/net/http.rb, line 641 641: def HTTP.Proxy(p_addr, p_port = nil, p_user = nil, p_pass = nil) 642: return self unless p_addr 643: delta = ProxyDelta 644: proxyclass = Class.new(self) 645: proxyclass.module_eval { 646: include delta 647: # with proxy 648: @is_proxy_class = true 649: @proxy_address = p_addr 650: @proxy_port = p_port || default_port() 651: @proxy_user = p_user 652: @proxy_pass = p_pass 653: } 654: proxyclass 655: end
Send a GET request to the target and return the response as a string. The target can either be specified as (uri), or as (host, path, port = 80); so:
print Net::HTTP.get(URI.parse('http://www.example.com/index.html'))
or:
print Net::HTTP.get('www.example.com', '/index.html')
# File lib/net/http.rb, line 355 355: def HTTP.get(uri_or_host, path = nil, port = nil) 356: get_response(uri_or_host, path, port).body 357: end
Get body from target and output it to +$stdout+. The target can either be specified as (uri), or as (host, path, port = 80); so:
Net::HTTP.get_print URI.parse('http://www.example.com/index.html')
or:
Net::HTTP.get_print 'www.example.com', '/index.html'
# File lib/net/http.rb, line 336 336: def HTTP.get_print(uri_or_host, path = nil, port = nil) 337: get_response(uri_or_host, path, port) {|res| 338: res.read_body do |chunk| 339: $stdout.print chunk 340: end 341: } 342: nil 343: end
Send a GET request to the target and return the 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.parse('http://www.example.com/index.html')) print res.body
or:
res = Net::HTTP.get_response('www.example.com', '/index.html') print res.body
# File lib/net/http.rb, line 371 371: def HTTP.get_response(uri_or_host, path = nil, port = nil, &block) 372: if path 373: host = uri_or_host 374: new(host, port || HTTP.default_port).start {|http| 375: return http.request_get(path, &block) 376: } 377: else 378: uri = uri_or_host 379: new(uri.host, uri.port).start {|http| 380: return http.request_get(uri.request_uri, &block) 381: } 382: end 383: end
The default port to use for HTTPS requests; defaults to 443.
# File lib/net/http.rb, line 424 424: def HTTP.https_default_port 425: 443 426: end
Creates a new Net::HTTP object. If proxy_addr is given, creates an Net::HTTP object with proxy support. This method does not open the TCP connection.
# File lib/net/http.rb, line 450 450: def HTTP.new(address, port = nil, p_addr = nil, p_port = nil, p_user = nil, p_pass = nil) 451: h = Proxy(p_addr, p_port, p_user, p_pass).newobj(address, port) 452: h.instance_eval { 453: @newimpl = ::Net::HTTP.version_1_2? 454: } 455: h 456: end
Creates a new Net::HTTP object for the specified address. This method does not open the TCP connection.
# File lib/net/http.rb, line 460 460: def initialize(address, port = nil) 461: @address = address 462: @port = (port || HTTP.default_port) 463: @curr_http_version = HTTPVersion 464: @seems_1_0_server = false 465: @close_on_empty_response = false 466: @socket = nil 467: @started = false 468: @open_timeout = nil 469: @read_timeout = 60 470: @debug_output = nil 471: @use_ssl = false 472: @ssl_context = nil 473: end
Posts HTML form data to the URL. Form data must be represented as a Hash of String to String, e.g:
{ "cmd" => "search", "q" => "ruby", "max" => "50" }
This method also does Basic Authentication iff URL.user exists.
Example:
require 'net/http' require 'uri' HTTP.post_form URI.parse('http://www.example.com/search.cgi'), { "q" => "ruby", "max" => "50" }
# File lib/net/http.rb, line 400 400: def HTTP.post_form(url, params) 401: req = Post.new(url.path) 402: req.form_data = params 403: req.basic_auth url.user, url.password if url.user 404: new(url.host, url.port).start {|http| 405: http.request(req) 406: } 407: end
returns true if self is a class which was created by HTTP::Proxy.
# File lib/net/http.rb, line 659 659: def proxy_class? 660: @is_proxy_class 661: end
# File lib/net/https.rb, line 129 129: def self.ssl_context_accessor(name) 130: module_eval("def \#{name}\nreturn nil unless @ssl_context\n@ssl_context.\#{name}\nend\n\ndef \#{name}=(val)\n@ssl_context ||= OpenSSL::SSL::SSLContext.new\n@ssl_context.\#{name} = val\nend\n", __FILE__, __LINE__ + 1) 131: end
creates a new Net::HTTP object and opens its TCP connection and HTTP session. 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.
# File lib/net/http.rb, line 439 439: def HTTP.start(address, port = nil, p_addr = nil, p_port = nil, p_user = nil, p_pass = nil, &block) # :yield: +http+ 440: new(address, port, p_addr, p_port, p_user, p_pass).start(&block) 441: end
Turns on net/http 1.1 (ruby 1.6) features. Defaults to OFF in ruby 1.8.
# File lib/net/http.rb, line 300 300: def HTTP.version_1_1 301: @newimpl = false 302: end
true if net/http is in version 1.1 compatible mode. Defaults to true.
# File lib/net/http.rb, line 312 312: def HTTP.version_1_1? 313: not @newimpl 314: end
Turns on net/http 1.2 (ruby 1.8) features. Defaults to ON in ruby 1.8.
I strongly recommend to call this method always.
require 'net/http' Net::HTTP.version_1_2
# File lib/net/http.rb, line 294 294: def HTTP.version_1_2 295: @newimpl = true 296: end
true if net/http is in version 1.2 mode. Defaults to true.
# File lib/net/http.rb, line 306 306: def HTTP.version_1_2? 307: @newimpl 308: end
Sends a COPY request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 906 906: def copy(path, initheader = nil) 907: request(Copy.new(path, initheader)) 908: end
Sends a DELETE request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 894 894: def delete(path, initheader = {'Depth' => 'Infinity'}) 895: request(Delete.new(path, initheader)) 896: end
Gets data from path on the connected-to host. header must be a Hash like { ‘Accept’ => ’*/*’, … }.
In version 1.1 (ruby 1.6), this method returns a pair of objects, a Net::HTTPResponse object and the entity body string. In version 1.2 (ruby 1.8), 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.
In version 1.1, this method might raise an exception for 3xx (redirect). In this case you can get a HTTPResponse object by "anException.response".
In version 1.2, this method never raises exception.
# version 1.1 (bundled with Ruby 1.6) response, body = http.get('/index.html') # version 1.2 (bundled with Ruby 1.8 or later) response = http.get('/index.html') # using block File.open('result.txt', 'w') {|f| http.get('/~foo/') do |str| f.write str end }
# File lib/net/http.rb, line 770 770: def get(path, initheader = nil, dest = nil, &block) # :yield: +body_segment+ 771: res = nil 772: request(Get.new(path, initheader)) {|r| 773: r.read_body dest, &block 774: res = r 775: } 776: unless @newimpl 777: res.value 778: return res, res.body 779: end 780: 781: res 782: end
Gets only the header from path on the connected-to host. header is a Hash like { ‘Accept’ => ’*/*’, … }.
This method returns a Net::HTTPResponse object.
In version 1.1, this method might raise an exception for 3xx (redirect). On the case you can get a HTTPResponse object by "anException.response". In version 1.2, 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']
# File lib/net/http.rb, line 800 800: def head(path, initheader = nil) 801: res = request(Head.new(path, initheader)) 802: res.value unless @newimpl 803: res 804: end
# File lib/net/http.rb, line 475 475: def inspect 476: "#<#{self.class} #{@address}:#{@port} open=#{started?}>" 477: end
Sends a LOCK request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 870 870: def lock(path, body, initheader = nil) 871: request(Lock.new(path, initheader), body) 872: end
Sends a MKCOL request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 912 912: def mkcol(path, body = nil, initheader = nil) 913: request(Mkcol.new(path, initheader), body) 914: end
Sends a MOVE request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 900 900: def move(path, initheader = nil) 901: request(Move.new(path, initheader)) 902: end
Sends a OPTIONS request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 882 882: def options(path, initheader = nil) 883: request(Options.new(path, initheader)) 884: end
# File lib/net/https.rb, line 168 168: def peer_cert 169: return nil if not use_ssl? or not @socket 170: @socket.io.peer_cert 171: end
Posts data (must be a String) to path. header must be a Hash like { ‘Accept’ => ’*/*’, … }.
In version 1.1 (ruby 1.6), this method returns a pair of objects, a Net::HTTPResponse object and an entity body string. In version 1.2 (ruby 1.8), 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 are 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.
In version 1.1, this method might raise an exception for 3xx (redirect). In this case you can get an HTTPResponse object by "anException.response". In version 1.2, this method never raises exception.
# version 1.1 response, body = http.post('/cgi-bin/search.rb', 'query=foo') # version 1.2 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.
# File lib/net/http.rb, line 843 843: def post(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+ 844: res = nil 845: request(Post.new(path, initheader), data) {|r| 846: r.read_body dest, &block 847: res = r 848: } 849: unless @newimpl 850: res.value 851: return res, res.body 852: end 853: res 854: end
Sends a PROPFIND request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 888 888: def propfind(path, body = nil, initheader = {'Depth' => '0'}) 889: request(Propfind.new(path, initheader), body) 890: end
Sends a PROPPATCH request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 864 864: def proppatch(path, body, initheader = nil) 865: request(Proppatch.new(path, initheader), body) 866: end
Address of proxy host. If self does not use a proxy, nil.
# File lib/net/http.rb, line 675 675: def proxy_address 676: self.class.proxy_address 677: end
User password for accessing proxy. If self does not use a proxy, nil.
# File lib/net/http.rb, line 690 690: def proxy_pass 691: self.class.proxy_pass 692: end
Port number of proxy host. If self does not use a proxy, nil.
# File lib/net/http.rb, line 680 680: def proxy_port 681: self.class.proxy_port 682: end
User name for accessing proxy. If self does not use a proxy, nil.
# File lib/net/http.rb, line 685 685: def proxy_user 686: self.class.proxy_user 687: end
Setter for the read_timeout attribute.
# File lib/net/http.rb, line 510 510: def read_timeout=(sec) 511: @socket.read_timeout = sec if @socket 512: @read_timeout = sec 513: end
Sends an HTTPRequest object REQUEST to the HTTP server. This method also sends DATA string if REQUEST is a post/put request. Giving DATA for get/head request causes ArgumentError.
When called with a block, yields an HTTPResponse object. The body of this response will not have been read yet; the caller can process it using HTTPResponse#read_body, if desired.
Returns a HTTPResponse object.
This method never raises Net::* exceptions.
# File lib/net/http.rb, line 1033 1033: def request(req, body = nil, &block) # :yield: +response+ 1034: unless started? 1035: start { 1036: req['connection'] ||= 'close' 1037: return request(req, body, &block) 1038: } 1039: end 1040: if proxy_user() 1041: unless use_ssl? 1042: req.proxy_basic_auth proxy_user(), proxy_pass() 1043: end 1044: end 1045: 1046: req.set_body_internal body 1047: begin 1048: begin_transport req 1049: req.exec @socket, @curr_http_version, edit_path(req.path) 1050: begin 1051: res = HTTPResponse.read_new(@socket) 1052: end while res.kind_of?(HTTPContinue) 1053: res.reading_body(@socket, req.response_body_permitted?) { 1054: yield res if block_given? 1055: } 1056: end_transport req, res 1057: rescue => exception 1058: D "Conn close because of error #{exception}" 1059: @socket.close if @socket and not @socket.closed? 1060: raise exception 1061: end 1062: 1063: res 1064: end
Sends a GET request to the path and gets a response, as an HTTPResponse object.
When called with a block, yields an HTTPResponse object. The body of this response will not have been read yet; the caller 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 here. p response['content-type'] puts response.body # using block http.request_get('/index.html') {|response| p response['content-type'] response.read_body do |str| # read body now print str end }
# File lib/net/http.rb, line 947 947: def request_get(path, initheader = nil, &block) # :yield: +response+ 948: request(Get.new(path, initheader), &block) 949: end
Sends a HEAD request to the path and gets a response, as an HTTPResponse object.
Returns the response.
This method never raises Net::* exceptions.
response = http.request_head('/index.html') p response['content-type']
# File lib/net/http.rb, line 961 961: def request_head(path, initheader = nil, &block) 962: request(Head.new(path, initheader), &block) 963: end
Sends a POST request to the path and gets a response, as an HTTPResponse object.
When called with a block, yields an HTTPResponse object. The body of this response will not have been read yet; the caller 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 # 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 }
# File lib/net/http.rb, line 991 991: def request_post(path, data, initheader = nil, &block) # :yield: +response+ 992: request Post.new(path, initheader), data, &block 993: end
Sends an HTTP request to the HTTP server. This method also sends DATA string if DATA is given.
Returns a HTTPResponse object.
This method never raises Net::* exceptions.
response = http.send_request('GET', '/index.html') puts response.body
# File lib/net/http.rb, line 1015 1015: def send_request(name, path, data = nil, header = nil) 1016: r = HTTPGenericRequest.new(name,(data ? true : false),true,path,header) 1017: request r, data 1018: end
WARNING This method causes serious security hole. Never use this method in production code.
Set an output stream for debugging.
http = Net::HTTP.new http.set_debug_output $stderr http.start { .... }
# File lib/net/http.rb, line 488 488: def set_debug_output(output) 489: warn 'Net::HTTP#set_debug_output called after HTTP started' if started? 490: @debug_output = output 491: end
# File lib/net/https.rb, line 153 153: def ssl_timeout 154: return nil unless @ssl_context 155: @ssl_context.timeout 156: end
# File lib/net/https.rb, line 158 158: def ssl_timeout=(sec) 159: raise ArgumentError, 'Net::HTTP#ssl_timeout= called but use_ssl=false' \ 160: unless use_ssl? 161: @ssl_context ||= OpenSSL::SSL::SSLContext.new 162: @ssl_context.timeout = sec 163: end
Opens TCP connection and HTTP session.
When this method is called with block, gives a HTTP object to the block and closes the TCP connection / HTTP session after the block executed.
When called with a block, returns the return value of the block; otherwise, returns self.
# File lib/net/http.rb, line 538 538: def start # :yield: http 539: raise IOError, 'HTTP session already opened' if @started 540: if block_given? 541: begin 542: do_start 543: return yield(self) 544: ensure 545: do_finish 546: end 547: end 548: do_start 549: self 550: end
Sends a TRACE request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 918 918: def trace(path, initheader = nil) 919: request(Trace.new(path, initheader)) 920: end
Sends a UNLOCK request to the path and gets a response, as an HTTPResponse object.
# File lib/net/http.rb, line 876 876: def unlock(path, body, initheader = nil) 877: request(Unlock.new(path, initheader), body) 878: end
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.
# File lib/net/https.rb, line 119 119: def use_ssl=(flag) 120: flag = (flag ? true : false) 121: raise IOError, "use_ssl value changed, but session already started" \ 122: if started? and @use_ssl != flag 123: if flag and not @ssl_context 124: @ssl_context = OpenSSL::SSL::SSLContext.new 125: end 126: @use_ssl = flag 127: end
# File lib/net/http.rb, line 1122 1122: def D(msg) 1123: return unless @debug_output 1124: @debug_output << msg 1125: @debug_output << "\n" 1126: end
utils
# File lib/net/http.rb, line 1114 1114: def addr_port 1115: if use_ssl? 1116: address() + (port == HTTP.https_default_port ? '' : ":#{port()}") 1117: else 1118: address() + (port == HTTP.http_default_port ? '' : ":#{port()}") 1119: end 1120: end
# File lib/net/http.rb, line 1068 1068: def begin_transport(req) 1069: if @socket.closed? 1070: connect 1071: end 1072: if @seems_1_0_server 1073: req['connection'] ||= 'close' 1074: end 1075: if not req.response_body_permitted? and @close_on_empty_response 1076: req['connection'] ||= 'close' 1077: end 1078: req['host'] ||= addr_port() 1079: end
# File lib/net/http.rb, line 558 558: def connect 559: D "opening connection to #{conn_address()}..." 560: s = timeout(@open_timeout) { TCPSocket.open(conn_address(), conn_port()) } 561: D "opened" 562: if use_ssl? 563: unless @ssl_context.verify_mode 564: warn "warning: peer certificate won't be verified in this SSL session" 565: @ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE 566: end 567: s = OpenSSL::SSL::SSLSocket.new(s, @ssl_context) 568: s.sync_close = true 569: end 570: @socket = BufferedIO.new(s) 571: @socket.read_timeout = @read_timeout 572: @socket.debug_output = @debug_output 573: if use_ssl? 574: if proxy? 575: @socket.writeline sprintf('CONNECT %s:%s HTTP/%s', 576: @address, @port, HTTPVersion) 577: @socket.writeline "Host: #{@address}:#{@port}" 578: if proxy_user 579: credential = ["#{proxy_user}:#{proxy_pass}"].pack('m') 580: credential.delete!("\r\n") 581: @socket.writeline "Proxy-Authorization: Basic #{credential}" 582: end 583: @socket.writeline '' 584: HTTPResponse.read_new(@socket).value 585: end 586: s.connect 587: if @ssl_context.verify_mode != OpenSSL::SSL::VERIFY_NONE 588: s.post_connection_check(@address) 589: end 590: end 591: on_connect 592: end
# File lib/net/http.rb, line 606 606: def do_finish 607: @started = false 608: @socket.close if @socket and not @socket.closed? 609: @socket = nil 610: end
# File lib/net/http.rb, line 1081 1081: def end_transport(req, res) 1082: @curr_http_version = res.http_version 1083: if not res.body and @close_on_empty_response 1084: D 'Conn close' 1085: @socket.close 1086: elsif keep_alive?(req, res) 1087: D 'Conn keep-alive' 1088: if @socket.closed? 1089: D 'Conn (but seems 1.0 server)' 1090: @seems_1_0_server = true 1091: end 1092: else 1093: D 'Conn close' 1094: @socket.close 1095: end 1096: end
# File lib/net/http.rb, line 1098 1098: def keep_alive?(req, res) 1099: return false if /close/i =~ req['connection'].to_s 1100: return false if @seems_1_0_server 1101: return true if /keep-alive/i =~ res['connection'].to_s 1102: return false if /close/i =~ res['connection'].to_s 1103: return true if /keep-alive/i =~ res['proxy-connection'].to_s 1104: return false if /close/i =~ res['proxy-connection'].to_s 1105: (@curr_http_version == '1.1') 1106: end