vcr 2.1.1 → 2.2.0

data/.travis.yml

@@ -1,7 +1,8 @@
 language: ruby
 env: CUCUMBER_FORMAT=progress
+before_install: "gem uninstall json -a -I"
 bundler_args: --without extras
-script: "bundle exec rake ci:build --trace"
+script: "script/ci.sh"
 rvm:
   - 1.8.7
   - 1.9.2

data/CHANGELOG.md

@@ -1,6 +1,63 @@
 ## In git
 
-[Full Changelog](http://github.com/myronmarston/vcr/compare/v2.1.1...master)
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v2.2.0...master)
+
+## 2.2.0 (May 31, 2012)
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v2.1.1...v2.2.0)
+
+Enhancements:
+
+* Add new `:persist_with` cassette option. It allows you to provide a
+  customized persistence implementation so you can persist it to
+  something other than disk (i.e. a key-value store or a database).
+  Thanks to [Chris Le](https://github.com/chrisle) for the idea and
+  help with the implementation.
+* Allow requests to be stubbed by external libraries (e.g. WebMock,
+  FakeWeb or Typhoeus) without needing to turn VCR off.
+* Add new `:allow_unused_http_interactions` cassette option. When set
+  to false, an error will be raised when a cassette is ejected and
+  there are remaining unused HTTP interactions. Thanks to
+  [Mattias Putman](https://github.com/challengee) for the idea
+  and initial implementation.
+
+Bug Fixes:
+
+* Fix `after_http_request` to handle symbol request predicate filters
+  (e.g. `:ignored?`, `:stubbed?`, `:recordable?`, `:unhandled?`, `:real?`)
+  properly. Previously using one of these would raise an ArgumentError.
+  Thanks to [playupchris](https://github.com/playupchris) for reporting
+  the bug and providing a fix.
+* Fix FakeWeb hook so that it no longer breaks
+  `FakeWeb.allow_net_connect?` with arguments. Thanks to
+  [Ingemar](https://github.com/ingemar) for reporting the bug and
+  providing a fix.
+* Fix WebMock hook so that it no longer breaks
+  `WebMock.net_connect_allowed?` with arguments. Thanks to
+  [Gordon Wilson](https://github.com/gordoncww) for reporting the bug and
+  providing a fix.
+* Print a warning when VCR is used with a poorly behaved Faraday
+  connection stack that has a middleware after the HTTP adapter.
+  VCR may work improperly in this case.
+* Raise an error if a response object is recorded with a non-string
+  body. This fails early and indicates the problem rather than failing
+  later with a strange error.
+* Fix `filter_sensitive_data`/`define_cassette_placeholder` so that they
+  handle non-strings gracefully (e.g. the port number as a Fixnum).
+* Gracefully handle Faraday connection stacks that do not explicitly
+  specify an HTTP adapter. Thanks to [Patrick Roby](https://github.com/proby)
+  for reporting the bug.
+* Work around a bug in WebMock's em-http-request adapter that prevented
+  VCR from working when using the `:redirects` option with
+  em-http-request. This change is just a work around. It fixes the main
+  problem, but some features (such as the http request hooks) may not
+  work properly for this case. The bug will ultimately need to be
+  [fixed in WebMock](https://github.com/bblimke/webmock/pull/185).
+  Thanks to [Mark Abramov](https://github.com/markiz) for reporting
+  the bug and providing a great example test case.
+* Fix bug in handling of Faraday requests with multipart uploads.
+  Thanks to [Tyler Hunt](https://github.com/tylerhunt) for reporting
+  and fixing the bug.
 
 ## 2.1.1 (April 24, 2012)
 

data/Gemfile

@@ -11,8 +11,6 @@ gem 'yard'
 
 # Additional gems that are useful, but not required for development.
 group :extras do
-  gem 'guard-rspec'
-  gem 'growl'
   gem 'relish', '~> 0.5.0'
   gem 'fuubar'
   gem 'fuubar-cucumber'
@@ -20,10 +18,6 @@ group :extras do
   gem 'redcarpet', '~> 1.17.2'
   gem 'github-markup'
 
-  platforms :mri do
-    gem 'rb-fsevent'
-  end
-
   platforms :mri_18, :jruby do
     gem 'ruby-debug'
   end

data/README.md

@@ -142,9 +142,12 @@ Thanks also to the following people who have contributed patches or helpful sugg
 * [Bradley Isotope](https://github.com/bradleyisotope)
 * [Carlos Kirkconnell](https://github.com/kirkconnell)
 * [Chad Jolly](https://github.com/cjolly)
+* [Chris Le](https://github.com/chrisle)
 * [Eric Allam](http://github.com/rubymaverick)
 * [Ezekiel Templin](https://github.com/ezkl)
 * [Flaviu Simihaian](https://github.com/closedbracket)
+* [Gordon Wilson](https://github.com/gordoncww)
+* [Ingemar](https://github.com/ingemar)
 * [Jeff Pollard](https://github.com/Fluxx)
 * [Justin Smestad](https://github.com/jsmestad)
 * [Karl Baum](https://github.com/kbaum)
@@ -154,25 +157,31 @@ Thanks also to the following people who have contributed patches or helpful sugg
 * [Oliver Searle-Barnes](https://github.com/opsb)
 * [Omer Rauchwerger](https://github.com/rauchy)
 * [Paco Guzmán](https://github.com/pacoguzman)
+* [playupchris](https://github.com/playupchris)
 * [Ryan Bates](https://github.com/ryanb)
 * [Sathya Sekaran](https://github.com/sfsekaran)
+* [Tyler Hunt](https://github.com/tylerhunt)
 * [Wesley Beary](https://github.com/geemus)
 
 ## Ports in other languages
 
 * [Betamax](https://github.com/robfletcher/betamax) (Groovy)
-* [VCR.js](https://github.com/elcuervo/vcr.js) (JavaScript)
-* [TapeDeck.js](https://github.com/EndangeredMassa/TapeDeck.js) (JavaScript)
 * [Mimic](https://github.com/acoulton/mimic) (PHP/Kohana)
+* [Nock](https://github.com/flatiron/nock) (JavaScript/Node)
+* [NSURLConnectionVCR](https://bitbucket.org/martijnthe/nsurlconnectionvcr) (Objective C)
+* [TapeDeck.js](https://github.com/EndangeredMassa/TapeDeck.js) (JavaScript)
+* [VCR.js](https://github.com/elcuervo/vcr.js) (JavaScript)
+* [VCR.py](https://github.com/kevin1024/vcrpy) (Python)
+* [vcr-clj](https://github.com/ifesdjeen/vcr-clj) (Clojure)
 
 ## Similar Libraries in Ruby
 
 * [Ephemeral Response](https://github.com/sandro/ephemeral_response)
 * [Net::HTTP Spy](http://github.com/martinbtt/net-http-spy)
 * [NetRecorder](https://github.com/chrisyoung/netrecorder)
+* [REST-assured](https://github.com/BBC/REST-assured)
 * [Stale Fish](https://github.com/jsmestad/stale_fish)
 * [WebFixtures](http://github.com/trydionel/web_fixtures)
-* [REST-assured](https://github.com/BBC/REST-assured)
 
 ## Copyright
 

data/Rakefile

@@ -26,10 +26,10 @@ task :default => [:spec, :cucumber]
 desc "Ensures we keep up 100% YARD coverage"
 task :yard_coverage do
   coverage_stats = `yard stats --list-undoc 2>&1`
+  puts coverage_stats
   if coverage_stats.include?('100.00% documented')
-    puts "Nice work! 100% documentation coverage"
+    puts "\nNice work! 100% documentation coverage"
   else
-    puts coverage_stats
     raise "Documentation coverage is less than 100%"
   end
 end

data/features/.nav

@@ -13,6 +13,8 @@
   - exclusive.feature
   - update_content_length_header.feature
   - decompress.feature
+  - persistence.feature
+  - allow_unused_http_interactions.feature
 - record_modes:
   - once.feature
   - new_episodes.feature

data/features/cassettes/allow_unused_http_interactions.feature

@@ -0,0 +1,86 @@
+Feature: Allow Unused HTTP Interactions
+
+  If set to false, this cassette option will cause VCR to raise an error
+  when a cassette is ejected and there are unused HTTP interactions remaining.
+
+  It verifies that all requests included in the cassette were made, and allows
+  VCR to function a bit like a mock object at the HTTP layer.
+
+  The option defaults to true (mostly for backwards compatibility).
+
+  Background:
+    Given a file named "vcr_config.rb" with:
+      """ruby
+      require 'vcr'
+
+      VCR.configure do |c|
+        c.hook_into :fakeweb
+        c.cassette_library_dir = 'cassettes'
+      end
+      """
+    And a previously recorded cassette file "cassettes/example.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: Unused HTTP interactions are allowed by default
+    Given a file named "allowed_by_default.rb" with:
+      """ruby
+      require 'vcr_config'
+
+      VCR.use_cassette("example") do
+        # no requests
+      end
+      """
+    When I run `ruby allowed_by_default.rb`
+    Then it should pass
+
+  Scenario: Error raised if option is false and there are unused interactions
+    Given a file named "disallowed_with_no_requests.rb" with:
+      """ruby
+      require 'vcr_config'
+
+      VCR.use_cassette("example", :allow_unused_http_interactions => false) do
+        # no requests
+      end
+      """
+    When I run `ruby disallowed_with_no_requests.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: No error raised if option is false and all interactions are used
+    Given a file named "disallowed_with_all_requests.rb" with:
+      """ruby
+      require 'vcr_config'
+
+      VCR.use_cassette("example", :allow_unused_http_interactions => false) do
+        Net::HTTP.get_response(URI("http://example.com/foo"))
+      end
+      """
+    When I run `ruby disallowed_with_all_requests.rb`
+    Then it should pass
+

data/features/cassettes/naming.feature

@@ -1,8 +1,9 @@
 Feature: Naming
 
   When inserting or using a cassette, the first argument is the cassette name.
-  You can use any string for the name.  VCR will sanitize the string before
-  using it as a file name, so that it is a file-system friendly file name.
+  You can use any string for the name.  If you use the default `:file_system`
+  storage backend, VCR will sanitize the string before using it as a file name,
+  so that it is a file-system friendly file name.
 
   Scenario: Name sanitizing
     Given a file named "name_sanitizing.rb" with:

data/features/cassettes/persistence.feature

@@ -0,0 +1,63 @@
+Feature: Cassette Persistence
+
+  By default, cassettes will be persisted to the file system. However, you
+  can easily configure VCR to persist the cassettes to a database, a key-value
+  store, or anywhere you like.
+
+  To use something besides the file system, you must provide an object
+  that provides a hash-like interface:
+
+    * `persister[name]` should return the content previously persisted for the
+      given cassette name.
+    * `persister[name] = content` should persist the content for the
+      given cassette name.
+
+  Register this object with VCR, and then you can configure all cassettes
+  to use it (using the `default_cassette_options`) or just some cassettes
+  to use it (by passing it as an option to individual cassettes).
+
+  Scenario: Persist cassettes in Redis
+    Given the redis DB has no data
+      And a file named "use_redis.rb" with:
+      """ruby
+      if ARGV.include?('--with-server')
+        start_sinatra_app(:port => 7777) do
+          get('/') { "Hello" }
+        end
+      end
+
+      require 'redis'
+
+      class RedisCassettePersister
+        def initialize(redis)
+          @redis = redis
+        end
+
+        def [](name)
+          @redis.get(name)
+        end
+
+        def []=(name, content)
+          @redis.set(name, content)
+        end
+      end
+
+      require 'vcr'
+
+      VCR.configure do |c|
+        c.hook_into :fakeweb
+        c.cassette_persisters[:redis] = RedisCassettePersister.new(Redis.connect)
+        c.default_cassette_options = { :persist_with => :redis }
+      end
+
+      VCR.use_cassette("redis_example") do
+        response = Net::HTTP.get_response('localhost', '/', 7777)
+        puts "Response: #{response.body}"
+      end
+      """
+    When I run `ruby use_redis.rb --with-server`
+    Then it should pass with "Hello"
+     And the value stored at the redis key "redis_example.yml" should include "Hello"
+
+    When I run `ruby use_redis.rb`
+    Then it should pass with "Hello"

data/features/configuration/debug_logging.feature

@@ -30,7 +30,7 @@ Feature: Debug Logging
     When I run `ruby debug_logger.rb record.log --with-server`
     Then the file "record.log" should contain exactly:
       """
-      [Cassette: 'example'] Initialized with options: {:record=>:once, :match_requests_on=>[:method, :uri], :serialize_with=>:yaml}
+      [Cassette: 'example'] Initialized with options: {:record=>:once, :match_requests_on=>[:method, :uri], :allow_unused_http_interactions=>true, :serialize_with=>:yaml, :persist_with=>:file_system}
       [fakeweb] Handling request: [get http://localhost:7777/] (disabled: false)
         [Cassette: 'example'] Initialized HTTPInteractionList with request matchers [:method, :uri] and 0 interaction(s): {  }
       [fakeweb] Identified request type (recordable) for [get http://localhost:7777/]
@@ -40,13 +40,13 @@ Feature: Debug Logging
     When I run `ruby debug_logger.rb playback.log`
     Then the file "playback.log" should contain exactly:
       """
-      [Cassette: 'example'] Initialized with options: {:record=>:once, :match_requests_on=>[:method, :uri], :serialize_with=>:yaml}
+      [Cassette: 'example'] Initialized with options: {:record=>:once, :match_requests_on=>[:method, :uri], :allow_unused_http_interactions=>true, :serialize_with=>:yaml, :persist_with=>:file_system}
       [fakeweb] Handling request: [get http://localhost:7777/] (disabled: false)
         [Cassette: 'example'] Initialized HTTPInteractionList with request matchers [:method, :uri] and 1 interaction(s): { [get http://localhost:7777/] => [200 "Hello World"] }
         [Cassette: 'example'] Checking if [get http://localhost:7777/] matches [get http://localhost:7777/] using [:method, :uri]
           [Cassette: 'example'] method (matched): current request [get http://localhost:7777/] vs [get http://localhost:7777/]
           [Cassette: 'example'] uri (matched): current request [get http://localhost:7777/] vs [get http://localhost:7777/]
         [Cassette: 'example'] Found matching interaction for [get http://localhost:7777/] at index 0: [200 "Hello World"]
-      [fakeweb] Identified request type (stubbed) for [get http://localhost:7777/]
+      [fakeweb] Identified request type (stubbed_by_vcr) for [get http://localhost:7777/]
 
       """

data/features/configuration/ignore_request.feature

@@ -65,7 +65,7 @@ Feature: Ignore Request
       puts response_body_for(:get, "http://localhost:8888/")
       """
     When I run `ruby ignore_request.rb`
-    Then it should fail with:
+    Then it should fail with an error like:
       """
       An HTTP request has been made that VCR does not know how to handle:
         GET http://localhost:8888/

data/features/hooks/after_http_request.feature

@@ -33,7 +33,7 @@ Feature: after_http_request hook
         <configuration>
         c.cassette_library_dir = 'cassettes'
         c.ignore_localhost = true
-        c.after_http_request(lambda { |req| req.uri =~ /foo/ }) do |request, response|
+        c.after_http_request(:ignored?, lambda { |req| req.uri =~ /foo/ }) do |request, response|
           puts "Response for #{request.method} #{request.uri}: #{response.body}"
         end
       end

data/features/step_definitions/cli_steps.rb

@@ -73,6 +73,13 @@ module VCRHelpers
       File.open(file_name, 'w') { |f| f.write(file) }
     end
   end
+
+  def redis
+    @redis ||= begin
+       require 'redis'
+       Redis.connect
+    end
+  end
 end
 World(VCRHelpers)
 
@@ -92,6 +99,10 @@ Given /^it is (.*)$/ do |date_string|
   set_env('DATE_STRING', date_string)
 end
 
+Given /^the redis DB has no data$/ do
+  redis.flushdb
+end
+
 When /^I modify the file "([^"]*)" to replace "([^"]*)" with "([^"]*)"$/ do |file_name, orig_text, new_text|
   modify_file(file_name, orig_text, new_text)
 end
@@ -112,6 +123,20 @@ Then /^it should (pass|fail) with "([^"]*)"$/ do |pass_fail, partial_output|
   assert_exit_status_and_partial_output(pass_fail == 'pass', partial_output)
 end
 
+Then /^it should (pass|fail) with an error like:$/ do |pass_fail, partial_output|
+  assert_success(pass_fail == 'pass')
+
+  # different implementations place the exception class at different
+  # places relative to the message (i.e. with a multiline error message)
+  process_output = all_output.gsub(/\s*\(VCR::Errors::\w+\)/, '')
+
+  # Some implementations include extra leading spaces, for some reason...
+  process_output.gsub!(/^\s*/, '')
+  partial_output.gsub!(/^\s*/, '')
+
+  assert_partial_output(partial_output, process_output)
+end
+
 Then /^the output should contain each of the following:$/ do |table|
   table.raw.flatten.each do |string|
     assert_partial_output(string, all_output)
@@ -168,3 +193,11 @@ Then /^the cassette "([^"]*)" should have the following response bodies:$/ do |f
   actual_response_bodies.should =~ expected_response_bodies
 end
 
+Then /^the value stored at the redis key "([^"]*)" should include "([^"]*)"$/ do |key, value_fragment|
+  redis.get(key).should include(value_fragment)
+end
+
+Then /^it should (pass|fail)$/ do |pass_fail|
+  assert_success(pass_fail == 'pass')
+end
+

data/features/support/env.rb

@@ -2,7 +2,6 @@ require 'rubygems'
 require 'bundler'
 Bundler.setup
 
-require 'limited_red/plugins/cucumber'
 require 'ruby-debug' if !defined?(RUBY_ENGINE) && RUBY_VERSION != '1.9.3' && !ENV['CI']
 
 require 'aruba/cucumber'