excon 0.13.4 → 0.14.0

data/README.md

@@ -134,14 +134,18 @@ Alternatively you can pass a block instead of `response_attributes` and it will
       {:body => params[:body], :status => 200}
     end
 
-In order to clear previously defined stubs you can use:
+In order to clear all previously defined stubs you can use:
 
     Excon.stubs.clear
 
+Or to simply remove the last defined stub you can use:
+
+    Excon.stubs.shift
+
 For example, if using RSpec for your test suite you can clear stubs after running each example:
 
     config.after(:each) do
-        Excon.stubs.clear
+      Excon.stubs.clear
     end
 
 HTTPS/SSL Issues
@@ -193,7 +197,9 @@ If you don't want to add activesupport to your application, simply define a clas
       end
     end
 
-The #instrument method will be called for each HTTP request, retry, and error.
+The #instrument method will be called for each HTTP request, response, retry, and error.
+
+For debugging purposes you can also use Excon::StandardInstrumentor to output all events to stderr. This can also be specified by setting the `EXCON_STANDARD_INSTRUMENTOR` ENV var.
 
 See [the documentation for ActiveSupport::Notifications](http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html) for more detail on using the subscription interface.  See excon's instrumentation_test.rb for more examples of instrumenting excon.
 

data/changelog.txt

@@ -1,3 +1,12 @@
+0.14.0 05/31/12
+===============
+
+make stubs LIFO for ease of use/understanding, updated README to explain
+simplify https proxy logic
+add instrumentation for responses
+add StandardInstrumentor (events got to stderr)
+EXCON_STANDARD_INSTRUMENTOR=true sets StandardInstrumentor as default
+
 0.13.3 04/05/12
 ===============
 

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.13.4'
-  s.date              = '2012-04-12'
+  s.version           = '0.14.0'
+  s.date              = '2012-05-31'
   s.rubyforge_project = 'excon'
 
   ## Make sure your summary is short. The description may be as long
@@ -97,6 +97,7 @@ Gem::Specification.new do |s|
     lib/excon/response.rb
     lib/excon/socket.rb
     lib/excon/ssl_socket.rb
+    lib/excon/standard_instrumentor.rb
     tests/bad_tests.rb
     tests/basic_tests.rb
     tests/data/xs

data/lib/excon.rb

@@ -14,6 +14,7 @@ require 'excon/errors'
 require 'excon/response'
 require 'excon/socket'
 require 'excon/ssl_socket'
+require 'excon/standard_instrumentor'
 
 module Excon
   class << self
@@ -103,7 +104,7 @@ module Excon
       else
         raise(ArgumentError.new("stub requires either response_params OR a block"))
       end
-      stubs << stub
+      stubs.unshift(stub)
       stub
     end
 

data/lib/excon/connection.rb

@@ -37,17 +37,19 @@ module Excon
         @proxy = setup_proxy(params[:proxy])
       end
 
-      if @connection[:scheme] == HTTPS
-        # use https_proxy if that has been specified
-        if ENV.has_key?('https_proxy')
-          @proxy = setup_proxy(ENV['https_proxy'])
-        end
+      # use https_proxy if that has been specified
+      if @connection[:scheme] == HTTPS && ENV.has_key?('https_proxy')
+        @proxy = setup_proxy(ENV['https_proxy'])
       end
 
       if @proxy
         @connection[:headers]['Proxy-Connection'] ||= 'Keep-Alive'
       end
 
+      if ENV.has_key?('EXCON_STANDARD_INSTRUMENTOR')
+        @connection[:instrumentor] = Excon::StandardInstrumentor
+      end
+
       # Use Basic Auth if url contains a login
       if uri.user || uri.password
         auth = ["#{uri.user}:#{uri.password}"].pack('m').delete("\r\n")
@@ -90,9 +92,11 @@ module Excon
         else
           event_name = "#{params[:instrumentor_name]}.request"
         end
-        params[:instrumentor].instrument(event_name, params) do
+        response = params[:instrumentor].instrument(event_name, params) do
           request_kernel(params)
         end
+        params[:instrumentor].instrument("#{params[:instrumentor_name]}.response", response.attributes)
+        response
       else
         request_kernel(params)
       end

data/lib/excon/constants.rb

@@ -1,6 +1,6 @@
 module Excon
   unless const_defined?(:VERSION)
-    VERSION = '0.13.4'
+    VERSION = '0.14.0'
   end
 
   unless const_defined?(:CHUNK_SIZE)

data/lib/excon/standard_instrumentor.rb

@@ -0,0 +1,10 @@
+module Excon
+  class StandardInstrumentor
+    def self.instrument(name, params = {}, &block)
+      $stderr.puts("#{name}  #{params}")
+      if block_given?
+        yield
+      end
+    end
+  end
+end

data/tests/instrumentation_tests.rb

