vcr 1.3.1 → 1.3.2

data/features/configuration/cassette_library_dir.feature

@@ -0,0 +1,28 @@
+Feature: cassette_library_dir configuration option
+
+  The `cassette_library_dir` configuration option sets a directory
+  where VCR saves each cassette.
+
+  Scenario: cassette_library_dir
+    Given a file named "cassette_library_dir.rb" with:
+      """
+      require 'vcr_cucumber_helpers'
+
+      start_sinatra_app(:port => 7777) do
+        get('/') { "Hello" }
+      end
+
+      require 'vcr'
+
+      VCR.config do |c|
+        c.cassette_library_dir = 'vcr/cassettes'
+        c.stub_with :fakeweb
+      end
+
+      VCR.use_cassette('localhost', :record => :new_episodes) do
+        Net::HTTP.get_response('localhost', '/', 7777)
+      end
+      """
+     And the directory "vcr/cassettes" does not exist
+    When I run "ruby cassette_library_dir.rb"
+    Then the file "vcr/cassettes/localhost.yml" should exist

data/features/configuration/default_cassette_options.feature

@@ -0,0 +1,80 @@
+Feature: default_cassette_options configuration option
+
+  The `default_cassette_options` configuration option takes a hash
+  that provides defaults for each cassette you use.  Any cassette
+  can override the defaults as well as set additional options.
+
+  The `:match_requests_on` option defaults to [:method, :uri] when
+  it has not been set.
+
+  Background:
+    Given a file named "vcr_setup.rb" with:
+      """
+      require 'vcr'
+
+      VCR.config 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.cassette_library_dir = 'cassettes'
+      end
+      """
+
+  Scenario: cassettes get default values from configured default_cassette_options
+    Given a file named "default_cassette_options.rb" with:
+      """
+      require 'vcr_setup.rb'
+
+      VCR.use_cassette('example') do
+        puts "Record Mode: #{VCR.current_cassette.record_mode}"
+        puts "ERB: #{VCR.current_cassette.erb}"
+      end
+      """
+    When I run "ruby default_cassette_options.rb"
+    Then the output should contain:
+      """
+      Record Mode: new_episodes
+      ERB: true
+      """
+
+  Scenario: :match_requests_on defaults to [:method, :uri] when it has not been set
+    Given a file named "default_cassette_options.rb" with:
+      """
+      require 'vcr_setup.rb'
+
+      VCR.use_cassette('example') do
+        puts "Match Requests On: #{VCR.current_cassette.match_requests_on.inspect}"
+      end
+      """
+    When I run "ruby default_cassette_options.rb"
+    Then the output should contain "Match Requests On: [:method, :uri]"
+
+  Scenario: cassettes can set their own options
+    Given a file named "default_cassette_options.rb" with:
+      """
+      require 'vcr_setup.rb'
+
+      VCR.use_cassette('example', :re_record_interval => 10000) do
+        puts "Re-record Interval: #{VCR.current_cassette.re_record_interval}"
+      end
+      """
+    When I run "ruby default_cassette_options.rb"
+    Then the output should contain "Re-record Interval: 10000"
+
+  Scenario: cassettes can override default options
+    Given a file named "default_cassette_options.rb" with:
+      """
+      require 'vcr_setup.rb'
+
+      VCR.use_cassette('example', :record => :none, :erb => false) do
+        puts "Record Mode: #{VCR.current_cassette.record_mode}"
+        puts "ERB: #{VCR.current_cassette.erb}"
+      end
+      """
+    When I run "ruby default_cassette_options.rb"
+    Then the output should contain:
+      """
+      Record Mode: none
+      ERB: false
+      """

data/features/configuration/ignore_localhost.feature

@@ -0,0 +1,103 @@
+Feature: ignore_localhost configuration option
+
+  The `ignore_localhost` configuration option can be used to prevent VCR
+  from having any affect on localhost requests.  If set to true, it will
+  never record them and always allow them, regardless of the record mode,
+  and even outside of a `VCR.use_cassette` block.
+
+  This is particularly useful when you use VCR with Capybara, since
+  Capybara starts a localhost server and pings it when you use one of
+  its javascript drivers.
+
+  Background:
+    Given a file named "sinatra_app.rb" with:
+      """
+      require 'vcr_cucumber_helpers'
+
+      response_count = 0
+      start_sinatra_app(:port => 7777) do
+        get('/') { "Response #{response_count += 1}" }
+      end
+      """
+
+  Scenario Outline: localhost requests are not treated differently by default and when the setting is false
+    Given a file named "localhost_not_ignored.rb" with:
+      """
+      require 'vcr_cucumber_helpers'
+      include_http_adapter_for("<http_lib>")
+      require 'sinatra_app.rb'
+
+      require 'vcr'
+
+      VCR.config do |c|
+        c.cassette_library_dir = 'cassettes'
+        c.stub_with <stub_with>
+        <additional_config>
+      end
+
+      VCR.use_cassette('localhost', :record => :new_episodes) 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 "<error>"
+     And the file "cassettes/localhost.yml" should contain "body: Response 1"
+
+    Examples:
+      | stub_with  | http_lib        | error                              | additional_config          |
+      | :fakeweb   | net/http        | Real HTTP connections are disabled |                            |
+      | :fakeweb   | net/http        | Real HTTP connections are disabled | c.ignore_localhost = false |
+      | :webmock   | net/http        | Real HTTP connections are disabled |                            |
+      | :webmock   | net/http        | Real HTTP connections are disabled | c.ignore_localhost = false |
+      | :webmock   | httpclient      | Real HTTP connections are disabled |                            |
+      | :webmock   | httpclient      | Real HTTP connections are disabled | c.ignore_localhost = false |
+      | :webmock   | curb            | Real HTTP connections are disabled |                            |
+      | :webmock   | curb            | Real HTTP connections are disabled | c.ignore_localhost = false |
+      | :webmock   | patron          | Real HTTP connections are disabled |                            |
+      | :webmock   | patron          | Real HTTP connections are disabled | c.ignore_localhost = false |
+      | :webmock   | em-http-request | Real HTTP connections are disabled |                            |
+      | :webmock   | em-http-request | Real HTTP connections are disabled | c.ignore_localhost = false |
+      | :typhoeus  | typhoeus        | Real HTTP requests are not allowed |                            |
+      | :typhoeus  | typhoeus        | Real HTTP requests are not allowed | c.ignore_localhost = false |
+
+  Scenario Outline: localhost requests are allowed and not recorded when ignore_localhost = true
+    Given a file named "ignore_localhost_true.rb" with:
+      """
+      require 'vcr_cucumber_helpers'
+      include_http_adapter_for("<http_lib>")
+      require 'sinatra_app.rb'
+
+      require 'vcr'
+
+      VCR.config do |c|
+        c.cassette_library_dir = 'cassettes'
+        c.stub_with <stub_with>
+        c.ignore_localhost = true
+      end
+
+      VCR.use_cassette('localhost', :record => :new_episodes) 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:
+      """
+      Response 1
+      Response 2
+      """
+    And the file "cassettes/localhost.yml" should not exist
+
+    Examples:
+      | stub_with  | http_lib        |
+      | :fakeweb   | net/http        |
+      | :webmock   | net/http        |
+      | :webmock   | httpclient      |
+      | :webmock   | patron          |
+      | :webmock   | curb            |
+      | :webmock   | em-http-request |
+      | :typhoeus  | typhoeus        |
+

data/features/configuration/stub_with.feature

@@ -0,0 +1,164 @@
+Feature: stub_with configuration option
+
+  The `stub_with` configuration option determines which HTTP stubbing library
+  VCR will use.  There are currently 3 supported stubbing libraries which
+  support 6 different HTTP libraries:
+
+    * FakeWeb can be used to stub Net::HTTP.
+    * WebMock can be used to stub:
+      * Net::HTTP
+      * HTTPClient
+      * Patron
+      * Curb
+      * EM HTTP Request
+    * Typhoeus can be used to stub itself.
+
+  There are some addiitonal trade offs to consider when deciding which
+  stubbing library 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 and WebMock both support
+      matching on `:body` and `:headers`.
+    * FakeWeb is currently about 4 times faster than WebMock for stubbing
+      Net::HTTP (see benchmarks/http_stubbing_libraries.rb for details).
+    * FakeWeb and WebMock both use extensive monkey patching to stub their
+      supported HTTP libraries.  Typhoeus provides all the necessary
+      stubbing and recording integration points, and no monkey patching
+      is required at all.
+    * Typhoeus can be used together with either FakeWeb or WebMock.
+    * FakeWeb and WebMock cannot both be used.
+
+  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.  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
+  option and it'll work with no other changes required.
+
+  Scenario Outline: stub_with loads the given HTTP stubbing library
+    Given a file named "vcr_stub_with.rb" with:
+      """
+      require 'vcr'
+
+      VCR.config do |c|
+        c.stub_with <stub_with>
+      end
+
+      puts "FakeWeb Loaded: #{!!defined?(FakeWeb)}"
+      puts "WebMock Loaded: #{!!defined?(WebMock)}"
+      puts "Typhoeus Loaded: #{!!defined?(Typhoeus)}"
+      """
+    When I run "ruby vcr_stub_with.rb"
+    Then the output should contain:
+      """
+      FakeWeb Loaded: <fakeweb_loaded>
+      WebMock Loaded: <webmock_loaded>
+      Typhoeus Loaded: <typhoeus_loaded>
+      """
+
+    Examples:
+      | stub_with | fakeweb_loaded | webmock_loaded | typhoeus_loaded |
+      | :fakeweb  | true           | false          | false           |
+      | :webmock  | false          | true           | false           |
+      | :typhoeus | false          | false          | true            |
+
+  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'
+      include_http_adapter_for("<http_lib>")
+
+      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>
+        c.cassette_library_dir = 'vcr_cassettes'
+      end
+
+      VCR.use_cassette('example', :record => :new_episodes) 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'"
+    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'"
+    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        |
+
+  @exclude-jruby
+  Scenario Outline: Use Typhoeus in combination with FakeWeb or WebMock
+    Given a file named "stub_with_multiple.rb" with:
+      """
+      require 'vcr_cucumber_helpers'
+      require 'typhoeus'
+
+      start_sinatra_app(:port => 7777) do
+        get('/:path') { "#{ARGV[0]} #{params[:path]}" }
+      end
+
+      def net_http_response
+        Net::HTTP.get_response('localhost', '/net_http', 7777).body
+      end
+
+      def typhoeus_response
+        Typhoeus::Request.get("http://localhost:7777/typhoeus").body
+      end
+
+      puts "Net::HTTP 1: #{net_http_response}"
+      puts "Typhoeus 1: #{typhoeus_response}"
+
+      require 'vcr'
+
+      VCR.config do |c|
+        c.stub_with <stub_with>, :typhoeus
+        c.cassette_library_dir = 'vcr_cassettes'
+      end
+
+      VCR.use_cassette('example', :record => :new_episodes) do
+        puts "Net::HTTP 2: #{net_http_response}"
+        puts "Typhoeus 2: #{typhoeus_response}"
+      end
+      """
+    When I run "ruby stub_with_multiple.rb 'Hello'"
+    Then the output should contain each of the following:
+      | Net::HTTP 1: Hello net_http |
+      | Typhoeus 1: Hello typhoeus  |
+      | Net::HTTP 2: Hello net_http |
+      | Typhoeus 2: Hello typhoeus  |
+    And the file "vcr_cassettes/example.yml" should contain "body: Hello net_http"
+    And the file "vcr_cassettes/example.yml" should contain "body: Hello typhoeus"
+
+    When I run "ruby stub_with_multiple.rb 'Goodbye'"
+    Then the output should contain each of the following:
+      | Net::HTTP 1: Goodbye net_http |
+      | Typhoeus 1: Goodbye typhoeus  |
+      | Net::HTTP 2: Hello net_http   |
+      | Typhoeus 2: Hello typhoeus    |
+
+  Examples:
+    | stub_with |
+    | :fakeweb  |
+    | :webmock  |

data/features/http_libraries/net_http.feature

@@ -0,0 +1,137 @@
+Feature: Net::HTTP
+
+  There are many ways to use Net::HTTP.  The scenarios below provide regression
+  tests for some Net::HTTP APIs that have not worked properly with VCR and
+  FakeWeb or WebMock in the past (but have since been fixed).
+
+  Background:
+    Given a file named "vcr_setup.rb" with:
+      """
+      require 'vcr_cucumber_helpers'
+
+      if ARGV[0] == '--with-server'
+        start_sinatra_app(:port => 7777) do
+          get('/')  { 'VCR works with Net::HTTP gets!' }
+          post('/') { 'VCR works with Net::HTTP posts!' }
+        end
+      end
+
+      require 'vcr'
+      """
+
+  Scenario Outline: Calling #post on new Net::HTTP instance
+    Given a file named "vcr_net_http.rb" with:
+      """
+      require 'vcr_setup.rb'
+
+      VCR.config do |c|
+        c.stub_with <stub_with>
+        c.cassette_library_dir = 'cassettes'
+      end
+
+      VCR.use_cassette('net_http', :record => :new_episodes) do
+        puts Net::HTTP.new('localhost', 7777).post('/', '').body
+      end
+      """
+    When I run "ruby vcr_net_http.rb --with-server"
+    Then the output should contain "VCR works with Net::HTTP posts!"
+    And the file "cassettes/net_http.yml" should contain "body: VCR works with Net::HTTP posts!"
+
+    When I run "ruby vcr_net_http.rb"
+    Then the output should contain "VCR works with Net::HTTP posts!"
+
+    Examples:
+      | stub_with |
+      | :fakeweb  |
+      | :webmock  |
+
+  Scenario Outline: Return from yielded block
+    Given a file named "vcr_net_http.rb" with:
+      """
+      require 'vcr_setup.rb'
+
+      VCR.config do |c|
+        c.stub_with <stub_with>
+        c.cassette_library_dir = 'cassettes'
+      end
+
+      def perform_request
+        Net::HTTP.new('localhost', 7777).request(Net::HTTP::Get.new('/', {})) do |response|
+          return response
+        end
+      end
+
+      VCR.use_cassette('net_http', :record => :new_episodes) do
+        puts perform_request.body
+      end
+      """
+    When I run "ruby vcr_net_http.rb --with-server"
+    Then the output should contain "VCR works with Net::HTTP gets!"
+    And the file "cassettes/net_http.yml" should contain "body: VCR works with Net::HTTP gets!"
+
+    When I run "ruby vcr_net_http.rb"
+    Then the output should contain "VCR works with Net::HTTP gets!"
+
+    Examples:
+      | stub_with |
+      | :fakeweb  |
+      | :webmock  |
+
+  Scenario Outline: Use Net::ReadAdapter to read body in fragments
+    Given a file named "vcr_net_http.rb" with:
+      """
+      require 'vcr_setup.rb'
+
+      VCR.config do |c|
+        c.stub_with <stub_with>
+        c.cassette_library_dir = 'cassettes'
+      end
+
+      VCR.use_cassette('net_http', :record => :new_episodes) do
+        body = ''
+
+        Net::HTTP.new('localhost', 7777).request_get('/') do |response|
+          response.read_body { |frag| body << frag }
+        end
+
+        puts body
+      end
+      """
+    When I run "ruby vcr_net_http.rb --with-server"
+    Then the output should contain "VCR works with Net::HTTP gets!"
+    And the file "cassettes/net_http.yml" should contain "body: VCR works with Net::HTTP gets!"
+
+    When I run "ruby vcr_net_http.rb"
+    Then the output should contain "VCR works with Net::HTTP gets!"
+
+    Examples:
+      | stub_with |
+      | :fakeweb  |
+      | :webmock  |
+
+  Scenario Outline: Use open-uri (which is built on top of Net::HTTP and uses a seldom-used Net::HTTP API)
+    Given a file named "vcr_net_http.rb" with:
+      """
+      require 'open-uri'
+      require 'vcr_setup.rb'
+
+      VCR.config do |c|
+        c.stub_with <stub_with>
+        c.cassette_library_dir = 'cassettes'
+      end
+
+      VCR.use_cassette('net_http', :record => :new_episodes) do
+        puts open('http://localhost:7777/').read
+      end
+      """
+    When I run "ruby vcr_net_http.rb --with-server"
+    Then the output should contain "VCR works with Net::HTTP gets!"
+    And the file "cassettes/net_http.yml" should contain "body: VCR works with Net::HTTP gets!"
+
+    When I run "ruby vcr_net_http.rb"
+    Then the output should contain "VCR works with Net::HTTP gets!"
+
+    Examples:
+      | stub_with |
+      | :fakeweb  |
+      | :webmock  |