vcr 2.0.0.beta2 → 2.0.0.rc1

data/.gitignore

@@ -32,5 +32,6 @@ features/README.md
 features/CHANGELOG.md
 features/LICENSE.md
 features/Upgrade.md
+features/CONTRIBUTING.md
 
 .rvmrc

data/.travis.yml

@@ -7,8 +7,6 @@ rvm:
   - 1.9.3
   - ree
   - jruby
-  - rbx
-  - rbx-2.0
 branches:
   only:
     - master

data/CHANGELOG.md

@@ -1,6 +1,27 @@
 ## In git
 
-[Full Changelog](http://github.com/myronmarston/vcr/compare/v2.0.0.beta2...master)
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v2.0.0.rc1...master)
+
+## 2.0.0 RC 1 (December 8, 2011)
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v2.0.0.beta2...v2.0.0.rc1)
+
+* Add Faraday hook that automatically inserts the VCR middleware so that
+  you can use VCR with Faraday without needing to insert the middleware
+  yourself.  Use `VCR.configure { |c| c.hook_into :faraday }`.
+* Add `ignore_request` config option. Pass it a block that returns
+  true if the given request should be ignored.
+* Improve the unhandled HTTP request error message so that it lists
+  different options for how to get VCR to handle it.
+* Add {before,after,around}_http_request hooks.
+* Updated WebMock integration and bumped up required version to 1.7.8.
+* Test against latest Excon (0.7.9) and confirm that VCR works fine with
+  it.
+* Add define_cassette_placeholder as an alias for filter_sensitive_data.
+* Fix Faraday middleware so that it works properly when you use parallel
+  requests.
+* Integrate VCR with RSpec metadata. Thanks to [Ryan Bates](https://github.com/ryanb)
+  for the great idea.
 
 ## 2.0.0 Beta 2 (November 6, 2011)
 

data/CONTRIBUTING.md

@@ -0,0 +1,46 @@
+## Contributing
+
+Install [bundler](http://gembundler.com/) and use it to install all the development dependencies:
+
+```console
+gem install bundler
+bundle install
+```
+
+Next setup the Git submodules:
+
+```console
+git submodule init
+git submodule update
+```
+
+or using the single command form
+
+```console
+git submodule update --init
+```
+
+You should be able to run the tests now:
+
+```console
+bundle exec rake
+```
+
+VCR uses [RSpec 2](http://github.com/rspec/rspec) for unit tests.  The specs are written in a very "focused" style, where each spec is concerned only with exercising the object under test, using mocks as necessary.  You can run the specs using `rake spec`.
+
+[Cucumber](http://cukes.info/) is used for end-to-end full stack integration tests that also function as VCR's documentation.
+
+## Problems running bundle install?
+
+If you get an error while running `bundle install`, it may be one of the "extras" gems which are not required for development. Try installing it without these gems.
+
+```console
+bundle install --without extras
+```
+
+If you are getting an error installing `rb-fsevent` gem, you may want to temporarily change the Gemfile to use the pre-release version of the gem.
+
+```ruby
+gem 'rb-fsevent', '0.9.0.pre4'
+```
+

data/Gemfile

@@ -2,14 +2,6 @@ source :rubygems
 gemspec
 
 group :development do
-  # patron and em-http-request can't install on JRuby, so we have to limit their platform here.
-  platforms :ruby do
-    gem 'patron',           '~> 0.4.15'
-    gem 'em-http-request',  '~> 0.3.0'
-    gem 'curb',             '0.7.15'
-    gem 'typhoeus',         '~> 0.3.2'
-  end
-
   platforms :jruby do
     gem 'jruby-openssl'
   end
@@ -28,7 +20,7 @@ group :extras do
     gem 'rb-fsevent'
   end
 
-  platforms :mri_18 do
+  platforms :mri_18, :jruby do
     gem 'ruby-debug'
   end
 

data/README.md

@@ -11,9 +11,9 @@ require 'rubygems'
 require 'test/unit'
 require 'vcr'
 
-VCR.config do |c|
+VCR.configure do |c|
   c.cassette_library_dir = 'fixtures/vcr_cassettes'
-  c.stub_with :webmock # or :fakeweb
+  c.hook_into :webmock # or :fakeweb
 end
 
 class VCRTest < Test::Unit::TestCase
@@ -117,6 +117,8 @@ VCR has been tested on the following ruby interpreters:
 * Report issues on [GitHub Issues](http://github.com/myronmarston/vcr/issues).
 * Pull requests are very welcome! Please include spec and/or feature coverage for every patch,
   and create a topic branch for every separate change you make.
+* See the [Contributing](https://github.com/myronmarston/vcr/blob/master/CONTRIBUTING.md)
+  guide for instructions on running the specs and features.
 
 If you find VCR useful, please recommend me on [working with rails](http://workingwithrails.com/person/16590-myron-marston).
 
@@ -139,11 +141,15 @@ 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)
 * [Bradley Isotope](https://github.com/bradleyisotope)
+* [Carlos Kirkconnell](https://github.com/kirkconnell)
 * [Eric Allam](http://github.com/rubymaverick)
+* [Flaviu Simihaian](https://github.com/closedbracket)
 * [Justin Smestad](https://github.com/jsmestad)
 * [Karl Baum](https://github.com/kbaum)
 * [Nathaniel Bibler](https://github.com/nbibler)
 * [Oliver Searle-Barnes](https://github.com/opsb)
+* [Paco Guzmán](https://github.com/pacoguzman)
+* [Ryan Bates](https://github.com/ryanb)
 * [Sathya Sekaran](https://github.com/sfsekaran)
 * [Wesley Beary](https://github.com/geemus)
 

data/Rakefile

@@ -72,7 +72,7 @@ end
 
 desc "Push cukes to relishapp using the relish-client-gem"
 task :relish do
-  %w[ README.md CHANGELOG.md Upgrade.md LICENSE ].each do |file|
+  %w[ README.md CHANGELOG.md Upgrade.md LICENSE CONTRIBUTING.md].each do |file|
     ensure_relish_doc_symlinked(file)
   end
 
@@ -136,3 +136,14 @@ task :migrate_cucumber_cassettes do
   end
 end
 
+desc "Run the last cuke directly"
+task :run_last_cuke do
+  command = ENV.fetch('CMD') do
+    raise "Must pass CMD"
+  end
+
+  Dir.chdir("tmp/aruba") do
+    sh "RUBYOPT='-I.:../../lib -r../../features/support/vcr_cucumber_helpers' ruby #{command}"
+  end
+end
+

data/cucumber.yml

@@ -1,14 +1,13 @@
 <%
 rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
 rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'Cucumber::Formatter::Fuubar'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
-std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'Cucumber::Formatter::Fuubar'} --strict --tags ~@wip"
-interp_opts = if defined?(RUBY_ENGINE)
-  " --tags ~@exclude-#{RUBY_ENGINE}"
-else
-  ''
-end
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'Cucumber::Formatter::Fuubar'} --strict"
+
+exclusions = ["--tags ~@exclude-#{RUBY_VERSION.split('.').first(2).join}"].tap do |a|
+  a << "--tags ~@exclude-#{RUBY_ENGINE}" if defined?(RUBY_ENGINE)
+end.join(' ')
 %>
-default: <%= std_opts %><%= interp_opts %> features
-wip: --tags @wip:30 --wip features<%= interp_opts %>
-rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip<%= interp_opts %>
+default: <%= std_opts %> --tags ~@wip <%= exclusions %> features
+wip: --tags @wip <%= exclusions %> features
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip <%= exclusions %>
 

data/features/.nav

@@ -3,6 +3,7 @@
 - CHANGELOG.md (Changelog)
 - about_these_examples.md (About These Examples)
 - LICENSE.md (License)
+- CONTRIBUTING.md (Contributing)
 - cassettes:
   - format.feature
   - naming.feature
@@ -20,11 +21,15 @@
   - cassette_library_dir.feature
   - hook_into.feature
   - default_cassette_options.feature
-  - ignore_hosts.feature
-  - ignore_localhost.feature
-  - hooks.feature
+  - ignore_request.feature
   - filter_sensitive_data.feature
   - allow_http_connections_when_no_cassette.feature
+- hooks:
+  - before_record.feature
+  - before_playback.feature
+  - before_http_request.feature
+  - after_http_request.feature
+  - around_http_request.feature
 - request_matching:
   - method.feature
   - uri.feature
@@ -39,7 +44,8 @@
 - test_frameworks:
   - test_unit.feature
   - shoulda.feature
-  - rspec.feature
+  - rspec_metadata.feature
+  - rspec_macro.feature
   - cucumber.feature
 - middleware:
   - rack.feature

data/features/cassettes/format.feature

@@ -122,7 +122,7 @@ Feature: Cassette format
       | c.hook_into :webmock  | typhoeus              |
       | c.hook_into :typhoeus | typhoeus              |
       | c.hook_into :excon    | excon                 |
-      |                       | faraday (w/ net_http) |
+      | c.hook_into :faraday  | faraday (w/ net_http) |
 
   Scenario: Request/Response data can be saved as JSON
     Given a file named "cassette_json.rb" with:

data/features/cassettes/no_cassette.feature

@@ -7,9 +7,8 @@ Feature: Error for HTTP request made when no cassette is in use
   made so you can use a VCR cassette at that point in your code.
 
   If you want to allow an HTTP request to proceed as normal, you can
-  set the `allow_http_connections_when_no_cassette` configuration option
-  (see configuration/allow_http_connections_when_no_cassette.feature) or
-  you can temporarily turn VCR off:
+  set the [allow\_http\_connections\_when\_no\_cassette](../configuration/allow-http-connections-when-no-cassette)
+  configuration option or you can temporarily turn VCR off:
 
     - `VCR.turn_off!` => turn VCR off so HTTP requests are allowed.
       Cassette insertions will trigger an error.
@@ -19,6 +18,7 @@ Feature: Error for HTTP request made when no cassette is in use
     - `VCR.turned_off { ... }` => turn VCR off for the duration of the
       provided block.
 
+  @exclude-jruby
   Scenario Outline: Error for request when no cassette is in use
     Given a file named "no_cassette_error.rb" with:
       """ruby
@@ -34,10 +34,7 @@ Feature: Error for HTTP request made when no cassette is in use
       response_body_for(:get, 'http://example.com/')
       """
     When I run `ruby no_cassette_error.rb`
-    Then it should fail with "Real HTTP connections are disabled"
-    And the output should contain each of the following:
-      | You can use VCR to automatically record this request and replay it later. |
-      | no_cassette_error.rb:10                                                   |
+    Then it should fail with "An HTTP request has been made that VCR does not know how to handle"
 
     Examples:
       | configuration         | http_lib              |
@@ -50,7 +47,7 @@ Feature: Error for HTTP request made when no cassette is in use
       | c.hook_into :webmock  | typhoeus              |
       | c.hook_into :typhoeus | typhoeus              |
       | c.hook_into :excon    | excon                 |
-      |                       | faraday (w/ net_http) |
+      | c.hook_into :faraday  | faraday (w/ net_http) |
 
   Scenario: Temporarily turn VCR off to allow HTTP requests to procede as normal
     Given a file named "turn_off_vcr.rb" with:
@@ -69,7 +66,7 @@ Feature: Error for HTTP request made when no cassette is in use
         puts context
         puts Net::HTTP.get_response('localhost', '/', 7777).body
       rescue => e
-        puts "Error: #{e.message}"
+        puts "Error: #{e.class}"
       end
 
       VCR.turned_off do
@@ -93,7 +90,7 @@ Feature: Error for HTTP request made when no cassette is in use
     And the output should contain:
       """
       Outside of VCR.turned_off block
-      Error: Real HTTP connections are disabled.
+      Error: VCR::Errors::UnhandledHTTPRequestError
       """
     And the output should contain:
       """
@@ -103,7 +100,7 @@ Feature: Error for HTTP request made when no cassette is in use
     And the output should contain:
       """
       After calling VCR.turn_on!
-      Error: Real HTTP connections are disabled.
+      Error: VCR::Errors::UnhandledHTTPRequestError
       """
 
   Scenario: Turning VCR off prevents cassettes from being inserted

data/features/configuration/allow_http_connections_when_no_cassette.feature

@@ -1,9 +1,9 @@
 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
-  `allow_http_connections_when_no_cassette` configuration option to
-  true to allow requests, if you do not want to use VCR for everything.
+  Usually, HTTP requests made when no cassette is inserted will [result in an
+  error](../cassettes/error-for-http-request-made-when-no-cassette-is-in-use).
+  You can set the `allow_http_connections_when_no_cassette` configuration option
+  to true to allow requests, if you do not want to use VCR for everything.
 
   Background:
     Given a file named "vcr_setup.rb" with:

data/features/configuration/filter_sensitive_data.feature

@@ -1,5 +1,8 @@
 Feature: Filter sensitive data
 
+  Note: this config option is also available as `define_cassette_placeholder`
+  to reflect the fact that it is useful for more than just sensitive data.
+
   The `filter_sensitive_data` configuration option can be used to prevent
   sensitive data from being written to your cassette files.  This may be
   important if you commit your cassettes files to source control and do

data/features/configuration/hook_into.feature

@@ -15,10 +15,7 @@ Feature: hook_into
     - :typhoeus can be used to hook into itself (as long as you use Typhoeus::Hydra,
       but not Typhoeus::Easy or Typhoeus::Multi).
     - :excon can be used to hook into itself.
-
-  In addition, you can use VCR with Faraday if you use the provided
-  middleware in your Faraday connection stack.  When you use VCR with Faraday,
-  you do not need to configure `hook_into` (since the middleware is sufficient).
+    - :faraday can be used to hook into itself.
 
   There are some addiitonal trade offs to consider when deciding which
   option to use:
@@ -85,8 +82,8 @@ Feature: hook_into
       | 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) |
 
   @exclude-jruby
   Scenario Outline: Use Typhoeus, Excon and Faraday in combination with FakeWeb or WebMock
@@ -117,7 +114,6 @@ Feature: hook_into
 
       def faraday_response
         Faraday::Connection.new(:url => 'http://localhost:7777') do |builder|
-          builder.use VCR::Middleware::Faraday
           builder.adapter :<faraday_adapter>
         end.get('/faraday').body
       end
@@ -128,7 +124,7 @@ Feature: hook_into
       puts "Faraday 1: #{faraday_response}"
 
       VCR.configure do |c|
-        c.hook_into <hook_into>, :typhoeus, :excon
+        c.hook_into <hook_into>, :typhoeus, :excon, :faraday
         c.cassette_library_dir = 'vcr_cassettes'
         c.ignore_localhost = false
       end

data/features/configuration/ignore_request.feature

@@ -0,0 +1,191 @@
+Feature: Ignore Request
+
+  By default, VCR hooks into every request, either allowing it and recording
+  it, or playing back a recorded response, or raising an error to force you
+  to deal with the new request.  In some situations, you may prefer to have
+  VCR ignore some requests.
+
+  VCR provides 3 configuration options to accomplish this:
+
+    * `ignore_request { |req| ... }` will ignore any request for which the
+      given block returns true.
+    * `ignore_hosts 'foo.com', 'bar.com'` allows you to specify particular
+      hosts to ignore.
+    * `ignore_localhost = true` is equivalent to `ignore_hosts 'localhost',
+      '127.0.0.1', '0.0.0.0'`. It is particularly useful for when you use
+      VCR with a javascript-enabled capybara driver, since capybara boots
+      your rack app and makes localhost requests to it to check that it has
+      booted.
+
+  Ignored requests are not recorded and are always allowed, regardless of
+  the record mode, and even outside of a `VCR.use_cassette` block.
+
+  Background:
+    Given a file named "sinatra_app.rb" with:
+      """ruby
+      response_count = 0
+      start_sinatra_app(:port => 7777) do
+        get('/') { "Port 7777 Response #{response_count += 1}" }
+      end
+      """
+
+  @exclude-jruby
+  Scenario Outline: ignore requests to a specific port
+    Given a file named "ignore_request.rb" with:
+      """ruby
+      include_http_adapter_for("<http_lib>")
+      require 'sinatra_app.rb'
+
+      response_count = 0
+      start_sinatra_app(:port => 8888) do
+        get('/') { "Port 8888 Response #{response_count += 1}" }
+      end
+
+      require 'vcr'
+
+      VCR.configure do |c|
+        c.ignore_request do |request|
+          URI(request.uri).port == 7777
+        end
+
+        c.cassette_library_dir = 'cassettes'
+        <configuration>
+      end
+
+      VCR.use_cassette('example') do
+        puts response_body_for(:get, "http://localhost:8888/")
+      end
+
+      VCR.use_cassette('example') do
+        puts response_body_for(:get, "http://localhost:7777/")
+      end
+
+      puts response_body_for(:get, "http://localhost:7777/")
+      puts response_body_for(:get, "http://localhost:8888/")
+      """
+    When I run `ruby ignore_request.rb`
+    Then it should fail with:
+      """
+      An HTTP request has been made that VCR does not know how to handle:
+        GET http://localhost:8888/
+      """
+     And the output should contain:
+      """
+      Port 8888 Response 1
+      Port 7777 Response 1
+      Port 7777 Response 2
+      """
+    And the file "cassettes/example.yml" should contain "body: Port 8888"
+    And the file "cassettes/example.yml" should not contain "body: Port 7777"
+
+    Examples:
+      | configuration         | http_lib              |
+      | c.hook_into :fakeweb  | net/http              |
+      | c.hook_into :webmock  | net/http              |
+      | c.hook_into :typhoeus | typhoeus              |
+      | c.hook_into :faraday  | faraday (w/ net_http) |
+
+  Scenario Outline: ignored host requests are not recorded and are always allowed
+    Given a file named "ignore_hosts.rb" with:
+      """ruby
+      include_http_adapter_for("<http_lib>")
+      require 'sinatra_app.rb'
+
+      require 'vcr'
+
+      VCR.configure do |c|
+        c.ignore_hosts '127.0.0.1', 'localhost'
+        c.cassette_library_dir = 'cassettes'
+        <configuration>
+      end
+
+      VCR.use_cassette('example') do
+        puts response_body_for(:get, "http://localhost:7777/")
+      end
+
+      puts response_body_for(:get, "http://localhost:7777/")
+      """
+    When I run `ruby ignore_hosts.rb`
+    Then it should pass with:
+      """
+      Port 7777 Response 1
+      Port 7777 Response 2
+      """
+    And the file "cassettes/example.yml" should not exist
+
+    Examples:
+      | configuration         | http_lib              |
+      | c.hook_into :fakeweb  | net/http              |
+      | c.hook_into :webmock  | net/http              |
+      | c.hook_into :typhoeus | typhoeus              |
+      | c.hook_into :excon    | excon                 |
+      | c.hook_into :faraday  | faraday (w/ net_http) |
+
+  @exclude-jruby
+  Scenario Outline: localhost requests are not treated differently by default
+    Given a file named "localhost_not_ignored.rb" with:
+      """ruby
+      include_http_adapter_for("<http_lib>")
+      require 'sinatra_app.rb'
+
+      require 'vcr'
+
+      VCR.configure do |c|
+        c.cassette_library_dir = 'cassettes'
+        <configuration>
+      end
+
+      VCR.use_cassette('localhost') do
+        response_body_for(:get, "http://localhost:7777/")
+      end
+
+      response_body_for(:get, "http://localhost:7777/")
+      """
+    When I run `ruby localhost_not_ignored.rb`
+    Then it should fail with "An HTTP request has been made that VCR does not know how to handle"
+     And the file "cassettes/localhost.yml" should contain "body: Port 7777 Response 1"
+
+    Examples:
+      | configuration         | http_lib              |
+      | c.hook_into :fakeweb  | net/http              |
+      | c.hook_into :webmock  | net/http              |
+      | c.hook_into :typhoeus | typhoeus              |
+      | c.hook_into :excon    | excon                 |
+      | c.hook_into :faraday  | faraday (w/ net_http) |
+
+  Scenario Outline: localhost requests are allowed and not recorded when ignore_localhost = true
+    Given a file named "ignore_localhost_true.rb" with:
+      """ruby
+      include_http_adapter_for("<http_lib>")
+      require 'sinatra_app.rb'
+
+      require 'vcr'
+
+      VCR.configure do |c|
+        c.ignore_localhost = true
+        c.cassette_library_dir = 'cassettes'
+        <configuration>
+      end
+
+      VCR.use_cassette('localhost') do
+        puts response_body_for(:get, "http://localhost:7777/")
+      end
+
+      puts response_body_for(:get, "http://localhost:7777/")
+      """
+    When I run `ruby ignore_localhost_true.rb`
+    Then it should pass with:
+      """
+      Port 7777 Response 1
+      Port 7777 Response 2
+      """
+    And the file "cassettes/localhost.yml" should not exist
+
+    Examples:
+      | configuration         | http_lib              |
+      | c.hook_into :fakeweb  | net/http              |
+      | c.hook_into :webmock  | net/http              |
+      | c.hook_into :typhoeus | typhoeus              |
+      | c.hook_into :excon    | excon                 |
+      | c.hook_into :faraday  | faraday (w/ net_http) |
+