Class: HTTPClient

Inherits:
Object
  • Object
show all
Includes:
Util
Defined in:
lib/httpclient.rb,
lib/httpclient/auth.rb,
lib/httpclient/util.rb,
lib/httpclient/session.rb,
lib/httpclient/timeout.rb,
lib/httpclient/connection.rb,
lib/httpclient/ssl_config.rb

Overview

:main:HTTPClient 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

How to use

At first, how to create your client. See initialize for more detail.

  1. Create simple client.

    clnt = HTTPClient.new

  2. Accessing resources through HTTP proxy. You can use environment variable ‘http_proxy’ or ‘HTTP_PROXY’ instead.

    clnt = HTTPClient.new('http://myproxy:8080')

How to retrieve web resources

See get_content.

  1. Get content of specified URL. It returns a String of whole result.

    puts clnt.get_content('http://dev.ctor.org/')

  2. Get content as chunks of String. It yields chunks of String.

    clnt.get_content('http://dev.ctor.org/') do |chunk|
  puts chunk
end

Invoking other HTTP methods

See head, get, post, put, delete, options, propfind, proppatch and trace.

It returns a HTTP::Message instance as a response.

  1. Do HEAD request.

    res = clnt.head(uri)
p res.header['Last-Modified'][0]

  2. Do GET request with query.

    query = { 'keyword' => 'ruby', 'lang' => 'en' }
res = clnt.get(uri, query)
p res.status
p res.contenttype
p res.header['X-Custom']
puts res.content

How to POST

See post.

  1. Do POST a form data.

    body = { 'keyword' => 'ruby', 'lang' => 'en' }
res = clnt.post(uri, body)

  2. Do multipart file upload with POST. No need to set extra header by yourself from httpclient/2.1.4.

    File.open('/tmp/post_data') do |file|
  body = { 'upload' => file, 'user' => 'nahi' }
  res = clnt.post(uri, body)
end

  3. Do multipart wth custom body.

    File.open('/tmp/post_data') do |file|
  body = [{ 'Content-Type' => 'application/atom+xml; charset=UTF-8',
            :content => '<entry>...</entry>' },
          { 'Content-Type' => 'video/mp4',
            'Content-Transfer-Encoding' => 'binary',
            :content => file }]
  res = clnt.post(uri, body)
end

Accessing via SSL

Ruby needs to be compiled with OpenSSL.

  1. Get content of specified URL via SSL. Just pass an URL which starts with ‘https://’.

    https_url = 'https://www.rsa.com'
clnt.get_content(https_url)

  2. Getting peer certificate from response.

    res = clnt.get(https_url)
p res.peer_cert #=> returns OpenSSL::X509::Certificate

  3. Configuring OpenSSL options. See HTTPClient::SSLConfig for more details.

    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)

Handling Cookies

  1. Using volatile Cookies. Nothing to do. HTTPClient handles Cookies.

    clnt = HTTPClient.new
clnt.get_content(url1) # receives Cookies.
clnt.get_content(url2) # sends Cookies if needed.

  2. Saving non volatile Cookies to a specified file. Need to set a file at first and invoke save method at last.

    clnt = HTTPClient.new
clnt.set_cookie_store('/home/nahi/cookie.dat')
clnt.get_content(url)
...
clnt.save_cookie_store

  3. Disabling Cookies.

    clnt = HTTPClient.new
clnt.cookie_manager = nil

Configuring authentication credentials

  1. Authentication with Web server. Supports BasicAuth, DigestAuth, and Negotiate/NTLM (requires ruby/ntlm module).

    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

  2. Authentication with Proxy server. Supports BasicAuth and NTLM (requires win32/sspi)

    clnt = HTTPClient.new(proxy)
user = 'proxy'
password = 'proxy'
clnt.set_proxy_auth(user, password)
p clnt.get_content(url)

Invoking HTTP methods with custom header

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)

Invoking HTTP methods asynchronously

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.

Shortcut methods

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/

Direct Known Subclasses

HTTPAccess2::Client, OAuthClient

Defined Under Namespace

Modules: DebugSocket, SocketWrap, Timeout, Util Classes: AuthFilterBase, BadResponseError, BasicAuth, ConfigurationError, ConnectTimeoutError, Connection, DigestAuth, KeepAliveDisconnected, LoopBackSocket, NegotiateAuth, OAuth, ProxyAuth, ReceiveTimeoutError, RetryableResponse, SSLConfig, SSLSocketWrap, SSPINegotiateAuth, SendTimeoutError, Session, SessionManager, Site, TimeoutError, TimeoutScheduler, WWWAuth

