vcr 1.11.3 → 2.0.0.beta1

data/features/cassettes/naming.feature

@@ -6,21 +6,19 @@ Feature: Naming
 
   Scenario: Name sanitizing
     Given a file named "name_sanitizing.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
-
+      """ruby
       start_sinatra_app(:port => 7777) do
         get('/') { "Hello" }
       end
 
       require 'vcr'
 
-      VCR.config do |c|
+      VCR.configure do |c|
         c.cassette_library_dir = 'cassettes'
-        c.stub_with :fakeweb
+        c.hook_into :fakeweb
       end
 
-      VCR.use_cassette('Fee, Fi Fo Fum', :record => :new_episodes) do
+      VCR.use_cassette('Fee, Fi Fo Fum') do
         Net::HTTP.get_response('localhost', '/', 7777)
       end
       """

data/features/cassettes/no_cassette.feature

@@ -21,49 +21,48 @@ Feature: Error for HTTP request made when no cassette is in use
 
   Scenario Outline: Error for request when no cassette is in use
     Given a file named "no_cassette_error.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
+      """ruby
       include_http_adapter_for("<http_lib>")
 
       require 'vcr'
 
-      VCR.config do |c|
-        c.stub_with <stub_with>
+      VCR.configure do |c|
+        <configuration>
         c.cassette_library_dir = 'cassettes'
       end
 
       response_body_for(:get, 'http://example.com/')
       """
     When I run `ruby no_cassette_error.rb`
-    Then it should fail with "<error>"
+    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:11                                                   |
+      | no_cassette_error.rb:10                                                   |
 
     Examples:
-      | stub_with  | http_lib        | error                              |
-      | :fakeweb   | net/http        | Real HTTP connections are disabled |
-      | :webmock   | net/http        | Real HTTP connections are disabled |
-      | :webmock   | httpclient      | Real HTTP connections are disabled |
-      | :webmock   | curb            | Real HTTP connections are disabled |
-      | :webmock   | patron          | Real HTTP connections are disabled |
-      | :webmock   | em-http-request | Real HTTP connections are disabled |
-      | :typhoeus  | typhoeus        | Real HTTP requests are not allowed |
-      | :excon     | excon           | Real HTTP connections are disabled |
+      | configuration         | http_lib              |
+      | c.hook_into :fakeweb  | net/http              |
+      | c.hook_into :webmock  | net/http              |
+      | c.hook_into :webmock  | httpclient            |
+      | c.hook_into :webmock  | curb                  |
+      | c.hook_into :webmock  | patron                |
+      | 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) |
 
   Scenario: Temporarily turn VCR off to allow HTTP requests to procede as normal
     Given a file named "turn_off_vcr.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
-
+      """ruby
       start_sinatra_app(:port => 7777) do
         get('/') { 'Hello' }
       end
 
       require 'vcr'
 
-      VCR.config do |c|
-        c.stub_with :fakeweb
+      VCR.configure do |c|
+        c.hook_into :fakeweb
       end
 
       def make_request(context)
@@ -109,11 +108,11 @@ Feature: Error for HTTP request made when no cassette is in use
 
   Scenario: Turning VCR off prevents cassettes from being inserted
     Given a file named "turn_off_vcr_and_insert_cassette.rb" with:
-      """
+      """ruby
       require 'vcr'
 
-      VCR.config do |c|
-        c.stub_with :fakeweb
+      VCR.configure do |c|
+        c.hook_into :fakeweb
       end
 
       VCR.turn_off!
@@ -124,18 +123,16 @@ Feature: Error for HTTP request made when no cassette is in use
 
   Scenario: Turning VCR off with `:ignore_cassettes => true` ignores cassettes
     Given a file named "turn_off_vcr_and_insert_cassette.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
-
+      """ruby
       start_sinatra_app(:port => 7777) do
         get('/') { 'Hello' }
       end
 
       require 'vcr'
 
-      VCR.config do |c|
+      VCR.configure do |c|
         c.cassette_library_dir = 'cassettes'
-        c.stub_with :fakeweb
+        c.hook_into :fakeweb
       end
 
       VCR.turn_off!(:ignore_cassettes => true)

data/features/cassettes/update_content_length_header.feature

