vcr 1.6.0 → 1.7.0

data/spec/support/{http_stubbing_adapter.rb → shared_example_groups/http_stubbing_adapter.rb}

@@ -1,5 +1,4 @@
 shared_examples_for "an http stubbing adapter" do |supported_http_libraries, supported_request_match_attributes, *other|
-  extend HttpLibrarySpecs
   before(:each) { VCR.stub!(:http_stubbing_adapter).and_return(subject) }
   subject { described_class }
 
@@ -44,6 +43,19 @@ shared_examples_for "an http stubbing adapter" do |supported_http_libraries, sup
     end
   end
 
+  describe '.stub_requests' do
+    let(:request)     { VCR::Request.new(:get, 'http://example.com/') }
+    let(:status)      { VCR::ResponseStatus.new(200, 'OK') }
+    let(:response)    { VCR::Response.new(status) }
+    let(:interaction) { VCR::HTTPInteraction.new(request, response) }
+
+    it 'works when the request and response has no headers' do
+      expect {
+        subject.stub_requests([interaction], [:method, :uri])
+      }.not_to raise_error
+    end
+  end
+
   if other.include?(:needs_net_http_extension)
     describe '.request_uri' do
       it 'returns the uri for the given http request' do
@@ -61,7 +73,7 @@ shared_examples_for "an http stubbing adapter" do |supported_http_libraries, sup
     end
 
     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'))) }
+      let(:interactions) { VCR::YAML.load_file(File.join(VCR::SPEC_ROOT, 'fixtures', YAML_SERIALIZATION_VERSION, 'match_requests_on.yml')) }
 
       @supported_request_match_attributes = supported_request_match_attributes
       def self.matching_on(attribute, valid1, valid2, invalid, &block)
@@ -128,7 +140,7 @@ shared_examples_for "an http stubbing adapter" do |supported_http_libraries, sup
   end
 
   supported_http_libraries.each do |library|
-    test_http_library library, supported_request_match_attributes, *other
+    it_behaves_like 'an http library', library, supported_request_match_attributes, *other
   end
 end
 

data/spec/support/shared_example_groups/ignore_localhost_deprecation.rb

@@ -0,0 +1,28 @@
+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

data/spec/support/{normalizers.rb → shared_example_groups/normalizers.rb}

@@ -28,14 +28,14 @@ shared_examples_for "header normalization" 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
+    VCR::YAML.dump(instance.headers).should == VCR::YAML.dump('my-key' => ['value1'])
   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
+    VCR::YAML.dump(instance.headers).should == VCR::YAML.dump('my-key' => ['my-value'])
   end
 end
 
@@ -47,7 +47,7 @@ shared_examples_for "body normalization" do
   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
+    VCR::YAML.dump(instance(body).body).should == VCR::YAML.dump("My String")
   end
 end
 

data/spec/support/{version_checker.rb → shared_example_groups/version_checking.rb}

@@ -1,7 +1,7 @@
 shared_examples_for "version checking" do |options|
   library = described_class.library_name
 
-  describe '.check_version!' do
+  describe '.check_version!', :disable_warnings => true 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

@@ -2,8 +2,6 @@ require 'spec_helper'
 
 describe VCR::Cassette do
   describe '#file' do
-    temp_dir "#{VCR::SPEC_ROOT}/fixtures/file", :assign_to_cassette_library_dir => true
-
     it 'combines the cassette_library_dir with the cassette name' do
       cassette = VCR::Cassette.new('the_file')
       cassette.file.should == File.join(VCR::Config.cassette_library_dir, 'the_file.yml')
@@ -89,7 +87,7 @@ describe VCR::Cassette do
       it 'reads the appropriate file from disk using a VCR::Cassette::Reader' do
         VCR::Cassette::Reader.should_receive(:new).with(
           'cassette_lib/foo.yml', anything
-        ).and_return(mock('reader', :read => [].to_yaml))
+        ).and_return(mock('reader', :read => VCR::YAML.dump([])))
 
         VCR::Cassette.new('foo', :record => :new_episodes)
       end
@@ -101,7 +99,7 @@ describe VCR::Cassette do
 
           VCR::Cassette::Reader.should_receive(:new).with(
             anything, erb
-          ).and_return(mock('reader', :read => [].to_yaml))
+          ).and_return(mock('reader', :read => VCR::YAML.dump([])))
 
           VCR::Cassette.new('foo', :record => :new_episodes, :erb => erb)
         end
@@ -111,7 +109,7 @@ describe VCR::Cassette do
 
           VCR::Cassette::Reader.should_receive(:new).with(
             anything, erb
-          ).and_return(mock('reader', :read => [].to_yaml))
+          ).and_return(mock('reader', :read => VCR::YAML.dump([])))
 
           VCR::Cassette.new('foo', :record => :new_episodes)
         end
