- D
- P
- A
- B
- C
- D
- E
- F
- G
-
- get,
- get,
- get2,
- get_print,
- get_response
- H
- I
- K
- L
- M
- N
- O
- P
- R
- S
- T
- U
- V
SSL_ATTRIBUTES | = | %w( ssl_version key cert ca_file ca_path cert_store ciphers verify_mode verify_callback verify_depth ssl_timeout ) |
[R] | proxy_address | Address of proxy host. If Net::HTTP does not use a proxy, nil. |
[R] | proxy_pass | User password for accessing proxy. If Net::HTTP does not use a proxy, nil. |
[R] | proxy_port | Port number of proxy host. If Net::HTTP does not use a proxy, nil. |
[R] | proxy_user | User name for accessing proxy. If Net::HTTP does not use a proxy, nil. |
[R] | address | The DNS host name or IP address to connect to. |
[RW] | ca_file | Sets path of a CA certification file in PEM format. The file can contain several CA certificates. |
[RW] | ca_path | Sets path of a CA certification directory containing certifications in PEM format. |
[RW] | cert | Sets an OpenSSL::X509::Certificate object as client certificate. (This method is appeared in Michal Rokos's OpenSSL extension). |
[RW] | cert_store | Sets the X509::Store to verify peer certificate. |
[RW] | ciphers | Sets the available ciphers. See OpenSSL::SSL::SSLContext#ciphers= |
[RW] | close_on_empty_response | |
[R] | continue_timeout | 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 |
[RW] | key | Sets an OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object. (This method is appeared in Michal Rokos's OpenSSL extension.) |
[RW] | open_timeout | 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. The default
value is |
[R] | port | The port number to connect to. |
[R] | read_timeout | 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. The default value is 60 seconds. |
[RW] | ssl_timeout | Sets the SSL timeout seconds. |
[RW] | ssl_version | Sets the SSL version. See OpenSSL::SSL::SSLContext#ssl_version= |
[RW] | verify_callback | Sets the verify callback for the server certification verification. |
[RW] | verify_depth | Sets the maximum depth for the certificate chain verification. |
[RW] | verify_mode | 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. |
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.
# File ../ruby/lib/net/http.rb, line 880 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
The default port to use for HTTP requests; defaults to 80.
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')
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'
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
# File ../ruby/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
The default port to use for HTTP requests; defaults to 80.
The default port to use for HTTPS requests; defaults to 443.
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.
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.
# File ../ruby/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
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" }
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.
# File ../ruby/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
Turns on net/http 1.2 (ruby 1.8) features. Defaults to ON in ruby 1.8 or later.
Returns true if net/http is in version 1.2 mode. Defaults to true.
Setter for the #continue_timeout attribute.
Sends a COPY request to the path
and gets a response, as an HTTPResponse object.
Sends a DELETE request to the path
and gets a response, as an
HTTPResponse object.
Finishes the HTTP session and closes the TCP connection. Raises IOError if the session has not been started.
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
}
# File ../ruby/lib/net/http.rb, line 1017 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
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']
Sends a LOCK request to the path
and gets a response, as an HTTPResponse object.
Sends a MKCOL request to the path
and gets a response, as an
HTTPResponse object.
Sends a MOVE request to the path
and gets a response, as an HTTPResponse object.
Sends a OPTIONS request to the path
and gets a response, as an
HTTPResponse object.
Sends a PATCH request to the path
and gets a response, as an
HTTPResponse object.
Returns the X.509 certificates the server presented.
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.
Sends a PROPFIND request to the path
and gets a response, as
an HTTPResponse object.
Sends a PROPPATCH request to the path
and gets a response, as
an HTTPResponse object.
True if self is a HTTP proxy class.
A convenience method for accessing value of #proxy_address from Net::HTTP.
returns true if self is a class which was created by HTTP::Proxy.
A convenience method for accessing value of #proxy_pass from Net::HTTP.
A convenience method for accessing value of #proxy_port from Net::HTTP.
A convenience method for accessing value of #proxy_user from Net::HTTP.
Setter for the #read_timeout attribute.
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 Net::HTTPResponse#read_body, if desired.
This method never raises Net::* exceptions.
# File ../ruby/lib/net/http.rb, line 1283 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
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 Net::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
}
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']
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 Net::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
}
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
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 { .... }
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.
Sends a TRACE request to the path
and gets a response, as an
HTTPResponse object.
Sends a UNLOCK request to the path
and gets a response, as an
HTTPResponse 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.
Returns true if SSL/TLS is being used with HTTP.
utils
without proxy
# File ../ruby/lib/net/http.rb, line 761 def connect D "opening connection to #{conn_address()}..." s = timeout(@open_timeout) { TCPSocket.open(conn_address(), conn_port()) } D "opened" if use_ssl? ssl_parameters = Hash.new iv_list = instance_variables SSL_ATTRIBUTES.each do |name| ivname = "@#{name}".intern if iv_list.include?(ivname) and value = instance_variable_get(ivname) ssl_parameters[name] = value end end @ssl_context = OpenSSL::SSL::SSLContext.new @ssl_context.set_params(ssl_parameters) s = OpenSSL::SSL::SSLSocket.new(s, @ssl_context) s.sync_close = true end @socket = BufferedIO.new(s) @socket.read_timeout = @read_timeout @socket.continue_timeout = @continue_timeout @socket.debug_output = @debug_output if use_ssl? begin if proxy? @socket.writeline sprintf('CONNECT %s:%s HTTP/%s', @address, @port, HTTPVersion) @socket.writeline "Host: #{@address}:#{@port}" if proxy_user credential = ["#{proxy_user}:#{proxy_pass}"].pack('m') credential.delete!("\r\n") @socket.writeline "Proxy-Authorization: Basic #{credential}" end @socket.writeline '' HTTPResponse.read_new(@socket).value end # Server Name Indication (SNI) RFC 3546 s.hostname = @address if s.respond_to? :hostname= timeout(@open_timeout) { s.connect } if @ssl_context.verify_mode != OpenSSL::SSL::VERIFY_NONE s.post_connection_check(@address) end rescue => exception D "Conn close because of connect error #{exception}" @socket.close if @socket and not @socket.closed? raise exception end end on_connect end
# File ../ruby/lib/net/http.rb, line 1343 def end_transport(req, res) @curr_http_version = res.http_version if @socket.closed? D 'Conn socket closed' elsif not res.body and @close_on_empty_response D 'Conn close' @socket.close elsif keep_alive?(req, res) D 'Conn keep-alive' else D 'Conn close' @socket.close end end
Executes a request which uses a representation and returns its body.
# File ../ruby/lib/net/http.rb, line 1382 def sspi_auth(req) n = Win32::SSPI::NegotiateAuth.new req["Proxy-Authorization"] = "Negotiate #{n.get_initial_token}" # Some versions of ISA will close the connection if this isn't present. req["Connection"] = "Keep-Alive" req["Proxy-Connection"] = "Keep-Alive" res = transport_request(req) authphrase = res["Proxy-Authenticate"] or return res req["Proxy-Authorization"] = "Negotiate #{n.complete_authentication(authphrase)}" rescue => err raise HTTPAuthenticationError.new('HTTP authentication failed', err) end
# File ../ruby/lib/net/http.rb, line 1367 def sspi_auth?(res) return false unless @sspi_enabled if res.kind_of?(HTTPProxyAuthenticationRequired) and proxy? and res["Proxy-Authenticate"].include?("Negotiate") begin require 'win32/sspi' true rescue LoadError false end else false end end
# File ../ruby/lib/net/http.rb, line 1315 def transport_request(req) begin_transport req res = catch(:response) { req.exec @socket, @curr_http_version, edit_path(req.path) begin res = HTTPResponse.read_new(@socket) end while res.kind_of?(HTTPContinue) res.reading_body(@socket, req.response_body_permitted?) { yield res if block_given? } res } end_transport req, res res rescue => exception D "Conn close because of error #{exception}" @socket.close if @socket and not @socket.closed? raise exception end