vcr 1.6.0 → 1.7.0

data/lib/vcr/deprecations/config.rb

@@ -0,0 +1,18 @@
+module VCR
+  module Config
+    def http_stubbing_library
+      warn "WARNING: `VCR::Config.http_stubbing_library` is deprecated.  Use `VCR::Config.http_stubbing_libraries` instead."
+      @http_stubbing_libraries && @http_stubbing_libraries.first
+    end
+
+    def http_stubbing_library=(library)
+      warn "WARNING: `VCR::Config.http_stubbing_library = #{library.inspect}` is deprecated.  Use `VCR::Config.stub_with #{library.inspect}` instead."
+      stub_with library
+    end
+
+    def ignore_localhost?
+      warn "WARNING: `VCR::Config.ignore_localhost?` is deprecated.  Check the list of ignored hosts using `VCR::Config.ignored_hosts` instead."
+      (VCR::LOCALHOST_ALIASES - ignored_hosts).empty?
+    end
+  end
+end

data/lib/vcr/deprecations/http_stubbing_adapters/common.rb

@@ -0,0 +1,9 @@
+module VCR
+  module HttpStubbingAdapters
+    module Common
+      def ignore_localhost?
+        VCR::Config.ignore_localhost?
+      end
+    end
+  end
+end

data/lib/vcr/deprecations/http_stubbing_adapters/fakeweb.rb

@@ -0,0 +1,11 @@
+module VCR
+  module HttpStubbingAdapters
+    module FakeWeb
+      def self.const_missing(const)
+        return super unless const == :LOCALHOST_REGEX
+        warn "WARNING: `VCR::HttpStubbingAdapters::FakeWeb::LOCALHOST_REGEX` is deprecated."
+        VCR::Regexes.url_regex_for_hosts(VCR::LOCALHOST_ALIASES)
+      end
+    end
+  end
+end

data/lib/vcr/http_stubbing_adapters/common.rb

@@ -30,7 +30,7 @@ module VCR
       end
 
       RECORDING_INSTRUCTIONS = "You can use VCR to automatically record this request and replay it later.  " +
-                               "For more details, visit the VCR wiki at: http://github.com/myronmarston/vcr/wiki"
+                               "For more details, visit the VCR documentation at: http://relishapp.com/myronmarston/vcr/v/#{VCR.version.gsub('.', '-')}"
 
       def enabled?
         [nil, self].include? VCR::HttpStubbingAdapters::Common.exclusively_enabled_adapter

data/lib/vcr/http_stubbing_adapters/fakeweb.rb

@@ -1,4 +1,5 @@
 require 'fakeweb'
+require 'vcr/deprecations/http_stubbing_adapters/fakeweb'
 require 'vcr/extensions/net_http'
 
 module VCR
@@ -80,7 +81,7 @@ module VCR
       end
 
       def response_hash(response)
-        response.headers.merge(
+        (response.headers || {}).merge(
           :body   => response.body,
           :status => [response.status.code.to_s, response.status.message]
         )
@@ -92,12 +93,6 @@ module VCR
           raise UnsupportedRequestMatchAttributeError.new("FakeWeb does not support matching requests on #{invalid_attributes.join(' or ')}")
         end
       end
-
-      def self.const_missing(const)
-        return super unless const == :LOCALHOST_REGEX
-        warn "WARNING: `VCR::HttpStubbingAdapters::FakeWeb::LOCALHOST_REGEX` is deprecated."
-        VCR::Regexes.url_regex_for_hosts(VCR::LOCALHOST_ALIASES)
-      end
     end
   end
 end

data/lib/vcr/http_stubbing_adapters/multi_object_proxy.rb

@@ -1,6 +1,6 @@
 module VCR
   module HttpStubbingAdapters
-    class MultiObjectProxy < defined?(::BasicObject) ? ::BasicObject : VCR::BasicObject
+    class MultiObjectProxy < VCR::BasicObject
 
       def self.for(*objects)
         return objects.first if objects.size == 1

data/lib/vcr/middleware/common.rb

@@ -1,6 +1,8 @@
 module VCR
   module Middleware
     module Common
+      include VCR::VariableArgsBlockCaller
+
       def initialize(app, &block)
         raise ArgumentError.new("You must provide a block to set the cassette options") unless block
         @app, @cassette_arguments_block = app, block
@@ -10,11 +12,7 @@ module VCR
 
         def cassette_arguments(env)
           arguments = CassetteArguments.new
-
-          block_args = [arguments]
-          block_args << env unless @cassette_arguments_block.arity == 1
-
-          @cassette_arguments_block.call(*block_args)
+          call_block(@cassette_arguments_block, arguments, env)
           [arguments.name, arguments.options]
         end
     end

data/lib/vcr/rspec.rb

@@ -1,39 +1,2 @@
 require 'vcr'
-
-module VCR
-  module RSpec
-    module Macros
-      def use_vcr_cassette(*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        name    = args.first || infer_cassette_name
-
-        before(:each) do
-          VCR.insert_cassette(name, options)
-        end
-
-        after(:each) do
-          VCR.eject_cassette
-        end
-      end
-
-      private
-
-      def infer_cassette_name
-        # RSpec 1 exposes #description_parts; use that if its available
-        return description_parts.join("/") if respond_to?(:description_parts)
-
-        # Otherwise use RSpec 2 metadata...
-        group_descriptions = []
-        klass = self
-
-        while klass.respond_to?(:metadata) && klass.metadata
-          group_descriptions << klass.metadata[:example_group][:description]
-          klass = klass.superclass
-        end
-
-        group_descriptions.compact.reverse.join('/')
-      end
-    end
-  end
-end
-
+warn "`require 'vcr/rspec'` is deprecated.  You no longer need to require this file--just require 'vcr'."

data/lib/vcr/structs/http_interaction.rb

@@ -12,5 +12,34 @@ module VCR
     def ignored?
       @ignored
     end
+
+    def filter!(text, replacement_text)
+      return self if [text, replacement_text].any? { |t| t.to_s.empty? }
+      filter_object!(self, text, replacement_text)
+    end
+
+    private
+
+      def filter_object!(object, text, replacement_text)
+        if object.respond_to?(:gsub)
+          object.gsub!(text, replacement_text) if object.include?(text)
+        elsif Hash === object
+          filter_hash!(object, text, replacement_text)
+        elsif object.respond_to?(:each)
+          # This handles nested arrays and structs
+          object.each { |o| filter_object!(o, text, replacement_text) }
+        end
+
+        object
+      end
+
+      def filter_hash!(hash, text, replacement_text)
+        filter_object!(hash.values, text, replacement_text)
+
+        hash.keys.each do |k|
+          new_key = filter_object!(k.dup, text, replacement_text)
+          hash[new_key] = hash.delete(k) unless k == new_key
+        end
+      end
   end
 end

data/lib/vcr/structs/request.rb

@@ -13,6 +13,12 @@ module VCR
       )
     end
 
+    @@object_method = Object.instance_method(:method)
+    def method(*args)
+      return super if args.empty?
+      @@object_method.bind(self).call(*args)
+    end
+
     def matcher(match_attributes)
       RequestMatcher.new(self, match_attributes)
     end

data/lib/vcr/structs/response.rb

@@ -11,6 +11,10 @@ module VCR
         response.http_version
       )
     end
+
+    def update_content_length_header
+      headers['content-length'] &&= [body.length.to_s]
+    end
   end
 end
 

data/lib/vcr/{cucumber_tags.rb → test_frameworks/cucumber.rb}

@@ -21,8 +21,16 @@ module VCR
         tag_name = "@#{tag_name}" unless tag_name =~ /^@/
         cassette_name = "cucumber_tags/#{tag_name.gsub(/\A@/, '')}"
 
-        @main_object.Around(tag_name) do |scenario, block|
-          VCR.use_cassette(cassette_name, options, &block)
+        # It would be nice to use an Around hook here, but
+        # cucumber has a bug: background steps do not run
+        # within an around hook.
+        # https://gist.github.com/652968
+        @main_object.Before(tag_name) do
+          VCR.insert_cassette(cassette_name, options)
+        end
+
+        @main_object.After(tag_name) do
+          VCR.eject_cassette
         end
 
         self.class.add_tag(tag_name)

data/lib/vcr/test_frameworks/rspec.rb

