vcr 2.5.0 → 2.6.0

data/features/test_frameworks/rspec_metadata.feature

@@ -5,7 +5,7 @@ Feature: Usage with RSpec metadata
 
   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
+  string. It will 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
@@ -28,6 +28,31 @@ Feature: Usage with RSpec metadata
         c.treat_symbols_as_metadata_keys_with_true_values = true
       end
       """
+    And a previously recorded cassette file "spec/cassettes/Group/optionally_raises_an_error.yml" with:
+      """
+      --- 
+      http_interactions: 
+      - request: 
+          method: get
+          uri: http://example.com/foo
+          body: 
+            encoding: UTF-8
+            string: ""
+          headers: {}
+        response: 
+          status: 
+            code: 200
+            message: OK
+          headers: 
+            Content-Length: 
+            - "5"
+          body: 
+            encoding: UTF-8
+            string: Hello
+          http_version: "1.1"
+        recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
+      recorded_with: VCR 2.0.0
+      """
 
   Scenario: Use `:vcr` metadata
     Given a file named "spec/vcr_example_spec.rb" with:
@@ -71,6 +96,39 @@ Feature: Usage with RSpec metadata
      And the file "spec/cassettes/VCR_example_group_metadata/in_a_nested_example_group/records_another_one.yml" should contain "Hello"
      And the file "spec/cassettes/VCR_example_metadata/records_an_http_request.yml" should contain "Hello"
 
+  Scenario: `:allow_unused_http_interactions => false` causes a failure if there are unused interactions
+    And a file named "spec/vcr_example_spec.rb" with:
+      """ruby
+      require 'spec_helper'
+
+      describe "Group", :vcr => { :allow_unused_http_interactions => false } do
+        it 'optionally raises an error' do
+          # don't fail
+        end
+      end
+      """
+    When I run `rspec spec/vcr_example_spec.rb`
+    Then it should fail with an error like:
+      """
+      There are unused HTTP interactions left in the cassette:
+        - [get http://example.com/foo] => [200 "Hello"]
+      """
+
+  Scenario: `:allow_unused_http_interactions => false` does not raise if the example already failed
+    And a file named "spec/vcr_example_spec.rb" with:
+      """ruby
+      require 'spec_helper'
+
+      describe "Group", :vcr => { :allow_unused_http_interactions => false } do
+        it 'optionally raises an error' do
+          raise "boom"
+        end
+      end
+      """
+    When I run `rspec spec/vcr_example_spec.rb`
+    Then it should fail with "boom"
+     And the output should not contain "There are unused HTTP interactions"
+
   Scenario: Pass a hash to set the cassette options
     Given a file named "spec/vcr_example_spec.rb" with:
       """ruby

data/gemfiles/typhoeus_old.gemfile

@@ -10,6 +10,25 @@ gem "fuubar"
 gem "fuubar-cucumber"
 gem "redcarpet", "~> 1.17.2", :platforms=>:ruby
 gem "github-markup"
+gem "rake", ">= 0.9.2"
+gem "cucumber", ">= 1.1.4"
+gem "aruba", ">= 0.5"
+gem "rspec", ">= 2.11"
+gem "fakeweb", ">= 1.3.0"
+gem "faraday", ">= 0.8"
+gem "httpclient", ">= 2.2"
+gem "excon", ">= 0.22"
+gem "timecop", "0.6.1"
+gem "rack", ">= 1.3.6"
+gem "sinatra", ">= 1.3.2"
+gem "multi_json", ">= 1.0.3"
+gem "json", ">= 1.6.5"
+gem "simplecov", ">= 0.5.3"
+gem "redis", ">= 2.2.2"
+gem "patron", ">= 0.4.15", :platform=>:ruby
+gem "em-http-request", ">= 1.0.2", :platform=>:ruby
+gem "curb", ">= 0.8.0", :platform=>:ruby
+gem "yajl-ruby", ">= 1.1.0", :platform=>:ruby
 gem "typhoeus", "~> 0.4.2"
 gem "webmock", "1.8.11"
 

data/gemfiles/typhoeus_old.gemfile.lock

@@ -1,99 +1,99 @@
 PATH
   remote: /Users/myron/code/vcr
   specs:
-    vcr (2.4.0)
+    vcr (2.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.3)
-    appraisal (0.5.1)
+    addressable (2.3.5)
+    appraisal (0.5.2)
       bundler
       rake
     archive-tar-minitar (0.5.2)
-    aruba (0.4.11)
-      childprocess (>= 0.2.3)
+    aruba (0.5.3)
+      childprocess (>= 0.3.6)
       cucumber (>= 1.1.1)
-      ffi (>= 1.0.11)
-      rspec (>= 2.7.0)
-    builder (3.2.0)
+      rspec-expectations (>= 2.7.0)
+    builder (3.2.2)
     childprocess (0.3.9)
       ffi (~> 1.0, >= 1.0.11)
     cookiejar (0.3.0)
-    crack (0.3.2)
-    cucumber (1.1.9)
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    cucumber (1.3.8)
       builder (>= 2.1.2)
-      diff-lcs (>= 1.1.2)
-      gherkin (~> 2.9.0)
-      json (>= 1.4.6)
-      term-ansicolor (>= 1.0.6)
-    curb (0.8.3)
-    diff-lcs (1.2.1)
-    em-http-request (1.0.3)
-      addressable (>= 2.2.3)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12.1)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.0.2)
+    curb (0.8.4)
+    diff-lcs (1.2.4)
+    em-http-request (1.1.0)
+      addressable (>= 2.3.4)
       cookiejar
