vcr 1.5.1 → 1.6.0

data/CHANGELOG.md

@@ -2,7 +2,17 @@
 
 ## In git
 
-[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.5.1...master)
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.6.0...master)
+
+## 1.6.0 (February 3, 2011)
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v1.5.1...v1.6.0)
+
+* Add new `ignore_hosts` configuration option that allows you to ignore
+  any host (not just localhost aliases, as the `ignore_localhost` option
+  works).  Feature suggested by [Claudio Poli](https://github.com/masterkain).
+* Upgraded to the latest Typhoeus (0.2.1).
+* General code clean up and refactoring.
 
 ## 1.5.1 (January 12, 2011)
 

data/Gemfile

@@ -7,7 +7,7 @@ group :development do
     gem 'patron',           '~> 0.4.6'
     gem 'em-http-request',  '~> 0.2.7'
     gem 'curb',             '~> 0.7.8'
-    gem 'typhoeus',         '~> 0.2.0'
+    gem 'typhoeus',         '~> 0.2.1'
   end
 
   platforms :jruby do

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vcr (1.5.1)
+    vcr (1.6.0)
 
 GEM
   remote: http://rubygems.org/
@@ -113,7 +113,8 @@ GEM
     thor (0.14.6)
     tilt (1.1)
     timecop (0.3.5)
-    typhoeus (0.2.0)
+    typhoeus (0.2.1)
+      mime-types
     webmock (1.6.2)
       addressable (>= 2.2.2)
       crack (>= 0.1.7)
@@ -149,6 +150,6 @@ DEPENDENCIES
   shoulda (~> 2.9.2)
   sinatra (~> 1.1.0)
   timecop (~> 0.3.5)
-  typhoeus (~> 0.2.0)
+  typhoeus (~> 0.2.1)
   vcr!
   webmock (~> 1.6.0)

data/benchmarks/http_stubbing_libraries.rb

@@ -50,10 +50,10 @@ end
 # Output on my machine:
 #
 # Benchmarking Single setup/teardown:
-# webmock  0.000000   0.000000   8.500000 (  8.559143)
-# fakeweb  0.000000   0.000000   1.900000 (  1.967160)
+# 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   9.710000 (  9.764760)
-# fakeweb  0.000000   0.000000   2.470000 (  2.479292)
+# webmock  0.000000   0.000000   7.970000 (  7.981383)
+# fakeweb  0.000000   0.000000   2.210000 (  2.203478)

data/features/.nav

@@ -12,6 +12,7 @@
   - cassette_library_dir.feature
   - stub_with.feature
   - default_cassette_options.feature
+  - ignore_hosts.feature
   - ignore_localhost.feature
   - hooks.feature
   - allow_http_connections_when_no_cassette.feature

data/features/configuration/ignore_hosts.feature

@@ -0,0 +1,61 @@
+Feature: ignore_hosts
+
+  The `ignore_hosts` configuration option can be used to prevent VCR
+  from having any affect on requests to particular hosts.
+  Requests to ignored hosts will not be recorded and will always be
+  allowed, regardless of the record mode, and even outside of a
+  `VCR.use_cassette` block.
+
+  If you only want to ignore localhost (and its various aliases) you
+  may want to use the `ignore_localhost` option instead.
+
+  Background:
+    Given a file named "sinatra_app.rb" with:
+      """
+      require 'vcr_cucumber_helpers'
+
+      response_count = 0
+      start_sinatra_app(:port => 7777) do
+        get('/') { "Response #{response_count += 1}" }
+      end
+      """
+
+  Scenario Outline: ignored host requests are not recorded and are always allowed
+    Given a file named "ignore_hosts.rb" with:
+      """
+      require 'vcr_cucumber_helpers'
+      include_http_adapter_for("<http_lib>")
+      require 'sinatra_app.rb'
+
+      require 'vcr'
+
+      VCR.config do |c|
+        c.ignore_hosts '127.0.0.1', 'localhost'
+        c.cassette_library_dir = 'cassettes'
+        c.stub_with <stub_with>
+      end
+
+      VCR.use_cassette('example', :record => :new_episodes) do
+        puts response_body_for(:get, "http://localhost:7777/")
+      end
+
+      puts response_body_for(:get, "http://localhost:7777/")
+      """
+    When I run "ruby ignore_hosts.rb"
+    Then it should pass with:
+      """
+      Response 1
+      Response 2
+      """
+    And the file "cassettes/example.yml" should not exist
+
+    Examples:
+      | stub_with  | http_lib        |
+      | :fakeweb   | net/http        |
+      | :webmock   | net/http        |
+      | :webmock   | httpclient      |
+      | :webmock   | patron          |
+      | :webmock   | curb            |
+      | :webmock   | em-http-request |
+      | :typhoeus  | typhoeus        |
+

data/features/http_libraries/net_http.feature

@@ -135,3 +135,37 @@ Feature: Net::HTTP
       | stub_with |
       | :fakeweb  |
       | :webmock  |
+
+    Scenario Outline: Make an HTTPS request
+      Given a file named "vcr_https.rb" with:
+        """
+        require 'vcr'
+
+        VCR.config do |c|
+          c.stub_with <stub_with>
+          c.cassette_library_dir = 'cassettes'
+        end
+
+        uri = URI("https://gist.github.com/raw/fb555cb593f3349d53af/6921dd638337d3f6a51b0e02e7f30e3c414f70d6/vcr_gist")
+
+        VCR.use_cassette('https', :record => :new_episodes) do
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          response = http.request_get(uri.path)
+
+          puts response.body
+        end
+        """
+      When I run "ruby vcr_https.rb"
+      Then the output should contain "VCR gist"
+      And the file "cassettes/https.yml" should contain "body: VCR gist"
+
+      When I modify the file "cassettes/https.yml" to replace "body: VCR gist" with "body: HTTPS replaying works"
+      And I run "ruby vcr_https.rb"
+      Then the output should contain "HTTPS replaying works"
+
+      Examples:
+        | stub_with |
+        | :fakeweb  |
+        | :webmock  |

data/features/step_definitions/cli_steps.rb

@@ -1,4 +1,4 @@
-require 'vcr/structs'
+require 'vcr'
 
 module VCRHelpers
   YAML_REGEX_FOR_1_9_1 = Regexp.union(*[
@@ -36,6 +36,17 @@ module VCRHelpers
 
     structs
   end
+
+  def modify_file(file_name, orig_text, new_text)
+    in_current_dir do
+      file = File.read(file_name)
+      regex = /#{Regexp.escape(orig_text)}/
+      file.should =~ regex
+
+      file = file.gsub(regex, new_text)
+      File.open(file_name, 'w') { |f| f.write(file) }
+    end
+  end
 end
 World(VCRHelpers)
 
@@ -55,6 +66,10 @@ Given /^(\d+) days have passed since the cassette was recorded$/ do |day_count|
   set_env('DAYS_PASSED', day_count)
 end
 
+When /^I modify the file "([^"]*)" to replace "([^"]*)" with "([^"]*)"$/ do |file_name, orig_text, new_text|
+  modify_file(file_name, orig_text, new_text)
+end
+
 Then /^the file "([^"]*)" should exist$/ do |file_name|
   check_file_presence([file_name], true)
 end