Constant Summary collapse

VERSION = 
'2.1.7.1'
RUBY_VERSION_STRING = 
"ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
LIB_NAME = 
"(#{$1}/#{$2}, #{RUBY_VERSION_STRING})"
PROPFIND_DEFAULT_EXTHEADER =

Default extheader for PROPFIND request.

{ 'Depth' => '0' }

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Util

#force_binary, hash_find_value, #https?, #keyword_argument, uri_dirname, uri_part_of, #urify

Constructor Details

#initialize(*args) ⇒ HTTPClient

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 = '[email protected]'
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')



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/httpclient.rb', line 355

def initialize(*args)
  proxy, agent_name, from = keyword_argument(args, :proxy, :agent_name, :from)
  @proxy = nil        # assigned later.
  @no_proxy = nil
  @www_auth = WWWAuth.new
  @proxy_auth = ProxyAuth.new
  @request_filter = [@proxy_auth, @www_auth]
  @debug_dev = nil
  @redirect_uri_callback = method(:default_redirect_uri_callback)
  @test_loopback_response = []
  @session_manager = SessionManager.new(self)
  @session_manager.agent_name = agent_name
  @session_manager.from = from
  @session_manager.ssl_config = @ssl_config = SSLConfig.new(self)
  @cookie_manager = WebAgent::CookieManager.new
  @follow_redirect_count = 10
  load_environment
  self.proxy = proxy if proxy
end

Instance Attribute Details

WebAgent::CookieManager

Cookies configurator.



295
296
297
 
# File 'lib/httpclient.rb', line 295

def cookie_manager
  @cookie_manager
end

#follow_redirect_count ⇒ Object

How many times get_content and post_content follows HTTP redirect. 10 by default.



309
310
311
 
# File 'lib/httpclient.rb', line 309

def follow_redirect_count
  @follow_redirect_count
end

#proxy_auth ⇒ Object (readonly)

HTTPClient::ProxyAuth

Proxy authentication handler.



304
305
306
 
# File 'lib/httpclient.rb', line 304

def proxy_auth
  @proxy_auth
end

#request_filter ⇒ Object (readonly)

An array of request filter which can trap HTTP request/response. See HTTPClient::WWWAuth to see how to use it.



302
303
304
 
# File 'lib/httpclient.rb', line 302

def request_filter
  @request_filter
end

#ssl_config ⇒ Object (readonly)

HTTPClient::SSLConfig

SSL configurator.



293
294
295
 
# File 'lib/httpclient.rb', line 293

def ssl_config
  @ssl_config
end

#test_loopback_response ⇒ Object (readonly)

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.



299
300
301
 
# File 'lib/httpclient.rb', line 299

def test_loopback_response
  @test_loopback_response
end

#www_auth ⇒ Object (readonly)

HTTPClient::WWWAuth

WWW authentication handler.



306
307
308
 
# File 'lib/httpclient.rb', line 306

def www_auth
  @www_auth
end

Class Method Details

.timeout_scheduler ⇒ Object

CAUTION: caller must aware of race condition.



115
116
117
 
# File 'lib/httpclient/timeout.rb', line 115

def timeout_scheduler
  @timeout_scheduler ||= TimeoutScheduler.new
end

Instance Method Details

#debug_dev ⇒ Object

Returns debug device if exists. See debug_dev=.



376
377
378
 
# File 'lib/httpclient.rb', line 376

def debug_dev
  @debug_dev
end

#debug_dev=(dev) ⇒ Object

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.



384
385
386
387
388
 
# File 'lib/httpclient.rb', line 384

def debug_dev=(dev)
  @debug_dev = dev
  reset_all
  @session_manager.debug_dev = dev
end

#default_redirect_uri_callback(uri, res) ⇒ Object

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.



593
594
595
596
597
598
599
600
601
602
603
604
605
 
# File 'lib/httpclient.rb', line 593

def default_redirect_uri_callback(uri, res)
  newuri = URI.parse(res.header['location'][0])
  unless newuri.is_a?(URI::HTTP)
    newuri = uri + newuri
    STDERR.puts("could be a relative URI in location header which is not recommended")
    STDERR.puts("'The field value consists of a single absolute URI' in HTTP spec")
  end
  if https?(uri) && !https?(newuri)
    raise BadResponseError.new("redirecting to non-https resource")
  end
  puts "redirect to: #{newuri}" if $DEBUG
  newuri
