vcr 1.3.1 → 1.3.2

data/CHANGELOG.md

@@ -1,14 +1,26 @@
 # Changelog
 
+## 1.3.2 (November 16, 2010)
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.3.1...v1.3.2)
+
+* Fix serialized structs so that they are normalized andthey will be the same
+  regardless of which HTTP library made the request.
+  * Status "OK " => "OK"
+  * Body '' => nil
+  * Headers {} => nil
+  * Remove extraneous headers added by the HTTP lib (i.e. Typhoeus user agent)
+* Rewrite cucumber features in a more documentation-oriented style.
+
 ## 1.3.1 (November 11, 2010)
 
-[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.3.0...v.1.3.1)
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.3.0...v1.3.1)
 
 * Update WebMock adapter to work with (and require) newly released WebMock 1.6.0.
 
 ## 1.3.0 (November 11, 2010)
 
-[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.2.0...v.1.3.0)
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.2.0...v1.3.0)
 
 * Moved documentation from README to [Wiki](http://github.com/myronmarston/vcr/wiki).
 * Refactoring and code cleanup.

data/Gemfile

@@ -13,11 +13,14 @@ group :development do
   platforms :jruby do
     gem 'jruby-openssl'
   end
+
+  gem 'shoulda'
 end
 
 # Additional gems that are useful, but not required for development.
 group :extras do
   gem 'guard-rspec'
+  gem 'relish'
 
   platforms :mri do
     gem 'rcov'

data/Gemfile.lock

@@ -1,14 +1,17 @@
 PATH
   remote: .
   specs:
-    vcr (1.3.1)
+    vcr (1.3.2)
 
 GEM
   remote: http://rubygems.org/
   specs:
     addressable (2.2.2)
     archive-tar-minitar (0.5.2)
-    aruba (0.2.1)
+    aruba (0.2.4)
+      background_process
+      cucumber (~> 0.9.3)
+    background_process (1.2)
     bouncy-castle-java (1.5.0145.2)
     builder (2.1.2)
     columnize (0.3.1)
@@ -49,6 +52,7 @@ GEM
     linecache (0.43)
     linecache19 (0.5.11)
       ruby_core_source (>= 0.1.4)
+    mime-types (1.16)
     open_gem (1.4.2)
       launchy (~> 0.3.5)
     patron (0.4.9)
@@ -56,6 +60,12 @@ GEM
     rake (0.8.7)
     rb-fsevent (0.3.6)
     rcov (0.9.9)
+    relish (0.1.1)
+      archive-tar-minitar (~> 0.5.2)
+      json (~> 1.4.6)
+      rest-client (~> 1.6.1)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
     rspec (2.1.0)
       rspec-core (~> 2.1.0)
       rspec-expectations (~> 2.1.0)
@@ -79,8 +89,13 @@ GEM
       ruby-debug-base19 (>= 0.11.19)
     ruby_core_source (0.1.4)
       archive-tar-minitar (>= 0.5.2)
+    shoulda (2.9.2)
+    sinatra (1.1.0)
+      rack (~> 1.1)
+      tilt (~> 1.1)
     term-ansicolor (1.0.5)
     thor (0.14.4)
+    tilt (1.1)
     timecop (0.3.5)
     typhoeus (0.2.0)
     webmock (1.6.0)
@@ -106,10 +121,13 @@ DEPENDENCIES
   rake (~> 0.8.7)
   rb-fsevent
   rcov
+  relish
   rspec (~> 2.1.0)
   ruby-debug
   ruby-debug-base19 (= 0.11.23)
   ruby-debug19
+  shoulda
+  sinatra (~> 1.1.0)
   timecop (~> 0.3.5)
   typhoeus (~> 0.2.0)
   vcr!

data/README.md

@@ -53,7 +53,12 @@ maintenance) and accurate (the response from example.com will contain the same h
 
 ## Usage
 
-Visit the [wiki](http://github.com/myronmarston/vcr/wiki) for usage info and documentation.
+Browse the [cucumber features](http://relishapp.com/myronmarston/vcr) or visit
+the [wiki](http://github.com/myronmarston/vcr/wiki) for usage info and
+documentation.
+
+The [VCR talk given at Philly.rb](http://philly-rb-vcr-talk.heroku.com/) also
+contains good usage info.
 
 ## Development
 

data/Rakefile

@@ -4,9 +4,6 @@ Bundler::GemHelper.install_tasks
 
 require 'rake'
 require "rspec/core/rake_task"
-$LOAD_PATH.unshift 'spec'
-
-require 'support/ruby_interpreter'
 
 RSpec::Core::RakeTask.new(:spec) do |t|
   #t.rspec_opts = %w[--format documentation]
@@ -22,50 +19,15 @@ task :cleanup_rcov_files do
   rm_rf 'coverage.data'
 end
 
-permutations = {
-  'fakeweb'  => %w( net/http typhoeus ),
-  'typhoeus' => %w( typhoeus ),
-  'webmock'  => %w( net/http typhoeus httpclient patron em-http-request curb )
-}
-
-permutations.delete('typhoeus') if RUBY_INTERPRETER == :jruby
-
 require 'cucumber/rake/task'
-namespace :features do
-  permutations.each do |http_stubbing_adapter, http_libraries|
-    features_subtasks = []
-
-    namespace http_stubbing_adapter do
-      http_libraries.each do |http_lib|
-        next if RUBY_INTERPRETER != :mri && %w( patron em-http-request curb ).include?(http_lib)
-        next if RUBY_INTERPRETER == :jruby && http_lib == 'typhoeus'
+Cucumber::Rake::Task.new
 
-        sanitized_http_lib = http_lib.gsub('/', '_')
-        features_subtasks << "features:#{http_stubbing_adapter}:#{sanitized_http_lib}"
+task :default => [:spec, :cucumber]
 
-        task "#{sanitized_http_lib}_prep" do
-          ENV['HTTP_STUBBING_ADAPTER'] = http_stubbing_adapter
-          ENV['HTTP_LIB'] = http_lib
-        end
-
-        Cucumber::Rake::Task.new(
-          { sanitized_http_lib => "#{features_subtasks.last}_prep" },
-          "Run the features using #{http_stubbing_adapter} and #{http_lib}") do |t|
-            t.cucumber_opts = ['--format', 'progress', '--tags', "@#{http_stubbing_adapter},@all_http_libs,@#{sanitized_http_lib}"]
-
-            # disable scenarios on heroku that can't pass due to heroku's restrictions
-            t.cucumber_opts += ['--tags', '~@spawns_localhost_server'] if ENV.keys.include?('HEROKU_SLUG')
-        end
-      end
-    end
-
-    desc "Run the features using #{http_stubbing_adapter} and each of #{http_stubbing_adapter}'s supported http libraries"
-    task http_stubbing_adapter => features_subtasks
-  end
+desc "Push cukes to relishapp using the relish-client-gem"
+task :relish do
+  sh "relish push vcr"
 end
 
-desc "Run the features using each supported permutation of http stubbing library and http library."
-task :features => permutations.keys.map { |a| "features:#{a}" }
-
-task :default => [:spec, :features]
+task :release => :relish
 

data/benchmarks/http_stubbing_libraries.rb

@@ -50,10 +50,10 @@ end
 # Output on my machine:
 #
 # Benchmarking Single setup/teardown:
-# webmock  0.000000   0.000000   5.870000 (  6.211840)
-# fakeweb  0.000000   0.000000   1.840000 (  1.940935)
+# webmock  0.000000   0.000000   8.500000 (  8.559143)
+# fakeweb  0.000000   0.000000   1.900000 (  1.967160)
 # 
 # 
 # Benchmarking Setup/teardown for each http request:
-# webmock  0.000000   0.000000   7.710000 (  7.776178)
-# fakeweb  0.000000   0.000000   2.410000 (  2.420550)
+# webmock  0.000000   0.000000   9.710000 (  9.764760)
+# fakeweb  0.000000   0.000000   2.470000 (  2.479292)

data/cucumber.yml

@@ -0,0 +1,14 @@
+<%
+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'
+else
+  ''
+end
+%>
+default: <%= std_opts %><%= interp_opts %> features
+wip: --tags @wip:30 --wip features
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip<%= interp_opts %>
+

data/features/README.md

@@ -0,0 +1,21 @@
+## VCR
+
+The cucumber features provided here demonstrate all of the major features of
+VCR.  These features are executable documentation for VCR.
+
+Many of the examples use one (or both) of these helper functions
+provided by `vcr_cucumber_helpers.rb`:
+
+* `start_sinatra_app`: starts a sinatra application on the given port.
+  The server automatically shuts down when the ruby script ends.  Many
+  examples re-run the script without the sinatra server to demonstrate
+  the replaying of a recorded HTTP response.
+* `include_http_adapter_for`: includes a module that implements a common
+  HTTP interface for the given HTTP library.  The `response_body_for`
+  method will make an HTTP request using the given this library.  This
+  allows scenarios to be run against each different supported HTTP
+  library.
+
+If you have ideas to clarify or improve any of these cucumber features,
+please submit an [issue](https://github.com/myronmarston/vcr/issues) or
+pull request.

data/features/cassettes/automatic_re_recording.feature

@@ -0,0 +1,68 @@
+Feature: Automatic Re-recording
+
+  Over time, your cassettes may get out-of-date. APIs change and sites you
+  scrape get updated. VCR provides a facility to automatically re-record your
+  cassettes. Enable re-recording using the :re_record_interval option.
+
+  The value provided should be an interval (expressed in seconds) that
+  determines how often VCR will re-record the cassette.  When a cassette
+  is used, VCR checks the file modification time; if more time than the
+  interval has passed, VCR will use the :all record mode to cause it be
+  re-recorded.
+
+  Background:
+    Given a previously recorded cassette file "cassettes/example.yml" with:
+      """
+      --- 
+      - !ruby/struct:VCR::HTTPInteraction 
+        request: !ruby/struct:VCR::Request 
+          method: :get
+          uri: http://localhost:7777/
+          body: 
+          headers: 
+        response: !ruby/struct:VCR::Response 
+          status: !ruby/struct:VCR::ResponseStatus 
+            code: 200
+            message: OK
+          headers: 
+            content-length: 
+            - "12"
+          body: Old Response
+          http_version: "1.1"
+      """
+    And a file named "re_record.rb" with:
+      """
+      require 'vcr_cucumber_helpers'
+
+      start_sinatra_app(:port => 7777) do
+        get('/') { 'New Response' }
+      end
+
+      require 'vcr'
+
+      VCR.config do |c|
+        c.stub_with :fakeweb
+        c.cassette_library_dir = 'cassettes'
+      end
+
+      VCR.use_cassette('example', :record => :new_episodes, :re_record_interval => 7.days) do
+        puts Net::HTTP.get_response('localhost', '/', 7777).body
+      end
+      """
+
+  Scenario: Cassette is not re-recorded when not enough time has passed
+    Given 6 days have passed since the cassette was recorded
+    When I run "ruby re_record.rb"
+    Then the output should contain "Old Response"
+    But the output should not contain "New Response"
+    And the file "cassettes/example.yml" should contain "body: Old Response"
+    But the file "cassettes/example.yml" should not contain "body: New Response"
+
+  Scenario: Cassette is re-recorded when enough time has passed
+    Given 8 days have passed since the cassette was recorded
+    When I run "ruby re_record.rb"
+    Then the output should contain "New Response"
+    But the output should not contain "Old Response"
+    And the file "cassettes/example.yml" should contain "body: New Response"
+    But the file "cassettes/example.yml" should not contain "body: Old Response"
+

data/features/cassettes/dynamic_erb.feature

@@ -0,0 +1,90 @@
+Feature: Dynamic ERB cassettes
+
+  By default, cassettes are static: the exact response that was received
+  when the cassette was recorded will be replayed for all future requests.
+  Usually, this is fine, but in some cases you need something more dynamic.
+  You can use ERB for this.
+
+  To enable ERB evaluation of a cassette, pass the `:erb => true` option
+  to a cassette.  If you want to pass variables to the cassette, you can
+  pass the names and values of the variables in a hash (`:erb => { ... }`).
+
+  Scenario: Enable dynamic ERB cassette evalutation using :erb => true
+    Given a previously recorded cassette file "cassettes/dynamic.yml" with:
+      """
+      --- 
+      - !ruby/struct:VCR::HTTPInteraction 
+        request: !ruby/struct:VCR::Request 
+          method: :get
+          uri: http://example.com:80/foo?a=<%= 'b' * 3 %>
+          body: 
+          headers: 
+        response: !ruby/struct:VCR::Response 
+          status: !ruby/struct:VCR::ResponseStatus 
+            code: 200
+            message: OK
+          headers: 
+            content-type: 
+            - text/html;charset=utf-8
+            content-length: 
+            - "9"
+          body: Hello <%= 'bar'.next %>
+          http_version: "1.1"
+      """
+    And a file named "dynamic_erb_example.rb" with:
+      """
+      require 'vcr'
+
+      VCR.config do |c|
+        c.stub_with :fakeweb
+        c.cassette_library_dir = 'cassettes'
+        c.default_cassette_options = { :record => :none }
+      end
+
+      VCR.use_cassette('dynamic', :erb => true) do
+        response = Net::HTTP.get_response('example.com', '/foo?a=bbb')
+        puts "Response: #{response.body}"
+      end
+      """
+    When I run "ruby dynamic_erb_example.rb"
+    Then it should pass with "Response: Hello bas"
+
+  Scenario: Pass arguments to the ERB using :erb => { ... }
+    Given a previously recorded cassette file "cassettes/dynamic.yml" with:
+      """
+      --- 
+      - !ruby/struct:VCR::HTTPInteraction 
+        request: !ruby/struct:VCR::Request 
+          method: :get
+          uri: http://example.com:80/foo?a=<%= arg1 %>
+          body: 
+          headers: 
+        response: !ruby/struct:VCR::Response 
+          status: !ruby/struct:VCR::ResponseStatus 
+            code: 200
+            message: OK
+          headers: 
+            content-type: 
+            - text/html;charset=utf-8
+            content-length: 
+            - "9"
+          body: Hello <%= arg2 %>
+          http_version: "1.1"
+      """
+    And a file named "dynamic_erb_example.rb" with:
+      """
+      require 'vcr'
+
+      VCR.config do |c|
+        c.stub_with :fakeweb
+        c.cassette_library_dir = 'cassettes'
+        c.default_cassette_options = { :record => :none }
+      end
+
+      VCR.use_cassette('dynamic', :erb => { :arg1 => 7, :arg2 => 'baz' }) do
+        response = Net::HTTP.get_response('example.com', '/foo?a=7')
+        puts "Response: #{response.body}"
+      end
+      """
+    When I run "ruby dynamic_erb_example.rb"
+    Then it should pass with "Response: Hello baz"

data/features/cassettes/format.feature

@@ -0,0 +1,81 @@
+Feature: Cassette format
+
+  VCR Cassettes are YAML files that contain all of the information
+  about the requests and corresponding responses in a
+  human-readable/editable format.  A cassette contains an array
+  of HTTP interactions, each of which has the following:
+
+    * Request method, uri, body, headers
+    * Response status (code & message), headers, body, http version
+
+  Scenario Outline: Request/Response data is saved to disk as YAML
+    Given a file named "cassette_format.rb" with:
+      """
+      require 'vcr_cucumber_helpers'
+      include_http_adapter_for("<http_lib>")
+
+      start_sinatra_app(:port => 7777) do
+        get('/:path') { ARGV[0] + ' ' + params[:path] }
+      end
+
+      require 'vcr'
+
+      VCR.config do |c|
+        c.stub_with <stub_with>
+        c.cassette_library_dir = 'cassettes'
+      end
+
+      VCR.use_cassette('example', :record => :new_episodes) do
+        make_http_request(:get, "http://localhost:7777/foo")
+        make_http_request(:get, "http://localhost:7777/bar")
+      end
+      """
+    When I run "ruby cassette_format.rb 'Hello'"
+    Then the file "cassettes/example.yml" should contain YAML like:
+      """
+      --- 
+      - !ruby/struct:VCR::HTTPInteraction 
+        request: !ruby/struct:VCR::Request 
+          method: :get
+          uri: http://localhost:7777/foo
+          body: 
+          headers: 
+        response: !ruby/struct:VCR::Response 
+          status: !ruby/struct:VCR::ResponseStatus 
+            code: 200
+            message: OK
+          headers: 
+            content-type: 
+            - text/html;charset=utf-8
+            content-length: 
+            - "9"
+          body: Hello foo
+          http_version: "1.1"
+      - !ruby/struct:VCR::HTTPInteraction 
+        request: !ruby/struct:VCR::Request 
+          method: :get
+          uri: http://localhost:7777/bar
+          body: 
+          headers: 
+        response: !ruby/struct:VCR::Response 
+          status: !ruby/struct:VCR::ResponseStatus 
+            code: 200
+            message: OK
+          headers: 
+            content-type: 
+            - text/html;charset=utf-8
+            content-length: 
+            - "9"
+          body: Hello bar
+          http_version: "1.1"
+      """
+
+    Examples:
+      | stub_with  | http_lib        |
+      | :fakeweb   | net/http        |
+      | :webmock   | net/http        |
+      | :webmock   | httpclient      |
+      | :webmock   | patron          |
+      | :webmock   | curb            |
+      | :webmock   | em-http-request |
+      | :typhoeus  | typhoeus        |