data/lib/vcr.rb

@@ -2,10 +2,19 @@ require 'vcr/cassette'
 require 'vcr/config'
 require 'vcr/deprecations'
 require 'vcr/request_matcher'
-require 'vcr/structs'
+require 'vcr/util/regexes'
 require 'vcr/version'
 require 'vcr/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
   extend self
 
@@ -65,7 +74,7 @@ module VCR
     yield VCR::Config
     http_stubbing_adapter.check_version!
     http_stubbing_adapter.set_http_connections_allowed_to_default
-    http_stubbing_adapter.ignore_localhost = VCR::Config.ignore_localhost?
+    http_stubbing_adapter.ignored_hosts = VCR::Config.ignored_hosts
   end
 
   def cucumber_tags(&block)
@@ -79,16 +88,7 @@ module VCR
         raise ArgumentError.new("You have configured VCR to use both :fakeweb and :webmock.  You cannot use both.")
       end
 
-      adapters = VCR::Config.http_stubbing_libraries.map do |lib|
-        case lib
-          when :fakeweb;  HttpStubbingAdapters::FakeWeb
-          when :webmock;  HttpStubbingAdapters::WebMock
-          when :typhoeus; HttpStubbingAdapters::Typhoeus
-          when :faraday;  HttpStubbingAdapters::Faraday
-          else raise ArgumentError.new("#{lib.inspect} is not a supported HTTP stubbing library.")
-        end
-      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?
       HttpStubbingAdapters::MultiObjectProxy.for(*adapters)
     end
