excon 0.9.0 → 0.9.1

data/README.rdoc

@@ -81,7 +81,11 @@ NOTE: Excon will use the environment variables "http_proxy" and "https_proxy" if
 
 You can stub out requests for testing purposes by enabling mock mode on a connection.
 
-  Excon.mock = true
+  connection = Excon.new('http://example.com', :mock => true)
+
+Or by enabling mock mode for a request.
+
+  connection.request(:method => :get, :path => 'example', :mock => true)
 
 Then you can add stubs, for instance:
 
@@ -90,6 +94,13 @@ Then you can add stubs, for instance:
 
 Omitted attributes are assumed to match, so this stub will match any get request and return an Excon::Response with a body of 'body' and status of 200.  You can add whatever stubs you might like this way and they will be checked against in the order they were added, if none of them match then excon will raise an error to let you know.
 
+Alternatively you can pass a block instead of response_attributes and it will be called with the request params.  For example, you could create a stub that echoes the body given to it like this:
+
+  # Excon.stub(request_attributes, &response_block)
+  Excon.stub({:method => :put}) do |params|
+    {:body => params[:body], :status => 200}
+  end
+
 == HTTPS/SSL Issues
 
 By default excon will try to verify peer certificates when using SSL for HTTPS. Unfortunately on some operating systems the defaults will not work. This will likely manifest itself as something like "Excon::Errors::SocketError: SSL_connect returned=1 ..."

data/changelog.txt

@@ -1,3 +1,8 @@
+0.9.1 12/15/11
+==============
+
+* update mock usage to be at the connection/request level
+
 0.9.0 12/14/11
 ==============
 

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.9.0'
-  s.date              = '2011-12-14'
+  s.version           = '0.9.1'
+  s.date              = '2011-12-15'
   s.rubyforge_project = 'excon'
 
   ## Make sure your summary is short. The description may be as long
@@ -53,12 +53,13 @@ Gem::Specification.new do |s|
   ## List your development dependencies here. Development dependencies are
   ## those that are only needed during development
   # s.add_development_dependency('DEVDEPNAME', [">= 1.1.0", "< 2.0.0"])
+  s.add_development_dependency('activesupport', '~>3.1.3')
+  s.add_development_dependency('delorean')
   s.add_development_dependency('open4')
   s.add_development_dependency('rake')
+  s.add_development_dependency('rdoc')
   s.add_development_dependency('shindo', '0.2.0')
   s.add_development_dependency('sinatra')
-  s.add_development_dependency('activesupport', '~>3.1.3')
-  s.add_development_dependency('delorean')
 
   ## Leave this section as-is. It will be automatically generated from the
   ## contents of your Git repository via the gemspec task. DO NOT REMOVE

data/lib/excon.rb

@@ -26,11 +26,9 @@ module Excon
     # setup ssl defaults based on platform
     @ssl_verify_peer = RbConfig::CONFIG['host_os'] !~ /mswin|win32|dos|cygwin|mingw/i
 
-    # default mocking to off
-    @mock = false
-
     # Status of mocking
     def mock
+      puts("Excon#mock is deprecated, pass :mock to the initializer (#{caller.first})")
       @mock
     end
 
@@ -38,6 +36,7 @@ module Excon
     # false is the default and works as expected
     # true returns a value from stubs or raises
     def mock=(new_mock)
+      puts("Excon#mock= is deprecated, pass :mock to the initializer (#{caller.first})")
       @mock = new_mock
     end
 

data/lib/excon/connection.rb

@@ -23,7 +23,7 @@ module Excon
         :headers           => {},
         :host              => uri.host,
         :instrumentor_name => 'excon',
-        :mock              => Excon.mock,
+        :mock              => Excon.instance_variable_get(:@mock),
         :path              => uri.path,
         :port              => uri.port.to_s,
         :query             => uri.query,

data/lib/excon/constants.rb

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

data/tests/idempotent_tests.rb

@@ -1,5 +1,8 @@
 Shindo.tests('Excon request idempotencey') do
-  Excon.mock = true
+
+  before do
+    @connection = Excon.new('http://127.0.0.1:9292', :mock => true)
+  end
 
   after do
     # flush any existing stubs after each test
@@ -17,8 +20,7 @@ Shindo.tests('Excon request idempotencey') do
       end
     }
 
-    connection = Excon.new('http://127.0.0.1:9292')
-    response = connection.request(:method => :get, :path => '/some-path')
+    response = @connection.request(:method => :get, :path => '/some-path')
   end
 
   tests("Idempotent request with socket erroring first 3 times").returns(200) do
@@ -32,8 +34,7 @@ Shindo.tests('Excon request idempotencey') do
       end
     }
 
-    connection = Excon.new('http://127.0.0.1:9292')
-    response = connection.request(:method => :get, :idempotent => true, :path => '/some-path')
+    response = @connection.request(:method => :get, :idempotent => true, :path => '/some-path')
     response.status
   end
 
@@ -48,8 +49,7 @@ Shindo.tests('Excon request idempotencey') do
       end
     }
 
-    connection = Excon.new('http://127.0.0.1:9292')
-    response = connection.request(:method => :get, :idempotent => true, :path => '/some-path')
+    response = @connection.request(:method => :get, :idempotent => true, :path => '/some-path')
     response.status
   end
 
@@ -64,8 +64,7 @@ Shindo.tests('Excon request idempotencey') do
       end
     }
 
-    connection = Excon.new('http://127.0.0.1:9292', :retry_limit => 2)
-    response = connection.request(:method => :get, :idempotent => true, :path => '/some-path')
+    response = @connection.request(:method => :get, :idempotent => true, :path => '/some-path', :retry_limit => 2)
     response.status
   end
 
@@ -80,8 +79,7 @@ Shindo.tests('Excon request idempotencey') do
       end
     }
 
-    connection = Excon.new('http://127.0.0.1:9292', :retry_limit => 2)
-    response = connection.request(:method => :get, :idempotent => true, :path => '/some-path')
+    response = @connection.request(:method => :get, :idempotent => true, :path => '/some-path', :retry_limit => 2)
     response.status
   end
 
@@ -96,8 +94,7 @@ Shindo.tests('Excon request idempotencey') do
       end
     }
 
-    connection = Excon.new('http://127.0.0.1:9292', :retry_limit => 8)
-    response = connection.request(:method => :get, :idempotent => true, :path => '/some-path')
+    response = @connection.request(:method => :get, :idempotent => true, :path => '/some-path', :retry_limit => 8)
     response.status
   end
 
@@ -112,16 +109,12 @@ Shindo.tests('Excon request idempotencey') do
       end
     }
 
-    connection = Excon.new('http://127.0.0.1:9292', :retry_limit => 8)
-    response = connection.request(:method => :get, :idempotent => true, :path => '/some-path')
+    response = @connection.request(:method => :get, :idempotent => true, :path => '/some-path', :retry_limit => 8)
     response.status
   end
 
   tests("Retry limit in constructor with socket erroring first 5 times").returns(200) do
     run_count = 0
-
-    connection = Excon.new('http://127.0.0.1:9292', :retry_limit => 6)
-
     Excon.stub({:method => :get}) { |params|
       run_count += 1
       if run_count <= 5 # First 5 calls fail.
@@ -130,9 +123,9 @@ Shindo.tests('Excon request idempotencey') do
         {:body => params[:body], :headers => params[:headers], :status => 200}
       end
     }
-    response = connection.request(:method => :get, :idempotent => true, :path => '/some-path')
+
+    response = @connection.request(:method => :get, :idempotent => true, :path => '/some-path', :retry_limit => 6)
     response.status
   end
 
-  Excon.mock = false
 end

data/tests/instrumentation_tests.rb

@@ -13,9 +13,6 @@ class SimpleInstrumentor
 end
 
 Shindo.tests('Excon instrumentation') do
-  before do
-    Excon.mock = true
-  end
 
   after do
     ActiveSupport::Notifications.unsubscribe("excon")
@@ -25,7 +22,6 @@ Shindo.tests('Excon instrumentation') do
     ActiveSupport::Notifications.unsubscribe("gug")
     Delorean.back_to_the_present
     Excon.stubs.clear
-    Excon.mock = false
   end
 
   def subscribe(match)
@@ -36,8 +32,11 @@ Shindo.tests('Excon instrumentation') do
   end
 
   def make_request(idempotent = false, params = {})
-    connection = Excon.new('http://127.0.0.1:9292',
-        :instrumentor => ActiveSupport::Notifications)
+    connection = Excon.new(
+      'http://127.0.0.1:9292',
+      :instrumentor => ActiveSupport::Notifications,
+      :mock         => true
+    )
     if idempotent
       params[:idempotent] = :true
     end
@@ -139,8 +138,11 @@ Shindo.tests('Excon instrumentation') do
   tests('use our own instrumentor').returns(
       ['excon.request', 'excon.retry', 'excon.retry', 'excon.retry', 'excon.error']) do
     stub_failure
-    connection = Excon.new('http://127.0.0.1:9292',
-        :instrumentor => SimpleInstrumentor)
+    connection = Excon.new(
+      'http://127.0.0.1:9292',
+      :instrumentor => SimpleInstrumentor,
+      :mock         => true
+    )
     raises(Excon::Errors::SocketError) do
       connection.get(:idempotent => true)
     end
@@ -151,7 +153,7 @@ Shindo.tests('Excon instrumentation') do
   tests('does not generate events when not provided').returns(0) do
     subscribe(/excon/)
     stub_success
-    connection = Excon.new('http://127.0.0.1:9292')
+    connection = Excon.new('http://127.0.0.1:9292', :mock => true)
     connection.get(:idempotent => true)
     @events.count
   end
@@ -160,8 +162,12 @@ Shindo.tests('Excon instrumentation') do
       ['gug.request', 'gug.retry', 'gug.retry','gug.retry', 'gug.error']) do
     subscribe(/gug/)
     stub_failure
-    connection = Excon.new('http://127.0.0.1:9292',
-        :instrumentor => ActiveSupport::Notifications, :instrumentor_name => 'gug')
+    connection = Excon.new(
+      'http://127.0.0.1:9292',
+      :instrumentor       => ActiveSupport::Notifications,
+      :instrumentor_name  => 'gug',
+      :mock               => true
+    )
     raises(Excon::Errors::SocketError) do
       connection.get(:idempotent => true)
     end
@@ -172,8 +178,12 @@ Shindo.tests('Excon instrumentation') do
     ['gug.request', 'gug.error']) do
     subscribe(/gug/)
     stub_failure
-    connection = Excon.new('http://127.0.0.1:9292',
-        :instrumentor => ActiveSupport::Notifications, :instrumentor_name => 'gug')
+    connection = Excon.new(
+      'http://127.0.0.1:9292',
+      :instrumentor       => ActiveSupport::Notifications,
+      :instrumentor_name  => 'gug',
+      :mock               => true
+    )
     raises(Excon::Errors::SocketError) do
       connection.get()
     end
@@ -182,9 +192,8 @@ Shindo.tests('Excon instrumentation') do
 
   with_rackup('basic.ru') do
     tests('works unmocked').returns('excon.request') do
-      Excon.mock = false
       subscribe(/excon/)
-      make_request
+      make_request(false, :mock => false)
       @events.first.name
     end
   end

data/tests/stub_tests.rb

@@ -1,8 +1,7 @@
 Shindo.tests('Excon stubs') do
-  Excon.mock = true
 
   tests("missing stub").raises(Excon::Errors::StubNotFound) do
-    connection = Excon.new('http://127.0.0.1:9292')
+    connection = Excon.new('http://127.0.0.1:9292', :mock => true)
     response = connection.request(:method => :get, :path => '/content-length/100')
   end
 
@@ -18,7 +17,7 @@ Shindo.tests('Excon stubs') do
 
     Excon.stub({:method => :get}, {:body => 'body', :status => 200})
 
-    connection = Excon.new('http://127.0.0.1:9292')
+    connection = Excon.new('http://127.0.0.1:9292', :mock => true)
     response = connection.request(:method => :get, :path => '/content-length/100')
 
     tests('response.body').returns('body') do
@@ -41,7 +40,7 @@ Shindo.tests('Excon stubs') do
       body
     end
 
-    Excon.stubs.pop
+    Excon.stubs.clear
 
   end
 
