vcr 1.11.3 → 2.0.0.beta1

data/features/request_matching/uri.feature

@@ -0,0 +1,84 @@
+Feature: Matching on URI
+
+  Use the `:uri` request matcher to match requests on the request URI.
+
+  The `:uri` matcher is used (along with the `:method` matcher) by default
+  if you do not specify how requests should match.
+
+  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.com:80/foo
+          body: 
+          headers: 
+        response: !ruby/struct:VCR::Response 
+          status: !ruby/struct:VCR::ResponseStatus 
+            code: 200
+            message: OK
+          headers: 
+            content-length: 
+            - "12"
+          body: foo response
+          http_version: "1.1"
+      - !ruby/struct:VCR::HTTPInteraction 
+        request: !ruby/struct:VCR::Request 
+          method: :post
+          uri: http://example.com:80/bar
+          body:
+          headers: 
+        response: !ruby/struct:VCR::Response 
+          status: !ruby/struct:VCR::ResponseStatus 
+            code: 200
+            message: OK
+          headers: 
+            content-length: 
+            - "12"
+          body: bar response
+          http_version: "1.1"
+      """
+
+  Scenario Outline: Replay interaction that matches the request URI
+    And a file named "uri_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 => [:uri]) do
+        puts "Response for /bar: " + response_body_for(:get, "http://example.com/bar")
+      end
+
+      VCR.use_cassette('example', :match_requests_on => [:uri]) do
+        puts "Response for /foo: " + response_body_for(:get,  "http://example.com/foo")
+      end
+      """
+    When I run `ruby uri_matching.rb`
+    Then it should pass with:
+      """
+      Response for /bar: bar response
+      Response for /foo: foo 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/uri_without_param.feature

@@ -0,0 +1,85 @@
+Feature: URI without param(s)
+
+  A common source of difficulty when using VCR with the default matchers
+  are non-deterministic URIs. If the URI changes on every test run (because
+  it includes a timestamp parameter, or whatever), the default URI matcher
+  will not work well for you.
+
+  You can write a custom matcher to match URIs however you want, but for the
+  common need to match on a URI and ignore particular query parameters, VCR
+  provides an easier way:
+
+      :match_requests_on => [:method, VCR.request_matchers.uri_without_param(:timestamp)]
+
+  `uri_without_param` also has a plural alias (i.e. `uri_without_params(:timestamp, :session)`)
+
+  Background:
+    Given a previously recorded cassette file "cassettes/example.yml" with:
+      """
+      --- 
+      - !ruby/struct:VCR::HTTPInteraction 
+        request: !ruby/struct:VCR::Request 
+          method: :get
+          uri: http://example.com:80/search?q=foo&timestamp=1316920490
+          body: 
+          headers: 
+        response: !ruby/struct:VCR::Response 
+          status: !ruby/struct:VCR::ResponseStatus 
+            code: 200
+            message: OK
+          headers: 
+            content-length: 
+            - "12"
+          body: foo response
+          http_version: "1.1"
+      - !ruby/struct:VCR::HTTPInteraction 
+        request: !ruby/struct:VCR::Request 
+          method: :get
+          uri: http://example.com:80/search?q=bar&timestamp=1296723437
+          body: 
+          headers: 
+        response: !ruby/struct:VCR::Response 
+          status: !ruby/struct:VCR::ResponseStatus 
+            code: 200
+            message: OK
+          headers: 
+            content-length: 
+            - "12"
+          body: bar response
+          http_version: "1.1"
+      """
+
+  Scenario: Match the URI on all but the timestamp query parameter
+    And a file named "uri_without_param_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.default_cassette_options = {
+          :match_requests_on => [:method, VCR.request_matchers.uri_without_param(:timestamp)]
+        }
+      end
+
+      def search_uri(q)
+        "http://example.com:80/search?q=#{q}&timestamp=#{Time.now.to_i}"
+      end
+
+      VCR.use_cassette('example') do
+        puts "Response for bar: " + response_body_for(:get, search_uri("bar"))
+      end
+
+      VCR.use_cassette('example') do
+        puts "Response for foo: " + response_body_for(:get, search_uri("foo"))
+      end
+      """
+    When I run `ruby uri_without_param_matcher.rb`
+    Then it should pass with:
+      """
+      Response for bar: bar response
+      Response for foo: foo response
+      """
+