@@ -41,12 +41,12 @@ Feature: Update content_length header
           http_version: "1.1"
       """
     And a file named "common_stuff.rb" with:
-      """
+      """ruby
       require 'vcr'
 
-      VCR.config do |c|
+      VCR.configure do |c|
         c.cassette_library_dir = 'cassettes'
-        c.stub_with :fakeweb
+        c.hook_into :fakeweb
       end
 
       def make_request_and_print_results
@@ -58,10 +58,10 @@ Feature: Update content_length header
 
   Scenario: Default :update_content_length_header setting
     Given a file named "default.rb" with:
-      """
+      """ruby
       require 'common_stuff'
 
-      VCR.use_cassette('example', :record => :none) do
+      VCR.use_cassette('example') do
         make_request_and_print_results
       end
       """
@@ -74,10 +74,10 @@ Feature: Update content_length header
 
   Scenario: :update_content_length_header => false
     Given a file named "false.rb" with:
-      """
+      """ruby
       require 'common_stuff'
 
-      VCR.use_cassette('example', :record => :none, :update_content_length_header => false) do
+      VCR.use_cassette('example', :update_content_length_header => false) do
         make_request_and_print_results
       end
       """
@@ -90,10 +90,10 @@ Feature: Update content_length header
 
   Scenario: :update_content_length_header => true
     Given a file named "true.rb" with:
-      """
+      """ruby
       require 'common_stuff'
 
-      VCR.use_cassette('example', :record => :none, :update_content_length_header => true) do
+      VCR.use_cassette('example', :update_content_length_header => true) do
         make_request_and_print_results
       end
       """

data/features/configuration/allow_http_connections_when_no_cassette.feature

@@ -7,9 +7,7 @@ Feature: Allow HTTP connections when no cassette
 
   Background:
     Given a file named "vcr_setup.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
-
+      """ruby
       if ARGV.include?('--with-server')
         start_sinatra_app(:port => 7777) do
           get('/') { "Hello" }
@@ -18,9 +16,9 @@ Feature: Allow HTTP connections when no cassette
 
       require 'vcr'
 
-      VCR.config do |c|
+      VCR.configure do |c|
         c.allow_http_connections_when_no_cassette = true
-        c.stub_with :fakeweb
+        c.hook_into :fakeweb
         c.cassette_library_dir = 'cassettes'
       end
       """
@@ -28,7 +26,7 @@ Feature: Allow HTTP connections when no cassette
 
   Scenario: Allow HTTP connections when no cassette
     Given a file named "no_cassette.rb" with:
-      """
+      """ruby
       require 'vcr_setup.rb'
 
       puts "Response: " + Net::HTTP.get_response('localhost', '/', 7777).body
@@ -38,10 +36,10 @@ Feature: Allow HTTP connections when no cassette
 
   Scenario: Cassettes record and replay as normal
     Given a file named "record_replay_cassette.rb" with:
-      """
+      """ruby
       require 'vcr_setup.rb'
 
-      VCR.use_cassette('localhost', :record => :new_episodes) do
+      VCR.use_cassette('localhost') do
         puts "Response: " + Net::HTTP.get_response('localhost', '/', 7777).body
       end
       """

data/features/configuration/cassette_library_dir.feature

@@ -5,21 +5,19 @@ Feature: cassette_library_dir
 
   Scenario: cassette_library_dir
     Given a file named "cassette_library_dir.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
-
+      """ruby
       start_sinatra_app(:port => 7777) do
         get('/') { "Hello" }
       end
 
       require 'vcr'
 
-      VCR.config do |c|
+      VCR.configure do |c|
         c.cassette_library_dir = 'vcr/cassettes'
-        c.stub_with :fakeweb
+        c.hook_into :fakeweb
       end
 
-      VCR.use_cassette('localhost', :record => :new_episodes) do
+      VCR.use_cassette('localhost') do
         Net::HTTP.get_response('localhost', '/', 7777)
       end
       """

data/features/configuration/default_cassette_options.feature

@@ -7,23 +7,25 @@ Feature: default_cassette_options
   The `:match_requests_on` option defaults to `[:method, :uri]` when
   it has not been set.
 
+  The `:record` option defaults to `:once` when it has not been set.
+
   Background:
     Given a file named "vcr_setup.rb" with:
-      """
+      """ruby
       require 'vcr'
 
-      VCR.config do |c|
+      VCR.configure do |c|
         c.default_cassette_options = { :record => :new_episodes, :erb => true }
 
         # not important for this example, but must be set to something
-        c.stub_with :webmock
+        c.hook_into :webmock
         c.cassette_library_dir = 'cassettes'
       end
       """
 
   Scenario: cassettes get default values from configured `default_cassette_options`
     Given a file named "default_cassette_options.rb" with:
-      """
+      """ruby
       require 'vcr_setup.rb'
 
       VCR.use_cassette('example') do
@@ -40,7 +42,7 @@ Feature: default_cassette_options
 
   Scenario: `:match_requests_on` defaults to `[:method, :uri]` when it has not been set
     Given a file named "default_cassette_options.rb" with:
-      """
+      """ruby
       require 'vcr_setup.rb'
 
       VCR.use_cassette('example') do
@@ -52,12 +54,12 @@ Feature: default_cassette_options
 
   Scenario: `:record` defaults to `:once` when it has not been set
     Given a file named "default_record_mode.rb" with:
-      """
+      """ruby
       require 'vcr'
 
-      VCR.config do |c|
+      VCR.configure do |c|
         # not important for this example, but must be set to something
-        c.stub_with :webmock
+        c.hook_into :webmock
         c.cassette_library_dir = 'cassettes'
       end
 
@@ -70,7 +72,7 @@ Feature: default_cassette_options
 
   Scenario: cassettes can set their own options
     Given a file named "default_cassette_options.rb" with:
-      """
+      """ruby
       require 'vcr_setup.rb'
 
       VCR.use_cassette('example', :re_record_interval => 10000) do
@@ -82,7 +84,7 @@ Feature: default_cassette_options
 
   Scenario: cassettes can override default options
     Given a file named "default_cassette_options.rb" with:
-      """
+      """ruby
       require 'vcr_setup.rb'
 
       VCR.use_cassette('example', :record => :none, :erb => false) do

data/features/configuration/filter_sensitive_data.feature

@@ -25,9 +25,7 @@ Feature: Filter sensitive data
 
   Scenario: Multiple filterings
     Given a file named "filtering.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
-
+      """ruby
       if ARGV.include?('--with-server')
         start_sinatra_app(:port => 7777) do
           get('/') { "Hello World" }
@@ -36,14 +34,14 @@ Feature: Filter sensitive data
 
       require 'vcr'
 
-      VCR.config do |c|
-        c.stub_with :fakeweb
+      VCR.configure do |c|
+        c.hook_into :fakeweb
         c.cassette_library_dir = 'cassettes'
         c.filter_sensitive_data('<GREETING>') { 'Hello' }
         c.filter_sensitive_data('<LOCATION>') { 'World' }
       end
 
-      VCR.use_cassette('filtering', :record => :new_episodes) do
+      VCR.use_cassette('filtering') do
         response = Net::HTTP.get_response('localhost', '/', 7777)
         puts "Response: #{response.body}"
       end
@@ -59,9 +57,7 @@ Feature: Filter sensitive data
 
   Scenario: Filter tagged cassettes
     Given a file named "tagged_filtering.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
-
+      """ruby
       if ARGV.include?('--with-server')
         response_count = 0
         start_sinatra_app(:port => 7777) do
@@ -71,13 +67,13 @@ Feature: Filter sensitive data
 
       require 'vcr'
 
-      VCR.config do |c|
-        c.stub_with :fakeweb
+      VCR.configure do |c|
+        c.hook_into :fakeweb
         c.cassette_library_dir = 'cassettes'
         c.filter_sensitive_data('<LOCATION>', :my_tag) { 'World' }
       end
 
-      VCR.use_cassette('tagged', :tag => :my_tag, :record => :new_episodes) do
+      VCR.use_cassette('tagged', :tag => :my_tag) do
         response = Net::HTTP.get_response('localhost', '/', 7777)
         puts "Tagged Response: #{response.body}"
       end
@@ -101,8 +97,7 @@ Feature: Filter sensitive data
 
   Scenario: Filter dynamic data based on yielded HTTP interaction
     Given a file named "dynamic_filtering.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
