vcr 2.2.4 → 2.2.5

data/.travis.yml

@@ -19,6 +19,8 @@ branches:
     - travis-testing
 matrix:
   allow_failures:
+    - rvm: jruby-18mode
     - rvm: jruby-19mode
     - rvm: rbx-19mode
+    - rvm: rbx-18mode
 

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 2.2.5 (September 7, 2012)
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v2.2.4...v2.2.5)
+
+Enhancements:
+
+* Include note about `debug_logger` option in error message for
+  unhandled HTTP requests. Thanks to [Jacob Green](https://github.com/Jacobkg)
+  for implementing this.
+
+Bug Fixes:
+
+* Fix another edge case bug on the excon adapter that was causing it
+  to mis-record in certain situations that used Excon's :expects option.
+* Fix the `:use_scenario_name` cucumber tags option to work properly
+  with scenario outlines. Thanks to [Joe
+  Nelson](https://github.com/begriffs) and [Stephen
+  Anderson](https://github.com/bendycode) for the initial bug fixes and
+  [Jacob Green](https://github.com/Jacobkg) for some further improvements.
+
 ## 2.2.4 (July 19, 2012)
 
 [Full Changelog](http://github.com/myronmarston/vcr/compare/v2.2.3...v2.2.4)

data/README.md

@@ -132,6 +132,8 @@ yard server --reload
   support.
 * [Wesley Beary](https://github.com/geemus) for help with [Excon](https://github.com/geemus/excon)
   support.
+* [Jacob Green](https://github.com/Jacobkg) for help with ongoing VCR
+  maintenance.
 
 Thanks also to the following people who have contributed patches or helpful suggestions:
 
@@ -149,11 +151,14 @@ Thanks also to the following people who have contributed patches or helpful sugg
 * [Flaviu Simihaian](https://github.com/closedbracket)
 * [Gordon Wilson](https://github.com/gordoncww)
 * [Ingemar](https://github.com/ingemar)
+* [Jacob Green](https://github.com/Jacobkg)
 * [Jeff Pollard](https://github.com/Fluxx)
+* [Joe Nelson](https://github.com/begriffs)
+* [Jonathan Tron](https://github.com/JonathanTron)
 * [Justin Smestad](https://github.com/jsmestad)
 * [Karl Baum](https://github.com/kbaum)
 * [Michael Lavrisha](https://github.com/vrish88)
-* [Mislav Marohnić](https://github.com/mislav)
+* [Mislav Marohnić](https://github.com/mislav)
 * [Nathaniel Bibler](https://github.com/nbibler)
 * [Oliver Searle-Barnes](https://github.com/opsb)
 * [Omer Rauchwerger](https://github.com/rauchy)
@@ -161,6 +166,7 @@ Thanks also to the following people who have contributed patches or helpful sugg
 * [playupchris](https://github.com/playupchris)
 * [Ryan Bates](https://github.com/ryanb)
 * [Sathya Sekaran](https://github.com/sfsekaran)
+* [Steven Anderson](https://github.com/bendycode)
 * [Tyler Hunt](https://github.com/tylerhunt)
 * [Wesley Beary](https://github.com/geemus)
 

data/features/cassettes/no_cassette.feature

@@ -6,6 +6,10 @@ Feature: Error for HTTP request made when no cassette is in use
   use.  The error is helpful to pinpoint where HTTP requests are
   made so you can use a VCR cassette at that point in your code.
 
+  If you want insight about how VCR attempted to handle the request,
+  you can use the [debug\_logger](../configuration/debug-logging)
+  configuration option to log more details.
+
   If you want to allow an HTTP request to proceed as normal, you can
   set the [allow\_http\_connections\_when\_no\_cassette](../configuration/allow-http-connections-when-no-cassette)
   configuration option or you can temporarily turn VCR off:

data/features/test_frameworks/cucumber.feature

@@ -27,6 +27,8 @@ Feature: Usage with Cucumber
   You can also have VCR name your cassettes automatically according to the feature
   and scenario name by providing :use_scenario_name => true to '#tag' or '#tags'.
   In this case, the cassette will be named "<feature_name>/<scenario_name>".
+  For scenario outlines, VCR will record one cassette per row, and the cassettes
+  will be named "<feature_name>/<scenario_name>/<row_name>.
 
   @exclude-jruby
   Scenario: Record HTTP interactions in a scenario by tagging it
@@ -93,6 +95,14 @@ Feature: Usage with Cucumber
           When a request is made to "http://localhost:7777/localhost_request_1"
           Then the response should be "Hello localhost_request_1"
 
+        @vcr
+        Scenario Outline: tagged scenario outline
+          When a request is made to "http://localhost:7777/localhost_request_1"
+          Then the response should be "Hello localhost_request_1"
+          Examples:
+            | key  | value |
+            | foo  | bar   |
+
         @disallowed_1
         Scenario: tagged scenario
           When a request is made to "http://localhost:7777/allowed" within a cassette named "allowed"
@@ -105,7 +115,7 @@ Feature: Usage with Cucumber
       """
     And the directory "features/cassettes" does not exist
     When I run `cucumber WITH_SERVER=true features/vcr_example.feature`
-    Then it should fail with "4 scenarios (2 failed, 2 passed)"
+    Then it should fail with "5 scenarios (2 failed, 3 passed)"
     And the output should contain each of the following:
       | An HTTP request has been made that VCR does not know how to handle:               |
       |   GET http://localhost:7777/disallowed_1                                          |
@@ -116,11 +126,12 @@ Feature: Usage with Cucumber
     And the file "features/cassettes/nested_cassette.yml" should contain "Hello nested_cassette"
     And the file "features/cassettes/allowed.yml" should contain "Hello allowed"
     And the file "features/cassettes/VCR_example/tagged_scenario.yml" should contain "Hello localhost_request_1"
+    And the file "features/cassettes/VCR_example/tagged_scenario_outline/_foo_bar_.yml" should contain "Hello localhost_request_1"
 
     # Run again without the server; we'll get the same responses because VCR
     # will replay the recorded responses.
     When I run `cucumber features/vcr_example.feature`
-    Then it should fail with "4 scenarios (2 failed, 2 passed)"
+    Then it should fail with "5 scenarios (2 failed, 3 passed)"
     And the output should contain each of the following:
       | An HTTP request has been made that VCR does not know how to handle:               |
       |   GET http://localhost:7777/disallowed_1                                          |
@@ -131,3 +142,4 @@ Feature: Usage with Cucumber
     And the file "features/cassettes/nested_cassette.yml" should contain "Hello nested_cassette"
     And the file "features/cassettes/allowed.yml" should contain "Hello allowed"
     And the file "features/cassettes/VCR_example/tagged_scenario.yml" should contain "Hello localhost_request_1"
+    And the file "features/cassettes/VCR_example/tagged_scenario_outline/_foo_bar_.yml" should contain "Hello localhost_request_1"

data/lib/vcr/errors.rb

@@ -183,6 +183,13 @@ module VCR
            "change your :match_requests_on cassette option to be more lenient",
            "or use a custom request matcher to allow it to match"],
            "https://www.relishapp.com/myronmarston/vcr/v/%s/docs/request-matching"
+        ],
+
+        :try_debug_logger => [
+          ["If you're surprised VCR is raising this error",
+           "and want insight about how VCR attempted to handle the request,",
+           "you can use the debug_logger configuraiton option to log more details"],
+          "https://www.relishapp.com/myronmarston/vcr/v/%s/docs/configuration/debug-logging"
         ]
       }
 
@@ -196,7 +203,7 @@ module VCR
       def suggestions
         return no_cassette_suggestions unless cassette = VCR.current_cassette
 
-        [:use_new_episodes, :ignore_request].tap do |suggestions|
+        [:try_debug_logger, :use_new_episodes, :ignore_request].tap do |suggestions|
           suggestions.push(*record_mode_suggestion)
           suggestions << :allow_playback_repeats if cassette.http_interactions.has_used_interaction_matching?(request)
           suggestions.map! { |k| suggestion_for(k) }
@@ -205,7 +212,7 @@ module VCR
       end
 
       def no_cassette_suggestions
-        [:use_a_cassette, :allow_http_connections_when_no_cassette, :ignore_request].map do |key|
+        [:try_debug_logger, :use_a_cassette, :allow_http_connections_when_no_cassette, :ignore_request].map do |key|
           suggestion_for(key)
         end
       end

data/lib/vcr/library_hooks/excon.rb

@@ -2,7 +2,7 @@ require 'vcr/util/version_checker'
 require 'vcr/request_handler'
 require 'excon'
 
-VCR::VersionChecker.new('Excon', Excon::VERSION, '0.9.6', '0.15').check_version!
+VCR::VersionChecker.new('Excon', Excon::VERSION, '0.9.6', '0.16').check_version!
 
 module VCR
   class LibraryHooks
@@ -46,22 +46,30 @@ module VCR
           end
         end
 
+        PARAMS_TO_DELETE = [:expects, :idempotent,
+                            :instrumentor_name, :instrumentor,
+                            :response_block, :request_block]
+
         def real_request_params
           # Excon supports a variety of options that affect how it handles failure
           # and retry; we don't want to use any options here--we just want to get
           # a raw response, and then the main request (with :mock => true) can
           # handle failure/retry on its own with its set options.
-          params.merge(:mock => false, :retry_limit => 0).tap do |p|
-            [:expects, :idempotent, :instrumentor_name, :instrumentor, :response_block, :request_block].each do |key|
-              p.delete(key)
-            end
-          end
+          scrub_params_from params.merge(:mock => false, :retry_limit => 0)
         end
 
         def new_connection
           # Ensure the connection is constructed with the exact same args
           # that the orginal connection was constructed with.
-          ::Excon::Connection.new(*params.fetch(:__construction_args))
+          args, options = params.fetch(:__construction_args)
+          options = scrub_params_from(options) if options.is_a?(Hash)
+          ::Excon::Connection.new(*[args, options].compact)
+        end
+
+        def scrub_params_from(hash)
+          hash = hash.dup
+          PARAMS_TO_DELETE.each { |key| hash.delete(key) }
+          hash
         end
 
         def perform_real_request

data/lib/vcr/library_hooks/typhoeus.rb

@@ -2,7 +2,7 @@ require 'vcr/util/version_checker'
 require 'vcr/request_handler'
 require 'typhoeus'
 
-VCR::VersionChecker.new('Typhoeus', Typhoeus::VERSION, '0.3.2', '0.3').check_version!
+VCR::VersionChecker.new('Typhoeus', Typhoeus::VERSION, '0.3.2', '0.4').check_version!
 
 module VCR
   class LibraryHooks

data/lib/vcr/test_frameworks/cucumber.rb

@@ -40,7 +40,11 @@ module VCR
           options = original_options.dup
 
           cassette_name = if options.delete(:use_scenario_name)
-            "#{scenario.feature.name.split("\n").first}/#{scenario.name}"
+            feature = scenario.respond_to?(:scenario_outline) ? scenario.scenario_outline.feature : scenario.feature
+            name = feature.name.split("\n").first
+            name << "/#{scenario.scenario_outline.name}" if scenario.respond_to?(:scenario_outline)
+            name << "/#{scenario.name}"
+            name
           else
             "cucumber_tags/#{tag_name.gsub(/\A@/, '')}"
           end

data/lib/vcr/version.rb

@@ -10,7 +10,7 @@ module VCR
   #   * `parts` [Array<Integer>] List of the version parts.
   def version
     @version ||= begin
-      string = '2.2.4'
+      string = '2.2.5'
 
       def string.parts
         split('.').map { |p| p.to_i }

data/spec/support/shared_example_groups/hook_into_http_library.rb

@@ -56,7 +56,7 @@ shared_examples_for "a hook into an HTTP library" do |library_hook_name, library
     test_record_and_playback "with a complex escaped query param", "q=#{CGI.escape("A&(! 234k !@ kasdj232\#$ kjw35")}"
 
     it 'plays back an empty body response exactly as it was recorded (e.g. nil vs empty string)' do
-      pending "awaiting an external fix", :if => library.gsub('_', '/').include?('net/http') do
+      pending "awaiting an external fix", :if => library.gsub('_', '/').include?('net/http') && library_hook_name != :webmock do
         get_body = lambda do
           VCR.use_cassette('empty_body', :record => :once) do
             get_body_object make_http_request(:get, "http://localhost:#{VCR::SinatraApp.port}/204")

data/spec/vcr/errors_spec.rb

@@ -42,6 +42,10 @@ module VCR
         it 'does not double-insert the asterisks for the bullet points' do
           message.should_not match(/\s+\*\s+\*/)
         end
+
+        it 'mentions the debug logging configuration option' do
+          message.should include('debug_logger')
+        end
       end
 
       context 'when there is a current cassette' do
@@ -122,6 +126,12 @@ module VCR
             message.should include('2 HTTP interactions ')
           end
         end
+
+        it 'mentions the debug logging configuration option' do
+          VCR.use_cassette('example', :record => :new_episodes) do
+            message.should include('debug_logger')
+          end
+        end
       end
     end
   end

data/spec/vcr/test_frameworks/cucumber_spec.rb

@@ -61,6 +61,15 @@ describe VCR::CucumberTags do
           test_tag(:name, 'tag1', 'My feature name/My scenario name')
         end
 
+        it "makes a unique name for each element of scenario outline" do
+          subject.send(tag_method, 'tag1', :use_scenario_name => true)
+
+          scenario_with_outline = stub(:name => "My row name",
+                                       :scenario_outline => stub(:feature => stub(:name => "My feature name\nThe preamble text is not included"),
+                                                                 :name => "My scenario outline name"))
+          test_tag(:name, 'tag1', 'My feature name/My scenario outline name/My row name', scenario_with_outline)
+        end
+
         it 'does not pass :use_scenario_name along the given options to the cassette' do
           subject.send(tag_method, 'tag1', :use_scenario_name => true)
 

data/vcr.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'fakeweb', '~> 1.3.0'
   s.add_development_dependency 'webmock', '~> 1.8.3'
 
-  s.add_development_dependency 'faraday', '~> 0.8.0.rc2'
+  s.add_development_dependency 'faraday', '~> 0.8'
   s.add_development_dependency 'httpclient', '~> 2.2'
   s.add_development_dependency 'excon', '>= 0.11.0', '< 1.0'
 
@@ -45,7 +45,7 @@ Gem::Specification.new do |s|
     s.add_development_dependency 'patron', '~> 0.4.15'
     s.add_development_dependency 'em-http-request', '~> 1.0.2'
     s.add_development_dependency 'curb', '~> 0.8.0'
-    s.add_development_dependency 'typhoeus', '~> 0.3.3'
+    s.add_development_dependency 'typhoeus', '>= 0.3.3', '< 0.5.0'
     s.add_development_dependency 'yajl-ruby', '~> 1.1.0'
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: vcr
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 2
   - 2
-  - 4
-  version: 2.2.4
+  - 5
+  version: 2.2.5
 platform: ruby
 authors: 
 - Myron Marston
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-20 00:00:00 Z
+date: 2012-09-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -150,14 +150,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15424145
+        hash: 27
         segments: 
         - 0
         - 8
-        - 0
-        - rc
-        - 2
-        version: 0.8.0.rc2
+        version: "0.8"
   name: faraday
   type: :development
   prerelease: false
@@ -364,7 +361,7 @@ dependencies:
   version_requirements: &id022 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         hash: 21
         segments: 
@@ -372,6 +369,14 @@ dependencies:
         - 3
         - 3
         version: 0.3.3
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
   name: typhoeus
   type: :development
   prerelease: false