@@ -17,6 +17,7 @@ Shindo.tests('Excon instrumentation') do
   after do
     ActiveSupport::Notifications.unsubscribe("excon")
     ActiveSupport::Notifications.unsubscribe("excon.request")
+    ActiveSupport::Notifications.unsubscribe("excon.response")
     ActiveSupport::Notifications.unsubscribe("excon.retry")
     ActiveSupport::Notifications.unsubscribe("excon.error")
     ActiveSupport::Notifications.unsubscribe("gug")
@@ -69,11 +70,11 @@ Shindo.tests('Excon instrumentation') do
     }
   end
 
-  tests('basic notification').returns('excon.request') do
+  tests('basic notification').returns(['excon.request', 'excon.response']) do
     subscribe(/excon/)
     stub_success
     make_request
-    @events.first.name
+    @events.map(&:name)
   end
 
   tests('captures scheme, host, port, and path').returns([:host, :path, :port, :scheme]) do
@@ -83,7 +84,7 @@ Shindo.tests('Excon instrumentation') do
     [:host, :path, :port, :scheme].select {|k| @events.first.payload.has_key? k}
   end
 
-  tests('params in request overwrite those in construcor').returns('cheezburger') do
+  tests('params in request overwrite those in constructor').returns('cheezburger') do
     subscribe(/excon/)
     stub_success
     make_request(false, :host => 'cheezburger')
@@ -135,6 +136,28 @@ Shindo.tests('Excon instrumentation') do
     (@events.first.duration/1000 - REQUEST_DELAY_SECONDS).abs < 1
   end
 
+  tests('standard instrumentor').returns(
+    ['excon.request', 'excon.retry', 'excon.retry', 'excon.retry', 'excon.error']) do
+
+    begin
+      original_stderr = $stderr
+      $stderr = captured_stderr = StringIO.new
+      stub_failure
+      connection = Excon.new(
+        'http://127.0.0.1:9292',
+        :instrumentor => Excon::StandardInstrumentor,
+        :mock         => true
+      )
+      raises(Excon::Errors::SocketError) do
+        connection.get(:idempotent => true)
+      end
+
+      captured_stderr.string.split("\n").map {|event| event.split(' ').first}
+    ensure
+      $stderr = original_stderr
+    end
+  end
+
   tests('use our own instrumentor').returns(
       ['excon.request', 'excon.retry', 'excon.retry', 'excon.retry', 'excon.error']) do
     stub_failure
@@ -191,10 +214,10 @@ Shindo.tests('Excon instrumentation') do
   end
 
   with_rackup('basic.ru') do
-    tests('works unmocked').returns('excon.request') do
+    tests('works unmocked').returns(['excon.request', 'excon.response']) do
       subscribe(/excon/)
       make_request(false, :mock => false)
-      @events.first.name
+      @events.map(&:name)
     end
   end
 end

data/tests/test_helper.rb

@@ -3,6 +3,8 @@ require 'bundler'
 
 Bundler.require(:default, :development)
 
+require 'stringio'
+
 def basic_tests(url = 'http://127.0.0.1:9292')
 
   connection = Excon.new(url, :ssl_verify_peer => false)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excon
 version: !ruby/object:Gem::Version
-  version: 0.13.4
+  version: 0.14.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-12 00:00:00.000000000 Z
+date: 2012-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70221725989500 !ruby/object:Gem::Requirement
+  requirement: &70191342427280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70221725989500
+  version_requirements: *70191342427280
 - !ruby/object:Gem::Dependency
   name: delorean
-  requirement: &70221725988940 !ruby/object:Gem::Requirement
+  requirement: &70191342426160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70221725988940
+  version_requirements: *70191342426160
 - !ruby/object:Gem::Dependency
   name: open4
-  requirement: &70221725988260 !ruby/object:Gem::Requirement
+  requirement: &70191342425140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70221725988260
+  version_requirements: *70191342425140
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70221725987340 !ruby/object:Gem::Requirement
+  requirement: &70191342424280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70221725987340
+  version_requirements: *70191342424280
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70221725985040 !ruby/object:Gem::Requirement
+  requirement: &70191342423500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70221725985040
+  version_requirements: *70191342423500
 - !ruby/object:Gem::Dependency
   name: shindo
-  requirement: &70221726000800 !ruby/object:Gem::Requirement
+  requirement: &70191342422860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70221726000800
+  version_requirements: *70191342422860
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70221726000100 !ruby/object:Gem::Requirement
+  requirement: &70191342422180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,7 +89,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70221726000100
+  version_requirements: *70191342422180
 description: EXtended http(s) CONnections
 email: geemus@gmail.com
 executables: []
@@ -128,6 +128,7 @@ files:
 - lib/excon/response.rb
 - lib/excon/socket.rb
 - lib/excon/ssl_socket.rb
+- lib/excon/standard_instrumentor.rb
 - tests/bad_tests.rb
 - tests/basic_tests.rb
 - tests/data/xs
@@ -163,6 +164,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 830619460380179228
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: