vcr 1.11.3 → 2.0.0.beta1

data/features/test_frameworks/shoulda.feature

@@ -14,28 +14,25 @@ Feature: Usage with Shoulda
 
   Scenario: Use `VCR.insert_cassette` and `VCR.eject_cassette`
     Given a file named "test/test_server.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
-
+      """ruby
       start_sinatra_app(:port => 7777) do
         get('/') { "Hello" }
       end
       """
     Given a file named "test/test_helper.rb" with:
-      """
+      """ruby
       require 'test/test_server' if ENV['SERVER'] == 'true'
       require 'test/unit'
       require 'shoulda'
       require 'vcr'
 
-      VCR.config do |c|
-        c.stub_with :webmock
+      VCR.configure do |c|
+        c.hook_into :webmock
         c.cassette_library_dir = 'test/fixtures/vcr_cassettes'
-        c.default_cassette_options = { :record => :new_episodes }
       end
       """
     And a file named "test/vcr_example_test.rb" with:
-      """
+      """ruby
       require 'test_helper'
 
       class VCRExampleTest < Test::Unit::TestCase

data/features/test_frameworks/test_unit.feature

@@ -5,27 +5,24 @@ Feature: Usage with Test::Unit
 
   Scenario: Use `VCR.use_cassette` in a test
     Given a file named "test/test_server.rb" with:
-      """
-      require 'vcr_cucumber_helpers'
-
+      """ruby
       start_sinatra_app(:port => 7777) do
         get('/') { "Hello" }
       end
       """
     Given a file named "test/test_helper.rb" with:
-      """
+      """ruby
       require 'test/test_server' if ENV['SERVER'] == 'true'
       require 'test/unit'
       require 'vcr'
 
-      VCR.config do |c|
-        c.stub_with :webmock
+      VCR.configure do |c|
+        c.hook_into :webmock
         c.cassette_library_dir = 'test/fixtures/vcr_cassettes'
