Class | HTTPClient |
In: |
lib/httpclient/connection.rb
lib/httpclient/auth.rb lib/httpclient/util.rb lib/httpclient/session.rb lib/httpclient/ssl_config.rb lib/httpclient/timeout.rb lib/httpclient.rb |
Parent: | Object |
The HTTPClient class provides several methods for accessing Web resources via HTTP.
HTTPClient instance is designed to be MT-safe. You can call a HTTPClient instance from several threads without synchronization after setting up an instance.
clnt = HTTPClient.new clnt.set_cookie_store('/home/nahi/cookie.dat') urls.each do |url| Thread.new(url) do |u| p clnt.head(u).status end end
At first, how to create your client. See initialize for more detail.
clnt = HTTPClient.new
clnt = HTTPClient.new('http://myproxy:8080')
See get_content.
puts clnt.get_content('http://dev.ctor.org/')
clnt.get_content('http://dev.ctor.org/') do |chunk| puts chunk end
See head, get, post, put, delete, options, propfind, proppatch and trace. It returns a HTTP::Message instance as a response.
res = clnt.head(uri) p res.header['Last-Modified'][0]
query = { 'keyword' => 'ruby', 'lang' => 'en' } res = clnt.get(uri, query) p res.status p res.contenttype p res.header['X-Custom'] puts res.content
See post.
body = { 'keyword' => 'ruby', 'lang' => 'en' } res = clnt.post(uri, body)
File.open('/tmp/post_data') do |file| body = { 'upload' => file, 'user' => 'nahi' } res = clnt.post(uri, body) end
Ruby needs to be compiled with OpenSSL.
https_url = 'https://www.rsa.com' clnt.get_content(https_url)
res = clnt.get(https_url) p res.peer_cert #=> returns OpenSSL::X509::Certificate
user_cert_file = 'cert.pem' user_key_file = 'privkey.pem' clnt.ssl_config.set_client_cert_file(user_cert_file, user_key_file) clnt.get_content(https_url)
clnt = HTTPClient.new clnt.get_content(url1) # receives Cookies. clnt.get_content(url2) # sends Cookies if needed.
clnt = HTTPClient.new clnt.set_cookie_store('/home/nahi/cookie.dat') clnt.get_content(url) ... clnt.save_cookie_store
clnt = HTTPClient.new clnt.cookie_manager = nil
clnt = HTTPClient.new domain = 'http://dev.ctor.org/http-access2/' user = 'user' password = 'user' clnt.set_auth(domain, user, password) p clnt.get_content('http://dev.ctor.org/http-access2/login').status
clnt = HTTPClient.new(proxy) user = 'proxy' password = 'proxy' clnt.set_proxy_auth(user, password) p clnt.get_content(url)
Pass a Hash or an Array for extheader argument.
extheader = { 'Accept' => '*/*' } clnt.get_content(uri, query, extheader) extheader = [['Accept', 'image/jpeg'], ['Accept', 'image/png']] clnt.get_content(uri, query, extheader)
See head_async, get_async, post_async, put_async, delete_async, options_async, propfind_async, proppatch_async, and trace_async. It immediately returns a HTTPClient::Connection instance as a returning value.
connection = clnt.post_async(url, body) print 'posting.' while true break if connection.finished? print '.' sleep 1 end puts '.' res = connection.pop p res.status p res.content.read # res.content is an IO for the res of async method.
You can invoke get_content, get, etc. without creating HTTPClient instance.
ruby -rhttpclient -e 'puts HTTPClient.get_content(ARGV.shift)' http://dev.ctor.org/ ruby -rhttpclient -e 'p HTTPClient.head(ARGV.shift).header["last-modified"]' http://dev.ctor.org/
NTLMEnabled | = | true | ||
NTLMEnabled | = | false | ||
SSPIEnabled | = | true | ||
SSPIEnabled | = | false | ||
SSLEnabled | = | true | ||
SSLEnabled | = | false | ||
VERSION | = | '2.1.5' | ||
RUBY_VERSION_STRING | = | "ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]" | ||
LIB_NAME | = | "(#{$1}/#{$2}, #{RUBY_VERSION_STRING})" | ||
PROPFIND_DEFAULT_EXTHEADER | = | { 'Depth' => '0' } | Default extheader for PROPFIND request. | |
NO_PROXY_HOSTS | = | ['localhost'] |
cookie_manager | [RW] |
|
||
follow_redirect_count | [RW] | How many times get_content and post_content follows HTTP redirect. 10 by default. | ||
proxy_auth | [R] |
|
||
request_filter | [R] | An array of request filter which can trap HTTP request/response. See HTTPClient::WWWAuth to see how to use it. | ||
ssl_config | [R] |
|
||
test_loopback_response | [R] | An array of response HTTP message body String which is used for loop-back test. See test/* to see how to use it. If you want to do loop-back test of HTTP header, use test_loopback_http_response instead. | ||
www_auth | [R] |
|
Creates a HTTPClient instance which manages sessions, cookies, etc.
HTTPClient.new takes 3 optional arguments for proxy url string, User-Agent String and From header String. User-Agent and From are embedded in HTTP request Header if given. No User-Agent and From header added without setting it explicitly.
proxy = 'http://myproxy:8080' agent_name = 'MyAgent/0.1' from = 'from@example.com' HTTPClient.new(proxy, agent_name, from)
You can use a keyword argument style Hash. Keys are :proxy, :agent_name and :from.
HTTPClient.new(:agent_name = 'MyAgent/0.1')
Sets debug device. Once debug device is set, all HTTP requests and responses are dumped to given device. dev must respond to << for dump.
Calling this method resets all existing sessions.
A default method for redirect uri callback. This method is used by HTTPClient instance by default. This callback allows relative redirect such as
Location: ../foo/
in HTTP header.
Sends DELETE request in async style. See request_async for arguments. It immediately returns a HTTPClient::Connection instance as a result.
Sends GET request in async style. See request_async for arguments. It immediately returns a HTTPClient::Connection instance as a result.
Retrieves a web resource.
uri: | a String or an URI object which represents an URL of web resource. |
query: | a Hash or an Array of query part of URL. e.g. { "a" =>
"b" } => ‘host/part?a=b’. Give an array to pass
multiple value like
|
extheader: | a Hash or an Array of extra headers. e.g. { ‘Accept’ => ’*/*’ } or [[‘Accept’, ‘image/jpeg’], [‘Accept’, ‘image/png’]]. |
&block: | Give a block to get chunked message-body of response like get_content(uri) { |chunked_body| … }. Size of each chunk may not be the same. |
get_content follows HTTP redirect status (see HTTP::Status.redirect?) internally and try to retrieve content from redirected URL. See redirect_uri_callback= how HTTP redirection is handled.
If you need to get full HTTP response including HTTP status and headers, use get method. get returns HTTP::Message as a response and you need to follow HTTP redirect by yourself if you need.
Sends HEAD request in async style. See request_async for arguments. It immediately returns a HTTPClient::Connection instance as a result.
Sets NO_PROXY setting String. no_proxy must be a comma separated String. Each entry must be ‘host’ or ‘host:port’ such as; HTTPClient#no_proxy = ‘example.com,example.co.jp:443‘
‘localhost’ is treated as a no_proxy site regardless of explicitly listed. HTTPClient checks given URI objects before accessing it. ‘host’ is tail string match. No IP-addr conversion.
You can use environment variable ‘no_proxy’ or ‘NO_PROXY’ for it.
Calling this method resets all existing sessions.
Sends OPTIONS request in async style. See request_async for arguments. It immediately returns a HTTPClient::Connection instance as a result.
Sends POST request in async style. See request_async for arguments. It immediately returns a HTTPClient::Connection instance as a result.
Posts a content.
uri: | a String or an URI object which represents an URL of web resource. |
body: | a Hash or an Array of body part. e.g. { "a" => "b" }
=> ‘a=b’. Give an array to pass multiple value like
When you pass a File as a value, it will be posted as a multipart/form-data. e.g. { ‘upload’ => file } |
extheader: | a Hash or an Array of extra headers. e.g. { ‘Accept’ => ’*/*’ } or [[‘Accept’, ‘image/jpeg’], [‘Accept’, ‘image/png’]]. |
&block: | Give a block to get chunked message-body of response like post_content(uri) { |chunked_body| … }. Size of each chunk may not be the same. |
post_content follows HTTP redirect status (see HTTP::Status.redirect?) internally and try to post the content to redirected URL. See redirect_uri_callback= how HTTP redirection is handled.
If you need to get full HTTP response including HTTP status and headers, use post method.
Sends PROPFIND request in async style. See request_async for arguments. It immediately returns a HTTPClient::Connection instance as a result.
Sends PROPPATCH request in async style. See request_async for arguments. It immediately returns a HTTPClient::Connection instance as a result.
Sets HTTP proxy used for HTTP connection. Given proxy can be an URI, a String or nil. You can set user/password for proxy authentication like HTTPClient#proxy = ‘user:passwd@myproxy:8080‘
You can use environment variable ‘http_proxy’ or ‘HTTP_PROXY’ for it. You need to use ‘cgi_http_proxy’ or ‘CGI_HTTP_PROXY’ instead if you run HTTPClient from CGI environment from security reason. (HTTPClient checks ‘REQUEST_METHOD’ environment variable whether it‘s CGI or not)
Calling this method resets all existing sessions.
Sends PUT request in async style. See request_async for arguments. It immediately returns a HTTPClient::Connection instance as a result.
Sets callback proc when HTTP redirect status is returned for get_content and post_content. default_redirect_uri_callback is used by default.
If you need strict implementation which does not allow relative URI redirection, set strict_redirect_uri_callback instead.
clnt.redirect_uri_callback = clnt.method(:strict_redirect_uri_callback)
Sends a request to the specified URL.
method: | HTTP method to be sent. method.to_s.upcase is used. |
uri: | a String or an URI object which represents an URL of web resource. |
query: | a Hash or an Array of query part of URL. e.g. { "a" =>
"b" } => ‘host/part?a=b’ Give an array to pass
multiple value like
|
body: | a Hash or an Array of body part. e.g. { "a" => "b" }
=> ‘a=b’. Give an array to pass multiple value like
When the given method is ‘POST’ and the given body contains a file as a value, it will be posted as a multipart/form-data. e.g. { ‘upload’ => file } See HTTP::Message.file? for actual condition of ‘a file’. |
extheader: | a Hash or an Array of extra headers. e.g. { ‘Accept’ => ’*/*’ } or [[‘Accept’, ‘image/jpeg’], [‘Accept’, ‘image/png’]]. |
&block: | Give a block to get chunked message-body of response like get(uri) { |chunked_body| … }. Size of each chunk may not be the same. |
You can also pass a String as a body. HTTPClient just sends a String as a HTTP request message body.
When you pass an IO as a body, HTTPClient sends it as a HTTP request with chunked encoding (Transfer-Encoding: chunked in HTTP header). Bear in mind that some server application does not support chunked request. At least cgi.rb does not support it.
Resets internal session for the given URL. Keep-alive connection for the site (host-port pair) is disconnected if exists.
Try to save Cookies to the file specified in set_cookie_store. Unexpected error will be raised if you don‘t call set_cookie_store first. (interface mismatch between WebAgent::CookieManager implementation)
Sets credential for Web server authentication.
domain: | a String or an URI to specify where HTTPClient should use this |
credential. If you set uri to nil, HTTPClient uses this credential wherever a server requires it.
user: | username String. |
passwd: | password String. |
You can set multiple credentials for each uri.
clnt.set_auth('http://www.example.com/foo/', 'foo_user', 'passwd') clnt.set_auth('http://www.example.com/bar/', 'bar_user', 'passwd')
Calling this method resets all existing sessions.
Sets the filename where non-volatile Cookies be saved by calling save_cookie_store. This method tries to load and managing Cookies from the specified file.
Calling this method resets all existing sessions.
Sets credential for Proxy authentication.
user: | username String. |
passwd: | password String. |
Calling this method resets all existing sessions.
A method for redirect uri callback. How to use:
clnt.redirect_uri_callback = clnt.method(:strict_redirect_uri_callback)
This callback does not allow relative redirect such as
Location: ../foo/
in HTTP header. (raises BadResponseError instead)
Sends TRACE request in async style. See request_async for arguments. It immediately returns a HTTPClient::Connection instance as a result.