vcr 1.4.0 → 1.5.0

data/features/configuration/ignore_localhost.feature

@@ -1,4 +1,4 @@
-Feature: ignore_localhost configuration option
+Feature: ignore_localhost
 
   The `ignore_localhost` configuration option can be used to prevent VCR
   from having any affect on localhost requests.  If set to true, it will

data/features/configuration/stub_with.feature

@@ -1,37 +1,36 @@
-Feature: stub_with configuration option
+Feature: stub_with
 
   The `stub_with` configuration option determines which HTTP stubbing library
   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::Easy, but not Curb::Multi)
-      * EM HTTP Request
-    * Typhoeus can be used to stub itself (as long as you use Typhoeus::Hydra,
+    - FakeWeb can be used to stub Net::HTTP.
+    - WebMock can be used to stub:
+      - Net::HTTP
+      - HTTPClient
+      - Patron
+      - Curb (Curb::Easy, but not Curb::Multi)
+      - EM HTTP Request
+    - 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)
+    - 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:
 
-    * FakeWeb does not allow you to stub a request based on the headers or body.
+    - FakeWeb does not allow you to stub a request based on the headers or body.
       Therefore, the `:match_requests_on` option does not support `:body` or
-      `:headers` when you use FakeWeb.  Typhoeus and WebMock both support
-      matching on `:body` and `:headers`.
-    * FakeWeb is currently about 4 times faster than WebMock for stubbing
+      `:headers` when you use FakeWeb.  Typhoeus, WebMock and Faraday both
+      support matching on `:body` and `:headers`.
+    - FakeWeb is currently about 4 times faster than WebMock for stubbing
       Net::HTTP (see benchmarks/http_stubbing_libraries.rb for details).
-    * FakeWeb and WebMock both use extensive monkey patching to stub their
-      supported HTTP libraries.  Typhoeus provides all the necessary
-      stubbing and recording integration points, and no monkey patching
-      is required at all.
-    * FakeWeb and WebMock cannot both be used at the same time.
-    * Typhoeus and Faraday can be used together, and with either
+    - FakeWeb and WebMock both use extensive monkey patching to stub their
+      supported HTTP libraries.  No monkey patching is used for Typhoeus or
+      Faraday.
+    - 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

data/features/middleware/rack.feature

@@ -1,17 +1,17 @@
-Feature: rack middleware
+Feature: Rack
 
   VCR provides a rack middleware that uses a cassette for the duration of
-  a request.  Simply provide VCR::Middleware::Rack with a block that sets
+  a request.  Simply provide `VCR::Middleware::Rack` with a block that sets
   the cassette name and options.  You can set these based on the rack env
   if your block accepts two arguments.
 
-  There useful in a couple different ways:
+  This is useful in a couple different ways:
 
-  * In a rails app, you could use this to log all HTTP API calls made by
-    the rails app (using the :all record mode).  Of course, this will only
+  - In a rails app, you could use this to log all HTTP API calls made by
+    the rails app (using the `:all` record mode).  Of course, this will only
     record HTTP API calls made in the request-response cycle--API calls that
     are offloaded to a background job will not be logged.
-  * This can be used as middleware in a simple rack HTTP proxy, to record the
+  - This can be used as middleware in a simple rack HTTP proxy, to record
     and replay the proxied requests.
 
   Background:

data/features/{cassettes/record_modes → record_modes}/all.feature

@@ -1,6 +1,6 @@
-Feature: :all record mode
+Feature: :all
 
-  The :all record mode records all requests and does not
+  The `:all` record mode records all requests and does not
   replay any previously recorded responds.
 
   This can be temporarily used to force VCR to re-record

data/features/{cassettes/record_modes → record_modes}/new_episodes.feature

@@ -1,6 +1,6 @@
-Feature: :new_episodes record mode
+Feature: :new_episodes
 
-  The :new_episodes record mode replays previously recorded
+  The `:new_episodes` record mode replays previously recorded
   requests and records new ones.
 
   Background:
@@ -46,7 +46,7 @@ Feature: :new_episodes record mode
       """
       require 'setup'
 
-      VCR.use_cassette('example', :record => :none) do
+      VCR.use_cassette('example', :record => :new_episodes) do
         response = Net::HTTP.get_response('example.com', '/foo')
         puts "Response: #{response.body}"
       end

data/features/{cassettes/record_modes → record_modes}/none.feature

@@ -1,10 +1,10 @@
-Feature: :none record mode
+Feature: :none
 
-  The :none record mode allows previously recorded responses
+  The `:none` record mode allows previously recorded responses
   to be replayed, but raises an error for any new requests.
 
-  This is useful when you code makes potentially dangerous
-  HTTP requests.  The :none record mode guarantees that no
+  This is useful when your code makes potentially dangerous
+  HTTP requests.  The `:none` record mode guarantees that no
   new HTTP requests will be made.
 
   Background:

data/features/support/vcr_cucumber_helpers.rb

@@ -7,7 +7,7 @@ RUNNING_UNDER_ARUBA = File.dirname(__FILE__) == '.' || File.dirname(__FILE__) =~
 
 if RUNNING_UNDER_ARUBA
   require 'support/fixnum_extension'
-  require 'vcr/internet_connection'
+  require 'vcr/util/internet_connection'
 
   # pretend we're always on the internet (so that we don't have an
   # internet connection dependency for our cukes)

data/features/test_frameworks/cucumber.feature

@@ -1,25 +1,25 @@
-Feature: Usage with cucumber
+Feature: Usage with Cucumber
 
   VCR can be used with cucumber in two basic ways:
 
-    * Use `VCR.use_cassette` in a step definition.
-    * Use a `VCR.cucumber_tags` block to tell VCR to use a
+    - Use `VCR.use_cassette` in a step definition.
+    - Use a `VCR.cucumber_tags` block to tell VCR to use a
       cassette for a tagged scenario.
 
   In a cucumber support file (e.g. features/support/vcr.rb), put code like this:
 
-    VCR.cucumber_tags do |t|
-      t.tag  '@tag1'
-      t.tags '@tag2', '@tag3'
+      VCR.cucumber_tags do |t|
+        t.tag  '@tag1'
+        t.tags '@tag2', '@tag3'
 
-      t.tag  '@tag3', :cassette => :options
-      t.tags '@tag4, '@tag5', :cassette => :options
-    end
+        t.tag  '@tag3', :cassette => :options
+        t.tags '@tag4, '@tag5', :cassette => :options
+      end
 
   VCR will use a cassette named "cucumber_tags/<tag_name>" for scenarios
-  with each of these tags.  The configured default_cassette_options will
+  with each of these tags.  The configured `default_cassette_options` will
   be used, or you can override specific options by passing a hash as the
-  last argument to #tag or #tags.
+  last argument to `#tag` or `#tags`.
 
   Scenario: Record HTTP interactions in a scenario by tagging it
     Given a file named "features/support/vcr.rb" with:

data/features/test_frameworks/rspec.feature

@@ -7,20 +7,20 @@ Feature: Usage with RSpec
   In any example group, add a `use_vcr_cassette` declaration to use a cassette
   for that example group.  You can use this in a few different ways:
 
-    * use_vcr_cassette
-      * Infers a cassette name from the example group description (and parent
+    - `use_vcr_cassette`
+      - Infers a cassette name from the example group description (and parent
         example group descriptions).
-      * Uses the default_cassette_options you have configured.
-    * use_vcr_cassette "Cassette Name"
-      * Uses the given cassette name.
-      * Uses the default_cassette_options you have configured.
-    * use_vcr_cassette :cassette => :options
-      * Infers a cassette name from the example group description (and parent
+      - Uses the `default_cassette_options` you have configured.
+    - `use_vcr_cassette "Cassette Name"`
+      - Uses the given cassette name.
+      - Uses the `default_cassette_options` you have configured.
+    - `use_vcr_cassette :cassette => :options`
+      - Infers a cassette name from the example group description (and parent
         example group descriptions).
-      * Uses the provided cassette options (merged with the defaults).
-    * use_vcr_cassette "Cassette Name", :cassette => :options
-      * Uses the given cassette name.
-      * Uses the provided cassette options (merged with the defaults).
+      - Uses the provided cassette options (merged with the defaults).
+    - `use_vcr_cassette "Cassette Name", :cassette => :options`
+      - Uses the given cassette name.
+      - Uses the provided cassette options (merged with the defaults).
 
   Background:
     Given the following files do not exist:

data/features/test_frameworks/shoulda.feature

@@ -1,4 +1,4 @@
-Feature: Usage with shoulda
+Feature: Usage with Shoulda
 
   When using a test framework that provides setup and teardown hooks
   (such as shoulda), you can use `VCR.insert_cassette` and

data/lib/vcr.rb

@@ -9,9 +9,9 @@ require 'vcr/http_stubbing_adapters/common'
 module VCR
   extend self
 
-  autoload :BasicObject,        'vcr/basic_object'
+  autoload :BasicObject,        'vcr/util/basic_object'
   autoload :CucumberTags,       'vcr/cucumber_tags'
-  autoload :InternetConnection, 'vcr/internet_connection'
+  autoload :InternetConnection, 'vcr/util/internet_connection'
   autoload :RSpec,              'vcr/rspec'
 
   LOCALHOST_ALIASES = %w( localhost 127.0.0.1 0.0.0.0 )
@@ -30,12 +30,16 @@ module VCR
     cassettes.last
   end
 
-  def insert_cassette(*args)
+  def insert_cassette(name, options = {})
     unless turned_on?
       raise TurnedOffError.new("VCR is turned off.  You must turn it on before you can insert a cassette.")
     end
 
-    cassette = Cassette.new(*args)
+    if cassettes.any? { |c| c.name == name }
+      raise ArgumentError.new("There is already a cassette with the same name (#{name}).  You cannot nest multiple cassettes with the same name.")
+    end
+
+    cassette = Cassette.new(name, options)
     cassettes.push(cassette)
     cassette
   end

data/lib/vcr/cassette.rb

@@ -3,17 +3,17 @@ require 'yaml'
 require 'erb'
 require 'set'
 
+require 'vcr/cassette/reader'
+
 module VCR
   class Cassette
-    class MissingERBVariableError < NameError; end
-
     VALID_RECORD_MODES = [:all, :none, :new_episodes]
 
-    attr_reader :name, :record_mode, :match_requests_on, :erb, :re_record_interval
+    attr_reader :name, :record_mode, :match_requests_on, :erb, :re_record_interval, :tag
 
     def initialize(name, options = {})
       options = VCR::Config.default_cassette_options.merge(options)
-      invalid_options = options.keys - [:record, :erb, :allow_real_http, :match_requests_on, :re_record_interval]
+      invalid_options = options.keys - [:record, :erb, :allow_real_http, :match_requests_on, :re_record_interval, :tag]
 
       if invalid_options.size > 0
         raise ArgumentError.new("You passed the following invalid options to VCR::Cassette.new: #{invalid_options.inspect}.")
@@ -24,10 +24,11 @@ module VCR
       @erb                = options[:erb]
       @match_requests_on  = options[:match_requests_on]
       @re_record_interval = options[:re_record_interval]
+      @tag                = options[:tag]
       @record_mode        = :all if should_re_record?
 
       deprecate_old_cassette_options(options)
-      raise_error_unless_valid_record_mode(record_mode)
+      raise_error_unless_valid_record_mode
 
       set_http_connections_allowed
       load_recorded_interactions
@@ -35,7 +36,7 @@ module VCR
 
     def eject
       write_recorded_interactions_to_disk
-      VCR.http_stubbing_adapter.restore_stubs_checkpoint(name)
+      VCR.http_stubbing_adapter.restore_stubs_checkpoint(self)
       restore_http_connections_allowed
       restore_ignore_localhost_for_deprecation
     end
@@ -62,7 +63,7 @@ module VCR
       name.to_s.gsub(/[^\w\-\/]+/, '_')
     end
 
-    def raise_error_unless_valid_record_mode(record_mode)
+    def raise_error_unless_valid_record_mode
       unless VALID_RECORD_MODES.include?(record_mode)
         raise ArgumentError.new("#{record_mode} is not a valid cassette record mode.  Valid options are: #{VALID_RECORD_MODES.inspect}")
       end
@@ -97,11 +98,11 @@ module VCR
     end
 
     def load_recorded_interactions
-      VCR.http_stubbing_adapter.create_stubs_checkpoint(name)
-
-      if file && File.exist?(file)
+      VCR.http_stubbing_adapter.create_stubs_checkpoint(self)
+      if file && File.size?(file)
         begin
           interactions = YAML.load(raw_yaml_content)
+          invoke_hook(:before_playback, interactions)
 
           if VCR.http_stubbing_adapter.ignore_localhost?
             interactions.reject! do |i|
@@ -121,32 +122,8 @@ module VCR
       end
     end
 
-    @@struct_cache = Hash.new do |hash, attributes|
-      hash[attributes] = Struct.new(*attributes)
-    end
-
     def raw_yaml_content
-      content = File.read(file)
-      return content unless @erb
-
-      template = ERB.new(content)
-
-      begin
-        return template.result unless @erb.is_a?(Hash)
-
-        # create an object with methods for each desired local variable...
-        local_variables = @@struct_cache[@erb.keys].new(*@erb.values)
-
-        # instance_eval seems to be the only way to get the binding for ruby 1.9: http://redmine.ruby-lang.org/issues/show/2161
-        template.result(local_variables.instance_eval { binding })
-      rescue NameError => e
-        example_hash = (@erb.is_a?(Hash) ? @erb : {}).merge(e.name => 'some value')
-
-        raise MissingERBVariableError.new(
-          "The ERB in the #{sanitized_name}.yml cassette file references undefined variable #{e.name}.  " +
-          "Pass it to the cassette using :erb => #{ example_hash.inspect }."
-        )
-      end
+      VCR::Cassette::Reader.new(file, erb).read
     end
 
     def merged_interactions
@@ -168,10 +145,22 @@ module VCR
     end
 
     def write_recorded_interactions_to_disk
-      if VCR::Config.cassette_library_dir && new_recorded_interactions.size > 0
-        directory = File.dirname(file)
-        FileUtils.mkdir_p directory unless File.exist?(directory)
-        File.open(file, 'w') { |f| f.write merged_interactions.to_yaml }
+      return unless VCR::Config.cassette_library_dir
+      return if new_recorded_interactions.empty?
+
+      interactions = merged_interactions
+      invoke_hook(:before_record, interactions)
+      return if interactions.empty?
+
+      directory = File.dirname(file)
+      FileUtils.mkdir_p directory unless File.exist?(directory)
+      File.open(file, 'w') { |f| f.write interactions.to_yaml }
+    end
+
+    def invoke_hook(type, interactions)
+      interactions.delete_if do |i|
+        VCR::Config.invoke_hook(type, tag, i, self)
+        i.ignored?
       end
     end
   end

data/lib/vcr/cassette/reader.rb

@@ -0,0 +1,58 @@
+module VCR
+  class Cassette
+    class MissingERBVariableError < NameError; end
+
+    class Reader
+      def initialize(file_name, erb)
+        @file_name, @erb = file_name, erb
+      end
+
+      def read
+        return file_content unless use_erb?
+        binding = binding_for_variables if erb_variables
+        template.result(binding)
+      rescue NameError => e
+        handle_name_error(e)
+      end
+
+      private
+
+        def handle_name_error(e)
+          example_hash = (erb_variables || {}).merge(e.name => 'some value')
+
+          raise MissingERBVariableError.new(
+            "The ERB in the #{@file_name} cassette file references undefined variable #{e.name}.  " +
+            "Pass it to the cassette using :erb => #{ example_hash.inspect }."
+          )
+        end
+
+        def use_erb?
+          !!@erb
+        end
+
+        def erb_variables
+          @erb if @erb.is_a?(Hash)
+        end
+
+        def file_content
+          @file_content ||= File.read(@file_name)
+        end
+
+        def template
+          @template ||= ERB.new(file_content)
+        end
+
+        @@struct_cache = Hash.new do |hash, attributes|
+          hash[attributes] = Struct.new(*attributes)
+        end
+
+        def variables_object
+          @variables_object ||= @@struct_cache[erb_variables.keys].new(*erb_variables.values)
+        end
+
+        def binding_for_variables
+          @binding_for_variables ||= variables_object.instance_eval { binding }
+        end
+    end
+  end
+end

data/lib/vcr/config.rb

@@ -1,46 +1,51 @@
 require 'fileutils'
+require 'vcr/hooks'
 
 module VCR
-  class Config
-    class << self
-      attr_reader :cassette_library_dir
-      def cassette_library_dir=(cassette_library_dir)
-        @cassette_library_dir = cassette_library_dir
-        FileUtils.mkdir_p(cassette_library_dir) if cassette_library_dir
-      end
-
-      attr_writer :default_cassette_options
-      def default_cassette_options
-        @default_cassette_options ||= {}
-        @default_cassette_options.merge!(:match_requests_on => RequestMatcher::DEFAULT_MATCH_ATTRIBUTES) unless @default_cassette_options.has_key?(:match_requests_on)
-        @default_cassette_options
-      end
-
-      def stub_with(*http_stubbing_libraries)
-        @http_stubbing_libraries = http_stubbing_libraries
-      end
-
-      def http_stubbing_libraries
-        @http_stubbing_libraries ||= []
-      end
-
-      def ignore_localhost=(value)
-        @ignore_localhost = value
-        VCR.http_stubbing_adapter.ignore_localhost = value if http_stubbing_libraries.any?
-      end
-
-      def ignore_localhost?
-        @ignore_localhost
-      end
-
-      def allow_http_connections_when_no_cassette=(value)
-        @allow_http_connections_when_no_cassette = value
-        VCR.http_stubbing_adapter.set_http_connections_allowed_to_default if http_stubbing_libraries.any?
-      end
-
-      def allow_http_connections_when_no_cassette?
-        !!@allow_http_connections_when_no_cassette
-      end
+  module Config
+    include VCR::Hooks
+    extend self
+
+    define_hook :before_record
+    define_hook :before_playback
+
+    attr_reader :cassette_library_dir
+    def cassette_library_dir=(cassette_library_dir)
+      @cassette_library_dir = cassette_library_dir
+      FileUtils.mkdir_p(cassette_library_dir) if cassette_library_dir
+    end
+
+    attr_writer :default_cassette_options
+    def default_cassette_options
+      @default_cassette_options ||= {}
+      @default_cassette_options.merge!(:match_requests_on => RequestMatcher::DEFAULT_MATCH_ATTRIBUTES) unless @default_cassette_options.has_key?(:match_requests_on)
+      @default_cassette_options
+    end
+
+    def stub_with(*http_stubbing_libraries)
+      @http_stubbing_libraries = http_stubbing_libraries
+    end
+
+    def http_stubbing_libraries
+      @http_stubbing_libraries ||= []
+    end
+
+    def ignore_localhost=(value)
+      @ignore_localhost = value
+      VCR.http_stubbing_adapter.ignore_localhost = value if http_stubbing_libraries.any?
+    end
+
+    def ignore_localhost?
+      @ignore_localhost
+    end
+
+    def allow_http_connections_when_no_cassette=(value)
+      @allow_http_connections_when_no_cassette = value
+      VCR.http_stubbing_adapter.set_http_connections_allowed_to_default if http_stubbing_libraries.any?
+    end
+
+    def allow_http_connections_when_no_cassette?
+      !!@allow_http_connections_when_no_cassette
     end
   end
 end