+      """ruby
       include_http_adapter_for('net/http')
 
       if ARGV.include?('--with-server')
@@ -125,15 +120,15 @@ Feature: Filter sensitive data
         'jane.doe' => 'cheetah'
       }
 
-      VCR.config do |c|
-        c.stub_with :webmock
+      VCR.configure do |c|
+        c.hook_into :webmock
         c.cassette_library_dir = 'cassettes'
         c.filter_sensitive_data('<PASSWORD>') do |interaction|
           USER_PASSWORDS[interaction.request.headers['x-http-username'].first]
         end
       end
 
-      VCR.use_cassette('example', :record => :new_episodes, :match_requests_on => [:method, :uri, :headers]) do
+      VCR.use_cassette('example', :match_requests_on => [:method, :uri, :headers]) do
         puts "Response: " + response_body_for(
           :get, 'http://localhost:7777/', nil,
           'X-HTTP-USERNAME' => 'john.doe',

data/features/configuration/{stub_with.feature → hook_into.feature}

@@ -1,99 +1,103 @@
-Feature: stub_with
+Feature: hook_into
 
-  The `stub_with` configuration option determines which HTTP stubbing library
-  VCR will use.  There are currently 4 supported stubbing libraries which
-  support many different HTTP libraries:
+  The `hook_into` configuration option determines how VCR hooks into the
+  HTTP requests to record and replay them.  There are currently 4 valid
+  options which support many different HTTP libraries:
 
-    - FakeWeb can be used to stub Net::HTTP.
-    - WebMock can be used to stub:
+    - :fakeweb can be used to hook into Net::HTTP requests.
+    - :webmock can be used to hook into requests from:
       - Net::HTTP
       - HTTPClient
       - Patron
       - Curb (Curl::Easy, but not Curl::Multi)
       - EM HTTP Request
-    - Typhoeus can be used to stub itself (as long as you use Typhoeus::Hydra,
+      - Typhoeus (Typhoeus::Hydra, but not Typhoeus::Easy or Typhoeus::Multi)
+    - :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 stub itself.
-    - Faraday can be used (in combination with the provided Faraday middleware)
-      to stub requests made through Faraday (regardless of which Faraday HTTP
-      adapter is used).
+    - :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).
 
   There are some addiitonal trade offs to consider when deciding which
-  stubbing library to use:
+  option to use:
 
-    - FakeWeb does not allow you to stub a request based on the headers or body.
-      Therefore, the `:match_requests_on` option does not support `:body` or
-      `:headers` when you use FakeWeb.  Typhoeus, WebMock and Faraday both
-      support matching on `:body` and `:headers`.
-    - FakeWeb is currently about 4 times faster than WebMock for stubbing
+    - FakeWeb is currently about 4 times faster than WebMock for hooking into
       Net::HTTP (see benchmarks/http_stubbing_libraries.rb for details).
-    - FakeWeb and WebMock both use extensive monkey patching to stub their
-      supported HTTP libraries.  No monkey patching is used for Typhoeus or
+    - FakeWeb and WebMock both use extensive monkey patching to hook into their
+      supported HTTP libraries.  No monkey patching is used for Typhoeus, Excon or
       Faraday.
     - FakeWeb and WebMock cannot both be used at the same time.
-    - Typhoeus, Excon and Faraday can be used together, and with either
-      FakeWeb or WebMock.
+    - Typhoeus, Excon, Faraday can be used together, and with either FakeWeb or WebMock.
 
   Regardless of which library you use, VCR takes care of all of the configuration
   for you.  You should not need to interact directly with FakeWeb, WebMock or the
   stubbing facilities of Typhoeus, Excon or Faraday.  If/when you decide to change stubbing
   libraries (i.e. if you initially use FakeWeb because it's faster but later need the
-  additional features of WebMock) you can change the `stub_with` configuration
+  additional features of WebMock) you can change the `hook_into` configuration
   option and it'll work with no other changes required.
 
-  Scenario Outline: Record and replay a request using each supported stubbing/http library combination
-    Given a file named "stubbing_http_lib_combo.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
+  Scenario Outline: Record and replay a request using each supported hook_into/http library combination
+    Given a file named "hook_into_http_lib_combo.rb" with:
+      """ruby
       include_http_adapter_for("<http_lib>")
 
+      require 'vcr'
+      VCR.configure { |c| c.ignore_localhost = true }
+
       start_sinatra_app(:port => 7777) do
         get('/') { ARGV[0] }
       end
 
       puts "The response for request 1 was: #{response_body_for(:get, "http://localhost:7777/")}"
 
-      require 'vcr'
-
-      VCR.config do |c|
-        c.stub_with <stub_with>
+      VCR.configure do |c|
+        <configuration>
         c.cassette_library_dir = 'vcr_cassettes'
+        c.ignore_localhost = false
       end
 