@@ -96,8 +96,7 @@ module VCR
 
   def record_http_interaction(interaction)
     return unless cassette = current_cassette
-    return if http_stubbing_adapter.ignore_localhost? &&
-      LOCALHOST_ALIASES.include?(URI.parse(interaction.uri).host)
+    return if VCR::Config.uri_should_be_ignored?(interaction.uri)
 
     cassette.record_http_interaction(interaction)
   end
@@ -132,6 +131,16 @@ module VCR
 
   private
 
+  def adapter_for(lib)
+    case lib
+      when :fakeweb;  HttpStubbingAdapters::FakeWeb
+      when :webmock;  HttpStubbingAdapters::WebMock
+      when :typhoeus; HttpStubbingAdapters::Typhoeus
+      when :faraday;  HttpStubbingAdapters::Faraday
+      else raise ArgumentError.new("#{lib.inspect} is not a supported HTTP stubbing library.")
+    end
+  end
+
   def cassettes
     @cassettes ||= []
   end

data/lib/vcr/cassette.rb

@@ -104,10 +104,8 @@ module VCR
           interactions = YAML.load(raw_yaml_content)
           invoke_hook(:before_playback, interactions)
 
-          if VCR.http_stubbing_adapter.ignore_localhost?
-            interactions.reject! do |i|
-              i.uri.is_a?(String) && VCR::LOCALHOST_ALIASES.include?(URI.parse(i.uri).host)
-            end
+          interactions.reject! do |i|
+            i.request.uri.is_a?(String) && VCR::Config.uri_should_be_ignored?(i.request.uri)
           end
 
           recorded_interactions.replace(interactions)

data/lib/vcr/config.rb

@@ -30,13 +30,22 @@ module VCR
       @http_stubbing_libraries ||= []
     end
 
-    def ignore_localhost=(value)
-      @ignore_localhost = value
-      VCR.http_stubbing_adapter.ignore_localhost = value if http_stubbing_libraries.any?
+    def ignore_hosts(*hosts)
+      ignored_hosts.push(*hosts).uniq!
+      VCR.http_stubbing_adapter.ignored_hosts = ignored_hosts if http_stubbing_libraries.any?
+    end
+    alias ignore_host ignore_hosts
+
+    def ignored_hosts
+      @ignored_hosts ||= []
     end
 
-    def ignore_localhost?
-      @ignore_localhost
+    def ignore_localhost=(value)
+      if value
+        ignore_hosts *VCR::LOCALHOST_ALIASES
+      else
+        ignored_hosts.reject! { |h| VCR::LOCALHOST_ALIASES.include?(h) }
+      end
     end
 
     def allow_http_connections_when_no_cassette=(value)
@@ -47,5 +56,11 @@ module VCR
     def allow_http_connections_when_no_cassette?
       !!@allow_http_connections_when_no_cassette
     end
