vcr 2.0.0.beta2 → 2.0.0.rc1

data/features/middleware/faraday.feature

@@ -3,9 +3,13 @@ Feature: Faraday middleware
   VCR provides middleware that can be used with Faraday.  You can use this as
   an alternative to Faraday's built-in test adapter.
 
-  To use VCR with Faraday, simply add the VCR middleware to the Faraday
-  connection stack.  The middleware should come before the Faraday
-  HTTP adapter.
+  VCR will automatically insert this middleware in the Faraday stack
+  when you configure `hook_into :faraday`. However, if you want to control
+  where the middleware goes in the faraday stack, you can use it yourself.
+  The middleware should come before the Faraday HTTP adapter.
+
+  Note that when you use the middleware directly, you don't need to configure
+  `hook_into :faraday`.
 
   Scenario Outline: Use Faraday middleware
     Given a file named "faraday_example.rb" with:

data/features/record_modes/none.feature

@@ -54,6 +54,7 @@ Feature: :none
     When I run `ruby replay_recorded_response.rb`
     Then it should pass with "Response: Hello"
 
+  @exclude-jruby
   Scenario: New requests are prevented
     Given a file named "prevent_new_request.rb" with:
       """ruby
@@ -64,4 +65,4 @@ Feature: :none
       end
       """
     When I run `ruby prevent_new_request.rb`
-    Then it should fail with "Real HTTP connections are disabled. Request: GET http://example.com:80/bar"
+    Then it should fail with "An HTTP request has been made that VCR does not know how to handle"

data/features/record_modes/once.feature

@@ -61,6 +61,7 @@ Feature: :once
     When I run `ruby replay_recorded_response.rb`
     Then it should pass with "Response: example.com response"
 
+  @exclude-jruby
   Scenario: New requests result in an error when the cassette file exists
     Given a file named "error_for_new_requests_when_cassette_exists.rb" with:
       """ruby
@@ -72,7 +73,7 @@ Feature: :once
       end
       """
     When I run `ruby error_for_new_requests_when_cassette_exists.rb`
-    Then it should fail with "Real HTTP connections are disabled"
+    Then it should fail with "An HTTP request has been made that VCR does not know how to handle"
 
   Scenario: New requests get recorded when there is no cassette file
     Given a file named "record_new_requests.rb" with:

data/features/request_matching/body.feature

@@ -78,6 +78,6 @@ Feature: Matching on Body
       | c.hook_into :webmock  | typhoeus              |
       | c.hook_into :typhoeus | typhoeus              |
       | c.hook_into :excon    | excon                 |
-      |                       | faraday (w/ net_http) |
-      |                       | faraday (w/ typhoeus) |
+      | c.hook_into :faraday  | faraday (w/ net_http) |
+      | c.hook_into :faraday  | faraday (w/ typhoeus) |
 

data/features/request_matching/custom_matcher.feature

@@ -92,8 +92,8 @@ Feature: Register and use a custom matcher
       | c.hook_into :webmock  | typhoeus              |
       | c.hook_into :typhoeus | typhoeus              |
       | c.hook_into :excon    | excon                 |
-      |                       | faraday (w/ net_http) |
-      |                       | faraday (w/ typhoeus) |
+      | c.hook_into :faraday  | faraday (w/ net_http) |
+      | c.hook_into :faraday  | faraday (w/ typhoeus) |
 
   Scenario: Register a named custom matcher
     And a file named "register_custom_matcher.rb" with:

data/features/request_matching/headers.feature

@@ -76,6 +76,6 @@ Feature: Matching on Headers
       | c.hook_into :webmock  | patron                |
       | c.hook_into :webmock  | em-http-request       |
       | c.hook_into :excon    | excon                 |
-      |                       | faraday (w/ net_http) |
-      |                       | faraday (w/ typhoeus) |
+      | c.hook_into :faraday  | faraday (w/ net_http) |
+      | c.hook_into :faraday  | faraday (w/ typhoeus) |
 

data/features/request_matching/host.feature

@@ -82,6 +82,6 @@ Feature: Matching on Host
       | c.hook_into :webmock  | typhoeus              |
       | c.hook_into :typhoeus | typhoeus              |
       | c.hook_into :excon    | excon                 |
