vcr 1.4.0 → 1.5.0

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## In git
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.5.0...master)
+
+## 1.5.0 (January 12, 2011)
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.4.0...v1.5.0)
+
+* Fix VCR::Cassette so it does not raise an error when a cassette file is
+  empty.  Bug reported and fixed by [Karl Baum](https://github.com/kbaum).
+* Lots of code cleanup.
+* Fix the stubbing adapters so that they use the cassette instance
+  rather than the cassette name to create and restore checkpoints.
+* Raise an appropriate error when a nested cassette is inserted with the
+  same name as a cassette that is already in the stack (VCR's design
+  doesn't allow this and you would get weird errors later on).
+* Raise an appropriate error when restoring a stubs checkpoint if the
+  checkpoint cannot be found.
+* Add `before_record` and `before_playback` hooks.  Idea and initial
+  implementation by [Oliver Searle-Barnes](https://github.com/opsb);
+  futher suggestions, testing and feedback by
+  [Nathaniel Bibler](https://github.com/nbibler).
+
 ## 1.4.0 (December 3, 2010)
 
 [Full Changelog](http://github.com/myronmarston/vcr/compare/v1.3.3...v1.4.0)

data/Gemfile

@@ -13,8 +13,6 @@ group :development do
   platforms :jruby do
     gem 'jruby-openssl'
   end
-
-  gem 'shoulda'
 end
 
 # Additional gems that are useful, but not required for development.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vcr (1.4.0)
+    vcr (1.5.0)
 
 GEM
   remote: http://rubygems.org/
@@ -29,12 +29,13 @@ GEM
       addressable (>= 2.0.0)
       eventmachine (>= 0.12.9)
     eventmachine (0.12.10)
+    eventmachine (0.12.10-java)
     fakeweb (1.3.0)
     faraday (0.5.3)
       addressable (~> 2.2.2)
       multipart-post (~> 1.0.1)
       rack (>= 1.1.0, < 2)
-    fuubar (0.0.2)
+    fuubar (0.0.3)
       rspec (~> 2.0)
       rspec-instafail (~> 0.1.4)
       ruby-progressbar (~> 0.0.9)
@@ -73,21 +74,21 @@ GEM
     rake (0.8.7)
     rb-fsevent (0.3.6)
     rcov (0.9.9)
-    relish (0.1.5)
+    relish (0.2.0)
       archive-tar-minitar (~> 0.5.2)
       json (~> 1.4.6)
       rest-client (~> 1.6.1)
     rest-client (1.6.1)
       mime-types (>= 1.16)
-    rspec (2.1.0)
-      rspec-core (~> 2.1.0)
-      rspec-expectations (~> 2.1.0)
-      rspec-mocks (~> 2.1.0)
-    rspec-core (2.1.0)
-    rspec-expectations (2.1.0)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
       diff-lcs (~> 1.1.2)
-    rspec-instafail (0.1.4)
-    rspec-mocks (2.1.0)
+    rspec-instafail (0.1.5)
+    rspec-mocks (2.4.0)
     ruby-debug (0.10.3)
       columnize (>= 0.1)
       ruby-debug-base (~> 0.10.3.0)
@@ -113,7 +114,7 @@ GEM
     tilt (1.1)
     timecop (0.3.5)
     typhoeus (0.2.0)
-    webmock (1.6.1)
+    webmock (1.6.2)
       addressable (>= 2.2.2)
       crack (>= 0.1.7)
 
@@ -141,11 +142,11 @@ DEPENDENCIES
   rb-fsevent
   rcov
   relish
-  rspec (~> 2.1.0)
+  rspec (~> 2.4.0)
   ruby-debug
   ruby-debug-base19 (= 0.11.23)
   ruby-debug19
-  shoulda
+  shoulda (~> 2.9.2)
   sinatra (~> 1.1.0)
   timecop (~> 0.3.5)
   typhoeus (~> 0.2.0)

data/Guardfile

@@ -3,9 +3,8 @@
 
 guard 'rspec', :version => 2 do
   watch('^spec/(.*)_spec.rb')
-  watch('^lib/vcr.rb')                                { "spec/vcr_spec.rb" }
-  watch('^lib/vcr/(.*)\.rb')                          { |m| "spec/#{m[1]}_spec.rb" }
-  watch('^spec/spec_helper.rb')                       { "spec" }
+  watch('^lib/(.*)\.rb')           { |m| "spec/#{m[1]}_spec.rb" }
+  watch('^spec/spec_helper.rb')    { "spec" }
 end
 
 guard 'cucumber' do

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Myron Marston
+Copyright (c) 2010-2011 Myron Marston
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -4,6 +4,7 @@ Record your test suite's HTTP interactions and replay them during future test ru
 
 ## Synopsis
 
+    require 'rubygems'
     require 'test/unit'
     require 'vcr'
 
@@ -87,7 +88,10 @@ Thanks also to the following people who have contributed patches or helpful sugg
 * [Bartosz Blimke](http://github.com/bblimke)
 * [Ben Hutton](http://github.com/benhutton)
 * [Eric Allam](http://github.com/rubymaverick)
+* [Karl Baum](https://github.com/kbaum)
+* [Nathaniel Bibler](https://github.com/nbibler)
+* [Oliver Searle-Barnes](https://github.com/opsb)
 
 ## Copyright
 
-Copyright (c) 2010 Myron Marston. See LICENSE for details.
+Copyright (c) 2010-2011 Myron Marston. See LICENSE for details.

data/features/.nav

@@ -0,0 +1,28 @@
+- cassettes:
+  - format.feature
+  - no_cassette.feature
+  - request_matching.feature
+  - dynamic_erb.feature
+  - automatic_re_recording.feature
+- record_modes:
+  - new_episodes.feature
+  - none.feature
+  - all.feature
+- configuration:
+  - cassette_library_dir.feature
+  - stub_with.feature
+  - default_cassette_options.feature
+  - ignore_localhost.feature
+  - hooks.feature
+  - allow_http_connections_when_no_cassette.feature
+- test_frameworks:
+  - test_unit.feature
+  - shoulda.feature
+  - rspec.feature
+  - cucumber.feature
+- middleware:
+  - rack.feature
+  - faraday.feature
+- http_libraries:
+  - net_http.feature
+  - em_http_request.feature

data/features/README.md

@@ -12,7 +12,7 @@ provided by `vcr_cucumber_helpers.rb`:
   the replaying of a recorded HTTP response.
 * `include_http_adapter_for`: includes a module that implements a common
   HTTP interface for the given HTTP library.  The `response_body_for`
-  method will make an HTTP request using the given this library.  This
+  method will make an HTTP request using the given library.  This
   allows scenarios to be run against each different supported HTTP
   library.
 

data/features/cassettes/automatic_re_recording.feature

@@ -2,12 +2,12 @@ Feature: Automatic Re-recording
 
   Over time, your cassettes may get out-of-date. APIs change and sites you
   scrape get updated. VCR provides a facility to automatically re-record your
-  cassettes. Enable re-recording using the :re_record_interval option.
+  cassettes. Enable re-recording using the `:re_record_interval` option.
 
   The value provided should be an interval (expressed in seconds) that
   determines how often VCR will re-record the cassette.  When a cassette
   is used, VCR checks the file modification time; if more time than the
-  interval has passed, VCR will use the :all record mode to cause it be
+  interval has passed, VCR will use the `:all` record mode to cause it be
   re-recorded.
 
   Background:

data/features/cassettes/format.feature

@@ -5,8 +5,8 @@ Feature: Cassette format
   human-readable/editable format.  A cassette contains an array
   of HTTP interactions, each of which has the following:
 
-    * Request method, uri, body, headers
-    * Response status (code & message), headers, body, http version
+    - Request method, uri, body, headers
+    - Response status (code & message), headers, body, http version
 
   Scenario Outline: Request/Response data is saved to disk as YAML
     Given a file named "cassette_format.rb" with:

data/features/cassettes/no_cassette.feature

@@ -11,9 +11,9 @@ Feature: Error for HTTP request made when no cassette is in use
   (see configuration/allow_http_connections_when_no_cassette.feature) or
   you can temporarily turn VCR off:
 
-    * VCR.turn_off! => turn VCR off so HTTP requests are allowed
-    * VCR.turn_on! => turn VCR back on
-    * VCR.turned_off { ... } => turn VCR off for the duration of the
+    - `VCR.turn_off!` => turn VCR off so HTTP requests are allowed
+    - `VCR.turn_on!` => turn VCR back on
+    - `VCR.turned_off { ... }` => turn VCR off for the duration of the
       provided block.
 
   Scenario Outline: Error for request when no cassette is in use

data/features/cassettes/request_matching.feature

@@ -8,16 +8,16 @@ Feature: Request matching
   You can customize how VCR matches requests using the `:match_requests_on` option.
   Specify an array of attributes to match on.  Supported attributes are:
 
-    * :method - The HTTP method (i.e. GET, POST, PUT or DELETE) of the request.
-    * :uri - The full URI of the request.
-    * :host - The host of the URI. You can use this (alone, or in combination
-      with :path) as an alternative to :uri to cause VCR to match using a regex
+    - `:method` - The HTTP method (i.e. GET, POST, PUT or DELETE) of the request.
+    - `:uri` - The full URI of the request.
+    - `:host` - The host of the URI. You can use this (alone, or in combination
+      with `:path`) as an alternative to `:uri` to cause VCR to match using a regex
       that matches the host.
-    * :path - The path of the URI. You can use this (alone, or in combination
-      with :host) as an alternative to :uri to cause VCR to match using a regex
+    - `:path` - The path of the URI. You can use this (alone, or in combination
+      with `:host`) as an alternative to `:uri` to cause VCR to match using a regex
       that matches the path.
-    * :body - The body of the request. (Unsupported when you use FakeWeb.)
-    * :headers - The request headers. (Unsupported when you use FakeWeb.)
+    - `:body` - The body of the request. (Unsupported when you use FakeWeb.)
+    - `:headers` - The request headers. (Unsupported when you use FakeWeb.)
 
   Alternately, you can manually edit a cassette and change a URI to the YAML
   of a regular expression.

data/features/configuration/allow_http_connections_when_no_cassette.feature

@@ -1,4 +1,4 @@
-Feature: allow_http_connections_when_no_cassette configuration option
+Feature: allow_http_connections_when_no_cassette
 
   Usually, HTTP requests made when no cassette is inserted will result
   in an error (see cassettes/no_cassette.feature).  You can set the

data/features/configuration/cassette_library_dir.feature

@@ -1,4 +1,4 @@
-Feature: cassette_library_dir configuration option
+Feature: cassette_library_dir
 
   The `cassette_library_dir` configuration option sets a directory
   where VCR saves each cassette.

data/features/configuration/default_cassette_options.feature

@@ -1,10 +1,10 @@
-Feature: default_cassette_options configuration option
+Feature: default_cassette_options
 
   The `default_cassette_options` configuration option takes a hash
   that provides defaults for each cassette you use.  Any cassette
   can override the defaults as well as set additional options.
 
-  The `:match_requests_on` option defaults to [:method, :uri] when
+  The `:match_requests_on` option defaults to `[:method, :uri]` when
   it has not been set.
 
   Background:

data/features/configuration/hooks.feature

@@ -0,0 +1,276 @@
+Feature: Hooks
+
+  VCR provides two global hooks that you can use to customize recording and
+  playback:
+
+    - `before_record`: Called before a cassette is written to disk.
+    - `before_playback`: Called before a cassette sets up its stubs for playback.
+
+  To use these, call `config.before_record` or `config.before_playback` in
+  your `VCR.config` block.  Provide a block that accepts 0, 1 or 2 arguments.
+
+  The first argument, if the block accepts it, will be an HTTP interaction.
+  Changes you make to the interaction will be reflected in the recording or
+  playback.  You can also call `#ignore!` on the interaction to cause VCR to
+  ignore it.  It will not be recorded or played back (depending on which
+  kind of hook you use).
+
+  The second argument, if the block accepts it, will be the
+  `VCR::Cassette` instance.  This may be useful for hooks that you want to
+  behave differently for different cassettes.
+
+  You can also use tagging to apply hooks to particular cassettes.  Consider
+  this code:
+
+      VCR.config do |c|
+        c.before_record(:twitter) { ... } # modify the interactions somehow
+      end
+
+      VCR.use_cassette('cassette_1', :tag => :twitter) { ... }
+      VCR.use_cassette('cassette_2') { ... }
+
+  In this example, the hook would apply to the first cassette but not the
+  second cassette.
+
+  You can setup as many hooks as you like; each will be invoked at the
+  appropriate time.
+
+  Background:
+    Given a previously recorded cassette file "cassettes/example.yml" with:
+      """
+      ---
+      - !ruby/struct:VCR::HTTPInteraction
+        request: !ruby/struct:VCR::Request
+          method: :get
+          uri: http://example.com:80/foo
+          body:
+          headers:
+        response: !ruby/struct:VCR::Response
+          status: !ruby/struct:VCR::ResponseStatus
+            code: 200
+            message: OK
+          headers:
+            content-type:
+            - text/html;charset=utf-8
+            content-length:
+            - "20"
+          body: example.com response
+          http_version: "1.1"
+      """
+
+  Scenario: Replace sensitive data with before_record hook
+    Given a file named "before_record_example.rb" with:
+      """
+      require 'vcr_cucumber_helpers'
+
+      start_sinatra_app(:port => 7777) do
+        get('/') { "Hello <secret>" }
+      end
+
+      require 'vcr'
+
+      VCR.config do |c|
+        c.stub_with :fakeweb
+        c.cassette_library_dir = 'cassettes'
+
+        c.before_record do |i|
+          i.response.body.sub!(/^Hello .*$/, 'Hello World')
+        end
+
+      end
+
+      VCR.use_cassette('recording_example', :record => :new_episodes) do
+        Net::HTTP.get_response('localhost', '/', 7777)
+      end
+      """
+    When I run "ruby before_record_example.rb"
+    Then the file "cassettes/recording_example.yml" should contain "body: Hello World"
+     And the file "cassettes/recording_example.yml" should not contain "secret"
+
+  Scenario: Prevent recording by ignoring interaction in before_record hook
+    Given a file named "before_record_ignore.rb" with:
+      """
+      require 'vcr_cucumber_helpers'
+
+      start_sinatra_app(:port => 7777) do
+        get('/') { "Hello World" }
+      end
+
+      require 'vcr'
+
+      VCR.config do |c|
+        c.stub_with :fakeweb
+        c.cassette_library_dir = 'cassettes'
+        c.before_record { |i| i.ignore! }
+      end
+
+      VCR.use_cassette('recording_example', :record => :new_episodes) do
+        response = Net::HTTP.get_response('localhost', '/', 7777)
+        puts "Response: #{response.body}"
+      end
+      """
+    When I run "ruby before_record_ignore.rb"
+    Then it should pass with "Response: Hello World"
+    And the file "cassettes/recording_example.yml" should not exist
+
+  Scenario: Change playback with before_playback hook
+    Given a file named "before_playback_example.rb" with:
+      """
+      require 'vcr'
+
+      VCR.config do |c|
+        c.stub_with                :fakeweb
+        c.cassette_library_dir     = 'cassettes'
+
+        c.before_playback do |i|
+          i.response.body = 'response from before_playback'
+        end
+      end
+
+      VCR.use_cassette('example', :record => :new_episodes) do
+        response = Net::HTTP.get_response('example.com', '/foo')
+        puts "Response: #{response.body}"
+      end
+      """
+    When I run "ruby before_playback_example.rb"
+    Then it should pass with "Response: response from before_playback"
+
+  Scenario: Prevent playback by ignoring interaction in before_playback hook
+    Given a previously recorded cassette file "cassettes/localhost.yml" with:
+      """
+      ---
+      - !ruby/struct:VCR::HTTPInteraction
+        request: !ruby/struct:VCR::Request
+          method: :get
+          uri: http://localhost:7777/
+          body:
+          headers:
+        response: !ruby/struct:VCR::Response
+          status: !ruby/struct:VCR::ResponseStatus
+            code: 200
+            message: OK
+          headers:
+            content-type:
+            - text/html;charset=utf-8
+            content-length:
+            - "20"
+          body: recorded response
+          http_version: "1.1"
+      """
+    And a file named "before_playback_ignore.rb" with:
+      """
+      require 'vcr_cucumber_helpers'
+
+      start_sinatra_app(:port => 7777) do
+        get('/') { "sinatra response" }
+      end
+
+      require 'vcr'
+
+      VCR.config do |c|
+        c.stub_with                :fakeweb
+        c.cassette_library_dir     = 'cassettes'
+        c.before_playback { |i| i.ignore! }
+      end
+
+      VCR.use_cassette('localhost', :record => :new_episodes) do
+        response = Net::HTTP.get_response('localhost', '/', 7777)
+        puts "Response: #{response.body}"
+      end
+      """
+    When I run "ruby before_playback_ignore.rb"
+    Then it should pass with "Response: sinatra response"
+
+  Scenario: Multiple hooks are run in order
+    Given a file named "multiple_hooks.rb" with:
+      """
+      require 'vcr_cucumber_helpers'
+
+      start_sinatra_app(:port => 7777) do
+        get('/') { "Hello World" }
+      end
+
+      require 'vcr'
+
+      VCR.config do |c|
+        c.stub_with :fakeweb
+        c.cassette_library_dir = 'cassettes'
+
+        c.before_record { puts "In before_record hook 1" }
+        c.before_record { puts "In before_record hook 2" }
+
+        c.before_playback { puts "In before_playback hook 1" }
+        c.before_playback { puts "In before_playback hook 2" }
+      end
+
+      VCR.use_cassette('example', :record => :new_episodes) do
+        response = Net::HTTP.get_response('localhost', '/', 7777)
+        puts "Response 1: #{response.body}"
+
+        response = Net::HTTP.get_response('example.com', '/foo')
+        puts "Response 2: #{response.body}"
+      end
+      """
+    When I run "ruby multiple_hooks.rb"
+    Then it should pass with:
+      """
+      In before_playback hook 1
+      In before_playback hook 2
+      Response 1: Hello World
+      Response 2: example.com response
+      In before_record hook 1
+      In before_record hook 2
+      """
+
+  Scenario: Use tagging to apply hooks to only certain cassettes
+    Given a file named "tagged_hooks.rb" with:
+      """
+      require 'vcr_cucumber_helpers'
+
+      start_sinatra_app(:port => 7777) do
+        get('/') { "Hello World" }
+      end
+
+      require 'vcr'
+
+      VCR.config do |c|
+        c.stub_with :fakeweb
+        c.cassette_library_dir = 'cassettes'
+
+        c.before_record(:tag_1)   { |i| puts "In before_record hook for tag_1 (#{i.response.body})" }
+        c.before_playback(:tag_2) { |i| puts "In before_playback hook for tag_2 (#{i.response.body})" }
+      end
+
+      [:tag_1, :tag_2, nil].each do |tag|
+        puts
+        puts "Using tag: #{tag.inspect}"
+
+        VCR.use_cassette('example', :record => :new_episodes, :tag => tag) do
+          response = Net::HTTP.get_response('localhost', '/', 7777)
+          puts "Response 1: #{response.body}"
+
+          response = Net::HTTP.get_response('example.com', '/foo')
+          puts "Response 2: #{response.body}"
+        end
+      end
+      """
+    When I run "ruby tagged_hooks.rb"
+    Then it should pass with:
+      """
+      Using tag: :tag_1
+      Response 1: Hello World
+      Response 2: example.com response
+      In before_record hook for tag_1 (example.com response)
+      In before_record hook for tag_1 (Hello World)
+
+      Using tag: :tag_2
+      In before_playback hook for tag_2 (example.com response)
+      In before_playback hook for tag_2 (Hello World)
+      Response 1: Hello World
+      Response 2: example.com response
+
+      Using tag: nil
+      Response 1: Hello World
+      Response 2: example.com response
+      """
+