data/features/step_definitions/cli_steps.rb

@@ -1,32 +1,8 @@
 require 'vcr'
 
 module VCRHelpers
-  YAML_REGEX_FOR_1_9_1 = Regexp.union(*[
-    '  request',
-    '    method',
-    '    uri',
-    '    body',
-    '    headers',
-    '  response',
-    '    status',
-    '      code',
-    '      message',
-    '    body',
-    '    http_version'
-  ].uniq)
-
-  def normalize_cassette_yaml(content)
-    return content unless RUBY_VERSION == '1.9.1'
-
-    # Ruby 1.9.1 serializes YAML a bit different, so
-    # we deal with that difference and add leading colons here.
-    content = content.gsub(YAML_REGEX_FOR_1_9_1) do |match|
-      match.sub(/^ +/, '\0:')
-    end
-  end
 
   def normalize_cassette_structs(content)
-    content = normalize_cassette_yaml(content)
     structs = YAML.load(content)
 
     # Remove non-deterministic headers
@@ -34,9 +10,9 @@ module VCRHelpers
       s.response.headers.reject! { |k, v| %w[ server date ].include?(k) }
     end
 
-    case $stubbing_lib_for_current_scenario
-      when ':excon'
-        # Excon does not expose the status message or http version,
+    case @stubbing_lib_for_current_scenario
+      when /excon|faraday/
+        # Excon/Faraday do not expose the status message or http version,
         # so we have no way to record these attributes.
         structs.each do |s|
           s.response.status.message = nil
@@ -69,7 +45,7 @@ Given /^the directory "([^"]*)" does not exist$/ do |dir|
 end
 
 Given /^a previously recorded cassette file "([^"]*)" with:$/ do |file_name, content|
-  write_file(file_name, normalize_cassette_yaml(content))
+  write_file(file_name, content)
 end
 
 Given /^(\d+) days have passed since the cassette was recorded$/ do |day_count|

data/features/support/env.rb

@@ -4,20 +4,22 @@ Bundler.setup
 
 require 'aruba/cucumber'
 
-Before do
-  this_dir = File.dirname(__FILE__)
-  in_current_dir do
-    FileUtils.ln_s File.join(this_dir, 'vcr_cucumber_helpers.rb'), 'vcr_cucumber_helpers.rb'
-  end
-end
-
+cucumer_helpers_file = '../../features/support/vcr_cucumber_helpers'
 if RUBY_VERSION > '1.9.1'
   Before do
-    set_env('RUBYOPT', '-I.:../../lib')
+    set_env('RUBYOPT', "-I.:../../lib -r#{cucumer_helpers_file}")
   end
 elsif RUBY_PLATFORM == 'java'
   Before do
-    set_env('RUBYOPT', '-I../../lib -rubygems')
+    set_env('RUBYOPT', "-I../../lib -rubygems -r#{cucumer_helpers_file}")
+
+    # ideas taken from: http://blog.headius.com/2010/03/jruby-startup-time-tips.html
+    set_env('JRUBY_OPTS', '-X-C') # disable JIT since these processes are so short lived
+    set_env('JAVA_OPTS', '-d32') # force jRuby to use client JVM for faster startup times
+  end
+else
+  Before do
+    set_env('RUBYOPT', "-rubygems -r#{cucumer_helpers_file}")
   end
 end
 

data/features/support/http_lib_filters.rb

@@ -27,8 +27,6 @@ elsif RUBY_PLATFORM == 'java'
   # on JRuby.  I'm not sure why, and there's little benefit to running
   # them on JRuby...so we just skip them.  Excon seems to have the same issue :(.
   UNSUPPORTED_HTTP_LIBS = c_dependent_libs + %w[ httpclient excon ]
-elsif RUBY_VERSION == '1.8.6' && ENV['TRAVIS']
-  UNSUPPORTED_HTTP_LIBS = %w[ em-http-request ]
 end
 
 if defined?(UNSUPPORTED_HTTP_LIBS)
@@ -42,19 +40,12 @@ if defined?(UNSUPPORTED_HTTP_LIBS)
   end
 end
 
-stubbing_libs = %w[ :fakeweb :webmock :typhoeus :faraday :excon ]
-
 # Set a global based on the current stubbing lib so we can put special-case
 # logic in our step definitions based on the http stubbing library.
 Before do |scenario|
   if scenario.respond_to?(:cell_values)
-    stub_with = stubbing_libs & scenario.cell_values
-    if stub_with.size == 1
-      $stubbing_lib_for_current_scenario = stub_with.first
-    else
-      $stubbing_lib_for_current_scenario = nil
-    end
+    @stubbing_lib_for_current_scenario = scenario.cell_values.find { |v| v =~ /fakeweb|webmock|typhoeus|faraday|excon/ }
   else
-    $stubbing_lib_for_current_scenario = nil
+    @stubbing_lib_for_current_scenario = nil
   end
 end

data/features/support/vcr_cucumber_helpers.rb

@@ -1,11 +1,10 @@
 # This file gets symlinked into the tmp/aruba directory before
 # each scenario so that it is available to be required in them.
-$LOAD_PATH.unshift '../../spec' unless $LOAD_PATH.include?('../../spec')
+$LOAD_PATH << '../../spec' unless $LOAD_PATH.include?('../../spec')
 $LOAD_PATH.unshift '../../lib'  unless $LOAD_PATH.include?('../../lib')
 
-RUNNING_UNDER_ARUBA = File.dirname(__FILE__) == '.' || File.dirname(__FILE__) =~ /aruba/
-
-if RUNNING_UNDER_ARUBA
+running_under_aruba = File.expand_path('.').include?('aruba')
+if running_under_aruba
   require 'support/fixnum_extension'
   require 'vcr/util/internet_connection'
 
@@ -23,7 +22,7 @@ end
 
 def include_http_adapter_for(lib)
   require 'support/http_library_adapters'
-  require lib
+  require (lib =~ /faraday/ ? 'faraday' : lib)
   include HTTP_LIBRARY_ADAPTERS[lib]
 end
 

data/features/test_frameworks/cucumber.feature

@@ -8,13 +8,15 @@ Feature: Usage with Cucumber
 
   In a cucumber support file (e.g. features/support/vcr.rb), put code like this:
 
-      VCR.cucumber_tags do |t|
-        t.tag  '@tag1'
-        t.tags '@tag2', '@tag3'
+  ``` ruby
+  VCR.cucumber_tags do |t|
+    t.tag  '@tag1'
+    t.tags '@tag2', '@tag3'
 
-        t.tag  '@tag3', :cassette => :options
-        t.tags '@tag4, '@tag5', :cassette => :options
-      end
+    t.tag  '@tag3', :cassette => :options
+    t.tags '@tag4, '@tag5', :cassette => :options
+  end
+  ```
 
   VCR will use a cassette named "cucumber_tags/<tag_name>" for scenarios
   with each of these tags.  The configured `default_cassette_options` will
@@ -23,9 +25,7 @@ Feature: Usage with Cucumber
 
   Scenario: Record HTTP interactions in a scenario by tagging it
     Given a file named "lib/server.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
-
+      """ruby
       if ENV['WITH_SERVER'] == 'true'
         start_sinatra_app(:port => 7777) do
           get('/:path') { "Hello #{params[:path]}" }
@@ -34,14 +34,13 @@ Feature: Usage with Cucumber
       """
 
     Given a file named "features/support/vcr.rb" with:
-      """
+      """ruby
       require "lib/server"
       require 'vcr'
 
-      VCR.config do |c|
-        c.stub_with :webmock
+      VCR.configure do |c|
+        c.hook_into :fakeweb
         c.cassette_library_dir     = 'features/cassettes'
-        c.default_cassette_options = { :record => :new_episodes }
       end
 
       VCR.cucumber_tags do |t|
