httpclient 2.5.1 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2df4838bec1aba63f3823f9073278dd1ca98154
-  data.tar.gz: 13f5b992074f28118e5ed7c718af8b1454d0b6c3
+  metadata.gz: 96ac0d88857cdda17631e5d2f8d5055854324813
+  data.tar.gz: d481af07b3a540d43044a9065e47ea177d5f3aa7
 SHA512:
-  metadata.gz: 733c0562e2187daa398245e2e7095e845d141653beef44f7064cb08696f1352c3718364638bc33aaa147962bd093a3bf85c04c4593938988da214e34a00d39d7
-  data.tar.gz: 648e04e4c278634072da5f3cb7a4deb0708307c6631ba7c9983fb5b5bd499a9555caa1d1bdd0b17bc7691a9362232367f17e7ef4a847044336aacdb375434eeb
+  metadata.gz: fd7ee572d2081458053de5bcd27408848067abc83dfbf8be88b78740bac06692a504eaf16a0418e47ea1555170825a4740505581b3ddc24706f557ef1f2bc3a1
+  data.tar.gz: cd0a8f4fa967737b90d40bd073e0f0c7e264d2e1b5873342337abc3dc32caa9884e597d40675753d6458472f05cc560380aa955b1af62c9672013c71bf16cce8

data/lib/httpclient.rb

@@ -324,6 +324,8 @@ class HTTPClient
   # How many times get_content and post_content follows HTTP redirect.
   # 10 by default.
   attr_accessor :follow_redirect_count
+  # Base url of resources.
+  attr_accessor :base_url
 
   # Set HTTP version as a String:: 'HTTP/1.0' or 'HTTP/1.1'
   attr_proxy(:protocol_version, true)
@@ -362,27 +364,36 @@ class 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.
+  # HTTPClient.new takes optional arguments as a Hash.
+  #  * :proxy - proxy url string
+  #  * :agent_name - User-Agent String
+  #  * :from - from header String
+  #  * :base_url - base URL of resources
+  #  * :force_basic_auth - flag for sending Authorization header w/o gettin 401 first
+  # User-Agent and From are embedded in HTTP request Header if given.
+  # From header is not set 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.
+  # After you set base_url, all resources you pass to get, post and other
+  # methods are recognized to be prefixed with base_url. Say base_url is
+  # 'https://api.example.com/v1, get('/users') is the same as
+  # get('https://api.example.com/v1/users') internally. You can also pass
+  # full URL from 'http://' even after setting base_url.
   #
-  #   HTTPClient.new(:agent_name => 'MyAgent/0.1')
   def initialize(*args)
-    proxy, agent_name, from = keyword_argument(args, :proxy, :agent_name, :from)
+    proxy, agent_name, from, base_url, force_basic_auth =
+      keyword_argument(args, :proxy, :agent_name, :from, :base_url, :force_basic_auth)
     @proxy = nil        # assigned later.
     @no_proxy = nil
     @no_proxy_regexps = []
+    @base_url = base_url
     @www_auth = WWWAuth.new
     @proxy_auth = ProxyAuth.new
+    @www_auth.basic_auth.force_auth = @proxy_auth.basic_auth.force_auth = force_basic_auth
     @request_filter = [@proxy_auth, @www_auth]
     @debug_dev = nil
     @redirect_uri_callback = method(:default_redirect_uri_callback)
@@ -509,14 +520,14 @@ class HTTPClient
   #
   # Calling this method resets all existing sessions.
   def set_auth(domain, user, passwd)
-    uri = urify(domain)
+    uri = to_resource_url(domain)
     @www_auth.set_auth(uri, user, passwd)
     reset_all
   end
 
   # Deprecated.  Use set_auth instead.
   def set_basic_auth(domain, user, passwd)
-    uri = urify(domain)
+    uri = to_resource_url(domain)
     @www_auth.basic_auth.set(uri, user, passwd)
     reset_all
   end
@@ -531,6 +542,14 @@ class HTTPClient
     reset_all
   end
 
+  # Turn on/off the BasicAuth force flag. Generally HTTP client must
+  # send Authorization header after it gets 401 error from server from
+  # security reason. But in some situation (e.g. API client) you might
+  # want to send Authorization from the beginning.
+  def force_basic_auth=(force_basic_auth)
+    @www_auth.basic_auth.force_auth = @proxy_auth.basic_auth.force_auth = force_basic_auth
+  end
+
   # 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.