@@ -132,7 +130,55 @@ describe VCR::Cassette do
       end
 
       context "when :#{record_mode} is passed as the record option" do
+        if record_mode == :none
+          it 'does not allow http connections when there is an existing cassette file with recorded interactions' do
+            VCR::Config.cassette_library_dir = "#{VCR::SPEC_ROOT}/fixtures/#{YAML_SERIALIZATION_VERSION}/cassette_spec"
+            VCR.http_stubbing_adapter.should_receive(:http_connections_allowed=).with(false)
+            c = VCR::Cassette.new('example', :record => :once)
+            File.should exist(c.file)
+            File.size?(c.file).should be_true
+          end
+
+          it 'allows http connections when there is an empty existing cassette file' do
+            VCR::Config.cassette_library_dir = "#{VCR::SPEC_ROOT}/fixtures/#{YAML_SERIALIZATION_VERSION}/cassette_spec"
+            VCR.http_stubbing_adapter.should_receive(:http_connections_allowed=).with(true)
+            c = VCR::Cassette.new('empty', :record => :once)
+            File.should exist(c.file)
+            File.size?(c.file).should be_false
+          end
+
+          it 'allows http connections when there is not an existing cassette file' do
+            VCR::Config.cassette_library_dir = "#{VCR::SPEC_ROOT}/fixtures/#{YAML_SERIALIZATION_VERSION}/cassette_spec"
+            VCR.http_stubbing_adapter.should_receive(:http_connections_allowed=).with(true)
+            c = VCR::Cassette.new('non_existant_file', :record => :once)
+            File.should_not exist(c.file)
+          end
+        end
+
         unless record_mode == :all
+          let(:interaction_1) { VCR::HTTPInteraction.new(VCR::Request.new(:get, 'http://example.com/'), VCR::Response.new(VCR::ResponseStatus.new)) }
+          let(:interaction_2) { VCR::HTTPInteraction.new(VCR::Request.new(:get, 'http://example.com/'), VCR::Response.new(VCR::ResponseStatus.new)) }
+          let(:interactions)  { [interaction_1, interaction_2] }
+          before(:each) { VCR::Config.cassette_library_dir = "#{VCR::SPEC_ROOT}/fixtures/#{YAML_SERIALIZATION_VERSION}/cassette_spec" }
+
+          it 'updates the content_length headers when given :update_content_length_header => true' do
+            VCR::YAML.stub(:load => interactions)
+            interaction_1.response.should_receive(:update_content_length_header)
+            interaction_2.response.should_receive(:update_content_length_header)
+
+            VCR::Cassette.new('example', :record => record_mode, :update_content_length_header => true)
+          end
+
+          [nil, false].each do |val|
+            it "does not update the content_lenth headers when given :update_content_length_header => #{val.inspect}" do
+              VCR::YAML.stub(:load => interactions)
+              interaction_1.response.should_not_receive(:update_content_length_header)
+              interaction_2.response.should_not_receive(:update_content_length_header)
+
+              VCR::Cassette.new('example', :record => record_mode, :update_content_length_header => val)
+            end
+          end
+
           context "and re_record_interval is 7.days" do
             let(:file_name) { File.join(VCR::Config.cassette_library_dir, "cassette_name.yml") }
             subject { VCR::Cassette.new(File.basename(file_name).gsub('.yml', ''), :record => record_mode, :re_record_interval => 7.days) }
@@ -148,7 +194,7 @@ describe VCR::Cassette do
             context 'when the cassette file does exist' do
               before(:each) do
                 File.stub(:exist?).with(file_name).and_return(true)
-                File.stub(:read).with(file_name).and_return([].to_yaml)
+                File.stub(:read).with(file_name).and_return(VCR::YAML.dump([]))
               end
 
               context 'and the file was last modified less than 7 days ago' do
@@ -258,8 +304,6 @@ describe VCR::Cassette do
   end
 
   describe '#eject' do
-    temp_dir "#{VCR::SPEC_ROOT}/fixtures/cassette_spec_eject", :assign_to_cassette_library_dir => true
-
     [true, false].each do |orig_http_connections_allowed|
       it "resets #{orig_http_connections_allowed} on the http stubbing adapter if it was originally #{orig_http_connections_allowed}" do
         VCR.http_stubbing_adapter.should_receive(:http_connections_allowed?).and_return(orig_http_connections_allowed)
@@ -280,7 +324,7 @@ describe VCR::Cassette do
       cassette.stub!(:new_recorded_interactions).and_return(recorded_interactions)
 
       expect { cassette.eject }.to change { File.exist?(cassette.file) }.from(false).to(true)
