vcr 2.0.0.beta1 → 2.0.0.beta2

data/.gitignore

@@ -31,5 +31,6 @@ Gemfile.lock
 features/README.md
 features/CHANGELOG.md
 features/LICENSE.md
+features/Upgrade.md
 
 .rvmrc

data/.travis.yml

@@ -7,8 +7,11 @@ rvm:
   - 1.9.3
   - ree
   - jruby
+  - rbx
+  - rbx-2.0
 branches:
   only:
     - master
     - 1-x-stable
+    - travis-testing
 

data/CHANGELOG.md

@@ -1,12 +1,47 @@
 ## In git
 
-[Full Changelog](http://github.com/myronmarston/vcr/compare/v2.0.0.beta1...master)
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v2.0.0.beta2...master)
+
+## 2.0.0 Beta 2 (November 6, 2011)
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v2.0.0.beta1...v2.0.0.beta2)
+
+* Update to (and require) Typhoeus 0.3.2.
+* Fix a bug with `VCR.request_matchers.uri_without_param(:some_param)`
+  so that it properly handles URIs that have no parameters. Thanks to
+  [Sathya Sekaran](https://github.com/sfsekaran) for this fix.
+* The cassette format has changed significantly:
+  * The HTTPInteractions are no longer normalized in a lossy fashion.
+    VCR 1.x converted all HTTP header keys to lowercase.  VCR 2.0 no
+    longer does this because it is impossible to know what the original
+    casing was (i.e. given `etag`, was it originally `etag`, `ETag` or
+    `Etag`?). Also, some HTTP libraries add particular request headers
+    to every request, and these used to be ignored. The aren't anymore.
+  * The ruby struct objects are not directly serialized anymore.
+    Instead, only primitives (hashes, arrays, strings, integers) are
+    serialized. This allows swappable serializers and will allow other
+    tools to read and use a VCR cassette.
+  * Add new serializer API.  VCR ships with YAML, Syck, Psych and JSON
+    serializers, and it is very simple to implement your own. The
+    serializer can be configured on a per-cassette basis.
+  * New `vcr:migrate_cassettes DIR=path/to/cassettes` rake task assists
+    with upgrading from VCR 1.x to 2.0.
+  * Cassettes now contain a `recorded_with` attribute. This should
+    allow the cassette structure to be updated more easily in the future
+    as the version number provides a means for easily migrating
+    cassettes.
+  * Add `recorded_at` to data serialized with an HTTPInteraction.  This
+    allows the `:re_record_interval` cassette option to work more
+    accurately and no longer rely on the file modification time.
+
+Note that VCR 1.x cassettes cannot be used with VCR 2.0.  See the
+upgrade notes for more info.
 
 ## 2.0.0 Beta 1 (October 8, 2011)
 
 [Full Changelog](http://github.com/myronmarston/vcr/compare/v1.11.3...v2.0.0.beta1)
 
-### Changes
+### Changed
 
 * Previously, the last matching response in a cassette would
   repeatedly playback if the same request kept being made. This is

data/Gemfile

@@ -6,8 +6,8 @@ group :development do
   platforms :ruby do
     gem 'patron',           '~> 0.4.15'
     gem 'em-http-request',  '~> 0.3.0'
-    gem 'curb',             '~> 0.7.15'
-    gem 'typhoeus',         '~> 0.2.1'
+    gem 'curb',             '0.7.15'
+    gem 'typhoeus',         '~> 0.3.2'
   end
 
   platforms :jruby do

data/README.md

@@ -135,6 +135,7 @@ If you find VCR useful, please recommend me on [working with rails](http://worki
 Thanks also to the following people who have contributed patches or helpful suggestions:
 
 * [Aaron Brethorst](http://github.com/aaronbrethorst)
+* [Avdi Grimm](https://github.com/avdi)
 * [Bartosz Blimke](http://github.com/bblimke)
 * [Ben Hutton](http://github.com/benhutton)
 * [Bradley Isotope](https://github.com/bradleyisotope)
@@ -143,8 +144,16 @@ Thanks also to the following people who have contributed patches or helpful sugg
 * [Karl Baum](https://github.com/kbaum)
 * [Nathaniel Bibler](https://github.com/nbibler)
 * [Oliver Searle-Barnes](https://github.com/opsb)
+* [Sathya Sekaran](https://github.com/sfsekaran)
 * [Wesley Beary](https://github.com/geemus)
-* [Avdi Grimm](https://github.com/avdi)
+
+## Similar Libraries
+
+* [Betamax](https://github.com/robfletcher/betamax) (Groovy)
+* [Ephemeral Response](https://github.com/sandro/ephemeral_response) (Ruby)
+* [Mimic](https://github.com/acoulton/mimic) (PHP/Kohana)
+* [NetRecorder](https://github.com/chrisyoung/netrecorder) (Ruby)
+* [Stale Fish](https://github.com/jsmestad/stale_fish) (Ruby)
 
 ## Copyright
 

data/Rakefile

@@ -15,10 +15,6 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   # we require spec_helper so we don't get an RSpec warning about
   # examples being defined before configuration.
   t.ruby_opts = "-w -I./spec -r./spec/capture_warnings -rspec_helper"
-
-  # I'm not sure why, but bundler seems to silence warnings...
-  t.skip_bundler = true
-
   t.rspec_opts = %w[--format progress] if (ENV['FULL_BUILD'] || !using_git)
 end
 
@@ -51,8 +47,6 @@ namespace :ci do
     # we require spec_helper so we don't get an RSpec warning about
     # examples being defined before configuration.
     t.ruby_opts = "-w -I./spec -r./spec/capture_warnings -rspec_helper"
-    # I'm not sure why, but bundler seems to silence warnings...
-    t.skip_bundler = true
     t.rspec_opts = %w[--format progress --backtrace]
   end
 
@@ -78,7 +72,7 @@ end
 
 desc "Push cukes to relishapp using the relish-client-gem"
 task :relish do
-  %w[ README.md CHANGELOG.md LICENSE ].each do |file|
+  %w[ README.md CHANGELOG.md Upgrade.md LICENSE ].each do |file|
     ensure_relish_doc_symlinked(file)
   end
 
@@ -100,3 +94,45 @@ task :release => [:require_ruby_18, :prep_relish_release, :relish]
 # For gem-test: http://gem-testers.org/
 task :test => :spec
 
+load './lib/vcr/tasks/vcr.rake'
+namespace :vcr do
+  task :reset_spec_cassettes do
+    ENV['DIR'] = 'spec/fixtures'
+    def VCR.version; "2.0.0"; end
+    sh "git checkout v2.0.0.beta1 -- spec/fixtures"
+  end
+
+  task :migrate_cassettes => :reset_spec_cassettes
+end
+
+desc "Migrate cucumber cassettes"
+task :migrate_cucumber_cassettes do
+  sh "git checkout cb3559d6ffcb36cb823ae96a677e380e5b86ed80 -- features"
+  require 'vcr/cassette/migrator'
+  Dir["features/**/*.feature"].each do |feature_file|
+    puts " - Migrating #{feature_file}"
+    contents = File.read(feature_file)
+
+    # http://rubular.com/r/gjzkoaYX2O
+    contents.scan(/:\n^\s+"""\n([\s\S]+?)"""/).each do |captures|
+      capture = captures.first
+      indentation = capture[/^ +/]
+      cassette_yml = capture.gsub(/^#{indentation}/, '')
+      new_yml = nil
+
+      Dir.mktmpdir do |dir|
+        file_name = "#{dir}/cassette.yml"
+        File.open(file_name, 'w') { |f| f.write(cassette_yml) }
+        VCR::Cassette::Migrator.new(dir, StringIO.new).migrate!
+        new_yml = File.read(file_name)
+      end
+
+      new_yml.gsub!(/^/, indentation)
+      new_yml << indentation
+      contents.gsub!(capture, new_yml)
+    end
+
+    File.open(feature_file, 'w') { |f| f.write(contents) }
+  end
+end
+

data/Upgrade.md

@@ -0,0 +1,45 @@
+See the [Changelog](changelog) for a complete list of changes from VCR
+1.x to 2.0. This file simply lists the most pertinent ones to upgrading.
+
+## Configuration Changes
+
+In VCR 1.x, your configuration block would be something like this:
+
+``` ruby
+VCR.config do |c|
+  c.cassette_library_dir = 'cassettes'
+  c.stub_with :fakeweb, :typhoeus
+end
+```
+
+This will continue to work in VCR 2.0 but will generate deprecation
+warnings. Instead, you should change this to:
+
+``` ruby
+VCR.configure do |c|
+  c.cassette_library_dir = 'cassettes'
+  c.hook_into :fakeweb, :typhoeus
+end
+```
+
+## New Cassette Format
+
+The cassette format has changed between VCR 1.x and VCR 2.0.
+VCR 1.x cassettes cannot be used with VCR 2.0.
+
+The easiest way to upgrade is to simply delete your cassettes and
+re-record all of them. VCR also provides a rake task that attempts
+to upgrade your 1.x cassettes to the new 2.0 format. To use it, add
+the following line to your Rakefile:
+
+``` ruby
+load 'vcr/tasks/vcr.rake'
+```
+
+Then run `rake vcr:migrate_cassettes DIR=path/to/your/cassettes/directory` to
+upgrade your cassettes. Note that this rake task may be unable to
+upgrade some cassettes that make extensive use of ERB. In addition, now
+that VCR 2.0 does less normalization then before, it may not be able to
+migrate the cassette perfectly. It's recommended that you delete and
+re-record your cassettes if you are able.
+

data/features/.nav

@@ -1,4 +1,5 @@
 - getting_started.md (Getting Started)
+- Upgrade.md (Upgrade)
 - CHANGELOG.md (Changelog)
 - about_these_examples.md (About These Examples)
 - LICENSE.md (License)

data/features/cassettes/automatic_re_recording.feature

@@ -6,29 +6,31 @@ Feature: Automatic Re-recording
 
   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.
+  is used, VCR checks the earliest `recorded_at` timestamp in the cassette;
+  if more time than the interval has passed since that timestamp,
+  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
+      ---
+      http_interactions:
+      - request:
+          method: get
           uri: http://localhost:7777/
-          body: 
-          headers: 
-        response: !ruby/struct:VCR::Response 
-          status: !ruby/struct:VCR::ResponseStatus 
+          body: ''
+          headers: {}
+        response:
+          status:
             code: 200
             message: OK
-          headers: 
-            content-length: 
-            - "12"
+          headers:
+            Content-Length:
+            - '12'
           body: Old Response
-          http_version: "1.1"
+          http_version: '1.1'
+        recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
+      recorded_with: VCR 2.0.0
       """
     And a file named "re_record.rb" with:
       """ruby
@@ -49,7 +51,7 @@ Feature: Automatic Re-recording
       """
 
   Scenario: Cassette is not re-recorded when not enough time has passed
-    Given 6 days have passed since the cassette was recorded
+    Given it is Tue, 07 Nov 2011
     When I run `ruby re_record.rb`
     Then the output should contain "Old Response"
     But the output should not contain "New Response"
@@ -57,7 +59,7 @@ Feature: Automatic Re-recording
     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
+    Given it is Tue, 09 Nov 2011
     When I run `ruby re_record.rb`
     Then the output should contain "New Response"
     But the output should not contain "Old Response"

data/features/cassettes/dynamic_erb.feature

@@ -12,24 +12,26 @@ Feature: Dynamic ERB cassettes
   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 
+      ---
+      http_interactions:
+      - request:
+          method: get
+          uri: http://example.com/foo?a=<%= 'b' * 3 %>
+          body: ''
+          headers: {}
+        response:
+          status:
             code: 200
             message: OK
-          headers: 
-            content-type: 
+          headers:
+            Content-Type:
             - text/html;charset=utf-8
-            content-length: 
-            - "9"
+            Content-Length:
+            - '9'
           body: Hello <%= 'bar'.next %>
-          http_version: "1.1"
+          http_version: '1.1'
+        recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
+      recorded_with: VCR 2.0.0
       """
     And a file named "dynamic_erb_example.rb" with:
       """ruby
@@ -51,24 +53,26 @@ Feature: Dynamic ERB cassettes
   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 
+      ---
+      http_interactions:
+      - request:
+          method: get
+          uri: http://example.com/foo?a=<%= arg1 %>
+          body: ''
+          headers: {}
+        response:
+          status:
             code: 200
             message: OK
-          headers: 
-            content-type: 
+          headers:
+            Content-Type:
             - text/html;charset=utf-8
-            content-length: 
-            - "9"
+            Content-Length:
+            - '9'
           body: Hello <%= arg2 %>
-          http_version: "1.1"
+          http_version: '1.1'
+        recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
+      recorded_with: VCR 2.0.0
       """
     And a file named "dynamic_erb_example.rb" with:
       """ruby

data/features/cassettes/exclusive.feature

@@ -17,41 +17,45 @@ Feature: exclusive cassette
   Background:
     Given a previously recorded cassette file "cassettes/outer.yml" with:
       """
-      --- 
-      - !ruby/struct:VCR::HTTPInteraction 
-        request: !ruby/struct:VCR::Request 
-          method: :get
+      ---
+      http_interactions:
+      - request:
+          method: get
           uri: http://localhost:7777/outer
-          body: 
-          headers: 
-        response: !ruby/struct:VCR::Response 
-          status: !ruby/struct:VCR::ResponseStatus 
+          body: ''
+          headers: {}
+        response:
+          status:
             code: 200
             message: OK
-          headers: 
-            content-length: 
-            - "18"
+          headers:
+            Content-Length:
+            - '18'
           body: Old outer response
-          http_version: "1.1"
+          http_version: '1.1'
+        recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
+      recorded_with: VCR 2.0.0
       """
     And a previously recorded cassette file "cassettes/inner.yml" with:
       """
-      --- 
-      - !ruby/struct:VCR::HTTPInteraction 
-        request: !ruby/struct:VCR::Request 
-          method: :get
+      ---
+      http_interactions:
+      - request:
+          method: get
           uri: http://localhost:7777/inner
-          body: 
-          headers: 
-        response: !ruby/struct:VCR::Response 
-          status: !ruby/struct:VCR::ResponseStatus 
+          body: ''
+          headers: {}
+        response:
+          status:
             code: 200
             message: OK
-          headers: 
-            content-length: 
-            - "18"
+          headers:
+            Content-Length:
+            - '18'
           body: Old inner response
-          http_version: "1.1"
+          http_version: '1.1'
+        recorded_at: Tue, 01 Nov 2011 04:58:44 GMT
+      recorded_with: VCR 2.0.0
       """
     And a file named "setup.rb" with:
       """ruby