@@ -0,0 +1,37 @@
+module VCR
+  module RSpec
+    module Macros
+      def use_vcr_cassette(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        name    = args.first || infer_cassette_name
+
+        before(:each) do
+          VCR.insert_cassette(name, options)
+        end
+
+        after(:each) do
+          VCR.eject_cassette
+        end
+      end
+
+      private
+
+      def infer_cassette_name
+        # RSpec 1 exposes #description_parts; use that if its available
+        return description_parts.join("/") if respond_to?(:description_parts)
+
+        # Otherwise use RSpec 2 metadata...
+        group_descriptions = []
+        klass = self
+
+        while klass.respond_to?(:metadata) && klass.metadata
+          group_descriptions << klass.metadata[:example_group][:description]
+          klass = klass.superclass
+        end
+
+        group_descriptions.compact.reverse.join('/')
+      end
+    end
+  end
+end
+

data/lib/vcr/util/basic_object.rb

@@ -1,35 +1,39 @@
 module VCR
-  # taken directly from backports:
-  # https://github.com/marcandre/backports/blob/v1.18.2/lib/backports/basic_object.rb
-  class BasicObject
-    KEEP = [:instance_eval, :instance_exec, :__send__,
-            "instance_eval", "instance_exec", "__send__"]
-    # undefine almost all instance methods
-    begin
-      old_verbose, $VERBOSE = $VERBOSE, nil # silence the warning for undefining __id__
-      (instance_methods - KEEP).each do |method|
-        undef_method method
+  if defined?(::BasicObject)
+    BasicObject = ::BasicObject
+  else
+    # taken directly from backports:
+    # https://github.com/marcandre/backports/blob/v1.18.2/lib/backports/basic_object.rb
+    class BasicObject
+      KEEP = [:instance_eval, :instance_exec, :__send__,
+              "instance_eval", "instance_exec", "__send__"]
+      # undefine almost all instance methods
+      begin
+        old_verbose, $VERBOSE = $VERBOSE, nil # silence the warning for undefining __id__
+        (instance_methods - KEEP).each do |method|
+          undef_method method
+        end
+      ensure
+        $VERBOSE = old_verbose
       end
-    ensure
-      $VERBOSE = old_verbose
-    end
 
-    class << self
-      def === (cmp)
-        true
-      end
+      class << self
+        def === (cmp)
+          true
+        end
 
-      # Let's try to keep things clean, in case methods have been added to Object
-      # either directly or through an included module.
-      # We'll do this whenever a class is derived from BasicObject
-      # Ideally, we'd do this by trapping Object.method_added
-      # and M.method_added for any module M included in Object or a submodule
-      # Seems really though to get right, but pull requests welcome ;-)
-      def inherited(sub)
-        BasicObject.class_eval do
-          (instance_methods - KEEP).each do |method|
-            if Object.method_defined?(method) && instance_method(method).owner == Object.instance_method(method).owner
-              undef_method method
+        # Let's try to keep things clean, in case methods have been added to Object
+        # either directly or through an included module.
+        # We'll do this whenever a class is derived from BasicObject
+        # Ideally, we'd do this by trapping Object.method_added
+        # and M.method_added for any module M included in Object or a submodule
+        # Seems really though to get right, but pull requests welcome ;-)
+        def inherited(sub)
+          BasicObject.class_eval do
+            (instance_methods - KEEP).each do |method|
+              if Object.method_defined?(method) && instance_method(method).owner == Object.instance_method(method).owner
+                undef_method method
+              end
             end
           end
         end

data/lib/vcr/{hooks.rb → util/hooks.rb}

@@ -1,8 +1,10 @@
 module VCR
   module Hooks
+    include VariableArgsBlockCaller
+
     def invoke_hook(hook, tag, *args)
       hooks_for(hook, tag).each do |callback|
-        callback.call(*args_for_callback(args, callback))
+        call_block(callback, *args)
       end
     end
 
@@ -36,10 +38,5 @@ module VCR
         hooks += for_hook[nil] unless tag.nil? # untagged hooks
         hooks
       end
-
-      def args_for_callback(args, callback)
-        return args if callback.arity < 0
-        args.first([args.size, callback.arity].min)
-      end
   end
 end

data/lib/vcr/util/internet_connection.rb

@@ -7,7 +7,7 @@ module VCR
     EXAMPLE_HOST = "example.com"
 
     def available?
-      @available = Ping.pingecho(EXAMPLE_HOST, 1, 80) unless defined?(@available)
+      @available = VCR::Ping.pingecho(EXAMPLE_HOST, 1, 80) unless defined?(@available)
       @available
     end
   end

data/lib/vcr/util/ping.rb

@@ -1,26 +1,30 @@
 # Ruby 1.8 provides Ping.pingecho, but it was removed in 1.9.
 # So we try requiring it, and if that fails, define it ourselves.
-begin
-  require 'ping'
-rescue LoadError
-  # This is copied, verbatim, from Ruby 1.8.7's ping.rb.
-  require 'timeout'
-  require "socket"
 
-  module Ping
-    def pingecho(host, timeout=5, service="echo")
-      begin
-        timeout(timeout) do
-          s = TCPSocket.new(host, service)
-          s.close
+module VCR
+  begin
+    require 'ping'
+    Ping = ::Ping
+  rescue LoadError
+    # This is copied, verbatim, from Ruby 1.8.7's ping.rb.
+    require 'timeout'
+    require "socket"
+
+    module Ping
+      def pingecho(host, timeout=5, service="echo")
+        begin
+          timeout(timeout) do
+            s = TCPSocket.new(host, service)
+            s.close
+          end
+        rescue Errno::ECONNREFUSED
+          return true
+        rescue Timeout::Error, StandardError
+          return false
         end
-      rescue Errno::ECONNREFUSED
         return true
-      rescue Timeout::Error, StandardError
-        return false
       end
-      return true
+      module_function :pingecho
     end
-    module_function :pingecho
   end
 end

data/lib/vcr/util/variable_args_block_caller.rb

@@ -0,0 +1,12 @@
+module VCR
+  module VariableArgsBlockCaller
+    def call_block(block, *args)
+      if block.arity >= 0
+        args = args.first([args.size, block.arity].min)
+      end
+
+      block.call(*args)
+    end
+  end
+end
+

data/lib/vcr/util/yaml.rb

@@ -0,0 +1,11 @@
+require 'yaml'
+
+module VCR
+  # Attempt to use psych if it is available.
+  YAML = begin
+    require 'psych'
+    Psych
+  rescue LoadError
+    ::YAML
+  end
+end