vcr 1.5.1 → 1.6.0

data/spec/support/http_library_adapters.rb

@@ -340,7 +340,7 @@ module HttpLibrarySpecs
       end
 
       [true, false].each do |http_allowed|
-        context "when #http_connections_allowed is set to #{http_allowed}" do
+        context "when http_connections_allowed is set to #{http_allowed}" do
           before(:each) { subject.http_connections_allowed = http_allowed }
 
           it "returns #{http_allowed} for #http_connections_allowed?" do
@@ -350,25 +350,24 @@ module HttpLibrarySpecs
           test_real_http_request(http_allowed, *other)
 
           unless http_allowed
-            describe '.ignore_localhost =' do
-              localhost_response = "Localhost response"
+            localhost_response = "Localhost response"
+
+            describe '.ignore_hosts' do
               let(:record_mode) { :none }
 
-              VCR::LOCALHOST_ALIASES.each do |localhost_alias|
-                describe 'when set to true' do
-                  before(:each) { subject.ignore_localhost = true }
+              context 'when set to ["127.0.0.1", "localhost"]' do
+                before(:each) do
+                  subject.ignored_hosts = ["127.0.0.1", "localhost"]
+                end
 
+                %w[ 127.0.0.1 localhost ].each do |localhost_alias|
                   it "allows requests to #{localhost_alias}" do
                     get_body_string(make_http_request(:get, "http://#{localhost_alias}:#{VCR::SinatraApp.port}/localhost_test")).should == localhost_response
                   end
                 end
 
-                describe 'when set to false' do
-                  before(:each) { subject.ignore_localhost = false }
-
-                  it "does not allow requests to #{localhost_alias}" do
-                    expect { make_http_request(:get, "http://#{localhost_alias}:#{VCR::SinatraApp.port}/localhost_test") }.to raise_error(NET_CONNECT_NOT_ALLOWED_ERROR)
-                  end
+                it 'does not allow requests to 0.0.0.0' do
+                  expect { make_http_request(:get, "http://0.0.0.0:#{VCR::SinatraApp.port}/localhost_test") }.to raise_error(NET_CONNECT_NOT_ALLOWED_ERROR)
                 end
               end
             end

data/spec/support/http_stubbing_adapter.rb

@@ -3,20 +3,6 @@ shared_examples_for "an http stubbing adapter" do |supported_http_libraries, sup
   before(:each) { VCR.stub!(:http_stubbing_adapter).and_return(subject) }
   subject { described_class }
 
-  describe '.ignore_localhost?' do
-    [true, false].each do |val|
-      it "returns #{val} when ignore_localhost is set to #{val}" do
-        subject.ignore_localhost = val
-        subject.ignore_localhost?.should == val
-      end
-    end
-
-    it "returns false when ignore_localhost is set to nil" do
-      subject.ignore_localhost = nil
-      subject.ignore_localhost?.should == false
-    end
-  end
-
   describe '.set_http_connections_allowed_to_default' do
     [true, false].each do |default|
       context "when VCR::Config.allow_http_connections_when_no_cassette is #{default}" do
@@ -59,7 +45,7 @@ shared_examples_for "an http stubbing adapter" do |supported_http_libraries, sup
   end
 
   if other.include?(:needs_net_http_extension)
-    describe '#request_uri' do
+    describe '.request_uri' do
       it 'returns the uri for the given http request' do
         net_http = Net::HTTP.new('example.com', 80)
         request = Net::HTTP::Get.new('/foo/bar')
@@ -74,7 +60,7 @@ shared_examples_for "an http stubbing adapter" do |supported_http_libraries, sup
       end
     end
 
-    describe '#request_stubbed? using specific match_attributes' do
+    describe '.request_stubbed? using specific match_attributes' do
       let(:interactions) { YAML.load(File.read(File.join(File.dirname(__FILE__), '..', 'fixtures', YAML_SERIALIZATION_VERSION, 'match_requests_on.yml'))) }
 
       @supported_request_match_attributes = supported_request_match_attributes

data/spec/support/normalizers.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+shared_examples_for "header normalization" do
+  let(:instance) do
+    with_headers('Some_Header' => 'value1', 'aNother' => ['a', 'b'], 'third' => [], 'fourth' => nil)
+  end
+
+  it 'normalizes the hash to lower case keys and arrays of values' do
+    instance.headers['some_header'].should == ['value1']
+    instance.headers['another'].should == ['a', 'b']
+  end
+
+  it 'removes empty headers' do
+    instance.headers.should_not have_key('third')
+    instance.headers.should_not have_key('fourth')
+  end
+
+  it 'filters out unimportant default values set by the HTTP library' do
+    instance = with_headers('accept' => ['*/*'], 'connection' => 'close', 'http-user' => ['foo'], 'expect' => ['', 'bar'])
+    instance.headers.should == { 'http-user' => ['foo'], 'expect' => ['bar'] }
+  end
+
+  it 'sets empty hash header to nil' do
+    with_headers({}).headers.should be_nil
+  end
+
+  it 'ensures header keys are serialized to yaml as raw strings' do
+    key = 'my-key'
+    key.instance_variable_set(:@foo, 7)
+    instance = with_headers(key => ['value1'])
+    instance.headers.to_yaml.should == { 'my-key' => ['value1'] }.to_yaml
+  end
+
+  it 'ensures header values are serialized to yaml as raw strings' do
+    value = 'my-value'
+    value.instance_variable_set(:@foo, 7)
+    instance = with_headers('my-key' => [value])
+    instance.headers.to_yaml.should == { 'my-key' => ['my-value'] }.to_yaml
+  end
+end
+
+shared_examples_for "body normalization" do
+  it 'sets empty string to nil' do
+    instance('').body.should be_nil
+  end
+
+  it "ensures the body is serialized to yaml as a raw string" do
+    body = "My String"
+    body.instance_variable_set(:@foo, 7)
+    instance(body).body.to_yaml.should == "My String".to_yaml
+  end
+end
+
+shared_examples_for 'uri normalization' do
+  it 'adds port 80 to an http URI that lacks a port' do
+    instance('http://example.com/foo').uri.should == 'http://example.com:80/foo'
+  end
+
+  it 'keeps the existing port for an http URI' do
+    instance('http://example.com:8000/foo').uri.should == 'http://example.com:8000/foo'
+  end
+
+  it 'adds port 443 to an https URI that lacks a port' do
+    instance('https://example.com/foo').uri.should == 'https://example.com:443/foo'
+  end
+
+  it 'keeps the existing port for an https URI' do
+    instance('https://example.com:8000/foo').uri.should == 'https://example.com:8000/foo'
+  end
+end
+
+shared_examples_for 'status message normalization' do
+  it 'chomps leading and trailing spaces on the status message' do
+    instance(' OK ').message.should == 'OK'
+  end
+
+  it 'sets status message to nil when it is the empty string' do
+    instance('').message.should be_nil
+  end
+
+  it 'sets status message to nil when it is a blank string' do
+    instance('  ').message.should be_nil
+  end
+end

data/spec/support/version_checker.rb

@@ -1,7 +1,7 @@
 shared_examples_for "version checking" do |options|
   library = described_class.library_name
 
-  describe '#check_version!' do
+  describe '.check_version!' do
     options[:valid].each do |version|
       it "does nothing when #{library}'s version is #{version}" do
         stub_version(version)

data/spec/vcr/cassette_spec.rb

@@ -49,7 +49,7 @@ describe VCR::Cassette do
     end
   end
 
-  describe 'on creation' do
+  describe '.new' do
     it 'raises an error with a helpful message when loading an old unsupported cassette' do
       VCR::Config.cassette_library_dir = "#{VCR::SPEC_ROOT}/fixtures/#{YAML_SERIALIZATION_VERSION}"
       expect { VCR::Cassette.new('0_3_1_cassette') }.to raise_error(/The VCR cassette 0_3_1_cassette.yml uses an old format that is now deprecated/)
@@ -181,16 +181,14 @@ describe VCR::Cassette do
           VCR::Cassette.new(:name, :record => record_mode)
         end
 
-        [true, false].each do |ignore_localhost|
-          expected_uri_hosts = %w(example.com)
-          expected_uri_hosts += VCR::LOCALHOST_ALIASES unless ignore_localhost
-
-          it "#{ ignore_localhost ? 'does not load' : 'loads' } localhost interactions from the cassette file when http_stubbing_adapter.ignore_localhost is set to #{ignore_localhost}" do
-            VCR.http_stubbing_adapter.stub!(:ignore_localhost?).and_return(ignore_localhost)
-            VCR::Config.cassette_library_dir = "#{VCR::SPEC_ROOT}/fixtures/#{YAML_SERIALIZATION_VERSION}/cassette_spec"
-            cassette = VCR::Cassette.new('with_localhost_requests', :record => record_mode)
-            cassette.recorded_interactions.map { |i| URI.parse(i.uri).host }.should =~ expected_uri_hosts
+        it 'does not load ignored interactions' do
+          VCR::Config.stub(:uri_should_be_ignored?) do |uri|
+            uri.to_s !~ /example\.com/
           end
+
+          VCR::Config.cassette_library_dir = "#{VCR::SPEC_ROOT}/fixtures/#{YAML_SERIALIZATION_VERSION}/cassette_spec"
+          cassette = VCR::Cassette.new('with_localhost_requests', :record => record_mode)
+          cassette.recorded_interactions.map { |i| URI.parse(i.uri).host }.should == %w[example.com]
         end
 
         it "loads the recorded interactions from the library yml file" do

data/spec/vcr/config_spec.rb

@@ -6,7 +6,7 @@ describe VCR::Config do
     VCR::Config.stub(:http_stubbing_libraries).and_return([])
   end
 
-  describe '#cassette_library_dir=' do
+  describe '.cassette_library_dir=' do
     temp_dir(File.expand_path(File.dirname(__FILE__) + '/fixtures/config_spec'))
 
     it 'creates the directory if it does not exist' do
@@ -18,7 +18,7 @@ describe VCR::Config do
     end
   end
 
-  describe '#default_cassette_options' do
+  describe '.default_cassette_options' do
     it 'has a hash with some defaults even if it is set to nil' do
       VCR::Config.default_cassette_options = nil
       VCR::Config.default_cassette_options.should == { :match_requests_on => VCR::RequestMatcher::DEFAULT_MATCH_ATTRIBUTES }
@@ -47,26 +47,52 @@ describe VCR::Config do
     end
   end
 
-  describe '#ignore_localhost' do
-    it 'sets VCR.http_stubbing_adapter.ignore_localhost?' do
-      [true, false].each do |val|
-        VCR.http_stubbing_adapter.ignore_localhost = !val
-        expect {
-          VCR::Config.ignore_localhost = val
-        }.to change { VCR.http_stubbing_adapter.ignore_localhost? }.from(!val).to(val)
-      end
+  describe '.ignore_hosts' do
+    let(:stubbing_adapter) { VCR::HttpStubbingAdapters::FakeWeb }
+    before(:each) do
+      stubbing_adapter.send(:ignored_hosts).should be_empty
+      VCR.stub(:http_stubbing_adapter => stubbing_adapter)
+      VCR::Config.ignored_hosts.should be_empty
     end
 
-    it 'stores the value even when VCR.http_stubbing_adapter is not set' do
-      stub_no_http_stubbing_adapter
-      [true, false].each do |val|
-        VCR::Config.ignore_localhost = val
-        VCR::Config.ignore_localhost?.should == val
-      end
+    it 'adds the given hosts to the ignored_hosts list' do
+      VCR::Config.ignore_hosts 'example.com', 'example.net'
+      VCR::Config.ignored_hosts.should == %w[ example.com example.net ]
+      VCR::Config.ignore_host 'example.org'
+      VCR::Config.ignored_hosts.should == %w[ example.com example.net example.org ]
+    end
+
+    it 'removes duplicate hosts' do
+      VCR::Config.ignore_host 'example.com'
+      VCR::Config.ignore_host 'example.com'
+      VCR::Config.ignored_hosts.should == ['example.com']
+    end
+
+    it "updates the http_stubbing_adapter's ignored_hosts list" do
+      VCR::Config.ignore_hosts 'example.com', 'example.org'
+      stubbing_adapter.send(:ignored_hosts).should == %w[ example.com example.org ]
+    end
+  end
+
+  describe '.ignore_localhost=' do
+    before(:each) do
+      VCR::Config.ignored_hosts.should be_empty
+    end
+
+    it 'adds the localhost aliases to the ignored_hosts list when set to true' do
+      VCR::Config.ignore_host 'example.com'
+      VCR::Config.ignore_localhost = true
+      VCR::Config.ignored_hosts.should == ['example.com', *VCR::LOCALHOST_ALIASES]
+    end
+
+    it 'removes the localhost aliases from the ignored_hosts list when set to false' do
+      VCR::Config.ignore_host 'example.com', *VCR::LOCALHOST_ALIASES
+      VCR::Config.ignore_localhost = false
+      VCR::Config.ignored_hosts.should == ['example.com']
     end
   end
 
-  describe '#allow_http_connections_when_no_cassette=' do
+  describe '.allow_http_connections_when_no_cassette=' do
     [true, false].each do |val|
       it "sets the allow_http_connections_when_no_cassette to #{val} when set to #{val}" do
         VCR::Config.allow_http_connections_when_no_cassette = val
@@ -85,4 +111,24 @@ describe VCR::Config do
       VCR::Config.allow_http_connections_when_no_cassette = true
     end
   end
+
+  describe '.uri_should_be_ignored?' do
+    before(:each) { described_class.ignore_hosts 'example.com' }
+
+    it 'returns true for a string URI with a host in the ignore_hosts list' do
+      described_class.uri_should_be_ignored?("http://example.com/").should be_true
+    end
+
+    it 'returns true for a URI instance with a host in the ignore_hosts list' do
+      described_class.uri_should_be_ignored?(URI("http://example.com/")).should be_true
+    end
+
+    it 'returns false for a string URI with a host in the ignore_hosts list' do
+      described_class.uri_should_be_ignored?("http://example.net/").should be_false
+    end
+
+    it 'returns false for a URI instance with a host in the ignore_hosts list' do
+      described_class.uri_should_be_ignored?(URI("http://example.net/")).should be_false
+    end
+  end
 end

data/spec/vcr/deprecations_spec.rb

@@ -1,8 +1,58 @@
 require 'spec_helper'
 
+shared_examples_for '.ignore_localhost? deprecation' do
+  it 'returns false when no hosts are ignored' do
+    VCR::Config.ignored_hosts.should be_empty
+    described_class.ignore_localhost?.should be_false
+  end
+
+  it 'returns false when only non-local hosts are ignored' do
+    VCR::Config.ignore_hosts 'example.com'
+    described_class.ignore_localhost?.should be_false
+  end
+
+  it 'returns false when only some localhost aliases are ignored' do
+    aliases = VCR::LOCALHOST_ALIASES.dup
+    aliases.pop
+    VCR::Config.ignore_hosts *aliases
+    described_class.ignore_localhost?.should be_false
+  end
+
+  it 'returns true when all localhost aliases are ignored, even if some other hosts are ignored, too' do
+    VCR::Config.ignore_hosts 'example.com', *VCR::LOCALHOST_ALIASES
+    described_class.ignore_localhost?.should be_true
+  end
+
+  it 'prints a warning: WARNING: `VCR::Config.ignore_localhost?` is deprecated.  Check the list of ignored hosts using `VCR::Config.ignored_hosts` instead.' do
+    VCR::Config.should_receive(:warn).with(/Check the list of ignored hosts using `VCR::Config.ignored_hosts` instead/)
+    described_class.ignore_localhost?
+  end
+end
+
 describe 'Deprecations' do
   disable_warnings
 