-      saved_recorded_interactions = File.open(cassette.file, "r") { |f| YAML.load(f.read) }
+      saved_recorded_interactions = VCR::YAML.load_file(cassette.file)
       saved_recorded_interactions.should == recorded_interactions
     end
 
@@ -315,7 +359,7 @@ describe VCR::Cassette do
       cassette.stub!(:new_recorded_interactions).and_return([interaction_1, interaction_2])
       cassette.eject
 
-      saved_recorded_interactions = YAML.load_file(cassette.file)
+      saved_recorded_interactions = VCR::YAML.load_file(cassette.file)
       saved_recorded_interactions.should == [interaction_2]
     end
 
@@ -336,19 +380,17 @@ describe VCR::Cassette do
       cassette.stub!(:new_recorded_interactions).and_return(recorded_interactions)
 
       expect { cassette.eject }.to change { File.exist?(cassette.file) }.from(false).to(true)
-      saved_recorded_interactions = File.open(cassette.file, "r") { |f| YAML.load(f.read) }
+      saved_recorded_interactions = VCR::YAML.load_file(cassette.file)
       saved_recorded_interactions.should == recorded_interactions
     end
 
     [:all, :none, :new_episodes].each do |record_mode|
       context "for a :record => :#{record_mode} cassette with previously recorded interactions" do
-        temp_dir "#{VCR::SPEC_ROOT}/fixtures/#{YAML_SERIALIZATION_VERSION}/cassette_spec/temp", :assign_to_cassette_library_dir => true
-
         subject { VCR::Cassette.new('example', :record => record_mode, :match_requests_on => [:uri]) }
 
         before(:each) do
           base_dir = "#{VCR::SPEC_ROOT}/fixtures/#{YAML_SERIALIZATION_VERSION}/cassette_spec"
-          FileUtils.cp(base_dir + "/example.yml", base_dir + "/temp/example.yml")
+          FileUtils.cp(base_dir + "/example.yml", VCR::Config.cassette_library_dir + "/example.yml")
         end
 
         it "restore the stubs checkpoint on the http stubbing adapter" do
@@ -371,16 +413,24 @@ describe VCR::Cassette do
           let(:old_interaction_2) { subject.recorded_interactions[1] }
           let(:old_interaction_3) { subject.recorded_interactions[2] }
 
-          let(:saved_recorded_interactions) { YAML.load(File.read(subject.file)) }
+          let(:saved_recorded_interactions) { VCR::YAML.load_file(subject.file) }
+
+          def stub_matcher_for(interaction, matcher)
+            # There are issues with serializing an object stubbed w/ rspec-mocks using Psych.
+            # So we manually define the method here.
+            class << interaction.request; self; end.class_eval do
+              define_method(:matcher) { |*a| matcher }
+            end
+          end
 
           before(:each) do
-            old_interaction_1.request.stub(:matcher => :matcher_c)
-            old_interaction_2.request.stub(:matcher => :matcher_d)
-            old_interaction_3.request.stub(:matcher => :matcher_c)
+            stub_matcher_for(old_interaction_1, :matcher_c)
+            stub_matcher_for(old_interaction_2, :matcher_d)
+            stub_matcher_for(old_interaction_3, :matcher_c)
 
-            new_interaction_1.request.stub(:matcher => :matcher_a)
-            new_interaction_2.request.stub(:matcher => :matcher_b)
-            new_interaction_3.request.stub(:matcher => :matcher_c)
+            stub_matcher_for(new_interaction_1, :matcher_a)
+            stub_matcher_for(new_interaction_2, :matcher_b)
+            stub_matcher_for(new_interaction_3, :matcher_c)
 
             [new_interaction_1, new_interaction_2, new_interaction_3].each do |i|
               subject.record_http_interaction(i)
@@ -400,14 +450,16 @@ describe VCR::Cassette do
             end
 
             it "matches old requests to new ones using the cassette's match attributes" do
-              [
-                old_interaction_1, old_interaction_2, old_interaction_3,
-                new_interaction_1, new_interaction_2, new_interaction_3
-              ].each do |i|
-                i.request.should_receive(:matcher).with(subject.match_requests_on).and_return(:the_matcher)
-              end
+              pending("Need to fix this to work with Psych", :if => defined?(::Psych)) do
+                [
+                  old_interaction_1, old_interaction_2, old_interaction_3,
+                  new_interaction_1, new_interaction_2, new_interaction_3
+                ].each do |i|
+                  i.request.should_receive(:matcher).with(subject.match_requests_on).and_return(:the_matcher)
+                end
 
-              subject.eject
+                subject.eject
+              end
             end
           else
             it 'saves the old interactions followed by the new ones to disk' do

data/spec/vcr/config_spec.rb

@@ -7,10 +7,11 @@ describe VCR::Config do
   end
 
   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