-        c.default_cassette_options = { :record => :new_episodes }
       end
       """
     And a file named "test/vcr_example_test.rb" with:
-      """
+      """ruby
       require 'test_helper'
 
       class VCRExampleTest < Test::Unit::TestCase

data/lib/vcr.rb

@@ -1,44 +1,28 @@
-require 'vcr/util/regexes'
 require 'vcr/util/variable_args_block_caller'
 require 'vcr/util/yaml'
 
 require 'vcr/cassette'
-require 'vcr/config'
-require 'vcr/request_matcher'
+require 'vcr/configuration'
+require 'vcr/deprecations'
+require 'vcr/errors'
+require 'vcr/library_hooks'
+require 'vcr/request_ignorer'
+require 'vcr/request_matcher_registry'
 require 'vcr/version'
 
-require 'vcr/http_stubbing_adapters/common'
-
-require 'vcr/deprecations/cassette'
-require 'vcr/deprecations/config'
-require 'vcr/deprecations/http_stubbing_adapters/common'
-
-require 'vcr/structs/normalizers/body'
-require 'vcr/structs/normalizers/header'
-require 'vcr/structs/normalizers/status_message'
-require 'vcr/structs/normalizers/uri'
 require 'vcr/structs/http_interaction'
-require 'vcr/structs/request'
-require 'vcr/structs/response'
-require 'vcr/structs/response_status'
 
 module VCR
   include VariableArgsBlockCaller
+  include Errors
+
   extend self
 
-  autoload :BasicObject,        'vcr/util/basic_object'
   autoload :CucumberTags,       'vcr/test_frameworks/cucumber'
   autoload :InternetConnection, 'vcr/util/internet_connection'
   autoload :RSpec,              'vcr/test_frameworks/rspec'
 
-  LOCALHOST_ALIASES = %w( localhost 127.0.0.1 0.0.0.0 )
-
-  class CassetteInUseError < StandardError; end
-  class TurnedOffError < StandardError; end
-
   module Middleware
-    autoload :CassetteArguments, 'vcr/middleware/cassette_arguments'
-    autoload :Common,            'vcr/middleware/common'
     autoload :Faraday,           'vcr/middleware/faraday'
     autoload :Rack,              'vcr/middleware/rack'
   end
@@ -79,35 +63,44 @@ module VCR
     end
   end
 
-  def config
-    yield VCR::Config
-    http_stubbing_adapter.check_version!
-    http_stubbing_adapter.set_http_connections_allowed_to_default
-    http_stubbing_adapter.ignored_hosts = VCR::Config.ignored_hosts
+  def http_interactions
+    return current_cassette.http_interactions if current_cassette
+    VCR::Cassette::HTTPInteractionList::NullList.new
   end
 
-  def cucumber_tags(&block)
-    main_object = eval('self', block.binding)
-    yield VCR::CucumberTags.new(main_object)
+  def real_http_connections_allowed?
+    return current_cassette.recording? if current_cassette
+    configuration.allow_http_connections_when_no_cassette? || @turned_off
   end
 
-  def http_stubbing_adapter
-    @http_stubbing_adapter ||= begin
-      if [:fakeweb, :webmock].all? { |l| VCR::Config.http_stubbing_libraries.include?(l) }
-        raise ArgumentError.new("You have configured VCR to use both :fakeweb and :webmock.  You cannot use both.")
-      end
+  def request_matchers
+    @request_matchers ||= RequestMatcherRegistry.new
+  end
 
-      adapters = VCR::Config.http_stubbing_libraries.map { |l| adapter_for(l) }
-      raise ArgumentError.new("The http stubbing library is not configured.") if adapters.empty?
-      adapter = HttpStubbingAdapters::MultiObjectProxy.for(*adapters)
-      adapter.after_adapters_loaded
-      adapter
-    end
+  def request_ignorer
+    @request_ignorer ||= RequestIgnorer.new
+  end
+
+  def library_hooks
+    @library_hooks ||= LibraryHooks.new
+  end
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  def configure
+    yield configuration
+  end
+
+  def cucumber_tags(&block)
+    main_object = eval('self', block.binding)
+    yield VCR::CucumberTags.new(main_object)
   end
 
   def record_http_interaction(interaction)
     return unless cassette = current_cassette
-    return if VCR::Config.uri_should_be_ignored?(interaction.uri)
+    return if VCR.request_ignorer.ignore?(interaction.request)
 
     cassette.record_http_interaction(interaction)
   end
@@ -133,12 +126,10 @@ module VCR
       raise ArgumentError.new("You passed some invalid options: #{invalid_options.inspect}")
     end
 
-    VCR.http_stubbing_adapter.http_connections_allowed = true
     @turned_off = true
   end
 
   def turn_on!
-    VCR.http_stubbing_adapter.set_http_connections_allowed_to_default
     @turned_off = false
   end
 
@@ -150,18 +141,7 @@ module VCR
     @ignore_cassettes
   end
 
-  private
-
-  def adapter_for(lib)
-    case lib
-      when :excon;    HttpStubbingAdapters::Excon
-      when :fakeweb;  HttpStubbingAdapters::FakeWeb
-      when :faraday;  HttpStubbingAdapters::Faraday
-      when :typhoeus; HttpStubbingAdapters::Typhoeus
-      when :webmock;  HttpStubbingAdapters::WebMock
-      else raise ArgumentError.new("#{lib.inspect} is not a supported HTTP stubbing library.")
-    end
-  end
+private
 
   def cassettes
     @cassettes ||= []

data/lib/vcr/cassette.rb

@@ -3,50 +3,43 @@ require 'erb'
 require 'set'
 
 require 'vcr/cassette/reader'
+require 'vcr/cassette/http_interaction_list'
 
 module VCR
   class Cassette
     VALID_RECORD_MODES = [:all, :none, :new_episodes, :once]
 
-    attr_reader :name, :record_mode, :match_requests_on, :erb, :re_record_interval, :tag
+    attr_reader :name, :record_mode, :match_requests_on, :erb, :re_record_interval, :tag, :http_interactions
 
     def initialize(name, options = {})
-      options = VCR::Config.default_cassette_options.merge(options)
+      options = VCR.configuration.default_cassette_options.merge(options)
       invalid_options = options.keys - [
-        :record,
-        :erb,
-        :allow_real_http,
-        :match_requests_on,
-        :re_record_interval,
-        :tag,
-        :update_content_length_header
+        :record, :erb, :match_requests_on, :re_record_interval, :tag,
+        :update_content_length_header, :allow_playback_repeats, :exclusive
       ]
 
       if invalid_options.size > 0
         raise ArgumentError.new("You passed the following invalid options to VCR::Cassette.new: #{invalid_options.inspect}.")
       end
 
-      @name               = name
-      @record_mode        = options[:record]
-      @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?
+      @name                         = name
+      @record_mode                  = options[:record]
+      @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?
       @update_content_length_header = options[:update_content_length_header]
+      @allow_playback_repeats       = options[:allow_playback_repeats]
+      @exclusive                    = options[:exclusive]
 
-      deprecate_old_cassette_options(options)
       raise_error_unless_valid_record_mode
 
-      set_http_connections_allowed
       load_recorded_interactions
     end
 
     def eject
       write_recorded_interactions_to_disk
-      VCR.http_stubbing_adapter.restore_stubs_checkpoint(self)
-      restore_http_connections_allowed
-      restore_ignore_localhost_for_deprecation
     end
 
     def recorded_interactions
@@ -62,14 +55,22 @@ module VCR
     end
 
     def file
-      File.join(VCR::Config.cassette_library_dir, "#{sanitized_name}.yml") if VCR::Config.cassette_library_dir
+      File.join(VCR.configuration.cassette_library_dir, "#{sanitized_name}.yml") if VCR.configuration.cassette_library_dir
     end
 
     def update_content_length_header?
       @update_content_length_header
     end
 
-    private
+    def recording?
+      case record_mode
+        when :none; false
+        when :once; file.nil? || !File.size?(file)
+        else true
+      end
+    end
+
+  private
 
     def sanitized_name
       name.to_s.gsub(/[^\w\-\/]+/, '_')
@@ -88,14 +89,6 @@ module VCR
       InternetConnection.available?
     end
 
-    def should_allow_http_connections?
-      case record_mode
-        when :none; false
-        when :once; !File.size?(file)
-        else true
-      end
-    end
-
     def should_stub_requests?
       record_mode != :all
     end
@@ -104,29 +97,14 @@ module VCR
       record_mode == :all
     end
 
-    def set_http_connections_allowed
-      @orig_http_connections_allowed = VCR.http_stubbing_adapter.http_connections_allowed?
-      VCR.http_stubbing_adapter.http_connections_allowed = should_allow_http_connections?
-    end
-
-    def restore_http_connections_allowed
-      VCR.http_stubbing_adapter.http_connections_allowed = @orig_http_connections_allowed
-    end
-
     def load_recorded_interactions
-      VCR.http_stubbing_adapter.create_stubs_checkpoint(self)
       if file && File.size?(file)
-        begin
-          interactions = VCR::YAML.load(raw_yaml_content)
-        rescue TypeError, ArgumentError # Syck raises TypeError, Psych raises ArgumentError
-          raise unless raw_yaml_content =~ /VCR::RecordedResponse/
-          raise "The VCR cassette #{sanitized_name}.yml uses an old format that is now deprecated.  VCR provides a rake task to migrate your old cassettes to the new format.  See http://github.com/myronmarston/vcr/blob/master/CHANGELOG.md for more info."
-        end
+        interactions = VCR::YAML.load(raw_yaml_content)
 
         invoke_hook(:before_playback, interactions)
 
         interactions.reject! do |i|
-          i.request.uri.is_a?(String) && VCR::Config.uri_should_be_ignored?(i.request.uri)
+          i.request.uri.is_a?(String) && VCR.request_ignorer.ignore?(i.request)
         end
 
         if update_content_length_header?
@@ -136,9 +114,17 @@ module VCR
         recorded_interactions.replace(interactions)
       end
 
-      if should_stub_requests?
-        VCR.http_stubbing_adapter.stub_requests(recorded_interactions, match_requests_on)
-      end
+      interactions = should_stub_requests? ? recorded_interactions : []
+
+      @http_interactions = HTTPInteractionList.new(
+        interactions,
+        match_requests_on,
+        @allow_playback_repeats,
+        parent_list)
+    end
+
+    def parent_list
+      @exclusive ? HTTPInteractionList::NullList.new : VCR.http_interactions
     end
 
     def raw_yaml_content
@@ -149,14 +135,9 @@ module VCR
       old_interactions = recorded_interactions
 
       if should_remove_matching_existing_interactions?
-        match_attributes = match_requests_on
-
-        new_request_matchers = Set.new new_recorded_interactions.map do |i|
-          i.request.matcher(match_attributes)
-        end
-
+        new_interaction_list = HTTPInteractionList.new(new_recorded_interactions, match_requests_on)
         old_interactions = old_interactions.reject do |i|
-          new_request_matchers.include?(i.request.matcher(match_attributes))
+          new_interaction_list.has_interaction_matching?(i.request)
         end
       end
 
@@ -164,7 +145,7 @@ module VCR
     end
 
     def write_recorded_interactions_to_disk
-      return unless VCR::Config.cassette_library_dir
+      return unless VCR.configuration.cassette_library_dir
       return if new_recorded_interactions.empty?
 
       interactions = merged_interactions
@@ -178,7 +159,7 @@ module VCR
 
     def invoke_hook(type, interactions)
       interactions.delete_if do |i|
-        VCR::Config.invoke_hook(type, tag, i, self)
+        VCR.configuration.invoke_hook(type, tag, i, self)
         i.ignored?
       end
     end

data/lib/vcr/cassette/http_interaction_list.rb

@@ -0,0 +1,56 @@
+module VCR
+  class Cassette
+    class HTTPInteractionList
+      class NullList
+        def response_for(*a); nil; end
+        def has_interaction_matching?(*a); false; end
+      end
+
+      attr_reader :interactions, :request_matchers, :allow_playback_repeats, :parent_list
+
+      def initialize(interactions, request_matchers, allow_playback_repeats = false, parent_list = NullList.new)
+        @interactions           = interactions.dup
+        @request_matchers       = request_matchers
+        @allow_playback_repeats = allow_playback_repeats
+        @parent_list            = parent_list
+        @used_interactions      = []
+      end
+
+      def response_for(request)
+        if index = matching_interaction_index_for(request)
+          interaction = @interactions.delete_at(index)
+          @used_interactions.unshift interaction
+          interaction.response
+        elsif interaction = matching_used_interaction_for(request)
+          interaction.response
+        else
+          @parent_list.response_for(request)
+        end
+      end
+
+      def has_interaction_matching?(request)
+        !!matching_interaction_index_for(request) ||
+        !!matching_used_interaction_for(request) ||
+        @parent_list.has_interaction_matching?(request)
+      end
+
+    private
+
+      def matching_interaction_index_for(request)
+        @interactions.index { |i| interaction_matches_request?(request, i) }
+      end
+
+      def matching_used_interaction_for(request)
+        return nil unless @allow_playback_repeats
+        @used_interactions.find { |i| interaction_matches_request?(request, i) }
+      end
+
+      def interaction_matches_request?(request, interaction)
+        @request_matchers.all? do |matcher|
+          VCR.request_matchers[matcher].matches?(request, interaction.request)
+        end
+      end
+    end
+  end
+end
+