vcr 1.1.2 → 1.2.0

data/.gitignore

@@ -24,4 +24,4 @@ pkg
 features/fixtures/vcr_cassettes/**/temp/
 *.rbc
 .bundle
-
+tmp

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/rspec-1"]
+	path = vendor/rspec-1
+	url = git://github.com/myronmarston/rspec-1.git

data/CHANGELOG.md

@@ -1,7 +1,28 @@
-#Changelog
+# Changelog
+
+## 1.2.0 (October 13, 2010)
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.1.2...v1.2.0)
+
+* Improved the `:all` record mode so that it keeps previously recorded interactions that do not match the
+  new recorded interactions.  Previously, all of the previously recorded interactions were deleted.
+* Added `:re_record_interval` cassette option.  This option causes a cassette to be re-recorded when the
+  existing file is older than the specified interval.
+* Improved RSpec support.  Added #use_vcr_cassette RSpec macro method that sets up a cassette for an RSpec
+  example group.
+* Fixed VCR/Net::HTTP/WebMock integration so that VCR no longer loads its Net::HTTP monkey patch when
+  WebMock is used, and relies upon WebMock's after_request callback to record Net::HTTP instead.  This
+  fixes [a bug](http://github.com/myronmarston/vcr/issues/14) when using WebMock and Open URI.
+* Consider 0.0.0.0 to be a localhost alias (previously only "localhost" and 127.0.0.1 were considered).
+* Added spec and feature coverage for Curb integration.  Works out of the box with no changes required
+  to VCR due to [Pete Higgins'](http://github.com/phiggins) great work to add Curb support to WebMock.
+* Got specs and features to pass on rubinius.
+* Changed WebMock version requirement to 1.4.0.
 
 ## 1.1.2 (September 9, 2010)
 
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.1.1...v1.1.2)
+
 * Fixed a minor bug with the WebMock integration: WebMock extends each `Net::HTTPResponse` with an extension
   module after reading the body, and VCR was doing the same thing, leading to some slight deviance from
   standard Net::HTTP behavior.  The fix prevents VCR from adding the same extension to a `Net::HTTPResponse`
@@ -14,6 +35,8 @@
 
 ## 1.1.1 (August 26, 2010)
 
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.1.0...v1.1.1)
+
 * Updated to use and require FakeWeb 1.3.0. It includes a fix for a bug related to multiple values for the
   same response header.
 * Use new `FakeWeb::Utility.request_uri_as_string` method rather than our own logic to construct a request uri.
@@ -27,6 +50,8 @@
 
 ## 1.1.0 (August 22, 2010)
 
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.0.3...v1.1.0)
+
 * Added `:match_requests_on` cassette option, which determines how VCR matches requests.
 * Removed VCR::TaskRunner and the corresponding rake task definition.  The rake task migrated cassettes from the
   0.3.1 format to the 0.4+ format.  If you are still on 0.3.1 or earlier, I recommend you upgrade to 0.4.1 first,
@@ -40,6 +65,8 @@
 
 ## 1.0.3 (August 5, 2010)
 
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.0.2...v1.0.3)
+
 * Upgraded VCR specs to RSpec 2.
 * Updated `VCR::CucumberTags` so that it uses an `around` hook rather than a `before` hook and an `after` hook.
   Around hooks were added to Cucumber in the 0.7.3 release, so you'll have to be on that version or higher to use
@@ -50,6 +77,8 @@
 
 ## 1.0.2 (July 6, 2010)
 
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.0.1...v1.0.2)
+
 * Fixed VCR to work with [rest-client](http://github.com/archiloque/rest-client).  Rest-client extends the Net::HTTP
   response body string with a module containing additional data, which got serialized to the cassette file YAML
   and occasionally caused problems when the YAML was deserialized.  Bug reported by
@@ -58,6 +87,8 @@
 
 ## 1.0.1 (July 1, 2010)
 
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.0.0...v1.0.1)
+
 * Fixed specs and features so they pass on MRI 1.9.2-preview3 and JRuby 1.5.1.
 * Normalized response and request headers so that they are stored the same (i.e. lower case keys, arrays of values)
   in the cassette yaml files, regardless of which HTTP library is used.  This is the same way Net::HTTP normalizes
@@ -68,6 +99,8 @@
 
 ## 1.0.0 (June 22, 2010)
 
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v0.4.1...v1.0.0)
+
 * New Features
   * Added support for [HTTPClient](http://github.com/nahi/httpclient), [Patron](http://github.com/toland/patron) and
     [em-http-request](http://github.com/igrigorik/em-http-request) when WebMock is used.  Any future http libraries
@@ -101,11 +134,17 @@
   * Removed some extensions that are no longer necessary.
 
 ## 0.4.1 May 11, 2010
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v0.4.0...v0.4.1)
+
 * Fixed a bug: when `Net::HTTPResponse#read_body` was called after VCR had read the body to record a new request,
   it raised an error (`IOError: Net::HTTPResponse#read_body called twice`).  My fix extends Net::HTTPResponse
   so that it no longer raises this error.
 
 ## 0.4.0 April 28, 2010
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v0.3.1...v0.4.0)
+
 * Added support for webmock.  All the fakeweb-specific code is now in an adapter (as is the webmock code).
 
 * Changed the format of the VCR cassettes.  The old format was tied directly to Net::HTTP, but webmock supports
@@ -131,9 +170,15 @@
 * Lots of other refactoring.
 
 ## 0.3.1 April 10, 2010
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v0.3.0...v0.3.1)
+
 * Fixed a bug: when `Net::HTTP#request` was called with a block that had a return statement, the response was not being recorded.
 
 ## 0.3.0 March 24, 2010
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v0.2.0...v0.3.0)
+
 * Renamed a bunch of methods, replacing them with method names that more clearly fit the VCR/cassette metaphor:
   * `VCR.create_cassette!` => `VCR.insert_cassette`
   * `VCR.destroy_cassette!` => `VCR.eject_cassette`
@@ -146,12 +191,18 @@
 * All the old methods still work, but you'll get deprecation warnings.
 
 ## 0.2.0 March 9, 2010
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v0.1.2...v0.2.0)
+
 * Added `:allow_real_http` cassette option, which allows VCR to work with capybara and a javascript driver.
   Bug reported by [Ben Hutton](http://github.com/benhutton).
 
 * Deprecated the `default_cassette_record_mode` option.  Use `default_cassette_options[:record_mode]` instead.
 
 ## 0.1.2 March 4, 2010
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v0.1.1...v0.1.2)
+
 * Added explanatory note about VCR to `FakeWeb::NetConnectNotAllowedError#message`.
 
 * Got things to work for when a cassette records multiple requests made to the same URL with the same HTTP verb,
@@ -161,7 +212,13 @@
   Internally, `Net::HTTP#request` recursively calls itself (passing slightly different arguments) in certain circumstances.
 
 ## 0.1.1 February 25, 2010
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v0.1.0...v0.1.1)
+
 * Handle asynchronous HTTP requests (such as for mechanize).  Bug reported by [Thibaud Guillaume-Gentil](http://github.com/thibaudgg).
 
 ## 0.1.0 February 25, 2010
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/d2577f79247d7db60bf160881b1b64e9fa10e4fd...v0.1.0)
+
 * Initial release.  Basic recording and replaying of responses works.

data/Gemfile

@@ -2,19 +2,17 @@ source :rubygems
 gemspec
 
 group :development do
-  # Our specs rely on something in rspec-core master that hasn't been released yet.
-  gem 'rspec-core', :git => 'git://github.com/rspec/rspec-core.git'
-
   # patron and em-http-request can't install on JRuby, so we have to limit their platform here.
   platforms :ruby do
     gem 'patron',           '~> 0.4.6'
     gem 'em-http-request',  '~> 0.2.7'
+    gem 'curb',             '~> 0.7.8'
   end
 end
 
 # Additional gems that are useful, but not required for development.
 group :extras do
-  platforms :mri, :jruby do
+  platforms :mri do
     gem 'rcov'
   end
 

data/Gemfile.lock

@@ -1,27 +1,15 @@
-GIT
-  remote: git://github.com/rspec/rspec-core.git
-  revision: 6258abe
-  specs:
-    rspec-core (2.0.0.beta.20)
-
 PATH
   remote: .
   specs:
-    vcr (1.1.2)
+    vcr (1.2.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.2.0)
+    addressable (2.2.2)
     archive-tar-minitar (0.5.2)
+    aruba (0.2.1)
     builder (2.1.2)
-    capybara (0.3.9)
-      culerity (>= 0.2.4)
-      mime-types (>= 1.16)
-      nokogiri (>= 1.3.3)
-      rack (>= 1.0.0)
-      rack-test (>= 0.5.4)
-      selenium-webdriver (>= 0.0.3)
     columnize (0.3.1)
     crack (0.1.8)
     cucumber (0.8.5)
@@ -30,16 +18,13 @@ GEM
       gherkin (~> 2.1.4)
       json_pure (~> 1.4.3)
       term-ansicolor (~> 1.0.4)
-    culerity (0.2.12)
+    curb (0.7.8)
     diff-lcs (1.1.2)
-    em-http-request (0.2.11)
+    em-http-request (0.2.12)
       addressable (>= 2.0.0)
       eventmachine (>= 0.12.9)
     eventmachine (0.12.10)
     fakeweb (1.3.0)
-    ffi (0.6.3)
-      rake (>= 0.8.7)
-    ffi (0.6.3-java)
     gherkin (2.1.5)
       trollop (~> 1.16.2)
     gherkin (2.1.5-java)
@@ -49,24 +34,20 @@ GEM
     linecache (0.43)
     linecache19 (0.5.11)
       ruby_core_source (>= 0.1.4)
-    mime-types (1.16)
-    nokogiri (1.4.3.1)
-    nokogiri (1.4.3.1-java)
-      weakling (>= 0.0.3)
-    patron (0.4.6)
-    rack (1.2.0)
-    rack-test (0.5.4)
-      rack (>= 1.0)
+    patron (0.4.9)
+    rack (1.1.0)
     rake (0.8.7)
-    rcov (0.9.8)
-    rcov (0.9.8-java)
-    rspec (2.0.0.beta.20)
-      rspec-core (= 2.0.0.beta.20)
-      rspec-expectations (= 2.0.0.beta.20)
-      rspec-mocks (= 2.0.0.beta.20)
-    rspec-expectations (2.0.0.beta.20)
+    rcov (0.9.9)
+    rspec (2.0.0)
+      rspec-core (= 2.0.0)
+      rspec-expectations (= 2.0.0)
+      rspec-mocks (= 2.0.0)
+    rspec-core (2.0.0)
+    rspec-expectations (2.0.0)
       diff-lcs (>= 1.1.2)
-    rspec-mocks (2.0.0.beta.20)
+    rspec-mocks (2.0.0)
+      rspec-core (= 2.0.0)
+      rspec-expectations (= 2.0.0)
     ruby-debug (0.10.3)
       columnize (>= 0.1)
       ruby-debug-base (~> 0.10.3.0)
@@ -82,16 +63,11 @@ GEM
       ruby-debug-base19 (>= 0.11.19)
     ruby_core_source (0.1.4)
       archive-tar-minitar (>= 0.5.2)
-    rubyzip (0.9.4)
-    selenium-webdriver (0.0.28)
-      ffi (>= 0.6.1)
-      json_pure
-      rubyzip
     term-ansicolor (1.0.5)
+    timecop (0.3.5)
     trollop (1.16.2)
-    weakling (0.0.4-java)
-    webmock (1.3.5)
-      addressable (>= 2.1.1)
+    webmock (1.4.0)
+      addressable (>= 2.2.2)
       crack (>= 0.1.7)
 
 PLATFORMS
@@ -99,20 +75,21 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  aruba (~> 0.2.1)
   bundler (~> 1.0.0)
-  capybara (~> 0.3.9)
   cucumber (~> 0.8.5)
+  curb (~> 0.7.8)
   em-http-request (~> 0.2.7)
   fakeweb (~> 1.3.0)
   httpclient (~> 2.1.5.2)
   patron (~> 0.4.6)
-  rack (= 1.2.0)
+  rack (= 1.1.0)
   rake (~> 0.8.7)
   rcov
-  rspec (~> 2.0.0.beta.20)
-  rspec-core!
+  rspec (~> 2.0.0)
   ruby-debug
   ruby-debug-base19 (= 0.11.23)
   ruby-debug19
+  timecop (~> 0.3.5)
   vcr!
-  webmock (~> 1.3.5)
+  webmock (~> 1.4.0)

data/README.md

@@ -43,19 +43,24 @@ maintenance) and accurate (the response from example.com will contain the same h
 * 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 libraries: [Net::HTTP](http://www.ruby-doc.org/stdlib/libdoc/net/http/rdoc/index.html)
-  (all HTTP stubbing libraries), [Patron](http://github.com/toland/patron) (WebMock only),
-  [HTTPClient](http://github.com/nahi/httpclient) (WebMock only) and
-  [em-http-request](http://github.com/igrigorik/em-http-request) (WebMock only).
+* Supports multiple HTTP libraries:
+  * [Patron](http://github.com/toland/patron) (WebMock)
+  * [Curb](http://github.com/taf2/curb) (WebMock)
+  * [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)
+  * 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.
 * The same request can receive different responses in different tests--just use different cassettes.
 * The recorded requests and responses are stored on disk as YAML and can easily be inspected and edited.
 * Dynamic responses are supported using ERB.
+* Automatically re-records cassettes on a configurable regular interval to keep them fresh and current.
 * Disables all HTTP requests that you don't explicitly allow.
 * Simple cucumber integration is provided using tags.
-* Known to work well with many popular ruby libraries including RSpec, Cucumber, Test::Unit, Capybara, Mechanize and
-  Rest-Client.
-* Extensively tested on 6 different ruby interpretters.
+* Known to work well with many popular ruby libraries including RSpec 1 & 2, Cucumber, Test::Unit,
+  Capybara, Mechanize and Rest-Client.
+* Extensively tested on 7 different ruby interpretters.
 
 ## Development
 
@@ -74,11 +79,15 @@ a cassette that contains previously recorded HTTP interactions, it registers the
 library of your choice (fakeweb or webmock) so that HTTP requests get the recorded response.  Between test
 runs, cassettes are stored on disk as YAML files in your configured cassette library directory.
 
-Each cassette can be configured with a couple options:
+Each cassette acts a bit like a sandbox: it has an effect on HTTP requests during the current test while it
+is inserted, but has no effect on the rest of your test suite.
+
+Cassettes can be configured with a few options:
 
 * `:record`: Specifies a record mode for this cassette.
 * `:erb`: Used for dynamic cassettes (see below for more details).
 * `:match_requests_on`: An array of request attributes to match on (see below for more details).
+* `:re_record_interval`: Controls automatic re-recording of the cassette (see below for more details).
 
 ## Record modes
 
@@ -86,8 +95,18 @@ VCR supports 3 record modes.  You can set a default record mode in your configur
 and a per-cassette record mode when inserting a cassette.  The record modes are:
 
 * `:new_episodes`: Previously recorded HTTP interactions will be replayed.  New HTTP interactions will be recorded.
+  This is generally the most useful mode.  VCR will automatically record and replay new HTTP requests as your
+  codebase evolves to make new requests.
 * `:all`: Previously recorded HTTP interactions will be ignored.  All HTTP interactions will be recorded.
+  This is useful if you're interested in using VCR to log your HTTP interactions but don't care to ever replay
+  them.  Alternately, you can temporarily change your record mode to `:all` to force it to re-record all requests.
 * `:none`: Previously recorded HTTP interactions will be replayed.  New HTTP interactions will result in an error.
+  This mode is useful when your code makes potentially dangerous HTTP requests (i.e. it hits a production
+  server rather than a sandbox/staging server), as it will prevent any new requests from completing, raising
+  an error instead.  Generally, you will temporarily use the `:new_episodes` or `:all` record modes
+  to perform the initial recording before changing it to `:none`.
+
+When no cassette is inserted, all HTTP requests will result in a `Real HTTP connections are disabled` error.
 
 ## Request Matching
 
@@ -139,9 +158,7 @@ configuration options:
   `RAILS_ROOT/test/fixtures`.  Rails will assume your cassette YAML files are ActiveRecord fixtures and raise an
   error when the content doesn't conform to its expectations.
 * `http_stubbing_library`: Which http stubbing library to use.  Currently `:fakeweb` and `:webmock` are supported.
-  This is currently optional--VCR will try to guess based on the presence or absence of the `FakeWeb` or `WebMock`
-  constants, but this is mostly done to assist users upgrading from VCR 0.3.1, which only worked with fakeweb and
-  didn't have this option.  I recommend you explicitly configure this.
+  VCR will automatically configure FakeWeb/WebMock for you; you do not need to reference either one at all.
 * `ignore_localhost`: Defaults to false.  Setting it true does the following:
     * Localhost requests will proceed as normal.  The "Real HTTP connections are disabled" error will not occur.
     * Localhost requests will not be recorded.
@@ -157,32 +174,66 @@ VCR can easily be used with any ruby test or spec framework.  Usually, you'll wa
       # do something that makes an HTTP request
     end
 
-Alternately, you can insert and eject a cassette with individual method calls from setup/before and teardown/after:
+Alternately, with a framework like [shoulda](http://github.com/thoughtbot/shoulda), you can insert and eject a
+cassette with individual method calls from setup and teardown:
 
-    describe "Some object that makes an HTTP request" do
-      before(:each) do
+    context "Some object that makes an HTTP request" do
+      setup do
         VCR.insert_cassette('geocoding/Seattle, WA', :record => :new_episodes)
       end
 
-      it "does something that makes an HTTP request"
+      should "make an HTTP request" do
+        # ...
+      end
 
-      it "does something else that makes an HTTP request"
+      should "make another HTTP request" do
+        # ...
+      end
 
-      after(:each) do
+      teardown do
         VCR.eject_cassette
       end
     end
 
-If you're using RSpec 2, you can use the new `around` hook:
+## Usage with RSpec
+
+If you're using RSpec, you can use a special macro provided by VCR:
+
+    describe MyApiClient do
+      context "create" do
+        # Pass use_vcr_cassette the same args you would pass VCR.use_cassette.
+        use_vcr_cassette "my_api_client/create", :record => :new_episodes
 
-    describe "Some object that makes an HTTP request" do
-      around(:each) do |example|
-        VCR.use_cassette('geocoding/Seattle, WA', :record => :new_episodes, &example)
+        it "makes an HTTP request"
+        it "makes another HTTP request"
       end
 
-      it "does something that makes an HTTP request"
+      context "destroy" do
+        # You can leave off the cassette name and it will be inferred from the example group
+        # descriptions--in this case "MyApiClient/destroy".
+        # You can also leave off the options hash--the configured default options will be used.
+        use_vcr_cassette :record => :new_episodes, :match_requests_on => [:uri, :method, :body]
+
+        it "makes an HTTP request"
+        it "makes another HTTP request"
+      end
+    end
+
+To use this, you need to configure RSpec to make the `use_vcr_cassette` available as a macro.
+Here's how to do that for RSpec 1:
+
+    require 'vcr'
+
+    Spec::Runner.configure do |c|
+      c.extend VCR::RSpec::Macros
+    end
+
+Or for RSpec 2:
+
+    require 'vcr'
 
-      it "does something else that makes an HTTP request"
+    RSpec.configure do |c|
+      c.extend VCR::RSpec::Macros
     end
 
 ## Usage with Cucumber
@@ -274,6 +325,21 @@ In your cassette:
       ...
       body: Hello, <%= user.name %>!
 
+## Automatic cassette 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.  You enable re-recording using the
+`:re_record_interval` option:
+
+    A_WEEK = 7 * 24 * 60 * 60 # or use 7.days if you're using ActiveSupport
+
+    VCR.use_cassette('my_cassette', :re_record_interval => A_WEEK) { ... }
+
+If the cassette file was last modified more than 7 days ago, VCR will use the `:all` record mode (regardless
+of the configured record mode) to allow new HTTP requests and record them.  VCR will check to make sure you
+have an internet connection before doing this, so if you are running the tests without one, the automatic
+re-recording will not kick in.
+
 ## FakeWeb or WebMock?
 
 VCR works fine with either FakeWeb or WebMock.  Overall, WebMock has more features, and you'll need to use
@@ -333,6 +399,7 @@ VCR has been tested on the following ruby interpreters:
 * MRI 1.9.2-p0
 * REE 1.8.7-2010.02
 * JRuby 1.5.1
+* Rubinius 1.1
 
 ## Notes, etc.
 
@@ -373,6 +440,8 @@ how VCR could be improved.  You may also want to try one of these similar librar
 * [Stale Fish](http://github.com/jsmestad/stale_fish)
 * [NetRecorder](http://github.com/chrisyoung/netrecorder)
 * [Ephemeral Response](http://github.com/sandro/ephemeral_response)
+* [Net::HTTP Spy](http://github.com/martinbtt/net-http-spy)
+* [WebFixtures](http://github.com/trydionel/web_fixtures)
 
 ## Copyright