vcr 1.3.3 → 1.4.0

data/.rspec

@@ -0,0 +1,2 @@
+--format Fuubar
+--color

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 1.4.0 (December 3, 2010)
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.3.3...v1.4.0)
+
+* Added support for making HTTP requests without a cassette (i.e. if you don't
+  want to use VCR for all of your test suite).  There are a few ways to
+  enable this:
+  * In your `VCR.config` block, set `allow_http_connections_when_no_cassette`
+    to true to allow HTTP requests without a cassette.
+  * You can temporarily turn off VCR using `VCR.turned_off { ... }`.
+  * You can toggle VCR off and on with `VCR.turn_off!` and `VCR.turn_on!`.
+* Fixed bug with `ignore_localhost` config option.  Previously, an error would
+  be raised if it was set before the `stub_with` option.
+* Added VCR::Middleware::Rack (see features/middleware/rack.feature for usage).
+* Added support for Faraday (see features/middleware/faraday.feature for usage).
+
 ## 1.3.3 (November 21, 2010)
 
 [Full Changelog](http://github.com/myronmarston/vcr/compare/v1.3.2...v1.3.3)

data/Gemfile

@@ -20,7 +20,10 @@ end
 # Additional gems that are useful, but not required for development.
 group :extras do
   gem 'guard-rspec'
+  gem 'guard-cucumber'
+  gem 'growl'
   gem 'relish'
+  gem 'fuubar'
 
   platforms :mri do
     gem 'rcov'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vcr (1.3.3)
+    vcr (1.4.0)
 
 GEM
   remote: http://rubygems.org/
@@ -15,7 +15,7 @@ GEM
     bouncy-castle-java (1.5.0145.2)
     builder (2.1.2)
     columnize (0.3.1)
-    configuration (1.1.0)
+    configuration (1.2.0)
     crack (0.1.8)
     cucumber (0.9.4)
       builder (~> 2.1.2)
@@ -30,16 +30,28 @@ GEM
       eventmachine (>= 0.12.9)
     eventmachine (0.12.10)
     fakeweb (1.3.0)
+    faraday (0.5.3)
+      addressable (~> 2.2.2)
+      multipart-post (~> 1.0.1)
+      rack (>= 1.1.0, < 2)
+    fuubar (0.0.2)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.1.4)
+      ruby-progressbar (~> 0.0.9)
     gherkin (2.2.9)
       json (~> 1.4.6)
       term-ansicolor (~> 1.0.5)
     gherkin (2.2.9-java)
       json (~> 1.4.6)
       term-ansicolor (~> 1.0.5)
+    growl (1.0.3)
     guard (0.2.2)
       open_gem (~> 1.4.2)
       thor (~> 0.14.3)
-    guard-rspec (0.1.5)
+    guard-cucumber (0.2.1)
+      cucumber (~> 0.9.4)
+      guard (~> 0.2.2)
+    guard-rspec (0.1.8)
       guard (>= 0.2.0)
     httpclient (2.1.5.2)
     jruby-openssl (0.7.2)
@@ -53,6 +65,7 @@ GEM
     linecache19 (0.5.11)
       ruby_core_source (>= 0.1.4)
     mime-types (1.16)
+    multipart-post (1.0.1)
     open_gem (1.4.2)
       launchy (~> 0.3.5)
     patron (0.4.9)
@@ -73,6 +86,7 @@ GEM
     rspec-core (2.1.0)
     rspec-expectations (2.1.0)
       diff-lcs (~> 1.1.2)
+    rspec-instafail (0.1.4)
     rspec-mocks (2.1.0)
     ruby-debug (0.10.3)
       columnize (>= 0.1)
@@ -87,6 +101,7 @@ GEM
       columnize (>= 0.3.1)
       linecache19 (>= 0.5.11)
       ruby-debug-base19 (>= 0.11.19)
+    ruby-progressbar (0.0.9)
     ruby_core_source (0.1.4)
       archive-tar-minitar (>= 0.5.2)
     shoulda (2.9.2)
@@ -94,7 +109,7 @@ GEM
       rack (~> 1.1)
       tilt (~> 1.1)
     term-ansicolor (1.0.5)
-    thor (0.14.4)
+    thor (0.14.6)
     tilt (1.1)
     timecop (0.3.5)
     typhoeus (0.2.0)
@@ -113,6 +128,10 @@ DEPENDENCIES
   curb (~> 0.7.8)
   em-http-request (~> 0.2.7)
   fakeweb (~> 1.3.0)
+  faraday (~> 0.5.3)
+  fuubar
+  growl
+  guard-cucumber
   guard-rspec
   httpclient (~> 2.1.5.2)
   jruby-openssl

data/Guardfile

@@ -7,3 +7,9 @@ guard 'rspec', :version => 2 do
   watch('^lib/vcr/(.*)\.rb')                          { |m| "spec/#{m[1]}_spec.rb" }
   watch('^spec/spec_helper.rb')                       { "spec" }
 end
+
+guard 'cucumber' do
+  watch('^features/(.*).feature')
+  watch('^features/support')                       { 'features' }
+  watch('^features/step_definitions')              { 'features' }
+end

data/README.md

@@ -29,15 +29,15 @@ maintenance) and accurate (the response from example.com will contain the same h
 ## Features
 
 * Automatically records and replays your HTTP interactions with minimal setup/configuration code.
-* Supports multiple HTTP stubbing libraries.  Currently FakeWeb and WebMock are supported, and the adapter interface
-  is easy to implement for any future libraries.
+* Supports multiple HTTP stubbing libraries.  Currently FakeWeb, WebMock, Typhoeus and Faraday
+  are supported.
 * Supports multiple HTTP libraries:
   * [Patron](http://github.com/toland/patron) (WebMock)
-  * [Curb](http://github.com/taf2/curb) (WebMock)
+  * [Curb](http://github.com/taf2/curb) (WebMock -- only supports Curb::Easy at the moment)
   * [HTTPClient](http://github.com/nahi/httpclient) (WebMock)
   * [em-http-request](http://github.com/igrigorik/em-http-request) (WebMock)
   * [Net::HTTP](http://www.ruby-doc.org/stdlib/libdoc/net/http/rdoc/index.html) (FakeWeb and WebMock)
-  * [Typhoeus](https://github.com/pauldix/typhoeus)
+  * [Typhoeus](https://github.com/pauldix/typhoeus) (Typhoeus::Hydra, but not Typhoeus::Easy or Typhoeus::Multi)
   * And of course any library built on Net::HTTP, such as [Mechanize](http://github.com/tenderlove/mechanize),
     [HTTParty](http://github.com/jnunemaker/httparty) or [Rest Client](http://github.com/archiloque/rest-client).
 * Request matching is configurable based on HTTP method, URI, host, path, body and headers.
@@ -50,6 +50,7 @@ maintenance) and accurate (the response from example.com will contain the same h
 * Known to work well with many popular ruby libraries including RSpec 1 & 2, Cucumber, Test::Unit,
   Capybara, Mechanize, Rest-Client and HTTParty.
 * Extensively tested on 7 different ruby interpretters.
+* Includes Rack and Faraday middleware.
 
 ## Usage
 

data/Rakefile

@@ -5,9 +5,7 @@ Bundler::GemHelper.install_tasks
 require 'rake'
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec) do |t|
-  #t.rspec_opts = %w[--format documentation]
-end
+RSpec::Core::RakeTask.new(:spec)
 
 desc "Run all examples using rcov"
 RSpec::Core::RakeTask.new :rcov => :cleanup_rcov_files do |t|

data/TODO.md

@@ -1,2 +1,5 @@
 * Use fakefs gem instead of using temp_dir in specs.
 * Fix #method vs .method in specs.
+* Cuke for Net::HTTP HTTPS request
+* Cuke for multiple simultaneous em-http-request
+* Ensure the checkpoints are properly deep-duped

data/cucumber.yml

@@ -2,13 +2,13 @@
 rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
 rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
 std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} --strict --tags ~@wip"
-interp_opts = if RUBY_PLATFORM == 'java'
-  ' --tags ~@exclude-jruby'
+interp_opts = if defined?(RUBY_ENGINE)
+  " --tags ~@exclude-#{RUBY_ENGINE}"
 else
   ''
 end
 %>
 default: <%= std_opts %><%= interp_opts %> features
-wip: --tags @wip:30 --wip features
+wip: --tags @wip:30 --wip features<%= interp_opts %>
 rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip<%= interp_opts %>
 

data/features/cassettes/no_cassette.feature

@@ -6,6 +6,16 @@ Feature: Error for HTTP request made when no cassette is in use
   use.  The error is helpful to pinpoint where HTTP requests are
   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:
+
+    * VCR.turn_off! => turn VCR off so HTTP requests are allowed
+    * VCR.turn_on! => turn VCR back on
+    * VCR.turned_off { ... } => turn VCR off for the duration of the
+      provided block.
+
   Scenario Outline: Error for request when no cassette is in use
     Given a file named "no_cassette_error.rb" with:
       """
@@ -36,3 +46,60 @@ Feature: Error for HTTP request made when no cassette is in use
       | :webmock   | patron          | Real HTTP connections are disabled |
       | :webmock   | em-http-request | Real HTTP connections are disabled |
       | :typhoeus  | typhoeus        | Real HTTP requests are not allowed |
+
+  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'
+
+      start_sinatra_app(:port => 7777) do
+        get('/') { 'Hello' }
+      end
+
+      require 'vcr'
+
+      VCR.config do |c|
+        c.stub_with :fakeweb
+      end
+
+      def make_request(context)
+        puts context
+        puts Net::HTTP.get_response('localhost', '/', 7777).body
+      rescue => e
+        puts "Error: #{e.message}"
+      end
+
+      VCR.turned_off do
+        make_request "In VCR.turned_off block"
+      end
+
+      make_request "Outside of VCR.turned_off block"
+
+      VCR.turn_off!
+      make_request "After calling VCR.turn_off!"
+
+      VCR.turn_on!
+      make_request "After calling VCR.turn_on!"
+      """
+    When I run "ruby turn_off_vcr.rb"
+    Then the output should contain:
+      """
+      In VCR.turned_off block
+      Hello
+      """
+    And the output should contain:
+      """
+      Outside of VCR.turned_off block
+      Error: Real HTTP connections are disabled.
+      """
+    And the output should contain:
+      """
+      After calling VCR.turn_off!
+      Hello
+      """
+    And the output should contain:
+      """
+      After calling VCR.turn_on!
+      Error: Real HTTP connections are disabled.
+      """
+

data/features/configuration/allow_http_connections_when_no_cassette.feature

@@ -0,0 +1,54 @@
+Feature: allow_http_connections_when_no_cassette configuration option
+
+  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.
+
+  Background:
+    Given a file named "vcr_setup.rb" with:
+      """
+      require 'vcr_cucumber_helpers'
+
+      if ARGV.include?('--with-server')
+        start_sinatra_app(:port => 7777) do
+          get('/') { "Hello" }
+        end
+      end
+
+      require 'vcr'
+
+      VCR.config do |c|
+        c.allow_http_connections_when_no_cassette = true
+        c.stub_with :fakeweb
+        c.cassette_library_dir = 'cassettes'
+      end
+      """
+    And the directory "vcr/cassettes" does not exist
+
+  Scenario: Allow HTTP connections when no cassette
+    Given a file named "no_cassette.rb" with:
+      """
+      require 'vcr_setup.rb'
+
+      puts "Response: " + Net::HTTP.get_response('localhost', '/', 7777).body
+      """
+    When I run "ruby no_cassette.rb --with-server"
+    Then the output should contain "Response: Hello"
+
+  Scenario: Cassettes record and replay as normal
+    Given a file named "record_replay_cassette.rb" with:
+      """
+      require 'vcr_setup.rb'
+
+      VCR.use_cassette('localhost', :record => :new_episodes) do
+        puts "Response: " + Net::HTTP.get_response('localhost', '/', 7777).body
+      end
+      """
+    When I run "ruby record_replay_cassette.rb --with-server"
+    Then the output should contain "Response: Hello"
+    And the file "cassettes/localhost.yml" should contain "body: Hello"
+
+    When I run "ruby record_replay_cassette.rb"
+    Then the output should contain "Response: Hello"
+

data/features/configuration/ignore_localhost.feature

@@ -30,9 +30,9 @@ Feature: ignore_localhost configuration option
       require 'vcr'
 
       VCR.config do |c|
+        <additional_config>
         c.cassette_library_dir = 'cassettes'
         c.stub_with <stub_with>
-        <additional_config>
       end
 
       VCR.use_cassette('localhost', :record => :new_episodes) do
@@ -72,9 +72,9 @@ Feature: ignore_localhost configuration option
       require 'vcr'
 
       VCR.config do |c|
+        c.ignore_localhost = true
         c.cassette_library_dir = 'cassettes'
         c.stub_with <stub_with>
-        c.ignore_localhost = true
       end
 
       VCR.use_cassette('localhost', :record => :new_episodes) do

data/features/configuration/stub_with.feature

@@ -1,17 +1,21 @@
 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:
+  VCR will use.  There are currently 4 supported stubbing libraries which
+  support many different HTTP libraries:
 
     * FakeWeb can be used to stub Net::HTTP.
     * WebMock can be used to stub:
       * Net::HTTP
       * HTTPClient
       * Patron
-      * Curb
+      * Curb (Curb::Easy, but not Curb::Multi)
       * EM HTTP Request
-    * Typhoeus can be used to stub itself.
+    * Typhoeus can be used to stub itself (as long as you use Typhoeus::Hydra,
+      but not Typhoeus::Easy or Typhoeus::Multi).
+    * 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).
 
   There are some addiitonal trade offs to consider when deciding which
   stubbing library to use:
@@ -26,13 +30,14 @@ Feature: stub_with configuration option
       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.
+    * FakeWeb and WebMock cannot both be used at the same time.
+    * Typhoeus and 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.  If/when you decide to change stubbing libraries
-  (i.e. if you initially use FakeWeb because it's faster but later need the
+  stubbing facilities of Typhoeus 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
   option and it'll work with no other changes required.
 
@@ -109,7 +114,7 @@ Feature: stub_with configuration option
       | :typhoeus  | typhoeus        |
 
   @exclude-jruby
-  Scenario Outline: Use Typhoeus in combination with FakeWeb or WebMock
+  Scenario Outline: Use Typhoeus and Faraday in combination with FakeWeb or WebMock
     Given a file named "stub_with_multiple.rb" with:
       """
       require 'vcr_cucumber_helpers'
@@ -127,13 +132,24 @@ Feature: stub_with configuration option
         Typhoeus::Request.get("http://localhost:7777/typhoeus").body
       end
 
+      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.adapter :<faraday_adapter>
+        end.get('/faraday').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.stub_with <stub_with>, :typhoeus, :faraday
         c.cassette_library_dir = 'vcr_cassettes'
       end
 
@@ -141,6 +157,8 @@ Feature: stub_with configuration option
         puts "Net::HTTP 2: #{net_http_response}"
         puts "Typhoeus 2: #{typhoeus_response}"
       end
+
+      puts "Faraday: #{faraday_response}"
       """
     When I run "ruby stub_with_multiple.rb 'Hello'"
     Then the output should contain each of the following:
@@ -148,8 +166,11 @@ Feature: stub_with configuration option
       | 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"
+      | Faraday: Hello faraday      |
+    And the cassette "vcr_cassettes/example.yml" should have the following response bodies:
+      | Hello net_http |
+      | Hello typhoeus |
+      | Hello faraday  |
 
     When I run "ruby stub_with_multiple.rb 'Goodbye'"
     Then the output should contain each of the following:
@@ -157,8 +178,11 @@ Feature: stub_with configuration option
       | Typhoeus 1: Goodbye typhoeus  |
       | Net::HTTP 2: Hello net_http   |
       | Typhoeus 2: Hello typhoeus    |
+      | Faraday: Hello faraday        |
 
-  Examples:
-    | stub_with |
-    | :fakeweb  |
-    | :webmock  |
+    Examples:
+      | stub_with | faraday_adapter |
+      | :fakeweb  | net_http        |
+      | :webmock  | net_http        |
+      | :fakeweb  | typhoeus        |
+      | :webmock  | typhoeus        |