@@ -778,7 +797,7 @@ class HTTPClient
     else
       header ||= {}
     end
-    uri = urify(uri)
+    uri = to_resource_url(uri)
     if block
       if block.arity == 1
         filtered_block = proc { |res, str|
@@ -798,15 +817,13 @@ class HTTPClient
   # Sends HEAD request in async style.  See request_async for arguments.
   # It immediately returns a HTTPClient::Connection instance as a result.
   def head_async(uri, *args)
-    query, header = keyword_argument(args, :query, :header)
-    request_async(:head, uri, query, nil, header || {})
+    request_async2(:head, uri, argument_to_hash(args, :query, :header))
   end
 
   # Sends GET request in async style.  See request_async for arguments.
   # It immediately returns a HTTPClient::Connection instance as a result.
   def get_async(uri, *args)
-    query, header = keyword_argument(args, :query, :header)
-    request_async(:get, uri, query, nil, header || {})
+    request_async2(:get, uri, argument_to_hash(args, :query, :header))
   end
 
   # Sends POST request in async style.  See request_async for arguments.
@@ -866,7 +883,7 @@ class HTTPClient
   #
   # Arguments definition is the same as request.
   def request_async(method, uri, query = nil, body = nil, header = {})
-    uri = urify(uri)
+    uri = to_resource_url(uri)
     do_request_async(method, uri, query, body, header)
   end
 
@@ -881,14 +898,14 @@ class HTTPClient
     else
       header ||= {}
     end
-    uri = urify(uri)
+    uri = to_resource_url(uri)
     do_request_async(method, uri, query, body, header)
   end
 
   # Resets internal session for the given URL.  Keep-alive connection for the
   # site (host-port pair) is disconnected if exists.
   def reset(uri)
-    uri = urify(uri)
+    uri = to_resource_url(uri)
     @session_manager.reset(uri)
   end
 
@@ -965,8 +982,8 @@ private
             retry_count -= 1
           end
         end
-      rescue Exception
-        conn.push $!
+      rescue Exception => e
+        conn.push e
       end
     }
     conn.async_thread = t
@@ -992,7 +1009,7 @@ private
   end
 
   def follow_redirect(method, uri, query, body, header, &block)
