excon 0.18.5 → 0.19.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    excon (0.18.5)
+    excon (0.19.0)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -106,7 +106,7 @@ Pipelining Requests
 You can make use of HTTP pipelining to improve performance. Insead of the normal request/response cyle, pipelining sends a series of requests and then receives a series of responses. You can take advantage of this using the `requests` method, which takes an array of params where each is a hash like request would receive and returns an array of responses.
 
     connection = Excon.new('http://geemus.com/')
-    connection.requests([{:method => :get, :method => :get}])
+    connection.requests([{:method => :get}, {:method => :get}])
 
 Streaming Responses
 -------------------

data/changelog.txt

@@ -1,3 +1,16 @@
+0.19.0 02/27/2013
+=================
+
+fix requests (pipeline) example in README
+make StubNotFound inherit from StandardError (not Excon::Errors::Error)
+idempotent reimplemented as middleware
+remaining idempotent/instrumentor functionality moved to middleware
+move uri parsing to Excon.new
+allow for configurable URI parser (ie Addressable vs URI)
+move VALID_CONNECTION_KEYS to constants
+move idempotent tests to middleware directory
+fix output of expects middleware to pass response objects instead of hashes
+
 0.18.5 02/22/2013
 =================
 

data/excon.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'excon'
-  s.version           = '0.18.5'
-  s.date              = '2013-02-22'
+  s.version           = '0.19.0'
+  s.date              = '2013-02-27'
   s.rubyforge_project = 'excon'
 
   ## Make sure your summary is short. The description may be as long
@@ -98,6 +98,7 @@ Gem::Specification.new do |s|
     lib/excon/errors.rb
     lib/excon/middlewares/base.rb
     lib/excon/middlewares/expects.rb
+    lib/excon/middlewares/idempotent.rb
     lib/excon/middlewares/instrumentor.rb
     lib/excon/middlewares/mock.rb
     lib/excon/response.rb
@@ -109,7 +110,7 @@ Gem::Specification.new do |s|
     tests/basic_tests.rb
     tests/data/xs
     tests/header_tests.rb
-    tests/idempotent_tests.rb
+    tests/middlewares/idempotent_tests.rb
     tests/middlewares/instrumentation_tests.rb
     tests/middlewares/mock_tests.rb
     tests/proxy_tests.rb

data/lib/excon.rb

@@ -22,8 +22,9 @@ module Excon
         :idempotent         => false,
         :instrumentor_name  => 'excon',
         :middlewares        => [
-          Excon::Middleware::Instrumentor,
           Excon::Middleware::Expects,
+          Excon::Middleware::Idempotent,
+          Excon::Middleware::Instrumentor,
           Excon::Middleware::Mock
         ],
         :mock               => false,
@@ -32,6 +33,7 @@ module Excon
         :retry_limit        => DEFAULT_RETRY_LIMIT,
         :ssl_ca_file        => DEFAULT_CA_FILE,
         :ssl_verify_peer    => RbConfig::CONFIG['host_os'] !~ /mswin|win32|dos|cygwin|mingw/i,
+        :uri_parser         => URI,
         :write_timeout      => 60
       }
     end
@@ -50,6 +52,7 @@ require 'excon/connection'
 require 'excon/errors'
 require 'excon/middlewares/base'
 require 'excon/middlewares/expects'
+require 'excon/middlewares/idempotent'
 require 'excon/middlewares/instrumentor'
 require 'excon/middlewares/mock'
 require 'excon/response'
@@ -106,7 +109,18 @@ module Excon
     #   @param [Hash<Symbol, >] params One or more option params to set on the Connection instance
     #   @return [Connection] A new Excon::Connection instance
     def new(url, params = {})
-      Excon::Connection.new(url, params)
+      uri_parser = params[:uri_parser] || Excon.defaults[:uri_parser]
+      uri = uri_parser.parse(url)
+      params.merge!({
+        :host       => uri.host,
+        :path       => uri.path,
+        :port       => uri.port.to_s,
+        :query      => uri.query,
+        :scheme     => uri.scheme,
+        :user       => (URI.decode(uri.user) if uri.user),
+        :password   => (URI.decode(uri.password) if uri.password),
+      })
+      Excon::Connection.new(params)
     end
 
     # push an additional stub onto the list to check for mock requests

data/lib/excon/connection.rb

@@ -1,10 +1,6 @@
 module Excon
   class Connection
-    VALID_CONNECTION_KEYS = [:body, :family, :headers, :host, :path, :port, :query, :scheme, :user, :password,
-                             :instrumentor, :instrumentor_name, :ssl_ca_file, :ssl_verify_peer, :chunk_size,
-                             :nonblock, :retry_limit, :connect_timeout, :read_timeout, :write_timeout, :captures,
-                             :exception, :expects, :mock, :proxy, :method, :idempotent, :request_block, :response_block,
-                             :middlewares, :retries_remaining, :connection, :stack, :response, :pipeline]
+
     attr_reader :data
 
     def params
@@ -33,7 +29,6 @@ module Excon
     private :assert_valid_keys_for_argument!
 
     # Initializes a new Connection instance
-    #   @param [String] url The destination URL
     #   @param [Hash<Symbol, >] params One or more optional params
     #     @option params [String] :body Default text to be sent over a socket. Only used if :body absent in Connection#request params
     #     @option params [Hash<Symbol, String>] :headers The default headers to supply in a request. Only used if params[:headers] is not supplied to Connection#request
@@ -46,21 +41,14 @@ module Excon
     #     @option params [Fixnum] :retry_limit Set how many times we'll retry a failed request.  (Default 4)
     #     @option params [Class] :instrumentor Responds to #instrument as in ActiveSupport::Notifications
     #     @option params [String] :instrumentor_name Name prefix for #instrument events.  Defaults to 'excon'
-    def initialize(url, params = {})
-      assert_valid_keys_for_argument!(params, VALID_CONNECTION_KEYS)
-      uri = URI.parse(url)
-      @data = Excon.defaults.merge({
-        :host       => uri.host,
-        :path       => uri.path,
-        :port       => uri.port.to_s,
-        :query      => uri.query,
-        :scheme     => uri.scheme,
-        :user       => (URI.decode(uri.user) if uri.user),
-        :password   => (URI.decode(uri.password) if uri.password),
-      }).merge!(params)
+    def initialize(params = {})
+      assert_valid_keys_for_argument!(params, Excon::VALID_CONNECTION_KEYS)
+      @data = Excon.defaults.dup
       # merge does not deep-dup, so make sure headers is not the original
       @data[:headers] = @data[:headers].dup
 
+      @data.merge!(params)
+
       if @data[:scheme] == HTTPS && (ENV.has_key?('https_proxy') || ENV.has_key?('HTTPS_PROXY'))
         @data[:proxy] = setup_proxy(ENV['https_proxy'] || ENV['HTTPS_PROXY'])
       elsif (ENV.has_key?('http_proxy') || ENV.has_key?('HTTP_PROXY'))
@@ -83,14 +71,20 @@ module Excon
       end
 
       # Use Basic Auth if url contains a login
-      if uri.user || uri.password
-        @data[:headers]['Authorization'] ||= 'Basic ' << ['' << uri.user.to_s << ':' << uri.password.to_s].pack('m').delete(Excon::CR_NL)
+      if @data[:user] || @data[:password]
+        @data[:headers]['Authorization'] ||= 'Basic ' << ['' << @data[:user].to_s << ':' << @data[:password].to_s].pack('m').delete(Excon::CR_NL)
       end
 
-      @socket_key = '' << @data[:host] << ':' << @data[:port]
+      @socket_key = '' << @data[:host] << ':' << @data[:port].to_s
       reset
     end
 
+    def error_call(datum)
+      if datum[:error]
+        raise(datum[:error])
+      end
+    end
+
     def request_call(datum)
       begin
         if datum.has_key?(:response)
@@ -210,7 +204,7 @@ module Excon
       datum = @data.merge(params)
       assert_valid_keys_for_argument!(params, VALID_CONNECTION_KEYS)
       datum[:headers] = @data[:headers].merge(datum[:headers] || {})
-      datum[:headers]['Host']   ||= '' << datum[:host] << ':' << datum[:port]
+      datum[:headers]['Host']   ||= '' << datum[:host] << ':' << datum[:port].to_s
       datum[:retries_remaining] ||= datum[:retry_limit]
 
       # if path is empty or doesn't start with '/', insert one
@@ -243,18 +237,9 @@ module Excon
       else
         datum
       end
-    rescue => request_error
-      reset
-      if datum[:idempotent] && [Excon::Errors::Timeout, Excon::Errors::SocketError,
-          Excon::Errors::HTTPStatusError].any? {|ex| request_error.kind_of? ex } && datum[:retries_remaining] > 1
-        datum[:retries_remaining] -= 1
-        request(datum, &block)
-      else
-        if datum.has_key?(:instrumentor)
-          datum[:instrumentor].instrument("#{datum[:instrumentor_name]}.error", :error => request_error)
-        end
-        raise(request_error)
-      end
+    rescue => error
+      datum[:error] = error
+      datum[:stack].error_call(datum)
     end
 
     # Sends the supplied requests to the destination host using pipelining.

data/lib/excon/constants.rb

@@ -29,7 +29,47 @@ module Excon
 
   REDACTED = 'REDACTED'
 
-  VERSION = '0.18.5'
+  VALID_CONNECTION_KEYS = [
+    :body,
+    :captures,
+    :chunk_size,
+    :connect_timeout,
+    :connection,
+    :error,
+    :exception,
+    :expects,
+    :family,
+    :headers,
+    :host,
+    :idempotent,
+    :instrumentor,
+    :instrumentor_name,
+    :method,
+    :middlewares,
+    :mock,
+    :nonblock,
+    :password,
+    :path,
+    :pipeline,
+    :port,
+    :proxy,
+    :query,
+    :read_timeout,
+    :request_block,
+    :response,
+    :response_block,
+    :retries_remaining,
+    :retry_limit,
+    :scheme,
+    :uri_parser,
+    :user,
+    :ssl_ca_file,
+    :ssl_verify_peer,
+    :stack,
+    :write_timeout
+  ]
+
+  VERSION = '0.19.0'
 
   unless ::IO.const_defined?(:WaitReadable)
     class ::IO