-      |                       | faraday (w/ net_http) |
-      |                       | faraday (w/ typhoeus) |
+      | c.hook_into :faraday  | faraday (w/ net_http) |
+      | c.hook_into :faraday  | faraday (w/ typhoeus) |
 

data/features/request_matching/identical_request_sequence.feature

@@ -76,6 +76,6 @@ Feature: Identical requests are replayed in sequence
       | c.hook_into :webmock  | typhoeus              |
       | c.hook_into :typhoeus | typhoeus              |
       | c.hook_into :excon    | excon                 |
-      |                       | faraday (w/ net_http) |
-      |                       | faraday (w/ typhoeus) |
+      | c.hook_into :faraday  | faraday (w/ net_http) |
+      | c.hook_into :faraday  | faraday (w/ typhoeus) |
 

data/features/request_matching/method.feature

@@ -83,6 +83,6 @@ Feature: Matching on Method
       | c.hook_into :webmock  | typhoeus              |
       | c.hook_into :typhoeus | typhoeus              |
       | c.hook_into :excon    | excon                 |
-      |                       | faraday (w/ net_http) |
-      |                       | faraday (w/ typhoeus) |
+      | c.hook_into :faraday  | faraday (w/ net_http) |
+      | c.hook_into :faraday  | faraday (w/ typhoeus) |
 

data/features/request_matching/path.feature

@@ -83,6 +83,6 @@ Feature: Matching on Path
       | c.hook_into :webmock  | typhoeus              |
       | c.hook_into :typhoeus | typhoeus              |
       | c.hook_into :excon    | excon                 |
-      |                       | faraday (w/ net_http) |
-      |                       | faraday (w/ typhoeus) |
+      | c.hook_into :faraday  | faraday (w/ net_http) |
+      | c.hook_into :faraday  | faraday (w/ typhoeus) |
 

data/features/request_matching/playback_repeats.feature

@@ -12,6 +12,7 @@ Feature: Playback repeats
 
       :allow_playback_repeats => true
 
+  @exclude-jruby
   Scenario: Responses do not repeat by default
     Given a previously recorded cassette file "cassettes/example.yml" with:
       """
@@ -75,7 +76,7 @@ Feature: Playback repeats
       end
       """
     When I run `ruby playback_repeats.rb`
-    Then it should fail with "Real HTTP connections are disabled"
+    Then it should fail with "An HTTP request has been made that VCR does not know how to handle"
      And the output should contain:
       """
       == With :allow_playback_repeats ==

data/features/request_matching/uri.feature

@@ -81,6 +81,6 @@ Feature: Matching on URI
       | c.hook_into :webmock  | typhoeus              |
       | c.hook_into :typhoeus | typhoeus              |
       | c.hook_into :excon    | excon                 |
-      |                       | faraday (w/ net_http) |
-      |                       | faraday (w/ typhoeus) |
+      | c.hook_into :faraday  | faraday (w/ net_http) |
+      | c.hook_into :faraday  | faraday (w/ typhoeus) |
 

data/features/support/env.rb

@@ -6,26 +6,35 @@ require 'ruby-debug' if !defined?(RUBY_ENGINE) && RUBY_VERSION != '1.9.3' && !EN
 
 require 'aruba/cucumber'
 
-cucumer_helpers_file = '../../features/support/vcr_cucumber_helpers'
-if RUBY_VERSION > '1.9.1'
-  Before do
-    set_env('RUBYOPT', "-I.:../../lib -r#{cucumer_helpers_file}")
+additional_paths = []
+Before('@rspec-1') do
+  additional_paths << File.join(%w[ .. .. vendor rspec-1 bin ])
+end
+
+Before do
+  load_paths, requires = ['../../lib'], []
+
+  if RUBY_VERSION < '1.9'
+    requires << "rubygems"
+  else
+    load_paths << '.'
   end
-elsif RUBY_PLATFORM == 'java'
-  Before do
-    set_env('RUBYOPT', "-I../../lib -rubygems -r#{cucumer_helpers_file}")
 
+  requires << '../../features/support/vcr_cucumber_helpers'
+  requires.map! { |r| "-r#{r}" }
+  set_env('RUBYOPT', "-I#{load_paths.join(':')} #{requires.join(' ')}")
+
+  if RUBY_PLATFORM == 'java'
     # ideas taken from: http://blog.headius.com/2010/03/jruby-startup-time-tips.html
     set_env('JRUBY_OPTS', '-X-C') # disable JIT since these processes are so short lived
     set_env('JAVA_OPTS', '-d32') # force jRuby to use client JVM for faster startup times
   end
-else
-  Before do
-    set_env('RUBYOPT', "-rubygems -r#{cucumer_helpers_file}")
+
+  if additional_paths.any?
+    existing_paths = ENV['PATH'].split(':')
+    set_env('PATH', (additional_paths + existing_paths).join(':'))
   end
-end
 
-Before do
   @aruba_timeout_seconds = RUBY_PLATFORM == 'java' ? 60 : 20
 end
 

data/features/test_frameworks/cucumber.feature

@@ -23,6 +23,7 @@ Feature: Usage with Cucumber
   be used, or you can override specific options by passing a hash as the
   last argument to `#tag` or `#tags`.
 
+  @exclude-jruby
   Scenario: Record HTTP interactions in a scenario by tagging it
     Given a file named "lib/server.rb" with:
       """ruby