-      expect { VCR::Config.cassette_library_dir = @temp_dir }.to change { File.exist?(@temp_dir) }.from(false).to(true)
+      Dir.mktmpdir do |dir|
+        dir += '/cassettes'
+        expect { VCR::Config.cassette_library_dir = dir }.to change { File.exist?(dir) }.from(false).to(true)
+      end
     end
 
     it 'does not raise an error if given nil' do
@@ -21,15 +22,20 @@ describe VCR::Config 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 }
+      VCR::Config.default_cassette_options.should == {
+        :match_requests_on => VCR::RequestMatcher::DEFAULT_MATCH_ATTRIBUTES,
+        :record            => :once
+      }
     end
 
     it "returns #{VCR::RequestMatcher::DEFAULT_MATCH_ATTRIBUTES.inspect} for :match_requests_on when other defaults have been set" do
       VCR::Config.default_cassette_options = { :record => :none }
-      VCR::Config.default_cassette_options.should == {
-        :record            => :none,
-        :match_requests_on => VCR::RequestMatcher::DEFAULT_MATCH_ATTRIBUTES
-      }
+      VCR::Config.default_cassette_options.should include(:match_requests_on => VCR::RequestMatcher::DEFAULT_MATCH_ATTRIBUTES)
+    end
+
+    it "returns :once for :record when other defaults have been set" do
+      VCR::Config.default_cassette_options = { :erb => :true }
+      VCR::Config.default_cassette_options.should include(:record => :once)
     end
   end
 
@@ -131,4 +137,45 @@ describe VCR::Config do
       described_class.uri_should_be_ignored?(URI("http://example.net/")).should be_false
     end
   end
+
+  describe '.filter_sensitive_data' do
+    let(:interaction) { mock('interaction') }
+    before(:each) { interaction.stub(:filter!) }
+
+    it 'adds a before_record hook that replaces the string returned by the block with the given string' do
+      described_class.filter_sensitive_data('foo', &lambda { 'bar' })
+      interaction.should_receive(:filter!).with('bar', 'foo')
+      described_class.invoke_hook(:before_record, nil, interaction)
+    end
+
+    it 'adds a before_playback hook that replaces the given string with the string returned by the block' do
+      described_class.filter_sensitive_data('foo', &lambda { 'bar' })
+      interaction.should_receive(:filter!).with('foo', 'bar')
+      described_class.invoke_hook(:before_playback, nil, interaction)
+    end
+
+    it 'tags the before_record hook when given a tag' do
+      described_class.should_receive(:before_record).with(:my_tag)
+      described_class.filter_sensitive_data('foo', :my_tag) { 'bar' }
+    end
+
+    it 'tags the before_playback hook when given a tag' do
+      described_class.should_receive(:before_playback).with(:my_tag)
+      described_class.filter_sensitive_data('foo', :my_tag) { 'bar' }
+    end
+
+    it 'yields the interaction to the block for the before_record hook' do
+      yielded_interaction = nil
+      described_class.filter_sensitive_data('foo', &lambda { |i| yielded_interaction = i; 'bar' })
+      described_class.invoke_hook(:before_record, nil, interaction)
+      yielded_interaction.should equal(interaction)
+    end
+
+    it 'yields the interaction to the block for the before_playback hook' do
+      yielded_interaction = nil
+      described_class.filter_sensitive_data('foo', &lambda { |i| yielded_interaction = i; 'bar' })
+      described_class.invoke_hook(:before_playback, nil, interaction)
+      yielded_interaction.should equal(interaction)
+    end
+  end
 end

data/spec/vcr/deprecations/cassette_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe VCR::Cassette, 'deprecations', :disable_warnings => true do
+
+  subject { VCR::Cassette.new('cassette name') }
+
+  it 'raises an error when an :allow_real_http lambda is given' do
+    expect { VCR::Cassette.new('cassette name', :allow_real_http => lambda {}) }.to raise_error(ArgumentError)
+  end
+
+  it "prints a warning: WARNING: VCR::Cassette#allow_real_http_requests_to? is deprecated and should no longer be used" do
+    subject.should_receive(:warn).with("WARNING: VCR::Cassette#allow_real_http_requests_to? is deprecated and should no longer be used.")
+    subject.allow_real_http_requests_to?(URI.parse('http://example.org'))
+  end
+
+  [true, false].each do |orig_ignore_localhost|
+    orig_ignored_hosts = if orig_ignore_localhost
+      VCR::LOCALHOST_ALIASES
+    else
+      []
+    end
+
+    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
+
+      subject { VCR::Cassette.new('cassette name', :allow_real_http => :localhost) }
+
+      it "sets the ignored_hosts list to the list of localhost aliases" do
+        subject
+        VCR::Config.ignored_hosts.should == VCR::LOCALHOST_ALIASES
+      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
+      end
+    end
+  end
+end