-    uri = urify(uri)
+    uri = to_resource_url(uri)
     if block
       filtered_block = proc { |r, str|
         block.call(str) if r.ok?
@@ -1201,4 +1218,13 @@ private
   def set_encoding(str, encoding)
     str.force_encoding(encoding) if encoding
   end
+
+  def to_resource_url(uri)
+    u = urify(uri)
+    if @base_url && u.scheme.nil? && u.host.nil?
+      urify(@base_url + uri)
+    else
+      u
+    end
+  end
 end

data/lib/httpclient/auth.rb

@@ -217,6 +217,9 @@ class HTTPClient
     # Authentication scheme.
     attr_reader :scheme
 
+    # Send Authorization Header without receiving 401
+    attr_accessor :force_auth
+
     # Creates new BasicAuth filter.
     def initialize
       super
@@ -224,6 +227,7 @@ class HTTPClient
       @auth = {}
       @challenge = {}
       @scheme = "Basic"
+      @force_auth = false
     end
 
     # Resets challenge state.  Do not send '*Authorization' header until the
@@ -259,7 +263,7 @@ class HTTPClient
     def get(req)
       target_uri = req.header.request_uri
       synchronize {
-        return nil unless @challenge.find { |uri, ok|
+        return nil if !@force_auth and !@challenge.any? { |uri, ok|
           Util.uri_part_of(target_uri, uri) and ok
         }
         return @cred if @cred

data/lib/httpclient/include_client.rb

@@ -36,6 +36,8 @@
 # are also provided. Widget.http_client is identical to Widget.new.http_client
 #
 #
+require 'httpclient'
+
 class HTTPClient
   module IncludeClient
         

data/lib/httpclient/session.rb

@@ -38,8 +38,8 @@ class HTTPClient
     # Creates a new Site based on the given URI.
     def initialize(uri = nil)
       if uri
-        @scheme = uri.scheme
-        @host = uri.hostname
+        @scheme = uri.scheme || 'tcp'
+        @host = uri.hostname || '0.0.0.0'
         @port = uri.port.to_i
       else
         @scheme = 'tcp'
@@ -623,10 +623,10 @@ class HTTPClient
       rescue HTTPClient::TimeoutError
         close
         raise
-      rescue
+      rescue => e
         close
-        if SSLEnabled and $!.is_a?(OpenSSL::SSL::SSLError)
-          raise KeepAliveDisconnected.new(self, $!)
+        if SSLEnabled and e.is_a?(OpenSSL::SSL::SSLError)
+          raise KeepAliveDisconnected.new(self, e)
         else
           raise
         end
@@ -797,13 +797,13 @@ class HTTPClient
       socket = nil
       begin
         @debug_dev << "! CONNECT TO #{site.host}:#{site.port}\n" if @debug_dev
-				clean_host = site.host.delete("[]")
-				clean_local = @socket_local.host.delete("[]")
+        clean_host = site.host.delete("[]")
         if str = @test_loopback_http_response.shift
           socket = LoopBackSocket.new(clean_host, site.port, str)
         elsif @socket_local == Site::EMPTY
           socket = TCPSocket.new(clean_host, site.port)
         else
+          clean_local = @socket_local.host.delete("[]")
           socket = TCPSocket.new(clean_host, site.port, clean_local, @socket_local.port)
         end
         if @debug_dev

data/lib/httpclient/version.rb

@@ -1,3 +1,3 @@
 class HTTPClient
-  VERSION = '2.5.1'
+  VERSION = '2.5.2'
 end

data/test/test_auth.rb

@@ -141,8 +141,10 @@ class TestAuth < Test::Unit::TestCase
     c = HTTPClient.new
     webrick_backup = @basic_auth.instance_eval { @auth_scheme }
     begin
+      # WEBrick in ruby 1.8.7 uses 'BASIC' instead of 'Basic'
       @basic_auth.instance_eval { @auth_scheme = "BASIC" }
       c.www_auth.basic_auth.instance_eval { @scheme = "BASIC" }
+      #
       c.set_auth("http://localhost:#{serverport}/", 'admin', 'admin')
       assert_equal('basic_auth OK', c.get_content("http://localhost:#{serverport}/basic_auth"))
     ensure
@@ -150,6 +152,41 @@ class TestAuth < Test::Unit::TestCase
     end
   end
 
+  def test_BASIC_auth_force
+    c = HTTPClient.new
+    webrick_backup = @basic_auth.instance_eval { @auth_scheme }
+    begin
+      # WEBrick in ruby 1.8.7 uses 'BASIC' instead of 'Basic'
+      @basic_auth.instance_eval { @auth_scheme = "BASIC" }
+      c.www_auth.basic_auth.instance_eval { @scheme = "BASIC" }
+      #
+      c.force_basic_auth = true
+      c.debug_dev = str = ''
+      c.set_auth("http://localhost:#{serverport}/", 'admin', 'admin')
+      assert_equal('basic_auth OK', c.get_content("http://localhost:#{serverport}/basic_auth"))
+      assert_equal('Authorization: Basic YWRtaW46YWRtaW4='.upcase, str.split(/\r?\n/)[5].upcase)
+    ensure
+      @basic_auth.instance_eval { @auth_scheme = webrick_backup }
+    end
+  end
+
+  def test_BASIC_auth_async
+    # async methods don't issure retry call so for successful authentication you need to set force_basic_auth flag
+    c = HTTPClient.new(:force_basic_auth => true)
+    webrick_backup = @basic_auth.instance_eval { @auth_scheme }
+    begin
+      # WEBrick in ruby 1.8.7 uses 'BASIC' instead of 'Basic'
+      @basic_auth.instance_eval { @auth_scheme = "BASIC" }
+      c.www_auth.basic_auth.instance_eval { @scheme = "BASIC" }
+      #
+      c.set_auth("http://localhost:#{serverport}/", 'admin', 'admin')
+      conn = c.get_async("http://localhost:#{serverport}/basic_auth")
+      assert_equal('basic_auth OK', conn.pop.body.read)
+    ensure
+      @basic_auth.instance_eval { @auth_scheme = webrick_backup }
+    end
+  end
+
   def test_BASIC_auth_nil_uri
     c = HTTPClient.new
     webrick_backup = @basic_auth.instance_eval { @auth_scheme }

data/test/test_http-access2.rb

@@ -118,8 +118,8 @@ class TestClient < Test::Unit::TestCase
     escape_noproxy do
       begin
        	@client.proxy = "http://あ"
-      rescue
-        assert_match(/InvalidURIError/, $!.class.to_s)
+      rescue => e
+        assert_match(/InvalidURIError/, e.class.to_s)
       end
       @client.proxy = ""
       assert_nil(@client.proxy)

data/test/test_httpclient.rb

@@ -177,8 +177,8 @@ class TestHTTPClient < Test::Unit::TestCase
     escape_noproxy do
       begin
         @client.proxy = "http://あ"
-      rescue
-        assert_match(/InvalidURIError/, $!.class.to_s)
+      rescue => e
+        assert_match(/InvalidURIError/, e.class.to_s)
       end
       @client.proxy = ""
       assert_nil(@client.proxy)
@@ -554,6 +554,28 @@ EOS
     assert(called)
   end
 
+  def test_get_content_with_base_url
+    @client = HTTPClient.new(:base_url => serverurl[0..-1])
+    assert_equal('hello', @client.get_content('/hello'))
+    assert_equal('hello', @client.get_content('/redirect1'))
+    assert_equal('hello', @client.get_content('/redirect2'))
+    @client.reset('/')
+    assert_raises(HTTPClient::BadResponseError) do
+      @client.get_content('/notfound')
+    end
+    assert_raises(HTTPClient::BadResponseError) do
+      @client.get_content('/redirect_self')
+    end
+    called = false
+    @client.redirect_uri_callback = lambda { |uri, res|
+      newuri = res.header['location'][0]
+      called = true
+      newuri
+    }
+    assert_equal('hello', @client.get_content('/relative_redirect'))
+    assert(called)
+  end
+
   GZIP_CONTENT = "\x1f\x8b\x08\x00\x1a\x96\xe0\x4c\x00\x03\xcb\x48\xcd\xc9\xc9\x07\x00\x86\xa6\x10\x36\x05\x00\x00\x00"
   DEFLATE_CONTENT = "\x78\x9c\xcb\x48\xcd\xc9\xc9\x07\x00\x06\x2c\x02\x15"
   GZIP_CONTENT.force_encoding('BINARY') if GZIP_CONTENT.respond_to?(:force_encoding)
@@ -640,6 +662,21 @@ EOS
     assert_nil(res.contenttype)
   end
 
+  def test_get_with_base_url
+    @client = HTTPClient.new(:base_url => serverurl[0..-1])
+    assert_equal("get", @client.get('/servlet').content)
+    param = {'1'=>'2', '3'=>'4'}
+    res = @client.get('/servlet', param)
+    assert_equal(param, params(res.header["x-query"][0]))
+    assert_nil(res.contenttype)
+    #
+    @client.base_url = serverurl[0..-1] + '/servlet'
+    url = '?5=6&7=8'
+    res = @client.get(url, param)
+    assert_equal(param.merge("5"=>"6", "7"=>"8"), params(res.header["x-query"][0]))
+    assert_nil(res.contenttype)
+  end
+
   def test_head_follow_redirect
     expected = urify(serverurl + 'hello')
     assert_equal(expected, @client.head(serverurl + 'hello', :follow_redirect => true).header.request_uri)
@@ -661,6 +698,22 @@ EOS
     assert_equal(param, params(res.header["x-query"][0]))
   end
 
+  def test_get_async_with_base_url
+    param = {'1'=>'2', '3'=>'4'}
+    @client = HTTPClient.new(:base_url => serverurl)
+
+    # Use preconfigured :base_url
+    conn = @client.get_async('servlet', param)
+    Thread.pass while !conn.finished?
+    res = conn.pop
+    assert_equal(param, params(res.header["x-query"][0]))
+    # full URL still works
+    conn = @client.get_async(serverurl + 'servlet', param)
+    Thread.pass while !conn.finished?
+    res = conn.pop
+    assert_equal(param, params(res.header["x-query"][0]))
+  end
+
   def test_get_async_for_largebody
     conn = @client.get_async(serverurl + 'largebody')
     res = conn.pop

data/test/test_ssl.rb

@@ -230,7 +230,7 @@ private
 
   def setup_server_with_ssl_version(ssl_version)
     logger = Logger.new(STDERR)
-    #logger.level = Logger::Severity::FATAL	# avoid logging SSLError (ERROR level)
+    logger.level = Logger::Severity::FATAL	# avoid logging SSLError (ERROR level)
     @server = WEBrick::HTTPServer.new(
       :BindAddress => "localhost",
       :Logger => logger,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httpclient
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.5.2
 platform: ruby
 authors:
 - Hiroshi Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-18 00:00:00.000000000 Z
+date: 2014-10-28 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: nahi@ruby-lang.org