-      em-socksify
-      eventmachine (>= 1.0.0.beta.4)
-      http_parser.rb (>= 0.5.3)
-    em-socksify (0.2.1)
+      em-socksify (>= 0.3)
+      eventmachine (>= 1.0.3)
+      http_parser.rb (>= 0.6.0.beta.2)
+    em-socksify (0.3.0)
       eventmachine (>= 1.0.0.beta.4)
-    eventmachine (1.0.1)
-    excon (0.20.0)
+    eventmachine (1.0.3)
+    excon (0.25.3)
     fakeweb (1.3.0)
-    faraday (0.8.6)
-      multipart-post (~> 1.1)
-    ffi (1.3.1)
-    fuubar (1.0.0)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    ffi (1.9.0)
+    fuubar (1.2.1)
       rspec (~> 2.0)
       rspec-instafail (~> 0.2.0)
-      ruby-progressbar (~> 0.0.10)
-    fuubar-cucumber (0.0.15)
-      cucumber (>= 1.0.2)
-      ruby-progressbar (~> 0.0.10)
-    gherkin (2.9.3)
-      json (>= 1.4.6)
+      ruby-progressbar (~> 1.0)
+    fuubar-cucumber (0.0.20)
+      cucumber (~> 1.3.0)
+      ruby-progressbar (~> 1.0.0)
+    gherkin (2.12.1)
+      multi_json (~> 1.3)
     github-markup (0.7.5)
-    http_parser.rb (0.5.3)
-    httpclient (2.3.3)
-    json (1.6.8)
-    mime-types (1.21)
-    multi_json (1.0.4)
+    http_parser.rb (0.6.0.beta.2)
+    httpclient (2.3.4.1)
+    json (1.8.0)
+    mime-types (1.25)
+    multi_json (1.8.0)
+    multi_test (0.0.2)
     multipart-post (1.2.0)
     patron (0.4.18)
-    rack (1.3.10)
-    rack-protection (1.4.0)
+    rack (1.5.2)
+    rack-protection (1.5.0)
       rack
-    rake (0.9.6)
+    rake (10.1.0)
     redcarpet (1.17.2)
