vcr 1.11.3 → 2.0.0.beta1

data/features/middleware/faraday.feature

@@ -3,47 +3,37 @@ Feature: Faraday middleware
   VCR provides middleware that can be used with Faraday.  You can use this as
   an alternative to Faraday's built-in test adapter.
 
-  To use VCR with Faraday, you should configure VCR to stub with faraday and
-  use the provided middleware.  The middleware should come before the Faraday
-  HTTP adapter.  You should provide the middleware with a block where you set
-  the cassette name and options.  If your block accepts two arguments, the
-  env hash will be yielded, allowing you to dynamically set the cassette name
-  and options based on the request environment.
-
-  Background:
-    Given a file named "env_setup.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
+  To use VCR with Faraday, simply add the VCR middleware to the Faraday
+  connection stack.  The middleware should come before the Faraday
+  HTTP adapter.
 
+  Scenario Outline: Use Faraday middleware
+    Given a file named "faraday_example.rb" with:
+      """ruby
       request_count = 0
       start_sinatra_app(:port => 7777) do
         get('/:path') { "Hello #{params[:path]} #{request_count += 1}" }
       end
 
+      require 'faraday'
       require 'vcr'
 
-      VCR.config do |c|
+      VCR.configure do |c|
         c.cassette_library_dir = 'cassettes'
-        c.stub_with :faraday
       end
-      """
-
-  Scenario Outline: Use Faraday middleware
-    Given a file named "faraday_example.rb" with:
-      """
-      require 'env_setup'
 
       conn = Faraday::Connection.new(:url => 'http://localhost:7777') do |builder|
-        builder.use VCR::Middleware::Faraday do |cassette|
-          cassette.name    'faraday_example'
-          cassette.options :record => :new_episodes
-        end
-
+        builder.use VCR::Middleware::Faraday
         builder.adapter :<adapter>
       end
 
-      puts "Response 1: #{conn.get('/foo').body}"
-      puts "Response 2: #{conn.get('/foo').body}"
+      VCR.use_cassette('example') do
+        puts "Response 1: #{conn.get('/foo').body}"
+      end
+
+      VCR.use_cassette('example') do
+        puts "Response 2: #{conn.get('/foo').body}"
+      end
       """
     When I run `ruby faraday_example.rb`
     Then the output should contain:
@@ -51,39 +41,10 @@ Feature: Faraday middleware
       Response 1: Hello foo 1
       Response 2: Hello foo 1
       """
-    And the file "cassettes/faraday_example.yml" should contain "body: Hello foo 1"
+    And the file "cassettes/example.yml" should contain "body: Hello foo 1"
 
     Examples:
       | adapter  |
       | net_http |
       | typhoeus |
 
-  Scenario: Set cassette name based on faraday env
-    Given a file named "faraday_example.rb" with:
-      """
-      require 'env_setup'
-
-      conn = Faraday::Connection.new(:url => 'http://localhost:7777') do |builder|
-        builder.use VCR::Middleware::Faraday do |cassette, env|
-          cassette.name    env[:url].path.sub(/^\//, '')
-          cassette.options :record => :new_episodes
-        end
-
-        builder.adapter :net_http
-      end
-
-      puts "Response 1: #{conn.get('/foo').body}"
-      puts "Response 2: #{conn.get('/foo').body}"
-      puts "Response 3: #{conn.get('/bar').body}"
-      puts "Response 4: #{conn.get('/bar').body}"
-      """
-    When I run `ruby faraday_example.rb`
-    Then the output should contain:
-      """
-      Response 1: Hello foo 1
-      Response 2: Hello foo 1
-      Response 3: Hello bar 2
-      Response 4: Hello bar 2
-      """
-    And the file "cassettes/foo.yml" should contain "body: Hello foo 1"
-    And the file "cassettes/bar.yml" should contain "body: Hello bar 2"

data/features/middleware/rack.feature

@@ -16,16 +16,14 @@ Feature: Rack
 
   Background:
     Given a file named "remote_server.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
-
+      """ruby
       request_count = 0
       start_sinatra_app(:port => 7777) do
         get('/:path') { "Hello #{params[:path]} #{request_count += 1}" }
       end
       """
     And a file named "client.rb" with:
-      """
+      """ruby
       require 'remote_server'
       require 'proxy_server'
       require 'cgi'
@@ -39,7 +37,7 @@ Feature: Rack
 
   Scenario: Use VCR rack middleware to record HTTP responses for a simple rack proxy app
     Given a file named "proxy_server.rb" with:
-      """
+      """ruby
       require 'vcr'
 
       start_sinatra_app(:port => 8888) do
@@ -51,9 +49,9 @@ Feature: Rack
         get('/') { Net::HTTP.get_response(URI.parse(params[:url])).body }
       end
 
-      VCR.config do |c|
+      VCR.configure do |c|
         c.cassette_library_dir = 'cassettes'
-        c.stub_with :fakeweb
+        c.hook_into :fakeweb
         c.allow_http_connections_when_no_cassette = true
       end
       """
@@ -67,21 +65,20 @@ Feature: Rack
 
   Scenario: Set cassette name based on rack request env
     Given a file named "proxy_server.rb" with:
-      """
+      """ruby
       require 'vcr'
 
       start_sinatra_app(:port => 8888) do
         use VCR::Middleware::Rack do |cassette, env|
           cassette.name    env['SERVER_NAME']
-          cassette.options :record => :new_episodes
         end
 
         get('/') { Net::HTTP.get_response(URI.parse(params[:url])).body }
       end
 
-      VCR.config do |c|
+      VCR.configure do |c|
         c.cassette_library_dir = 'cassettes'
-        c.stub_with :fakeweb
+        c.hook_into :fakeweb
         c.allow_http_connections_when_no_cassette = true
       end
       """

data/features/record_modes/all.feature

@@ -11,9 +11,7 @@ Feature: :all
 
   Background:
     Given a file named "setup.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
-
+      """ruby
       start_sinatra_app(:port => 7777) do
         get('/')    { 'Hello' }
         get('/foo') { 'Goodbye' }
@@ -21,8 +19,8 @@ Feature: :all
 
       require 'vcr'
 
-      VCR.config do |c|
-        c.stub_with                :fakeweb
+      VCR.configure do |c|
+        c.hook_into                :fakeweb
         c.cassette_library_dir     = 'cassettes'
       end
       """
@@ -50,7 +48,7 @@ Feature: :all
 
   Scenario: Re-record previously recorded response
     Given a file named "re_record.rb" with:
-      """
+      """ruby
       require 'setup'
 
       VCR.use_cassette('example', :record => :all) do
@@ -65,7 +63,7 @@ Feature: :all
 
   Scenario: Record new request
     Given a file named "record_new.rb" with:
-      """
+      """ruby
       require 'setup'
 
       VCR.use_cassette('example', :record => :all) do

data/features/record_modes/new_episodes.feature

@@ -11,17 +11,15 @@ Feature: :new_episodes
 
   Background:
     Given a file named "setup.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
         c.cassette_library_dir     = 'cassettes'
       end
       """
@@ -49,7 +47,7 @@ Feature: :new_episodes
 
   Scenario: Previously recorded responses are replayed
     Given a file named "replay_recorded_response.rb" with:
-      """
+      """ruby
       require 'setup'
 
       VCR.use_cassette('example', :record => :new_episodes) do
@@ -62,7 +60,7 @@ Feature: :new_episodes
 
   Scenario: New requests get recorded
     Given a file named "record_new_requests.rb" with:
-      """
+      """ruby
       require 'setup'
 
       VCR.use_cassette('example', :record => :new_episodes) do

data/features/record_modes/none.feature

@@ -11,11 +11,11 @@ Feature: :none
 
   Background:
     Given a file named "vcr_config.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'
       end
       """
@@ -43,7 +43,7 @@ Feature: :none
 
   Scenario: Previously recorded responses are replayed
     Given a file named "replay_recorded_response.rb" with:
-      """
+      """ruby
       require 'vcr_config'
 
       VCR.use_cassette('example', :record => :none) do
@@ -56,7 +56,7 @@ Feature: :none
 
   Scenario: New requests are prevented
     Given a file named "prevent_new_request.rb" with:
-      """
+      """ruby
       require 'vcr_config'
 
       VCR.use_cassette('example', :record => :none) do
@@ -64,4 +64,4 @@ Feature: :none
       end
       """
     When I run `ruby prevent_new_request.rb`
-    Then it should fail with "Real HTTP connections are disabled. Unregistered request: GET http://example.com/bar"
+    Then it should fail with "Real HTTP connections are disabled. Request: GET http://example.com:80/bar"

data/features/record_modes/once.feature

@@ -14,17 +14,15 @@ Feature: :once
 
   Background:
     Given a file named "setup.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
         c.cassette_library_dir     = 'cassettes'
       end
       """
@@ -52,7 +50,7 @@ Feature: :once
 
   Scenario: Previously recorded responses are replayed
     Given a file named "replay_recorded_response.rb" with:
-      """
+      """ruby
       require 'setup'
 
       VCR.use_cassette('example', :record => :once) do
@@ -65,7 +63,7 @@ Feature: :once
 
   Scenario: New requests result in an error when the cassette file exists
     Given a file named "error_for_new_requests_when_cassette_exists.rb" with:
-      """
+      """ruby
       require 'setup'
 
       VCR.use_cassette('example', :record => :once) do
@@ -78,7 +76,7 @@ Feature: :once
 
   Scenario: New requests get recorded when there is no cassette file
     Given a file named "record_new_requests.rb" with:
-      """
+      """ruby
       require 'setup'
 
       VCR.use_cassette('example', :record => :once) do

data/features/request_matching/README.md

@@ -0,0 +1,28 @@
+In order to properly replay previously recorded requests, VCR must match new
+HTTP requests to a previously recorded one. By default, it matches on HTTP
+method and URI, since that is usually deterministic and fully identifies the
+resource and action for typical RESTful APIs.
+
+You can customize how VCR matches requests using the `:match_requests_on` cassette 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
+    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
+    that matches the path.
+  - `:body` - The body of the request.
+  - `:headers` - The request headers.
+
+You can also register a custom request matcher. This particularly comes
+in handy for dealing with APIs that use non-deterministic URIs (i.e. by
+including a timestamp as a query parameter or whatever).
+
+When a cassette contains multiple HTTP interactions that match a request
+based on the configured `:match_requests_on` setting, the responses are
+sequenced: the first matching request will get the first response,
+the second matching request will get the second response, etc.
+

data/features/request_matching/body.feature

@@ -0,0 +1,81 @@
+Feature: Matching on Body
+
+  Use the `:body` request matcher to match requests on the request body.
+
+  Background:
+    Given a previously recorded cassette file "cassettes/example.yml" with:
+      """
+      --- 
+      - !ruby/struct:VCR::HTTPInteraction 
+        request: !ruby/struct:VCR::Request 
+          method: :post
+          uri: http://example.net:80/some/long/path
+          body: body1
+          headers: 
+        response: !ruby/struct:VCR::Response 
+          status: !ruby/struct:VCR::ResponseStatus 
+            code: 200
+            message: OK
+          headers: 
+            content-length: 
+            - "14"
+          body: body1 response
+          http_version: "1.1"
+      - !ruby/struct:VCR::HTTPInteraction 
+        request: !ruby/struct:VCR::Request 
+          method: :post
+          uri: http://example.net:80/some/long/path
+          body: body2
+          headers: 
+        response: !ruby/struct:VCR::Response 
+          status: !ruby/struct:VCR::ResponseStatus 
+            code: 200
+            message: OK
+          headers: 
+            content-length: 
+            - "14"
+          body: body2 response
+          http_version: "1.1"
+      """
+
+  Scenario Outline: Replay interaction that matches the body
+    And a file named "body_matching.rb" with:
+      """ruby
+      include_http_adapter_for("<http_lib>")
+
+      require 'vcr'
+
+      VCR.configure do |c|
+        <configuration>
+        c.cassette_library_dir = 'cassettes'
+      end
+
+      VCR.use_cassette('example', :match_requests_on => [:body]) do
+        puts "Response for body2: " + response_body_for(:put, "http://example.com/", "body2")
+      end
+
+      VCR.use_cassette('example', :match_requests_on => [:body]) do
+        puts "Response for body1: " + response_body_for(:put, "http://example.com/", "body1")
+      end
+      """
+    When I run `ruby body_matching.rb`
+    Then it should pass with:
+      """
+      Response for body2: body2 response
+      Response for body1: body1 response
+      """
+
+    Examples:
+      | 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) |
+

data/features/request_matching/custom_matcher.feature

@@ -0,0 +1,125 @@
+Feature: Register and use a custom matcher
+
+  If the built-in matchers do not meet your needs, you can use a custom matcher.
+
+  Any 2-argument callable (that is, an object that responds to #call and accepts
+  2 arguments) can be a matcher.  Simply put the callable in your
+  `:match_requests_on` array.
+
+  In addition, you can register a named custom matcher with VCR, and use
+  the name in your `:match_requests_on` array.
+
+  Either way, your custom matcher should return a truthy value if the
+  given requests should be considered equivalent.
+
+  Background:
+    Given a previously recorded cassette file "cassettes/example.yml" with:
+      """
+      --- 
+      - !ruby/struct:VCR::HTTPInteraction 
+        request: !ruby/struct:VCR::Request 
+          method: :get
+          uri: http://foo.com:9000/foo
+          body: 
+          headers: 
+        response: !ruby/struct:VCR::Response 
+          status: !ruby/struct:VCR::ResponseStatus 
+            code: 200
+            message: OK
+          headers: 
+            content-length: 
+            - "18"
+          body: port 9000 response
+          http_version: "1.1"
+      - !ruby/struct:VCR::HTTPInteraction 
+        request: !ruby/struct:VCR::Request 
+          method: :get
+          uri: http://foo.com:8000/foo
+          body: 
+          headers: 
+        response: !ruby/struct:VCR::Response 
+          status: !ruby/struct:VCR::ResponseStatus 
+            code: 200
+            message: OK
+          headers: 
+            content-length: 
+            - "18"
+          body: port 8000 response
+          http_version: "1.1"
+      """
+
+  Scenario Outline: Use a callable as a custom request matcher
+    And a file named "callable_matcher.rb" with:
+      """ruby
+      include_http_adapter_for("<http_lib>")
+
+      require 'vcr'
+
+      VCR.configure do |c|
+        <configuration>
+        c.cassette_library_dir = 'cassettes'
+      end
+
+      port_matcher = lambda do |request_1, request_2|
+        URI(request_1.uri).port == URI(request_2.uri).port
+      end
+
+      VCR.use_cassette('example', :match_requests_on => [:method, port_matcher]) do
+        puts "Response for port 8000: " + response_body_for(:get, "http://example.com:8000/")
+      end
+
+      VCR.use_cassette('example', :match_requests_on => [:method, port_matcher]) do
+        puts "Response for port 9000: " + response_body_for(:get, "http://example.com:9000/")
+      end
+      """
+    When I run `ruby callable_matcher.rb`
+    Then it should pass with:
+      """
+      Response for port 8000: port 8000 response
+      Response for port 9000: port 9000 response
+      """
+
+    Examples:
+      | 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) |
+
+  Scenario: Register a named custom matcher
+    And a file named "register_custom_matcher.rb" with:
+      """ruby
+      include_http_adapter_for("net/http")
+
+      require 'vcr'
+
+      VCR.configure do |c|
+        c.hook_into :fakeweb
+        c.cassette_library_dir = 'cassettes'
+        c.register_request_matcher :port do |request_1, request_2|
+          URI(request_1.uri).port == URI(request_2.uri).port
+        end
+      end
+
+      VCR.use_cassette('example', :match_requests_on => [:method, :port]) do
+        puts "Response for port 8000: " + response_body_for(:get, "http://example.com:8000/")
+      end
+
+      VCR.use_cassette('example', :match_requests_on => [:method, :port]) do
+        puts "Response for port 9000: " + response_body_for(:get, "http://example.com:9000/")
+      end
+      """
+    When I run `ruby register_custom_matcher.rb`
+    Then it should pass with:
+      """
+      Response for port 8000: port 8000 response
+      Response for port 9000: port 9000 response
+      """
+