+  VCR::HttpStubbingAdapters::Common.adapters.each do |adapter|
+    describe adapter do
+      it_behaves_like '.ignore_localhost? deprecation'
+    end
+  end
+
+  describe VCR::HttpStubbingAdapters::FakeWeb do
+    describe 'LOCALHOST_REGEX constant' do
+      subject { described_class::LOCALHOST_REGEX }
+
+      it 'refers to the expected regex' do
+        should == %r|\Ahttps?://((\w+:)?\w+@)?(#{VCR::LOCALHOST_ALIASES.sort.map { |a| Regexp.escape(a) }.join('|')})(:\d+)?/|i
+      end
+
+      it 'prints a warning: WARNING: `VCR::HttpStubbingAdapters::FakeWeb::LOCALHOST_REGEX` is deprecated.' do
+        described_class.should_receive(:warn).with("WARNING: `VCR::HttpStubbingAdapters::FakeWeb::LOCALHOST_REGEX` is deprecated.")
+        subject
+      end
+    end
+  end
+
   describe VCR::Config do
     describe '.http_stubbing_library' do
       before(:each) { described_class.stub_with :webmock, :typhoeus }
@@ -28,6 +78,8 @@ describe 'Deprecations' do
         described_class.http_stubbing_library = :webmock
       end
     end
+
+    it_behaves_like '.ignore_localhost? deprecation'
   end
 
   describe VCR::Cassette do
@@ -43,35 +95,42 @@ describe 'Deprecations' do
     end
 
     [true, false].each do |orig_ignore_localhost|
-      context "when the http_stubbing_adapter's ignore_localhost is set to #{orig_ignore_localhost}" do
-        before(:each) { VCR.http_stubbing_adapter.ignore_localhost = orig_ignore_localhost }
+      orig_ignored_hosts = if orig_ignore_localhost
+        VCR::LOCALHOST_ALIASES
+      else
+        []
+      end
 
-        context 'when the :allow_real_http option is set to :localhost' do
-          subject { VCR::Cassette.new('cassette name', :allow_real_http => :localhost) }
+      context "when the ignored_hosts list is set to #{orig_ignored_hosts.inspect} and the :allow_real_http option is set to :localhost" do
+        before(:each) do
+          VCR::Config.ignored_hosts.clear
+          VCR::Config.ignore_hosts *orig_ignored_hosts
+        end
 
-          it "sets the http_stubbing_adapter's ignore_localhost attribute to true" do
-            subject
-            VCR.http_stubbing_adapter.ignore_localhost?.should == true
-          end
+        subject { VCR::Cassette.new('cassette name', :allow_real_http => :localhost) }
 
-          it "prints a warning: VCR's :allow_real_http cassette option is deprecated.  Instead, use the ignore_localhost configuration option." do
-            Kernel.should_receive(:warn).with("WARNING: VCR's :allow_real_http cassette option is deprecated.  Instead, use the ignore_localhost configuration option.")
-            subject
-          end
+        it "sets the ignored_hosts list to the list of localhost aliases" do
+          subject
+          VCR::Config.ignored_hosts.should == VCR::LOCALHOST_ALIASES
+        end
 
-          it "reverts ignore_localhost when the cassette is ejected" do
-            subject.eject
-            VCR.http_stubbing_adapter.ignore_localhost?.should == orig_ignore_localhost
-          end
+        it "prints a warning: VCR's :allow_real_http cassette option is deprecated.  Instead, use the ignore_localhost configuration option." do
+          Kernel.should_receive(:warn).with("WARNING: VCR's :allow_real_http cassette option is deprecated.  Instead, use the ignore_localhost configuration option.")
+          subject
+        end
+
+        it "reverts ignore_hosts when the cassette is ejected" do
+          subject.eject
+          VCR::Config.ignored_hosts.should == orig_ignored_hosts
+        end
 
-          {
-            'http://localhost'   => true,
-            'http://127.0.0.1'   => true,
-            'http://example.com' => false
-          }.each do |url, expected_value|
-            it "returns #{expected_value} for #allow_real_http_requests_to? when it is given #{url}" do
-              subject.allow_real_http_requests_to?(URI.parse(url)).should == expected_value
-            end
+        {
+          'http://localhost'   => true,
+          'http://127.0.0.1'   => true,
+          'http://example.com' => false
+        }.each do |url, expected_value|
+          it "returns #{expected_value} for #allow_real_http_requests_to? when it is given #{url}" do
+            subject.allow_real_http_requests_to?(URI.parse(url)).should == expected_value
           end
         end
       end