-    redis (2.2.2)
-    relish (0.6)
+    redis (3.0.4)
+    relish (0.7)
       archive-tar-minitar (>= 0.5.2)
       json (>= 1.4.6)
       rest-client (>= 1.6.1)
     rest-client (1.6.7)
       mime-types (>= 1.16)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.0)
-    rspec-expectations (2.13.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-instafail (0.2.4)
-    rspec-mocks (2.13.0)
-    ruby-progressbar (0.0.10)
-    shoulda (2.9.2)
-    simplecov (0.5.4)
-      multi_json (~> 1.0.3)
-      simplecov-html (~> 0.5.3)
-    simplecov-html (0.5.3)
-    sinatra (1.3.3)
-      rack (~> 1.3, >= 1.3.6)
-      rack-protection (~> 1.2)
-      tilt (~> 1.3, >= 1.3.3)
-    term-ansicolor (1.0.7)
-    tilt (1.3.4)
-    timecop (0.3.5)
+    rspec-mocks (2.14.3)
+    ruby-progressbar (1.0.2)
+    safe_yaml (0.9.7)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    sinatra (1.4.3)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    tilt (1.4.1)
+    timecop (0.6.1)
     typhoeus (0.4.2)
       ffi (~> 1.0)
       mime-types (~> 1.18)
@@ -101,41 +101,39 @@ GEM
       addressable (>= 2.2.7)
       crack (>= 0.1.7)
     yajl-ruby (1.1.0)
-    yard (0.8.5.2)
+    yard (0.8.7.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   appraisal
-  aruba (~> 0.4.11)
-  bundler (>= 1.0.7)
-  cucumber (~> 1.1.4)
-  curb (~> 0.8.0)
-  em-http-request (~> 1.0.2)
-  excon (>= 0.11.0, < 1.0)
-  fakeweb (~> 1.3.0)
-  faraday (~> 0.8)
+  aruba (>= 0.5)
+  cucumber (>= 1.1.4)
+  curb (>= 0.8.0)
+  em-http-request (>= 1.0.2)
+  excon (>= 0.22)
+  fakeweb (>= 1.3.0)
+  faraday (>= 0.8)
   fuubar
   fuubar-cucumber
   github-markup
-  httpclient (~> 2.2)
+  httpclient (>= 2.2)
   jruby-openssl
-  json (~> 1.6.5)
-  multi_json (~> 1.0.3)
-  patron (~> 0.4.15)
-  rack (~> 1.3.6)
-  rake (~> 0.9.2)
+  json (>= 1.6.5)
+  multi_json (>= 1.0.3)
+  patron (>= 0.4.15)
+  rack (>= 1.3.6)
+  rake (>= 0.9.2)
   redcarpet (~> 1.17.2)
-  redis (~> 2.2.2)
+  redis (>= 2.2.2)
   relish (~> 0.6)
-  rspec (~> 2.11)
-  shoulda (~> 2.9.2)
-  simplecov (~> 0.5.3)
-  sinatra (~> 1.3.2)
-  timecop (~> 0.3.5)
+  rspec (>= 2.11)
+  simplecov (>= 0.5.3)
+  sinatra (>= 1.3.2)
+  timecop (= 0.6.1)
   typhoeus (~> 0.4.2)
   vcr!
   webmock (= 1.8.11)
-  yajl-ruby (~> 1.1.0)
+  yajl-ruby (>= 1.1.0)
   yard

data/lib/vcr.rb

@@ -88,7 +88,10 @@ module VCR
   # @option options :allow_unused_http_interactions [Boolean] If set to
   #  false, an error will be raised if a cassette is ejected before all
   #  previously recorded HTTP interactions have been used.
-  #  Defaults to true.
+  #  Defaults to true. Note that when an error has already occurred
+  #  (as indicated by the `$!` variable) unused interactions will be
+  #  allowed so that we don't silence the original error (which is almost
+  #  certainly more interesting/important).
   # @option options :exclusive [Boolean] Whether or not to use only this
   #  cassette and to completely ignore any cassettes in the cassettes stack.
   #  Defaults to false.
@@ -134,10 +137,16 @@ module VCR
   # In addition, any newly recorded HTTP interactions will be written to
   # disk.
   #
+  # @param options [Hash] Eject options.
+  # @option options :skip_no_unused_interactions_assertion [Boolean]
+  #  If `true` is given, this will skip the "no unused HTTP interactions"
+  #  assertion enabled by the `:allow_unused_http_interactions => false`
+  #  cassette option. This is intended for use when your test has had
+  #  an error, but your test framework has already handled it.
   # @return [VCR::Cassette, nil] the ejected cassette if there was one
-  def eject_cassette
+  def eject_cassette(options = {})
     cassette = cassettes.last
-    cassette.eject if cassette
+    cassette.eject(options) if cassette
     cassette
   ensure
     cassettes.pop

data/lib/vcr/cassette.rb

@@ -5,7 +5,7 @@ require 'vcr/cassette/serializers'
 module VCR
   # The media VCR uses to store HTTP interactions for later re-use.
   class Cassette
-    include Logger
+    include Logger::Mixin
 
     # The supported record modes.
     #
@@ -56,9 +56,17 @@ module VCR
     # Ejects the current cassette. The cassette will no longer be used.
     # In addition, any newly recorded HTTP interactions will be written to
     # disk.
-    def eject
+    #
+    # @note This is not intended to be called directly. Use `VCR.eject_cassette` instead.
+    #
+    # @param (see VCR#eject_casssette)
+    # @see VCR#eject_cassette
+    def eject(options = {})
       write_recorded_interactions_to_disk
-      http_interactions.assert_no_unused_interactions! unless @allow_unused_http_interactions
+
+      if should_assert_no_unused_interactions? && !options[:skip_no_unused_interactions_assertion]
+        http_interactions.assert_no_unused_interactions!
+      end
     end
 
     # @private
@@ -110,6 +118,20 @@ module VCR
       }
     end
 
+    # @return [Time, nil] The `recorded_at` time of the first HTTP interaction
+    #                     or nil if the cassette has no prior HTTP interactions.
+    #
+    # @example
+    #
+    #   VCR.use_cassette("some cassette") do |cassette|
+    #     Timecop.freeze(cassette.originally_recorded_at || Time.now) do
+    #       # ...
+    #     end
+    #   end
+    def originally_recorded_at
+      @originally_recorded_at ||= previously_recorded_interactions.map(&:recorded_at).min
+    end
+
   private
 
     def assert_valid_options!
@@ -174,13 +196,12 @@ module VCR
 
     def should_re_record?
       return false unless @re_record_interval
-      previously_recorded_at = earliest_interaction_recorded_at
-      return false unless previously_recorded_at
+      return false unless originally_recorded_at
 
       now = Time.now
 
-      (previously_recorded_at + @re_record_interval < now).tap do |value|
-        info = "previously recorded at: '#{previously_recorded_at}'; now: '#{now}'; interval: #{@re_record_interval} seconds"
+      (originally_recorded_at + @re_record_interval < now).tap do |value|
+        info = "previously recorded at: '#{originally_recorded_at}'; now: '#{now}'; interval: #{@re_record_interval} seconds"
 
         if !value
           log "Not re-recording since the interval has not elapsed (#{info})."
@@ -193,10 +214,6 @@ module VCR
       end
     end
 
-    def earliest_interaction_recorded_at
-      previously_recorded_interactions.map(&:recorded_at).min
-    end
-
     def should_stub_requests?
       record_mode != :all
     end
@@ -205,6 +222,10 @@ module VCR
       record_mode == :all
     end
 
+    def should_assert_no_unused_interactions?
+      !(@allow_unused_http_interactions || $!)
+    end
+
     def raw_cassette_bytes
       @raw_cassette_bytes ||= VCR::Cassette::ERBRenderer.new(@persister[storage_key], erb, name).render
     end