end

#delete(uri, extheader = {}, &block) ⇒ Object

Sends DELETE request to the specified URL. See request for arguments.



628
629
630
 
# File 'lib/httpclient.rb', line 628

def delete(uri, extheader = {}, &block)
  request(:delete, uri, nil, nil, extheader, &block)
end

#delete_async(uri, extheader = {}) ⇒ Object

Sends DELETE request in async style. See request_async for arguments. It immediately returns a HTTPClient::Connection instance as a result.



726
727
728
 
# File 'lib/httpclient.rb', line 726

def delete_async(uri, extheader = {})
  request_async(:delete, uri, nil, nil, extheader)
end

#get(uri, query = nil, extheader = {}, &block) ⇒ Object

Sends GET request to the specified URL. See request for arguments.



613
614
615
 
# File 'lib/httpclient.rb', line 613

def get(uri, query = nil, extheader = {}, &block)
  request(:get, uri, query, nil, extheader, &block)
end

#get_async(uri, query = nil, extheader = {}) ⇒ Object

Sends GET request in async style. See request_async for arguments. It immediately returns a HTTPClient::Connection instance as a result.



708
709
710
 
# File 'lib/httpclient.rb', line 708

def get_async(uri, query = nil, extheader = {})
  request_async(:get, uri, query, nil, extheader)
end

#get_content(uri, query = nil, extheader = {}, &block) ⇒ Object

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

[“a”, “b”], [“a”, “c”]

> ‘host/part?a=b&a=c’.

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.



533
534
535
 
# File 'lib/httpclient.rb', line 533

def get_content(uri, query = nil, extheader = {}, &block)
  follow_redirect(:get, uri, query, nil, extheader, &block).content
end

#head(uri, query = nil, extheader = {}) ⇒ Object

Sends HEAD request to the specified URL. See request for arguments.



608
609
610
 
# File 'lib/httpclient.rb', line 608

def head(uri, query = nil, extheader = {})
  request(:head, uri, query, nil, extheader)
end

#head_async(uri, query = nil, extheader = {}) ⇒ Object

Sends HEAD request in async style. See request_async for arguments. It immediately returns a HTTPClient::Connection instance as a result.



702
703
704
 
# File 'lib/httpclient.rb', line 702

def head_async(uri, query = nil, extheader = {})
  request_async(:head, uri, query, nil, extheader)
end

#no_proxy ⇒ Object

Returns NO_PROXY setting String if given.



426
427
428
 
# File 'lib/httpclient.rb', line 426

def no_proxy
  @no_proxy
end

#no_proxy=(no_proxy) ⇒ Object

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.



441
442
443
444
 
# File 'lib/httpclient.rb', line 441

def no_proxy=(no_proxy)
  @no_proxy = no_proxy
  reset_all
end

#options(uri, extheader = {}, &block) ⇒ Object

Sends OPTIONS request to the specified URL. See request for arguments.



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

def options(uri, extheader = {}, &block)
  request(:options, uri, nil, nil, extheader, &block)
end

#options_async(uri, extheader = {}) ⇒ Object

Sends OPTIONS request in async style. See request_async for arguments. It immediately returns a HTTPClient::Connection instance as a result.



732
733
734
 
# File 'lib/httpclient.rb', line 732

def options_async(uri, extheader = {})
  request_async(:options, uri, nil, nil, extheader)
end

#post(uri, body = '', extheader = {}, &block) ⇒ Object

Sends POST request to the specified URL. See request for arguments.



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

def post(uri, body = '', extheader = {}, &block)
  request(:post, uri, nil, body, extheader, &block)
end

#post_async(uri, body = nil, extheader = {}) ⇒ Object

Sends POST request in async style. See request_async for arguments. It immediately returns a HTTPClient::Connection instance as a result.



714
715
716
 
# File 'lib/httpclient.rb', line 714

def post_async(uri, body = nil, extheader = {})
  request_async(:post, uri, nil, body, extheader)
end

#post_content(uri, body = nil, extheader = {}, &block) ⇒ Object

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

[["a", "b"], ["a", "c"]] => 'a=b&a=c'