-      VCR.use_cassette('example', :record => :new_episodes) do
+      VCR.use_cassette('example') do
         puts "The response for request 2 was: #{response_body_for(:get, "http://localhost:7777/")}"
       end
       """
-    When I run `ruby stubbing_http_lib_combo.rb 'Hello World'`
+    When I run `ruby hook_into_http_lib_combo.rb 'Hello World'`
     Then the output should contain each of the following:
       | The response for request 1 was: Hello World |
       | The response for request 2 was: Hello World |
      And the file "vcr_cassettes/example.yml" should contain "body: Hello World"
 
-    When I run `ruby stubbing_http_lib_combo.rb 'Goodbye World'`
+    When I run `ruby hook_into_http_lib_combo.rb 'Goodbye World'`
     Then the output should contain each of the following:
       | The response for request 1 was: Goodbye World |
       | The response for request 2 was: Hello World   |
      And the file "vcr_cassettes/example.yml" should contain "body: Hello World"
 
    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  | curb                  |
+      | c.hook_into :webmock  | patron                |
+      | 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) |
+      |                       | faraday (w/ typhoeus) |
 
   @exclude-jruby
   Scenario Outline: Use Typhoeus, Excon and Faraday in combination with FakeWeb or WebMock
-    Given a file named "stub_with_multiple.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
+    Given a file named "hook_into_multiple.rb" with:
+      """ruby
       require 'typhoeus'
       require 'excon'
+      require 'faraday'
+      require 'vcr'
+
+      VCR.configure { |c| c.ignore_localhost = true }
 
       start_sinatra_app(:port => 7777) do
         get('/:path') { "#{ARGV[0]} #{params[:path]}" }
@@ -113,11 +117,7 @@ Feature: stub_with
 
       def faraday_response
         Faraday::Connection.new(:url => 'http://localhost:7777') do |builder|
-          builder.use VCR::Middleware::Faraday do |cassette|
-            cassette.name    'example'
-            cassette.options :record => :new_episodes
-          end
-
+          builder.use VCR::Middleware::Faraday
           builder.adapter :<faraday_adapter>
         end.get('/faraday').body
       end
@@ -125,49 +125,50 @@ Feature: stub_with
       puts "Net::HTTP 1: #{net_http_response}"
       puts "Typhoeus 1: #{typhoeus_response}"
       puts "Excon 1: #{excon_response}"
+      puts "Faraday 1: #{faraday_response}"
 
-      require 'vcr'
-
-      VCR.config do |c|
-        c.stub_with <stub_with>, :typhoeus, :excon, :faraday
+      VCR.configure do |c|
+        c.hook_into <hook_into>, :typhoeus, :excon
         c.cassette_library_dir = 'vcr_cassettes'
+        c.ignore_localhost = false
       end
 
-      VCR.use_cassette('example', :record => :new_episodes) do
+      VCR.use_cassette('example') do
         puts "Net::HTTP 2: #{net_http_response}"
         puts "Typhoeus 2: #{typhoeus_response}"
         puts "Excon 2: #{excon_response}"
+        puts "Faraday 2: #{faraday_response}"
       end
-
-      puts "Faraday: #{faraday_response}"
       """
-    When I run `ruby stub_with_multiple.rb 'Hello'`
+    When I run `ruby hook_into_multiple.rb 'Hello'`
     Then the output should contain each of the following:
       | Net::HTTP 1: Hello net_http |
       | Typhoeus 1: Hello typhoeus  |
       | Excon 1: Hello excon        |
+      | Faraday 1: Hello faraday    |
       | Net::HTTP 2: Hello net_http |
       | Typhoeus 2: Hello typhoeus  |
       | Excon 2: Hello excon        |
-      | Faraday: Hello faraday      |
+      | Faraday 2: Hello faraday    |
     And the cassette "vcr_cassettes/example.yml" should have the following response bodies:
       | Hello net_http |
       | Hello typhoeus |
       | Hello excon    |
       | Hello faraday  |
 
-    When I run `ruby stub_with_multiple.rb 'Goodbye'`
+    When I run `ruby hook_into_multiple.rb 'Goodbye'`
     Then the output should contain each of the following:
       | Net::HTTP 1: Goodbye net_http |
       | Typhoeus 1: Goodbye typhoeus  |
       | Excon 1: Goodbye excon        |
+      | Faraday 1: Goodbye faraday    |
       | Net::HTTP 2: Hello net_http   |
       | Typhoeus 2: Hello typhoeus    |
       | Excon 2: Hello excon          |
-      | Faraday: Hello faraday        |
+      | Faraday 2: Hello faraday      |
 
     Examples:
-      | stub_with | faraday_adapter |
+      | hook_into | faraday_adapter |
       | :fakeweb  | net_http        |
       | :webmock  | net_http        |
       | :fakeweb  | typhoeus        |