vcr 1.11.3 → 2.0.0.beta1

data/.gitignore

@@ -31,3 +31,5 @@ Gemfile.lock
 features/README.md
 features/CHANGELOG.md
 features/LICENSE.md
+
+.rvmrc

data/.travis.yml

@@ -1,10 +1,14 @@
 env: CUCUMBER_FORMAT=progress
 bundler_args: --without extras
-script: "bundle exec rake ci:build"
+script: "bundle exec rake ci:build --trace"
 rvm:
-  - 1.8.6
   - 1.8.7
   - 1.9.2
   - 1.9.3
   - ree
   - jruby
+branches:
+  only:
+    - master
+    - 1-x-stable
+

data/CHANGELOG.md

@@ -1,6 +1,54 @@
 ## In git
 
-[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.11.3...master)
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v2.0.0.beta1...master)
+
+## 2.0.0 Beta 1 (October 8, 2011)
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.11.3...v2.0.0.beta1)
+
+### Changes
+
+* Previously, the last matching response in a cassette would
+  repeatedly playback if the same request kept being made. This is
+  no longer the case.
+* The Faraday middleware has been rewritten.
+  * You no longer need to configure `stub_with :faraday` to use it.
+  * It has been updated to work in parallel mode.
+  * It no longer accepts a block and uses that to determine the
+    cassette.  Instead, use `VCR.use_cassette` just like you would
+    with FakeWeb or WebMock.
+
+### Added
+
+* Allow any callable (an object that responds to #call, such as a
+  lambda) to be used as a request matcher. Thanks to [Avdi Grimm](https://github.com/avdi)
+  for the idea.
+* Add ability to register custom request matchers.
+* Add `VCR.request_matchers.uri_without_param(:some_param)` to generate
+  a request matcher that matches on URI but ignores the named parameter.
+* New `:allow_playback_repeats` cassette option preserves the old
+  playback repeat behavior. Thanks to [Avdi Grimm](https://github.com/avdi)
+  for the idea.
+* New `:exclusive` cassette option allows a cassette to be exclusively
+  used rather than keeping the existing one active as a fallback. Thanks
+  to [Avdi Grimm](https://github.com/avdi) for the idea.
+
+### Removed
+
+* Removed support for Ruby 1.8.6 and 1.9.1.
+* Removed lots of old deprecated APIs.
+* Removed support for manually changing the URI in a cassette to a regex.
+
+### Deprecated
+
+* Deprecated `VCR.config` in favor of `VCR.configure`.
+* Deprecated `VCR::Config` singleton module in favor of
+  `VCR::Configuration` class.  The current configuration instance
+  can be accessed via `VCR.configuration`.
+* Deprecated `stub_with` in favor of `hook_into`.  The stubbing
+  adapters have been completely rewritten and are no longer an
+  implementation of the adapter design pattern. Instead they simply
+  use the named library to globally hook into every HTTP request.
 
 ## 1.11.3 (August 31, 2011)
 

data/Gemfile

@@ -18,9 +18,8 @@ end
 # Additional gems that are useful, but not required for development.
 group :extras do
   gem 'guard-rspec'
-  gem 'guard-cucumber'
   gem 'growl'
-  gem 'relish'
+  gem 'relish', '~> 0.5.0'
   gem 'fuubar'
   gem 'fuubar-cucumber'
 
@@ -31,13 +30,10 @@ group :extras do
 
   platforms :mri_18 do
     gem 'ruby-debug'
-    gem 'linecache', '0.43' # later versions do not work on 1.8.6
   end
 
   platforms :mri_19 do
-    gem 'linecache19', '0.5.11' # 0.5.12 cannot install on 1.9.1, and 0.5.11 appears to work with both 1.9.1 & 1.9.2
     gem 'ruby-debug19'
-    gem 'ruby-debug-base19', RUBY_VERSION == '1.9.1' ? '0.11.23' : '~> 0.11.24'
   end unless RUBY_VERSION == '1.9.3'
 end
 

data/Guardfile

@@ -7,8 +7,3 @@ guard 'rspec', :version => 2 do
   watch(%r|^spec/spec_helper.rb|)    { "spec" }
 end
 
-guard 'cucumber' do
-  watch(%r|^features/(.*).feature|)
-  watch(%r|^features/support|)                       { 'features' }
-  watch(%r|^features/step_definitions|)              { 'features' }
-end

data/README.md

@@ -2,6 +2,8 @@
 
 Record your test suite's HTTP interactions and replay them during future test runs for fast, deterministic, accurate tests.
 
+[![Build Status](https://secure.travis-ci.org/myronmarston/vcr.png?branch=master)](http://travis-ci.org/myronmarston/vcr)
+
 ## Synopsis
 
 ``` ruby
@@ -82,9 +84,7 @@ contain backwards-incompatible changes to the public API.
 
 VCR has been tested on the following ruby interpreters:
 
-* MRI 1.8.6
 * MRI 1.8.7
-* MRI 1.9.1
 * MRI 1.9.2
 * REE 1.8.7
 * JRuby 1.5.6
@@ -144,6 +144,7 @@ Thanks also to the following people who have contributed patches or helpful sugg
 * [Nathaniel Bibler](https://github.com/nbibler)
 * [Oliver Searle-Barnes](https://github.com/opsb)
 * [Wesley Beary](https://github.com/geemus)
+* [Avdi Grimm](https://github.com/avdi)
 
 ## Copyright
 

data/Rakefile

@@ -11,7 +11,10 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.verbose = false
-  t.ruby_opts = "-w -r./spec/capture_warnings"
+
+  # we require spec_helper so we don't get an RSpec warning about
+  # examples being defined before configuration.
+  t.ruby_opts = "-w -I./spec -r./spec/capture_warnings -rspec_helper"
 
   # I'm not sure why, but bundler seems to silence warnings...
   t.skip_bundler = true
@@ -29,10 +32,8 @@ task :cleanup_rcov_files do
   rm_rf 'coverage.data'
 end
 
-unless RUBY_VERSION == '1.8.6'
-  require 'cucumber/rake/task'
-  Cucumber::Rake::Task.new
-end
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new
 
 task :default => [:spec, :cucumber]
 
@@ -46,16 +47,17 @@ namespace :ci do
 
   RSpec::Core::RakeTask.new(:spec) do |t|
     t.verbose = true
-    t.ruby_opts = "-w -r./spec/capture_warnings"
+
+    # we require spec_helper so we don't get an RSpec warning about
+    # examples being defined before configuration.
+    t.ruby_opts = "-w -I./spec -r./spec/capture_warnings -rspec_helper"
     # I'm not sure why, but bundler seems to silence warnings...
     t.skip_bundler = true
     t.rspec_opts = %w[--format progress --backtrace]
   end
 
-  ci_tasks = [:setup, :spec]
-  ci_tasks << :cucumber if %w[ 1.8.7 1.9.2 1.9.3 ].include?(RUBY_VERSION) && (!defined?(RUBY_ENGINE) || RUBY_ENGINE == 'ruby')
   desc "Run a ci build"
-  task :build => ci_tasks
+  task :build => [:setup, :spec, :cucumber]
 end
 
 def ensure_relish_doc_symlinked(filename)
@@ -98,10 +100,3 @@ task :release => [:require_ruby_18, :prep_relish_release, :relish]
 # For gem-test: http://gem-testers.org/
 task :test => :spec
 
-task :fix_should_eq do
-  Dir["spec/**/*.rb"].each do |spec_file|
-    contents = File.read(spec_file)
-    contents.gsub!(/should == (.*)$/, 'should eq(\1)')
-    File.open(spec_file, 'w') { |f| f.write(contents) }
-  end
-end

data/cucumber.yml

@@ -7,10 +7,6 @@ interp_opts = if defined?(RUBY_ENGINE)
 else
   ''
 end
-
-if ENV['TRAVIS'] && RUBY_VERSION == '1.8.6'
-  interp_opts << ' --tags ~@exclude-travis-186'
-end
 %>
 default: <%= std_opts %><%= interp_opts %> features
 wip: --tags @wip:30 --wip features<%= interp_opts %>

data/features/.nav

@@ -6,9 +6,9 @@
   - format.feature
   - naming.feature
   - no_cassette.feature
-  - request_matching.feature
   - dynamic_erb.feature
   - automatic_re_recording.feature
+  - exclusive.feature
   - update_content_length_header.feature
 - record_modes:
   - once.feature
@@ -17,12 +17,24 @@
   - all.feature
 - configuration:
   - cassette_library_dir.feature
-  - stub_with.feature
+  - hook_into.feature
   - default_cassette_options.feature
   - ignore_hosts.feature
   - ignore_localhost.feature
   - hooks.feature
+  - filter_sensitive_data.feature
   - allow_http_connections_when_no_cassette.feature
+- request_matching:
+  - method.feature
+  - uri.feature
+  - host.feature
+  - path.feature
+  - body.feature
+  - headers.feature
+  - identical_request_sequence.feature
+  - custom_matcher.feature
+  - uri_without_param.feature
+  - playback_repeats.feature
 - test_frameworks:
   - test_unit.feature
   - shoulda.feature

data/features/cassettes/automatic_re_recording.feature

@@ -31,21 +31,19 @@ Feature: Automatic Re-recording
           http_version: "1.1"
       """
     And a file named "re_record.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
-
+      """ruby
       start_sinatra_app(:port => 7777) do
         get('/') { 'New Response' }
       end
 
       require 'vcr'
 
-      VCR.config do |c|
-        c.stub_with :fakeweb
+      VCR.configure do |c|
+        c.hook_into :fakeweb
         c.cassette_library_dir = 'cassettes'
       end
 
-      VCR.use_cassette('example', :record => :new_episodes, :re_record_interval => 7.days) do
+      VCR.use_cassette('example', :re_record_interval => 7.days) do
         puts Net::HTTP.get_response('localhost', '/', 7777).body
       end
       """

data/features/cassettes/dynamic_erb.feature

@@ -32,13 +32,12 @@ Feature: Dynamic ERB cassettes
           http_version: "1.1"
       """
     And a file named "dynamic_erb_example.rb" with:
-      """
+      """ruby
       require 'vcr'
 
-      VCR.config do |c|
-        c.stub_with :fakeweb
+      VCR.configure do |c|
+        c.hook_into :fakeweb
         c.cassette_library_dir = 'cassettes'
-        c.default_cassette_options = { :record => :none }
       end
 
       VCR.use_cassette('dynamic', :erb => true) do
@@ -72,13 +71,12 @@ Feature: Dynamic ERB cassettes
           http_version: "1.1"
       """
     And a file named "dynamic_erb_example.rb" with:
-      """
+      """ruby
       require 'vcr'
 
-      VCR.config do |c|
-        c.stub_with :fakeweb
+      VCR.configure do |c|
+        c.hook_into :fakeweb
         c.cassette_library_dir = 'cassettes'
-        c.default_cassette_options = { :record => :none }
       end
 
       VCR.use_cassette('dynamic', :erb => { :arg1 => 7, :arg2 => 'baz' }) do

data/features/cassettes/exclusive.feature

@@ -0,0 +1,111 @@
+Feature: exclusive cassette
+
+  VCR allows cassettes to be nested. This is particularly useful in
+  a context like cucumber, where you may be using a cassette for an
+  entire scenario, and also using a cassette within a particular step
+  definition.
+
+  By default, both the inner and outer cassettes are active. On each
+  request, VCR will look for a matching HTTP interaction in the inner
+  cassette, and it will use the outer cassette as a fall back if none
+  can be found.
+
+  If you do not want the HTTP interactions of the outer cassette considered,
+  you can pass the `:exclusive` option, so that the inner cassette is
+  used exclusively.
+
+  Background:
+    Given a previously recorded cassette file "cassettes/outer.yml" with:
+      """
+      --- 
+      - !ruby/struct:VCR::HTTPInteraction 
+        request: !ruby/struct:VCR::Request 
+          method: :get
+          uri: http://localhost:7777/outer
+          body: 
+          headers: 
+        response: !ruby/struct:VCR::Response 
+          status: !ruby/struct:VCR::ResponseStatus 
+            code: 200
+            message: OK
+          headers: 
+            content-length: 
+            - "18"
+          body: Old outer response
+          http_version: "1.1"
+      """
+    And a previously recorded cassette file "cassettes/inner.yml" with:
+      """
+      --- 
+      - !ruby/struct:VCR::HTTPInteraction 
+        request: !ruby/struct:VCR::Request 
+          method: :get
+          uri: http://localhost:7777/inner
+          body: 
+          headers: 
+        response: !ruby/struct:VCR::Response 
+          status: !ruby/struct:VCR::ResponseStatus 
+            code: 200
+            message: OK
+          headers: 
+            content-length: 
+            - "18"
+          body: Old inner response
+          http_version: "1.1"
+      """
+    And a file named "setup.rb" with:
+      """ruby
+      include_http_adapter_for("net/http")
+
+      start_sinatra_app(:port => 7777) do
+        get('/:path') { "New #{params[:path]} response" }
+      end
+
+      require 'vcr'
+
+      VCR.configure do |c|
+        c.hook_into :fakeweb
+        c.cassette_library_dir = 'cassettes'
+        c.default_cassette_options = { :record => :new_episodes }
+      end
+      """
+
+  Scenario: Cassettes are not exclusive by default
+    Given a file named "not_exclusive.rb" with:
+      """ruby
+      require 'setup'
+
+      VCR.use_cassette('outer') do
+        VCR.use_cassette('inner') do
+          puts response_body_for(:get, "http://localhost:7777/outer")
+          puts response_body_for(:get, "http://localhost:7777/inner")
+        end
+      end
+      """
+    When I run `ruby not_exclusive.rb`
+    Then it should pass with:
+      """
+      Old outer response
+      Old inner response
+      """
+
+  Scenario: Use an exclusive cassette
+    Given a file named "exclusive.rb" with:
+      """ruby
+      require 'setup'
+
+      VCR.use_cassette('outer') do
+        VCR.use_cassette('inner', :exclusive => true) do
+          puts response_body_for(:get, "http://localhost:7777/outer")
+          puts response_body_for(:get, "http://localhost:7777/inner")
+        end
+      end
+      """
+    When I run `ruby exclusive.rb`
+    Then it should pass with:
+      """
+      New outer response
+      Old inner response
+      """
+    And the file "cassettes/inner.yml" should contain "body: New outer response"
+

data/features/cassettes/format.feature

@@ -20,8 +20,7 @@ Feature: Cassette format
 
   Scenario Outline: Request/Response data is saved to disk as YAML
     Given a file named "cassette_format.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
+      """ruby
       include_http_adapter_for("<http_lib>")
 
       start_sinatra_app(:port => 7777) do
@@ -30,12 +29,12 @@ Feature: Cassette format
 
       require 'vcr'
 
-      VCR.config do |c|
-        c.stub_with <stub_with>
+      VCR.configure do |c|
+        <configuration>
         c.cassette_library_dir = 'cassettes'
       end
 
-      VCR.use_cassette('example', :record => :new_episodes) do
+      VCR.use_cassette('example') do
         make_http_request(:get, "http://localhost:7777/foo")
         make_http_request(:get, "http://localhost:7777/bar")
       end
@@ -81,12 +80,15 @@ Feature: Cassette format
       """
 
     Examples:
-      | stub_with  | http_lib        |
-      | :fakeweb   | net/http        |
-      | :webmock   | net/http        |
-      | :webmock   | httpclient      |
-      | :webmock   | patron          |
-      | :webmock   | curb            |
-      | :webmock   | em-http-request |
-      | :typhoeus  | typhoeus        |
-      | :excon     | excon           |
+      | configuration         | http_lib              |
+      | c.hook_into :fakeweb  | net/http              |
+      | c.hook_into :webmock  | net/http              |
+      | c.hook_into :webmock  | httpclient            |
+      | c.hook_into :webmock  | patron                |
+      | c.hook_into :webmock  | curb                  |
+      | c.hook_into :webmock  | em-http-request       |
+      | c.hook_into :webmock  | typhoeus              |
+      | c.hook_into :typhoeus | typhoeus              |
+      | c.hook_into :excon    | excon                 |
+      |                       | faraday (w/ net_http) |
+