When you pass a File as a value, it will be posted as a multipart/form-data. e.g.

{ 'upload' => file }

You can also send custom multipart by passing an array of hashes. Each part must have a :content attribute which can be a file, all other keys will become headers.

[{ 'Content-Type' => 'text/plain', :content => "some text" },
 { 'Content-Type' => 'video/mp4', :content => File.new('video.mp4') }]
=> <Two parts with custom Content-Type header>
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.



567
568
569
 
# File 'lib/httpclient.rb', line 567

def post_content(uri, body = nil, extheader = {}, &block)
  follow_redirect(:post, uri, nil, body, extheader, &block).content
end

#propfind(uri, extheader = PROPFIND_DEFAULT_EXTHEADER, &block) ⇒ Object

Sends PROPFIND request to the specified URL. See request for arguments.



638
639
640
 
# File 'lib/httpclient.rb', line 638

def propfind(uri, extheader = PROPFIND_DEFAULT_EXTHEADER, &block)
  request(:propfind, uri, nil, nil, extheader, &block)
end

#propfind_async(uri, extheader = PROPFIND_DEFAULT_EXTHEADER) ⇒ Object

Sends PROPFIND request in async style. See request_async for arguments. It immediately returns a HTTPClient::Connection instance as a result.



738
739
740
 
# File 'lib/httpclient.rb', line 738

def propfind_async(uri, extheader = PROPFIND_DEFAULT_EXTHEADER)
  request_async(:propfind, uri, nil, nil, extheader)
end

#proppatch(uri, body = nil, extheader = {}, &block) ⇒ Object

Sends PROPPATCH request to the specified URL. See request for arguments.



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

def proppatch(uri, body = nil, extheader = {}, &block)
  request(:proppatch, uri, nil, body, extheader, &block)
end

#proppatch_async(uri, body = nil, extheader = {}) ⇒ Object

Sends PROPPATCH request in async style. See request_async for arguments. It immediately returns a HTTPClient::Connection instance as a result.



744
745
746
 
# File 'lib/httpclient.rb', line 744

def proppatch_async(uri, body = nil, extheader = {})
  request_async(:proppatch, uri, nil, body, extheader)
end

#proxy ⇒ Object

Returns URI object of HTTP proxy if exists.



391
392
393
 
# File 'lib/httpclient.rb', line 391

def proxy
  @proxy
end

#proxy=(proxy) ⇒ Object

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.



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/httpclient.rb', line 405

def proxy=(proxy)
  if proxy.nil?
    @proxy = nil
    @proxy_auth.reset_challenge
  else
    @proxy = urify(proxy)
    if @proxy.scheme == nil or @proxy.scheme.downcase != 'http' or
        @proxy.host == nil or @proxy.port == nil
      raise ArgumentError.new("unsupported proxy #{proxy}")
    end
    @proxy_auth.reset_challenge
    if @proxy.user || @proxy.password
      @proxy_auth.set_auth(@proxy.user, @proxy.password)
    end
  end
  reset_all
  @session_manager.proxy = @proxy
  @proxy
end

#put(uri, body = '', extheader = {}, &block) ⇒ Object

Sends PUT request to the specified URL. See request for arguments.



623
624
625
 
# File 'lib/httpclient.rb', line 623

def put(uri, body = '', extheader = {}, &block)
  request(:put, uri, nil, body, extheader, &block)
end

#put_async(uri, body = nil, extheader = {}) ⇒ Object

Sends PUT request in async style. See request_async for arguments. It immediately returns a HTTPClient::Connection instance as a result.



720
721
722
 
# File 'lib/httpclient.rb', line 720

def put_async(uri, body = nil, extheader = {})
  request_async(:put, uri, nil, body, extheader)
end

#redirect_uri_callback=(redirect_uri_callback) ⇒ Object

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)



508
509
510
 
# File 'lib/httpclient.rb', line 508

def redirect_uri_callback=(redirect_uri_callback)
  @redirect_uri_callback = redirect_uri_callback
end

#request(method, uri, query = nil, body = nil, extheader = {}, &block) ⇒ Object

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

[“a”, “b”], [“a”, “c”]

> ‘host/part?a=b&a=c’

body

a Hash or an Array of body part. e.g.

{ "a" => "b" }
=> 'a=b'

Give an array to pass multiple value like

[["a", "b"], ["a", "c"]]
=> 'a=b&a=c'.

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 }