data/lib/excon/errors.rb

@@ -2,6 +2,7 @@ module Excon
   module Errors
 
     class Error < StandardError; end
+    class StubNotFound < StandardError; end
 
     class SocketError < Error
       attr_reader :socket_error
@@ -23,8 +24,6 @@ module Excon
 
     class ProxyConnectionError < Error; end
 
-    class StubNotFound < Error; end
-
     class HTTPStatusError < Error
       attr_reader :request, :response
 

data/lib/excon/middlewares/base.rb

@@ -5,6 +5,11 @@ module Excon
         @stack = stack
       end
 
+      def error_call(datum)
+        # do stuff
+        @stack.error_call(datum)
+      end
+
       def request_call(datum)
         # do stuff
         @stack.request_call(datum)

data/lib/excon/middlewares/expects.rb

@@ -6,7 +6,7 @@ module Excon
           raise(
             Excon::Errors.status_error(
               datum.reject {|key,value| key == :response},
-              datum[:response]
+              Excon::Response.new(datum[:response])              
             )
           )
         else

data/lib/excon/middlewares/idempotent.rb

@@ -0,0 +1,18 @@
+module Excon
+  module Middleware
+    class Idempotent < Excon::Middleware::Base
+      def error_call(datum)
+        if datum[:idempotent] && [Excon::Errors::Timeout, Excon::Errors::SocketError,
+            Excon::Errors::HTTPStatusError].any? {|ex| datum[:error].kind_of?(ex) } && datum[:retries_remaining] > 1
+          # reduces remaining retries, reset connection, and restart request_call
+          datum[:retries_remaining] -= 1
+          datum[:connection].reset
+          datum.delete(:error)
+          datum[:connection].request(datum)
+        else
+          @stack.error_call(datum)
+        end
+      end
+    end
+  end
+end

data/lib/excon/middlewares/instrumentor.rb

@@ -1,6 +1,13 @@
 module Excon
   module Middleware
     class Instrumentor < Excon::Middleware::Base
+      def error_call(datum)
+        if datum.has_key?(:instrumentor)
+          datum[:instrumentor].instrument("#{datum[:instrumentor_name]}.error", :error => datum[:error])
+        end
+        @stack.error_call(datum)
+      end
+
       def request_call(datum)
         if datum.has_key?(:instrumentor)
           if datum[:retries_remaining] < datum[:retry_limit]

data/tests/basic_tests.rb

@@ -2,6 +2,24 @@ with_rackup('basic.ru') do
   Shindo.tests('Excon basics') do
     basic_tests
   end
+
+  Shindo.tests('explicit uri passed to connection') do
+    connection = Excon::Connection.new({
+      :host             => '127.0.0.1',
+      :nonblock         => false,
+      :port             => 9292,
+      :scheme           => 'http',
+      :ssl_verify_peer  => false
+    })
+
+    tests('GET /content-length/100') do
+      response = connection.request(:method => :get, :path => '/content-length/100')
+
+      tests('response[:status]').returns(200) do
+        response[:status]
+      end
+    end
+  end
 end
 
 with_rackup('basic_auth.ru') do

data/tests/middlewares/mock_tests.rb

@@ -167,6 +167,15 @@ Shindo.tests('Excon stubs') do
       connection.request(:expects => 200, :method => :get, :path => '/')
     end
 
+    tests("Expects exception should contain response object") do
+      begin
+        connection.request(:expects => 200, :method => :get, :path => '/')
+      rescue Excon::Errors::NotFound => e
+        returns(Excon::Response) { e.response.class }
+      end
+    end
+
+
     test("request(:expects => 200, :method => :get, :path => '/') with block does not invoke the block since it raises an error") do
       block_called = false
       begin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excon
 version: !ruby/object:Gem::Version
-  version: 0.18.5
+  version: 0.19.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-22 00:00:00.000000000 Z
+date: 2013-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -179,6 +179,7 @@ files:
 - lib/excon/errors.rb
 - lib/excon/middlewares/base.rb
 - lib/excon/middlewares/expects.rb
+- lib/excon/middlewares/idempotent.rb
 - lib/excon/middlewares/instrumentor.rb
 - lib/excon/middlewares/mock.rb
 - lib/excon/response.rb
@@ -190,7 +191,7 @@ files:
 - tests/basic_tests.rb
 - tests/data/xs
 - tests/header_tests.rb
-- tests/idempotent_tests.rb
+- tests/middlewares/idempotent_tests.rb
 - tests/middlewares/instrumentation_tests.rb
 - tests/middlewares/mock_tests.rb
 - tests/proxy_tests.rb
@@ -229,7 +230,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3422335355113761229
+      hash: 4361906214434444580
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: