vcr 2.0.0.rc2 → 2.0.0

data/.travis.yml

@@ -11,6 +11,7 @@ rvm:
   - jruby-19mode
   - rbx-18mode
   - rbx-19mode
+  - ruby-head
 branches:
   only:
     - master
@@ -21,4 +22,5 @@ matrix:
     - rvm: jruby-19mode
     - rvm: rbx-18mode
     - rvm: rbx-19mode
+    - rvm: ruby-head
 

data/CHANGELOG.md

@@ -1,6 +1,23 @@
 ## In git
 
-[Full Changelog](http://github.com/myronmarston/vcr/compare/v2.0.0.rc2...master)
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v2.0.0...master)
+
+## 2.0.0 (March 2, 2012)
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v2.0.0.rc2...v2.0.0)
+
+* Add some additional logged events for the `debug_logger`.
+* Don't worry about stripping the standard port from the request URI on
+  playback. The standard port only needs to be stripped during recording;
+  for playback, it will have already been stripped.  This allows people
+  to use the `filter_sensitive_data` option in a way that changes the URI;
+  before this change, doing so could result in `URI::InvalidURIError`.
+  Thanks to [Patrick Schmitz](https://github.com/bullfight) and
+  [Dan Thompson](https://github.com/danthompson) for reporting the issue
+  and helping diagnose it.
+* Relax Excon dependency to include newly released 0.10.
+* Relax Faraday dependency to include 0.8.
+* Fix Faraday library hook so that it always does the version checking.
 
 ## 2.0.0 RC 2 (February 23, 2012)
 
@@ -479,7 +496,7 @@ upgrade notes for more info.
 * 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
-    WebMock supports should (theoretically, at least) work without any VCR code changes.  Thanks to 
+    WebMock supports should (theoretically, at least) work without any VCR code changes.  Thanks to
     [Bartosz Blimke](http://github.com/bblimke) for adding the necessary code to WebMock to make this happen!
   * Added support for dynamic responses using ERB.  A cassette will be evaluated as ERB before the YAML
     is deserialized if you pass it an `:erb => true` option.  You can pass variables using

data/README.md

@@ -69,15 +69,23 @@ maintenance) and accurate (the response will contain the same headers and body y
 
 ## Usage
 
-Browse the [documentation](http://relishapp.com/myronmarston/vcr) for usage info.
+The docs come in two flavors:
 
-The [VCR talk given at Philly.rb](http://philly-rb-vcr-talk.heroku.com/) also
-contains good usage info.
+* The [relish docs](http://relishapp.com/myronmarston/vcr) contain
+  example-based documentation (VCR's cucumber suite, in fact). It's a
+  good place to look when you are first getting started with VCR, or if
+  you want to see an example of how to use a feature.
+* The [rubydoc.info docs](http://rubydoc.info/gems/vcr/frames) contain
+  API documentation. The API docs contain detailed info about all of VCR's
+  public API.
+
+See the [Upgrade](https://github.com/myronmarston/vcr/blob/master/Upgrade.md) doc
+for info about what's new and changed in VCR 2.0.
 
 ## Release Policy
 
 VCR follows the principles of [semantic versioning](http://semver.org/).
-The [cucumber features](http://relishapp.com/myronmarston/vcr) define
+The [API documentation](http://rubydoc.info/gems/vcr/frames) define
 VCR's public API.  Patch level releases contain only bug fixes.  Minor
 releases contain backward-compatible new features.  Major new releases
 contain backwards-incompatible changes to the public API.
@@ -88,10 +96,13 @@ VCR has been tested on the following ruby interpreters:
 
 * MRI 1.8.7
 * MRI 1.9.2
+* MRI 1.9.3
 * REE 1.8.7
 * JRuby
 * Rubinius
 
+Note that as of VCR 2, 1.8.6 and 1.9.1 are not supported.
+
 ## Development
 
 * Source hosted on [GitHub](http://github.com/myronmarston/vcr).
@@ -158,4 +169,5 @@ Thanks also to the following people who have contributed patches or helpful sugg
 
 ## Copyright
 
-Copyright (c) 2010-2012 Myron Marston. See LICENSE for details.
+Copyright (c) 2010-2012 Myron Marston. Released under the terms of the
+MIT license. See LICENSE for details.

data/Upgrade.md

@@ -220,6 +220,39 @@ the philosophy of VCR to record the entire sequence of HTTP interactions
 interaction can only be played back once unless you use the new
 `:allow_playback_repeats` option.
 
+In VCR 1.x, request matching was delegated to the HTTP stubbing library
+(typically FakeWeb or WebMock). They contain some normalization logic
+that can treat some URIs that are different strings as equivalent.
+For example, WebMock ignores the ordering of query parameters:
+
+``` ruby
+> require 'webmock'
+ => true
+> uri1 = "http://foo.com/bar?a=1&b=2"
+ => "http://foo.com/bar?a=1&b=2"
+> uri2 = "http://foo.com/bar?b=2&a=1"
+ => "http://foo.com/bar?b=2&a=1"
+> uri1 == uri2
+ => false
+> WebMock::Util::URI.normalize_uri(uri1) == WebMock::Util::URI.normalize_uri(uri2)
+ => true
+```
+
+VCR 2, the `:uri` matcher simply [uses string
+equality](https://github.com/myronmarston/vcr/blob/v2.0.0/lib/vcr/request_matcher_registry.rb#L111).
+This means that there are some cases of non-deterministic URIs that VCR
+1.x matched but VCR 2.0 will not match. If you need the `:uri` matcher
+to be tolerant of slight variations like these, you can easily override
+it:
+
+``` ruby
+VCR.configure do |c|
+  c.register_request_matcher(:uri) do |r1, r2|
+    WebMock::Util::URI.normalize_uri(r1.uri) == WebMock::Util::URI.normalize_uri(r2.uri)
+  end
+end
+```
+
 ## Preserve Exact Body Bytes
 
 Sometimes the request or response body of an HTTP interaction cannot

data/benchmarks/http_stubbing_libraries.rb

@@ -52,8 +52,8 @@ end
 # Benchmarking Single setup/teardown:
 # webmock  0.000000   0.000000   6.950000 (  6.981525)
 # fakeweb  0.000000   0.010000   1.750000 (  1.740679)
-# 
-# 
+#
+#
 # Benchmarking Setup/teardown for each http request:
 # webmock  0.000000   0.000000   7.970000 (  7.981383)
 # fakeweb  0.000000   0.000000   2.210000 (  2.203478)

data/features/getting_started.md

@@ -55,7 +55,7 @@ Wrap the body of it (or at least the code that makes the HTTP request) in a
 Run this test.  It will record the HTTP request to disk as a cassette (a
 test fixture), with content like:
 
-    --- 
+    ---
     http_interactions:
     - request:
         method: get

data/features/http_libraries/em_http_request.feature

@@ -145,13 +145,16 @@ Feature: EM HTTP Request
           multi = EventMachine::MultiRequest.new
 
           %w[ foo bar bazz ].each do |path|
-            multi.add(EventMachine::HttpRequest.new("http://localhost:7777/#{path}").get)
+            multi.add(path, EventMachine::HttpRequest.new("http://localhost:7777/#{path}").get)
           end
 
           multi.callback do
-            multi.responses[:succeeded].each do |http|
-              puts http.response
+            responses = Hash[multi.responses[:callback]]
+
+            %w[ foo bar bazz ].each do |path|
+              puts responses[path].response
             end
+
             EventMachine.stop
           end
         end

data/lib/vcr.rb

@@ -153,43 +153,6 @@ module VCR
     end
   end
 
-  # @private
-  def http_interactions
-    return current_cassette.http_interactions if current_cassette
-    VCR::Cassette::HTTPInteractionList::NullList
-  end
-
-  # @private
-  def real_http_connections_allowed?
-    return current_cassette.recording? if current_cassette
-    configuration.allow_http_connections_when_no_cassette? || @turned_off
-  end
-
-  # @return [RequestMatcherRegistry] the request matcher registry
-  def request_matchers
-    @request_matchers ||= RequestMatcherRegistry.new
-  end
-
-  # @private
-  def request_ignorer
-    @request_ignorer ||= RequestIgnorer.new
-  end
-
-  # @private
-  def library_hooks
-    @library_hooks ||= LibraryHooks.new
-  end
-
-  # @private
-  def cassette_serializers
-    @cassette_serializers ||= Cassette::Serializers.new
-  end
-
-  # @return [VCR::Configuration] the VCR configuration.
-  def configuration
-    @configuration ||= Configuration.new
-  end
-
   # Used to configure VCR.
   #
   # @example
@@ -204,6 +167,11 @@ module VCR
     yield configuration
   end
 
+  # @return [VCR::Configuration] the VCR configuration.
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
   # Sets up `Before` and `After` cucumber hooks in order to
   # use VCR with particular cucumber tags.
   #
@@ -222,14 +190,6 @@ module VCR
     yield VCR::CucumberTags.new(main_object)
   end
 
-  # @private
-  def record_http_interaction(interaction)
-    return unless cassette = current_cassette
-    return if VCR.request_ignorer.ignore?(interaction.request)
-
-    cassette.record_http_interaction(interaction)
-  end
-
   # Turns VCR off for the duration of a block.
   #
   # @param (see #turn_off!)
@@ -292,12 +252,51 @@ module VCR
   end
 
   # @private
-  def ignore_cassettes?
-    @ignore_cassettes
+  def http_interactions
+    return current_cassette.http_interactions if current_cassette
+    VCR::Cassette::HTTPInteractionList::NullList
+  end
+
+  # @private
+  def real_http_connections_allowed?
+    return current_cassette.recording? if current_cassette
+    configuration.allow_http_connections_when_no_cassette? || @turned_off
+  end
+
+  # @return [RequestMatcherRegistry] the request matcher registry
+  def request_matchers
+    @request_matchers ||= RequestMatcherRegistry.new
+  end
+
+  # @private
+  def request_ignorer
+    @request_ignorer ||= RequestIgnorer.new
+  end
+
+  # @private
+  def library_hooks
+    @library_hooks ||= LibraryHooks.new
+  end
+
+  # @private
+  def cassette_serializers
+    @cassette_serializers ||= Cassette::Serializers.new
+  end
+
+  # @private
+  def record_http_interaction(interaction)
+    return unless cassette = current_cassette
+    return if VCR.request_ignorer.ignore?(interaction.request)
+
+    cassette.record_http_interaction(interaction)
   end
 
 private
 
+  def ignore_cassettes?
+    @ignore_cassettes
+  end
+
   def cassettes
     @cassettes ||= []
   end

data/lib/vcr/cassette.rb

@@ -156,11 +156,24 @@ module VCR
 
     def should_re_record?
       return false unless @re_record_interval
-      return false unless earliest_interaction_recorded_at
+      previously_recorded_at = earliest_interaction_recorded_at
+      return false unless previously_recorded_at
       return false unless File.exist?(file)
-      return false unless InternetConnection.available?
 
-      earliest_interaction_recorded_at + @re_record_interval < Time.now
+      now = Time.now
+
+      (previously_recorded_at + @re_record_interval < now).tap do |value|
+        info = "previously recorded at: '#{previously_recorded_at}'; now: '#{now}'; interval: #{@re_record_interval} seconds"
+
+        if !value
+          log "Not re-recording since the interval has not elapsed (#{info})."
+        elsif InternetConnection.available?
+          log "re-recording (#{info})."
+        else
+          log "Not re-recording because no internet connection is available (#{info})."
+          return false
+        end
+      end
     end
 
     def earliest_interaction_recorded_at

data/lib/vcr/configuration.rb

@@ -4,119 +4,9 @@ require 'vcr/util/hooks'
 module VCR
   # Stores the VCR configuration.
   class Configuration
-    include VCR::Hooks
-    include VCR::VariableArgsBlockCaller
-
-    # Adds a callback that will be called before the recorded HTTP interactions
-    # are serialized and written to disk.
-    #
-    # @example
-    #  VCR.configure do |c|
-    #    # Don't record transient 5xx errors
-    #    c.before_record do |interaction|
-    #      interaction.ignore! if interaction.response.status.code >= 500
-    #    end
-    #
-    #    # Modify the response body for cassettes tagged with :twilio
-    #    c.before_record(:twilio) do |interaction|
-    #      interaction.response.body.downcase!
-    #    end
-    #  end
-    #
-    # @param tag [(optional) Symbol] Used to apply this hook to only cassettes that match
-    #  the given tag.
-    # @yield the callback
-    # @yieldparam interaction [VCR::HTTPInteraction::HookAware] The interaction that will be
-    #  serialized and written to disk.
-    # @yieldparam cassette [(optional) VCR::Cassette] The current cassette.
-    # @see #before_playback
-    define_hook :before_record
-    def before_record(tag = nil, &block)
-      super(filter_from(tag), &block)
-    end
-
-    # Adds a callback that will be called before a previously recorded
-    # HTTP interaction is loaded for playback.
-    #
-    # @example
-    #  VCR.configure do |c|
-    #    # Don't playback transient 5xx errors
-    #    c.before_playback do |interaction|
-    #      interaction.ignore! if interaction.response.status.code >= 500
-    #    end
-    #
-    #    # Change a response header for playback
-    #    c.before_playback(:twilio) do |interaction|
-    #      interaction.response.headers['X-Foo-Bar'] = 'Bazz'
-    #    end
-    #  end
-    #
-    # @param tag [(optional) Symbol] Used to apply this hook to only cassettes that match
-    #  the given tag.
-    # @yield the callback
-    # @yieldparam interaction [VCR::HTTPInteraction::HookAware] The interaction that is being
-    #  loaded.
-    # @yieldparam cassette [(optional) VCR::Cassette] The current cassette.
-    # @see #before_record
-    define_hook :before_playback
-    def before_playback(tag = nil, &block)
-      super(filter_from(tag), &block)
-    end
-
-    # @private
-    define_hook :after_library_hooks_loaded
-
-    # Adds a callback that will be called with each HTTP request before it is made.
-    #
-    # @example
-    #  VCR.configure do |c|
-    #    c.before_http_request(:real?) do |request|
-    #      puts "Request: #{request.method} #{request.uri}"
-    #    end
-    #  end
-    #
-    # @param filters [optional splat of #to_proc] one or more filters to apply.
-    #   The objects provided will be converted to procs using `#to_proc`. If provided,
-    #   the callback will only be invoked if these procs all return `true`.
-    # @yield the callback
-    # @yieldparam request [VCR::Request::Typed] the request that is being made
-    # @see #after_http_request
-    # @see #around_http_request
-    define_hook :before_http_request
-
-    # Adds a callback that will be called with each HTTP request after it is complete.
-    #
-    # @example
-    #  VCR.configure do |c|
-    #    c.after_http_request(:ignored?) do |request, response|
-    #      puts "Request: #{request.method} #{request.uri}"
-    #      puts "Response: #{response.status.code}"
-    #    end
-    #  end
-    #
-    # @param filters [optional splat of #to_proc] one or more filters to apply.
-    #   The objects provided will be converted to procs using `#to_proc`. If provided,
-    #   the callback will only be invoked if these procs all return `true`.
-    # @yield the callback
-    # @yieldparam request [VCR::Request::Typed] the request that is being made
-    # @yieldparam response [VCR::Response] the response from the request
-    # @see #before_http_request
-    # @see #around_http_request
-    define_hook :after_http_request, :prepend
-
-    # @private
-    def initialize
-      @allow_http_connections_when_no_cassette = nil
-      @default_cassette_options = {
-        :record            => :once,
-        :match_requests_on => RequestMatcherRegistry::DEFAULT_MATCHERS,
-        :serialize_with    => :yaml
-      }
-
-      self.debug_logger = NullDebugLogger
-
-      register_built_in_hooks
-    end
+    include Hooks
+    include VariableArgsBlockCaller
+    include Logger
 
     # The directory to read cassettes from and write cassettes to.
     #
@@ -175,29 +65,6 @@ module VCR
       invoke_hook(:after_library_hooks_loaded)
     end
 
-    # Registers a request matcher for later use.
-    #
-    # @example
-    #  VCR.configure do |c|
-    #    c.register_request_matcher :port do |request_1, request_2|
-    #      URI(request_1.uri).port == URI(request_2.uri).port
-    #    end
-    #  end
-    #
-    #  VCR.use_cassette("my_cassette", :match_requests_on => [:method, :host, :port]) do
-    #    # ...
-    #  end
-    #
-    # @param name [Symbol] the name of the request matcher
-    # @yield the request matcher
-    # @yieldparam request_1 [VCR::Request] One request
-    # @yieldparam request_2 [VCR::Request] The other request
-    # @yieldreturn [Boolean] whether or not these two requests should be considered
-    #  equivalent
-    def register_request_matcher(name, &block)
-      VCR.request_matchers.register(name, &block)
-    end
-
     # Specifies host(s) that VCR should ignore.
     #
     # @param hosts [Array<String>] List of hosts to ignore
@@ -254,6 +121,29 @@ module VCR
       !!@allow_http_connections_when_no_cassette
     end
 
+    # Registers a request matcher for later use.
+    #
+    # @example
+    #  VCR.configure do |c|
+    #    c.register_request_matcher :port do |request_1, request_2|
+    #      URI(request_1.uri).port == URI(request_2.uri).port
+    #    end
+    #  end
+    #
+    #  VCR.use_cassette("my_cassette", :match_requests_on => [:method, :host, :port]) do
+    #    # ...
+    #  end
+    #
+    # @param name [Symbol] the name of the request matcher
+    # @yield the request matcher
+    # @yieldparam request_1 [VCR::Request] One request
+    # @yieldparam request_2 [VCR::Request] The other request
+    # @yieldreturn [Boolean] whether or not these two requests should be considered
+    #  equivalent
+    def register_request_matcher(name, &block)
+      VCR.request_matchers.register(name, &block)
+    end
+
     # Sets up a {#before_record} and a {#before_playback} hook that will
     # insert a placeholder string in the cassette in place of another string.
     # You can use this as a generic way to interpolate a variable into the
@@ -279,11 +169,15 @@ module VCR
     # @yieldreturn the string to replace
     def define_cassette_placeholder(placeholder, tag = nil, &block)
       before_record(tag) do |interaction|
-        interaction.filter!(call_block(block, interaction), placeholder)
+        orig_text = call_block(block, interaction)
+        log "before_record: replacing #{orig_text.inspect} with #{placeholder.inspect}"
+        interaction.filter!(orig_text, placeholder)
       end
 
       before_playback(tag) do |interaction|
-        interaction.filter!(placeholder, call_block(block, interaction))
+        orig_text = call_block(block, interaction)
+        log "before_playback: replacing #{placeholder.inspect} with #{orig_text.inspect}"
+        interaction.filter!(placeholder, orig_text)
       end
     end
     alias filter_sensitive_data define_cassette_placeholder
@@ -305,6 +199,100 @@ module VCR
       VCR.cassette_serializers
     end
 
+    # Adds a callback that will be called before the recorded HTTP interactions
+    # are serialized and written to disk.
+    #
+    # @example
+    #  VCR.configure do |c|
+    #    # Don't record transient 5xx errors
+    #    c.before_record do |interaction|
+    #      interaction.ignore! if interaction.response.status.code >= 500
+    #    end
+    #
+    #    # Modify the response body for cassettes tagged with :twilio
+    #    c.before_record(:twilio) do |interaction|
+    #      interaction.response.body.downcase!
+    #    end
+    #  end
+    #
+    # @param tag [(optional) Symbol] Used to apply this hook to only cassettes that match
+    #  the given tag.
+    # @yield the callback
+    # @yieldparam interaction [VCR::HTTPInteraction::HookAware] The interaction that will be
+    #  serialized and written to disk.
+    # @yieldparam cassette [(optional) VCR::Cassette] The current cassette.
+    # @see #before_playback
+    define_hook :before_record
+    def before_record(tag = nil, &block)
+      super(filter_from(tag), &block)
+    end
+
+    # Adds a callback that will be called before a previously recorded
+    # HTTP interaction is loaded for playback.
+    #
+    # @example
+    #  VCR.configure do |c|
+    #    # Don't playback transient 5xx errors
+    #    c.before_playback do |interaction|
+    #      interaction.ignore! if interaction.response.status.code >= 500
+    #    end
+    #
+    #    # Change a response header for playback
+    #    c.before_playback(:twilio) do |interaction|
+    #      interaction.response.headers['X-Foo-Bar'] = 'Bazz'
+    #    end
+    #  end
+    #
+    # @param tag [(optional) Symbol] Used to apply this hook to only cassettes that match
+    #  the given tag.
+    # @yield the callback
+    # @yieldparam interaction [VCR::HTTPInteraction::HookAware] The interaction that is being
+    #  loaded.
+    # @yieldparam cassette [(optional) VCR::Cassette] The current cassette.
+    # @see #before_record
+    define_hook :before_playback
+    def before_playback(tag = nil, &block)
+      super(filter_from(tag), &block)
+    end
+
+    # Adds a callback that will be called with each HTTP request before it is made.
+    #
+    # @example
+    #  VCR.configure do |c|
+    #    c.before_http_request(:real?) do |request|
+    #      puts "Request: #{request.method} #{request.uri}"
+    #    end
+    #  end
+    #
+    # @param filters [optional splat of #to_proc] one or more filters to apply.
+    #   The objects provided will be converted to procs using `#to_proc`. If provided,
+    #   the callback will only be invoked if these procs all return `true`.
+    # @yield the callback
+    # @yieldparam request [VCR::Request::Typed] the request that is being made
+    # @see #after_http_request
+    # @see #around_http_request
+    define_hook :before_http_request
+
+    # Adds a callback that will be called with each HTTP request after it is complete.
+    #
+    # @example
+    #  VCR.configure do |c|
+    #    c.after_http_request(:ignored?) do |request, response|
+    #      puts "Request: #{request.method} #{request.uri}"
+    #      puts "Response: #{response.status.code}"
+    #    end
+    #  end
+    #
+    # @param filters [optional splat of #to_proc] one or more filters to apply.
+    #   The objects provided will be converted to procs using `#to_proc`. If provided,
+    #   the callback will only be invoked if these procs all return `true`.
+    # @yield the callback
+    # @yieldparam request [VCR::Request::Typed] the request that is being made
+    # @yieldparam response [VCR::Response] the response from the request
+    # @see #before_http_request
+    # @see #around_http_request
+    define_hook :after_http_request, :prepend
+
     # Adds a callback that will be executed around each HTTP request.
     #
     # @example
@@ -405,6 +393,19 @@ module VCR
 
   private
 
+    def initialize
+      @allow_http_connections_when_no_cassette = nil
+      @default_cassette_options = {
+        :record            => :once,
+        :match_requests_on => RequestMatcherRegistry::DEFAULT_MATCHERS,
+        :serialize_with    => :yaml
+      }
+
+      self.debug_logger = NullDebugLogger
+
+      register_built_in_hooks
+    end
+
     def load_library_hook(hook)
       file = "vcr/library_hooks/#{hook}"
       require file
@@ -445,6 +446,13 @@ module VCR
         cassette && cassette.tags.include?(:preserve_exact_body_bytes)
       end
     end
+
+    def log_prefix
+      "[VCR::Configuration] "
+    end
+
+    # @private
+    define_hook :after_library_hooks_loaded
   end
 
   # @private