You can also send custom multipart by passing an array of hashes. Each part must have a :content attribute which can be a file, all other keys will become headers.

[{ 'Content-Type' => 'text/plain', :content => "some text" },
 { 'Content-Type' => 'video/mp4', :content => File.new('video.mp4') }]
=> <Two parts with custom Content-Type header>

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.



690
691
692
693
694
695
696
697
698
 
# File 'lib/httpclient.rb', line 690

def request(method, uri, query = nil, body = nil, extheader = {}, &block)
  uri = urify(uri)
  if block
    filtered_block = proc { |res, str|
      block.call(str)
    }
  end
  do_request(method, uri, query, body, extheader, &filtered_block)
end

#request_async(method, uri, query = nil, body = nil, extheader = {}) ⇒ Object

Sends a request in async style. request method creates new Thread for HTTP connection and returns a HTTPClient::Connection instance immediately.

Arguments definition is the same as request.



758
759
760
761
 
# File 'lib/httpclient.rb', line 758

def request_async(method, uri, query = nil, body = nil, extheader = {})
  uri = urify(uri)
  do_request_async(method, uri, query, body, extheader)
end

#reset(uri) ⇒ Object

Resets internal session for the given URL. Keep-alive connection for the site (host-port pair) is disconnected if exists.



765
766
767
768
 
# File 'lib/httpclient.rb', line 765

def reset(uri)
  uri = urify(uri)
  @session_manager.reset(uri)
end

#reset_all ⇒ Object

Resets all of internal sessions. Keep-alive connections are disconnected.



771
772
773
 
# File 'lib/httpclient.rb', line 771

def reset_all
  @session_manager.reset_all
end

#save_cookie_store ⇒ Object

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)



496
497
498
 
# File 'lib/httpclient.rb', line 496

def save_cookie_store
  @cookie_manager.save_cookies
end

#set_auth(domain, user, passwd) ⇒ Object

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.



459
460
461
462
463
 
# File 'lib/httpclient.rb', line 459

def set_auth(domain, user, passwd)
  uri = urify(domain)
  @www_auth.set_auth(uri, user, passwd)
  reset_all
end

#set_basic_auth(domain, user, passwd) ⇒ Object

Deprecated. Use set_auth instead.



466
467
468
469
470
 
# File 'lib/httpclient.rb', line 466

def set_basic_auth(domain, user, passwd)
  uri = urify(domain)
  @www_auth.basic_auth.set(uri, user, passwd)
  reset_all
end

#set_cookie_store(filename) ⇒ Object

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.



487
488
489
490
491
 
# File 'lib/httpclient.rb', line 487

def set_cookie_store(filename)
  @cookie_manager.cookies_file = filename
  @cookie_manager.load_cookies if filename
  reset_all
end

#set_proxy_auth(user, passwd) ⇒ Object

Sets credential for Proxy authentication.

user

username String.

passwd

password String.

Calling this method resets all existing sessions.



477
478
479
480
 
# File 'lib/httpclient.rb', line 477

def set_proxy_auth(user, passwd)
  @proxy_auth.set_auth(user, passwd)
  reset_all
end

#strict_redirect_uri_callback(uri, res) ⇒ Object

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)



576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/httpclient.rb', line 576

def strict_redirect_uri_callback(uri, res)
  newuri = URI.parse(res.header['location'][0])
  if https?(uri) && !https?(newuri)
    raise BadResponseError.new("redirecting to non-https resource")
  end
  unless newuri.is_a?(URI::HTTP)
    raise BadResponseError.new("unexpected location: #{newuri}", res)
  end
  puts "redirect to: #{newuri}" if $DEBUG
  newuri
end

#trace(uri, query = nil, body = nil, extheader = {}, &block) ⇒ Object

Sends TRACE request to the specified URL. See request for arguments.



648
649
650
 
# File 'lib/httpclient.rb', line 648

def trace(uri, query = nil, body = nil, extheader = {}, &block)
  request('TRACE', uri, query, body, extheader, &block)
end

#trace_async(uri, query = nil, body = nil, extheader = {}) ⇒ Object

Sends TRACE request in async style. See request_async for arguments. It immediately returns a HTTPClient::Connection instance as a result.



750
751
752
 
# File 'lib/httpclient.rb', line 750

def trace_async(uri, query = nil, body = nil, extheader = {})
  request_async(:trace, uri, query, body, extheader)
end