@@ -49,7 +48,7 @@ Shindo.tests('Excon stubs') do
 
     Excon.stub({:body => 'body', :method => :get}) {|params| {:body => params[:body], :headers => params[:headers], :status => 200}}
 
-    connection = Excon.new('http://127.0.0.1:9292')
+    connection = Excon.new('http://127.0.0.1:9292', :mock => true)
     response = connection.request(:body => 'body', :method => :get, :path => '/content-length/100')
 
     tests('response.body').returns('body') do
@@ -72,17 +71,19 @@ Shindo.tests('Excon stubs') do
       body
     end
 
-    Excon.stubs.pop
+    Excon.stubs.clear
 
   end
 
   tests("mismatched stub").raises(Excon::Errors::StubNotFound) do
     Excon.stub({:method => :post}, {:body => 'body'})
-    Excon.get('http://127.0.0.1:9292/')
+    Excon.get('http://127.0.0.1:9292/', :mock => true)
   end
 
+  Excon.stubs.clear
+
   tests("stub({}, {:body => 'x' * (Excon::CHUNK_SIZE + 1)})") do
-    connection = Excon.new('http://127.0.0.1:9292')
+    connection = Excon.new('http://127.0.0.1:9292', :mock => true)
     Excon.stub({}, {:body => 'x' * (Excon::CHUNK_SIZE + 1)})
 
     test("with block") do
@@ -95,7 +96,6 @@ Shindo.tests('Excon stubs') do
   end
 
   Excon.stubs.clear
-  Excon.mock = false
 
   tests('mock = false') do
     with_rackup('basic.ru') do

metadata

@@ -1,91 +1,129 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: excon
-version: !ruby/object:Gem::Version
-  version: 0.9.0
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 9
+  - 1
+  segments_generated: true
+  version: 0.9.1
 platform: ruby
-authors:
+authors: 
 - dpiddy (Dan Peterson)
 - geemus (Wesley Beary)
 - nextmat (Matt Sanders)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-14 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: open4
-  requirement: &70338621231260 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+
+date: 2011-12-15 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 1
+        - 3
+        segments_generated: true
+        version: 3.1.3
+  requirement: *id001
+  name: activesupport
+  prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        segments_generated: true
+        version: "0"
+  requirement: *id002
+  name: delorean
   prerelease: false
-  version_requirements: *70338621231260
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &70338621230800 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        segments_generated: true
+        version: "0"
+  requirement: *id003
+  name: open4
   prerelease: false
-  version_requirements: *70338621230800
-- !ruby/object:Gem::Dependency
-  name: shindo
-  requirement: &70338621230300 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - =
-      - !ruby/object:Gem::Version
-        version: 0.2.0
   type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        segments_generated: true
+        version: "0"
+  requirement: *id004
+  name: rake
   prerelease: false
-  version_requirements: *70338621230300
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: &70338621229880 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        segments_generated: true
+        version: "0"
+  requirement: *id005
+  name: rdoc
   prerelease: false
-  version_requirements: *70338621229880
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &70338621220620 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.1.3
   type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 0
+        segments_generated: true
+        version: 0.2.0
+  requirement: *id006
+  name: shindo
   prerelease: false
-  version_requirements: *70338621220620
-- !ruby/object:Gem::Dependency
-  name: delorean
-  requirement: &70338621220200 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        segments_generated: true
+        version: "0"
+  requirement: *id007
+  name: sinatra
   prerelease: false
-  version_requirements: *70338621220200
+  type: :development
 description: EXtended http(s) CONnections
 email: geemus@gmail.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README.rdoc
-files:
+files: 
 - Gemfile
 - README.rdoc
 - Rakefile
@@ -134,29 +172,37 @@ files:
 - tests/stub_tests.rb
 - tests/test_helper.rb
 - tests/thread_safety_tests.rb
+has_rdoc: true
 homepage: https://github.com/geemus/excon
 licenses: []
+
 post_install_message: 
-rdoc_options:
+rdoc_options: 
 - --charset=UTF-8
-require_paths:
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      segments_generated: true
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      segments_generated: true
+      version: "0"
 requirements: []
+
 rubyforge_project: excon
-rubygems_version: 1.8.10
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 2
 summary: speed, persistence, http(s)
 test_files: []
+