@@ -91,8 +92,10 @@ Feature: Usage with Cucumber
     When I run `cucumber WITH_SERVER=true features/vcr_example.feature`
     Then it should fail with "3 scenarios (2 failed, 1 passed)"
     And the output should contain each of the following:
-      | Real HTTP connections are disabled. Request: GET http://localhost:7777/disallowed_1 |
-      | Real HTTP connections are disabled. Request: GET http://localhost:7777/disallowed_2 |
+      | An HTTP request has been made that VCR does not know how to handle:               |
+      |   GET http://localhost:7777/disallowed_1                                          |
+      | An HTTP request has been made that VCR does not know how to handle:               |
+      |   GET http://localhost:7777/disallowed_2                                          |
     And the file "features/cassettes/cucumber_tags/localhost_request.yml" should contain "body: Hello localhost_request_1"
     And the file "features/cassettes/cucumber_tags/localhost_request.yml" should contain "body: Hello localhost_request_2"
     And the file "features/cassettes/nested_cassette.yml" should contain "body: Hello nested_cassette"
@@ -103,8 +106,10 @@ Feature: Usage with Cucumber
     When I run `cucumber features/vcr_example.feature`
     Then it should fail with "3 scenarios (2 failed, 1 passed)"
     And the output should contain each of the following:
-      | Real HTTP connections are disabled. Request: GET http://localhost:7777/disallowed_1 |
-      | Real HTTP connections are disabled. Request: GET http://localhost:7777/disallowed_2 |
+      | An HTTP request has been made that VCR does not know how to handle:               |
+      |   GET http://localhost:7777/disallowed_1                                          |
+      | An HTTP request has been made that VCR does not know how to handle:               |
+      |   GET http://localhost:7777/disallowed_2                                          |
     And the file "features/cassettes/cucumber_tags/localhost_request.yml" should contain "body: Hello localhost_request_1"
     And the file "features/cassettes/cucumber_tags/localhost_request.yml" should contain "body: Hello localhost_request_2"
     And the file "features/cassettes/nested_cassette.yml" should contain "body: Hello nested_cassette"

data/features/test_frameworks/{rspec.feature → rspec_macro.feature}

@@ -1,4 +1,4 @@
-Feature: Usage with RSpec
+Feature: Usage with RSpec macro
 
   VCR provides a macro that makes it easy to use a VCR cassette for an RSpec
   example group.  To use it, simply add `config.extend VCR::RSpec::Macros`
@@ -66,8 +66,8 @@ Feature: Usage with RSpec
       require 'vcr'
 
       VCR.configure do |c|
-        c.cassette_library_dir     = 'spec/cassettes'
-        c.hook_into                :fakeweb
+        c.cassette_library_dir = 'spec/cassettes'
+        c.hook_into :fakeweb
       end
 
       RSpec.configure do |c|
@@ -79,11 +79,11 @@ Feature: Usage with RSpec
      And the file "spec/cassettes/VCR-RSpec_integration/without_an_explicit_cassette_name.yml" should contain "body: Hello"
      And the file "spec/cassettes/net_http_example.yml" should contain "body: Hello"
 
+  @rspec-1 @exclude-jruby
   Scenario: Use `use_vcr_cassette` macro with RSpec 1
     Given a file named "spec/spec_helper.rb" with:
       """ruby
       require 'sinatra_app'
-      $LOAD_PATH.unshift(File.join(%w[ .. .. vendor rspec-1 lib ]))
 
       require 'spec'
       require 'spec/autorun'
@@ -91,15 +91,15 @@ Feature: Usage with RSpec
       require 'vcr'
 
       VCR.configure do |c|
-        c.cassette_library_dir     = 'spec/cassettes'
-        c.hook_into                  :fakeweb
+        c.cassette_library_dir = 'spec/cassettes'
+        c.hook_into :fakeweb
       end
 
       Spec::Runner.configure do |c|
         c.extend VCR::RSpec::Macros
       end
       """
-    When I run `ruby -Ispec spec/vcr_example_spec.rb`
+    When I run `spec spec/vcr_example_spec.rb`
     Then the output should contain "2 examples, 0 failures"
      And the file "spec/cassettes/VCR-RSpec_integration/without_an_explicit_cassette_name.yml" should contain "body: Hello"
      And the file "spec/cassettes/net_http_example.yml" should contain "body: Hello"

data/features/test_frameworks/rspec_metadata.feature

@@ -0,0 +1,90 @@
+Feature: Usage with RSpec metadata
+
+  VCR provides easy integration with RSpec using metadata. To set this
+  up, call `configure_rspec_metadata!` in your `VCR.configure` block.
+
+  Once you've done that, you can have an example group or example use
+  VCR by passing `:vcr` as an additional argument after the description
+  string. It will use set the cassette name based on the example's
+  full description.
+
+  If you need to override the cassette name or options, you can pass a
+  hash (`:vcr => { ... }`).
+
+  Background:
+    Given a file named "spec/spec_helper.rb" with:
+      """ruby
+      require 'vcr'
+
+      VCR.configure do |c|
+        c.cassette_library_dir = 'spec/cassettes'
+        c.hook_into :fakeweb
+        c.configure_rspec_metadata!
+      end
+
+      RSpec.configure do |c|
+        # so we can use `:vcr` rather than `:vcr => true`;
+        # in RSpec 3 this will no longer be necessary.
+        c.treat_symbols_as_metadata_keys_with_true_values = true
+      end
+      """
+
+  Scenario: Use `:vcr` metadata
+    Given a file named "spec/vcr_example_spec.rb" with:
+      """
+      start_sinatra_app(:port => 7777) do
+        get('/') { "Hello" }
+      end
+
+      def make_http_request
+        Net::HTTP.get_response('localhost', '/', 7777).body
+      end
+
+      require 'spec_helper'
+
+      describe "VCR example group metadata", :vcr do
+        it 'records an http request' do
+          make_http_request.should == 'Hello'
+        end
+
+        it 'records another http request' do
+          make_http_request.should == 'Hello'
+        end
+
+        context 'in a nested example group' do
+          it 'records another one' do
+            make_http_request.should == 'Hello'
+          end
+        end
+      end
+
+      describe "VCR example metadata" do
+        it 'records an http request', :vcr do
+          make_http_request.should == 'Hello'
+        end
+      end
+      """
+    When I run `rspec spec/vcr_example_spec.rb`
+    Then it should pass with "4 examples, 0 failures"
+     And the file "spec/cassettes/VCR_example_group_metadata/records_an_http_request.yml" should contain "body: Hello"
+     And the file "spec/cassettes/VCR_example_group_metadata/records_another_http_request.yml" should contain "body: Hello"
+     And the file "spec/cassettes/VCR_example_group_metadata/in_a_nested_example_group/records_another_one.yml" should contain "body: Hello"
+     And the file "spec/cassettes/VCR_example_metadata/records_an_http_request.yml" should contain "body: Hello"
+
+  Scenario: Pass a hash to set the cassette options
+    Given a file named "spec/vcr_example_spec.rb" with:
+      """
+      require 'spec_helper'
+
+      describe "Using an options hash", :vcr => { :cassette_name => "example", :record => :new_episodes } do
+        it 'uses the provided cassette name' do
+          VCR.current_cassette.name.should == "example"
+        end
+
+        it 'sets the given options' do
+          VCR.current_cassette.record_mode.should == :new_episodes
+        end
+      end
+      """
+    When I run `rspec spec/vcr_example_spec.rb`
+    Then it should pass with "2 examples, 0 failures"

data/lib/vcr.rb

@@ -65,7 +65,7 @@ module VCR
 
   def http_interactions
     return current_cassette.http_interactions if current_cassette
-    VCR::Cassette::HTTPInteractionList::NullList.new
+    VCR::Cassette::HTTPInteractionList::NullList
   end
 
   def real_http_connections_allowed?

data/lib/vcr/cassette.rb

@@ -34,7 +34,7 @@ module VCR
       @exclusive                    = options[:exclusive]
       @serializer                   = VCR.cassette_serializers[options[:serialize_with]]
       @record_mode                  = :all if should_re_record?
-      @parent_list                  = @exclusive ? HTTPInteractionList::NullList.new : VCR.http_interactions
+      @parent_list                  = @exclusive ? HTTPInteractionList::NullList : VCR.http_interactions
 
       raise_error_unless_valid_record_mode
     end
@@ -144,7 +144,7 @@ module VCR
       if should_remove_matching_existing_interactions?
         new_interaction_list = HTTPInteractionList.new(new_recorded_interactions, match_requests_on)
         old_interactions = old_interactions.reject do |i|
-          new_interaction_list.has_interaction_matching?(i.request)
+          new_interaction_list.response_for(i.request)
         end
       end
 
@@ -170,7 +170,7 @@ module VCR
 
     def invoke_hook(type, interactions)
       interactions.delete_if do |i|
-        VCR.configuration.invoke_hook(type, tag, i, self)
+        VCR.configuration.invoke_tagged_hook(type, tag, i, self)
         i.ignored?
       end
     end

data/lib/vcr/cassette/http_interaction_list.rb

@@ -1,16 +1,18 @@
 module VCR
   class Cassette
     class HTTPInteractionList
-      class NullList
+      module NullList
+        extend self
         def response_for(*a); nil; end
-        def has_interaction_matching?(*a); false; end
+        def has_used_interaction_matching?(*a); false; end
+        def remaining_unused_interaction_count(*a); 0; end
       end
 
       attr_reader :interactions, :request_matchers, :allow_playback_repeats, :parent_list
 
-      def initialize(interactions, request_matchers, allow_playback_repeats = false, parent_list = NullList.new)
+      def initialize(interactions, request_matchers, allow_playback_repeats = false, parent_list = NullList)
         @interactions           = interactions.dup
-        @request_matchers       = request_matchers
+        @request_matchers       = request_matchers.map { |m| VCR.request_matchers[m] }
         @allow_playback_repeats = allow_playback_repeats
         @parent_list            = parent_list
         @used_interactions      = []
@@ -28,10 +30,12 @@ module VCR
         end
       end
 
-      def has_interaction_matching?(request)
-        !!matching_interaction_index_for(request) ||
-        !!matching_used_interaction_for(request) ||
-        @parent_list.has_interaction_matching?(request)
+      def has_used_interaction_matching?(request)
+        @used_interactions.any? { |i| interaction_matches_request?(request, i) }
+      end
+
+      def remaining_unused_interaction_count
+        @interactions.size
       end
 
     private
@@ -47,7 +51,7 @@ module VCR
 
       def interaction_matches_request?(request, interaction)
         @request_matchers.all? do |matcher|
-          VCR.request_matchers[matcher].matches?(request, interaction.request)
+          matcher.matches?(request, interaction.request)
         end
       end
     end