@@ -50,7 +49,7 @@ Feature: Usage with Cucumber
       end
       """
     And a file named "features/step_definitions/steps.rb" with:
-      """
+      """ruby
       require 'net/http'
 
       When /^a request is made to "([^"]*)"$/ do |url|
@@ -92,8 +91,8 @@ Feature: Usage with Cucumber
     When I run `cucumber WITH_SERVER=true features/vcr_example.feature`
     Then it should fail with "3 scenarios (2 failed, 1 passed)"
     And the output should contain each of the following:
-      | Real HTTP connections are disabled. Unregistered request: GET http://localhost:7777/disallowed_1 |
-      | Real HTTP connections are disabled. Unregistered request: GET http://localhost:7777/disallowed_2 |
+      | Real HTTP connections are disabled. Request: GET http://localhost:7777/disallowed_1 |
+      | Real HTTP connections are disabled. Request: GET http://localhost:7777/disallowed_2 |
     And the file "features/cassettes/cucumber_tags/localhost_request.yml" should contain "body: Hello localhost_request_1"
     And the file "features/cassettes/cucumber_tags/localhost_request.yml" should contain "body: Hello localhost_request_2"
     And the file "features/cassettes/nested_cassette.yml" should contain "body: Hello nested_cassette"
@@ -104,8 +103,8 @@ Feature: Usage with Cucumber
     When I run `cucumber features/vcr_example.feature`
     Then it should fail with "3 scenarios (2 failed, 1 passed)"
     And the output should contain each of the following:
-      | Real HTTP connections are disabled. Unregistered request: GET http://localhost:7777/disallowed_1 |
-      | Real HTTP connections are disabled. Unregistered request: GET http://localhost:7777/disallowed_2 |
+      | Real HTTP connections are disabled. Request: GET http://localhost:7777/disallowed_1 |
+      | Real HTTP connections are disabled. Request: GET http://localhost:7777/disallowed_2 |
     And the file "features/cassettes/cucumber_tags/localhost_request.yml" should contain "body: Hello localhost_request_1"
     And the file "features/cassettes/cucumber_tags/localhost_request.yml" should contain "body: Hello localhost_request_2"
     And the file "features/cassettes/nested_cassette.yml" should contain "body: Hello nested_cassette"

data/features/test_frameworks/rspec.feature

@@ -27,15 +27,13 @@ Feature: Usage with RSpec
         | spec/cassettes/VCR-RSpec_integration/without_an_explicit_cassette_name.yml |
         | spec/cassettes/net_http_example.yml                                        |
     And a file named "spec/sinatra_app.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
-
+      """ruby
       start_sinatra_app(:port => 7777) do
         get('/') { "Hello" }
       end
       """
     And a file named "spec/vcr_example_spec.rb" with:
-      """
+      """ruby
       require 'spec_helper'
 
       describe "VCR-RSpec integration" do
@@ -63,14 +61,13 @@ Feature: Usage with RSpec
 
   Scenario: Use `use_vcr_cassette` macro with RSpec 2
     Given a file named "spec/spec_helper.rb" with:
-      """
+      """ruby
       require 'sinatra_app'
       require 'vcr'
 
-      VCR.config do |c|
+      VCR.configure do |c|
         c.cassette_library_dir     = 'spec/cassettes'
-        c.stub_with                :fakeweb
-        c.default_cassette_options = { :record => :new_episodes }
+        c.hook_into                :fakeweb
       end
 
       RSpec.configure do |c|
@@ -84,7 +81,7 @@ Feature: Usage with RSpec
 
   Scenario: Use `use_vcr_cassette` macro with RSpec 1
     Given a file named "spec/spec_helper.rb" with:
-      """
+      """ruby
       require 'sinatra_app'
       $LOAD_PATH.unshift(File.join(%w[ .. .. vendor rspec-1 lib ]))
 
@@ -93,10 +90,9 @@ Feature: Usage with RSpec
 
       require 'vcr'
 
-      VCR.config do |c|
+      VCR.configure do |c|
         c.cassette_library_dir     = 'spec/cassettes'
-        c.stub_with                  :fakeweb
-        c.default_cassette_options = { :record => :new_episodes }
+        c.hook_into                  :fakeweb
       end
 
       Spec::Runner.configure do |c|