+
+    def uri_should_be_ignored?(uri)
+      uri = URI.parse(uri) unless uri.respond_to?(:host)
+      ignored_hosts.include?(uri.host)
+    end
   end
 end
+

data/lib/vcr/deprecations.rb

@@ -1,22 +1,33 @@
 module VCR
-  module Config
-    class << self
-      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
+  module HttpStubbingAdapters
+    module Common
+      def ignore_localhost?
+        VCR::Config.ignore_localhost?
       end
+    end
+  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
+  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
 
   class Cassette
     def allow_real_http_requests_to?(uri)
       warn "WARNING: VCR::Cassette#allow_real_http_requests_to? is deprecated and should no longer be used."
-      VCR.http_stubbing_adapter.ignore_localhost? && VCR::LOCALHOST_ALIASES.include?(uri.host)
+      VCR::Config.uri_should_be_ignored?(uri.to_s)
     end
 
     private
@@ -24,8 +35,9 @@ module VCR
     def deprecate_old_cassette_options(options)
       message = "VCR's :allow_real_http cassette option is deprecated.  Instead, use the ignore_localhost configuration option."
       if options[:allow_real_http] == :localhost
-        @original_ignore_localhost = VCR.http_stubbing_adapter.ignore_localhost?
-        VCR.http_stubbing_adapter.ignore_localhost = true
+        @original_ignored_hosts = VCR::Config.ignored_hosts.dup
+        VCR::Config.ignored_hosts.clear
+        VCR::Config.ignore_hosts *VCR::LOCALHOST_ALIASES
         Kernel.warn "WARNING: #{message}"
       elsif options[:allow_real_http]
         raise ArgumentError.new(message)
@@ -33,8 +45,9 @@ module VCR
     end
 
     def restore_ignore_localhost_for_deprecation
-      if defined?(@original_ignore_localhost)
-        VCR.http_stubbing_adapter.ignore_localhost = @original_ignore_localhost
+      if defined?(@original_ignored_hosts)
+        VCR::Config.ignored_hosts.clear
+        VCR::Config.ignore_hosts *@original_ignored_hosts
       end
     end
   end

data/lib/vcr/http_stubbing_adapters/fakeweb.rb

@@ -8,7 +8,6 @@ module VCR
       extend self
 
       UNSUPPORTED_REQUEST_MATCH_ATTRIBUTES = [:body, :headers]
-      LOCALHOST_REGEX = %r|\Ahttps?://((\w+:)?\w+@)?(#{VCR::LOCALHOST_ALIASES.map { |a| Regexp.escape(a) }.join('|')})(:\d+)?/|i
 
       MINIMUM_VERSION = '1.3.0'
       MAXIMUM_VERSION = '1.3'
@@ -22,15 +21,11 @@ module VCR
         !!::FakeWeb.allow_net_connect?("http://some.url/besides/localhost")
       end
 
-      def ignore_localhost=(value)
-        @ignore_localhost = value
+      def ignored_hosts=(hosts)
+        @ignored_hosts = hosts
         update_fakeweb_allow_net_connect
       end
 
-      def ignore_localhost?
-        !!@ignore_localhost
-      end
-
       def stub_requests(http_interactions, match_attributes)
         validate_match_attributes(match_attributes)
 
@@ -62,6 +57,10 @@ module VCR
 
       private
 
+      def ignored_hosts
+        @ignored_hosts ||= []
+      end
+
       def version
         ::FakeWeb::VERSION
       end
@@ -69,8 +68,8 @@ module VCR
       def update_fakeweb_allow_net_connect
         ::FakeWeb.allow_net_connect = if @http_connections_allowed
           true
-        elsif @ignore_localhost
-          LOCALHOST_REGEX
+        elsif ignored_hosts.any?
+          VCR::Regexes.url_regex_for_hosts(ignored_hosts)
         else
           false
         end
@@ -93,6 +92,12 @@ 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