vcr 1.1.2 → 1.2.0

data/lib/vcr/ping.rb

@@ -0,0 +1,26 @@
+# 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
+        end
+      rescue Errno::ECONNREFUSED
+        return true
+      rescue Timeout::Error, StandardError
+        return false
+      end
+      return true
+    end
+    module_function :pingecho
+  end
+end

data/lib/vcr/rspec.rb

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

data/lib/vcr/version.rb

@@ -3,7 +3,7 @@ module VCR
 
   def version
     @version ||= begin
-      string = '1.1.2'
+      string = '1.2.0'
 
       def string.parts; VCR.version.split('.').map { |p| p.to_i }; end
       def string.major; parts[0]; end

data/spec/cassette_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe VCR::Cassette do
   describe '#file' do
@@ -27,11 +27,11 @@ describe VCR::Cassette do
   end
 
   describe '#record_http_interaction' do
-    it 'adds the interaction to #recorded_interactions' do
+    it 'adds the interaction to #new_recorded_interactions' do
       cassette = VCR::Cassette.new(:test_cassette)
-      cassette.recorded_interactions.should == []
+      cassette.new_recorded_interactions.should == []
       cassette.record_http_interaction(:the_interaction)
-      cassette.recorded_interactions.should == [:the_interaction]
+      cassette.new_recorded_interactions.should == [:the_interaction]
     end
   end
 
@@ -127,7 +127,7 @@ describe VCR::Cassette do
 
     VCR::Cassette::VALID_RECORD_MODES.each do |record_mode|
       http_connections_allowed = (record_mode != :none)
-      load_interactions = (record_mode != :all)
+      stub_requests = (record_mode != :all)
 
       context "when VCR::Config.default_cassette_options[:record] is :#{record_mode}" do
         before(:each) { VCR::Config.default_cassette_options = { :record => record_mode } }
@@ -138,47 +138,90 @@ describe VCR::Cassette do
         end
       end
 
-      context "when the record mode is :#{record_mode}" do
+      context "when :#{record_mode} is passed as the record option" do
+        unless record_mode == :all
+          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) }
+
+            context 'when the cassette file does not exist' do
+              before(:each) { File.stub(:exist?).with(file_name).and_return(false) }
+
+              it "has :#{record_mode} for the record mode" do
+                subject.record_mode.should == record_mode
+              end
+            end
+
+            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)
+              end
+
+              context 'and the file was last modified less than 7 days ago' do
+                before(:each) { File.stub(:stat).with(file_name).and_return(stub(:mtime => Time.now - 7.days + 60)) }
+
+                it "has :#{record_mode} for the record mode" do
+                  subject.record_mode.should == record_mode
+                end
+              end
+
+              context 'and the file was last modified more than 7 days ago' do
+                before(:each) { File.stub(:stat).with(file_name).and_return(stub(:mtime => Time.now - 7.days - 60)) }
+
+                it "has :all for the record mode when there is an internet connection available" do
+                  VCR::InternetConnection.stub(:available? => true)
+                  subject.record_mode.should == :all
+                end
+
+                it "has :#{record_mode} for the record mode when there is no internet connection available" do
+                  VCR::InternetConnection.stub(:available? => false)
+                  subject.record_mode.should == record_mode
+                end
+              end
+            end
+          end
+        end
+
         it "sets http_connections_allowed to #{http_connections_allowed} on the http stubbing adapter" do
           VCR.http_stubbing_adapter.should_receive(:http_connections_allowed=).with(http_connections_allowed)
           VCR::Cassette.new(:name, :record => record_mode)
         end
 
-        if load_interactions
-
-          [true, false].each do |ignore_localhost|
-            expected_uri_hosts = %w(example.com)
-            expected_uri_hosts += VCR::LOCALHOST_ALIASES unless ignore_localhost
+        [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 = File.expand_path(File.dirname(__FILE__) + "/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
-            end
+          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 = File.expand_path(File.dirname(__FILE__) + "/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
           end
+        end
 
-          it "loads the recorded interactions from the library yml file" do
-            VCR::Config.cassette_library_dir = File.expand_path(File.dirname(__FILE__) + "/fixtures/#{YAML_SERIALIZATION_VERSION}/cassette_spec")
-            cassette = VCR::Cassette.new('example', :record => record_mode)
+        it "loads the recorded interactions from the library yml file" do
+          VCR::Config.cassette_library_dir = File.expand_path(File.dirname(__FILE__) + "/fixtures/#{YAML_SERIALIZATION_VERSION}/cassette_spec")
+          cassette = VCR::Cassette.new('example', :record => record_mode)
 
-            cassette.should have(3).recorded_interactions
+          cassette.should have(3).recorded_interactions
 
-            i1, i2, i3 = *cassette.recorded_interactions
+          i1, i2, i3 = *cassette.recorded_interactions
 
-            i1.request.method.should == :get
-            i1.request.uri.should == 'http://example.com:80/'
-            i1.response.body.should =~ /You have reached this web page by typing.+example\.com/
+          i1.request.method.should == :get
+          i1.request.uri.should == 'http://example.com:80/'
+          i1.response.body.should =~ /You have reached this web page by typing.+example\.com/
 
-            i2.request.method.should == :get
-            i2.request.uri.should == 'http://example.com:80/foo'
-            i2.response.body.should =~ /foo was not found on this server/
+          i2.request.method.should == :get
+          i2.request.uri.should == 'http://example.com:80/foo'
+          i2.response.body.should =~ /foo was not found on this server/
 
-            i3.request.method.should == :get
-            i3.request.uri.should == 'http://example.com:80/'
-            i3.response.body.should =~ /Another example\.com response/
-          end
+          i3.request.method.should == :get
+          i3.request.uri.should == 'http://example.com:80/'
+          i3.response.body.should =~ /Another example\.com response/
+        end
 
+        if stub_requests
           it "stubs the recorded requests with the http stubbing adapter" do
             VCR::Config.cassette_library_dir = File.expand_path(File.dirname(__FILE__) + "/fixtures/#{YAML_SERIALIZATION_VERSION}/cassette_spec")
             VCR.http_stubbing_adapter.should_receive(:stub_requests).with([an_instance_of(VCR::HTTPInteraction)]*3, anything)
@@ -190,21 +233,12 @@ describe VCR::Cassette do
             VCR.http_stubbing_adapter.should_receive(:stub_requests).with(anything, [:body, :headers])
             cassette = VCR::Cassette.new('example', :record => record_mode, :match_requests_on => [:body, :headers])
           end
-
         else
-
           it "does not stub the recorded requests with the http stubbing adapter" do
             VCR::Config.cassette_library_dir = File.expand_path(File.dirname(__FILE__) + "/fixtures/#{YAML_SERIALIZATION_VERSION}/cassette_spec")
             VCR.http_stubbing_adapter.should_not_receive(:stub_requests)
             cassette = VCR::Cassette.new('example', :record => record_mode)
           end
-
-          it "does not load the recorded interactions from the library yml file" do
-            VCR::Config.cassette_library_dir = File.expand_path(File.dirname(__FILE__) + "/fixtures/#{YAML_SERIALIZATION_VERSION}/cassette_spec")
-            cassette = VCR::Cassette.new('example', :record => record_mode)
-            cassette.should have(0).recorded_interactions
-          end
-
         end
       end
     end
@@ -230,7 +264,7 @@ describe VCR::Cassette do
       ]
 
       cassette = VCR::Cassette.new(:eject_test)
-      cassette.stub!(:recorded_interactions).and_return(recorded_interactions)
+      cassette.stub!(:new_recorded_interactions).and_return(recorded_interactions)
 
       lambda { cassette.eject }.should change { File.exist?(cassette.file) }.from(false).to(true)
       saved_recorded_interactions = File.open(cassette.file, "r") { |f| YAML.load(f.read) }
@@ -240,41 +274,98 @@ describe VCR::Cassette do
     it "writes the recorded interactions to a subdirectory if the cassette name includes a directory" do
       recorded_interactions = [VCR::HTTPInteraction.new(:the_request, :the_response)]
       cassette = VCR::Cassette.new('subdirectory/test_cassette')
-      cassette.stub!(:recorded_interactions).and_return(recorded_interactions)
+      cassette.stub!(:new_recorded_interactions).and_return(recorded_interactions)
 
       lambda { cassette.eject }.should 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.should == recorded_interactions
     end
 
-    it "writes both old and new recorded interactions to disk" do
-      file = File.expand_path(File.dirname(__FILE__) + "/fixtures/#{YAML_SERIALIZATION_VERSION}/cassette_spec/example.yml")
-      FileUtils.cp file, File.join(@temp_dir, 'previously_recorded_interactions.yml')
-      cassette = VCR::Cassette.new('previously_recorded_interactions')
-      cassette.should have(3).recorded_interactions
-      new_recorded_interaction = VCR::HTTPInteraction.new(:the_request, :the_response)
-      cassette.record_http_interaction(new_recorded_interaction)
-      cassette.eject
-      saved_recorded_interactions = File.open(cassette.file, "r") { |f| YAML.load(f.read) }
-      saved_recorded_interactions.should have(4).recorded_interactions
-      saved_recorded_interactions.last.should == new_recorded_interaction
-    end
-  end
+    [:all, :none, :new_episodes].each do |record_mode|
+      context "for a :record => :#{record_mode} cassette with previously recorded interactions" do
+        temp_dir File.expand_path(File.dirname(__FILE__) + "/fixtures/#{YAML_SERIALIZATION_VERSION}/cassette_spec/temp"), :assign_to_cassette_library_dir => true
 
-  describe '#eject for a cassette with previously recorded interactions' do
-    it "restore the stubs checkpoint on the http stubbing adapter" do
-      VCR::Config.cassette_library_dir = File.expand_path(File.dirname(__FILE__) + "/fixtures/#{YAML_SERIALIZATION_VERSION}/cassette_spec")
-      cassette = VCR::Cassette.new('example', :record => :none)
-      VCR.http_stubbing_adapter.should_receive(:restore_stubs_checkpoint).with('example')
-      cassette.eject
-    end
+        subject { VCR::Cassette.new('example', :record => record_mode, :match_requests_on => [:uri]) }
+
+        before(:each) do
+          base_dir = File.expand_path(File.dirname(__FILE__) + "/fixtures/#{YAML_SERIALIZATION_VERSION}/cassette_spec")
+          FileUtils.cp(base_dir + "/example.yml", base_dir + "/temp/example.yml")
+        end
+
+        it "restore the stubs checkpoint on the http stubbing adapter" do
+          VCR.http_stubbing_adapter.should_receive(:restore_stubs_checkpoint).with('example')
+          subject.eject
+        end
+
+        it "does not re-write to disk the previously recorded interactions if there are no new ones" do
+          yaml_file = subject.file
+          File.should_not_receive(:open).with(subject.file, 'w')
+          lambda { subject.eject }.should_not change { File.mtime(yaml_file) }
+        end
+
+        context 'when some new interactions have been recorded' do
+          let(:new_interaction_1) { VCR::HTTPInteraction.new(VCR::Request.new, :response_1) }
+          let(:new_interaction_2) { VCR::HTTPInteraction.new(VCR::Request.new, :response_2) }
+          let(:new_interaction_3) { VCR::HTTPInteraction.new(VCR::Request.new, :response_3) }
+
+          let(:old_interaction_1) { subject.recorded_interactions[0] }
+          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)) }
+
+          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)
+
+            new_interaction_1.request.stub(:matcher => :matcher_a)
+            new_interaction_2.request.stub(:matcher => :matcher_b)
+            new_interaction_3.request.stub(:matcher => :matcher_c)
 
-    it "does not re-write to disk the previously recorded interactions if there are no new ones" do
-      VCR::Config.cassette_library_dir = File.expand_path(File.dirname(__FILE__) + "/fixtures/#{YAML_SERIALIZATION_VERSION}/cassette_spec")
-      yaml_file = File.join(VCR::Config.cassette_library_dir, 'example.yml')
-      cassette = VCR::Cassette.new('example', :record => :none)
-      File.should_not_receive(:open).with(cassette.file, 'w')
-      lambda { cassette.eject }.should_not change { File.mtime(yaml_file) }
+            [new_interaction_1, new_interaction_2, new_interaction_3].each do |i|
+              subject.record_http_interaction(i)
+            end
+          end
+
+          if record_mode == :all
+            it 'removes the old interactions that match new requests, and saves the new interactions follow the old ones' do
+              subject.eject
+
+              saved_recorded_interactions.should == [
+                old_interaction_2,
+                new_interaction_1,
+                new_interaction_2,
+                new_interaction_3
+              ]
+            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
+
+              subject.eject
+            end
+          else
+            it 'saves the old interactions followed by the new ones to disk' do
+              subject.eject
+
+              saved_recorded_interactions.should == [
+                old_interaction_1,
+                old_interaction_2,
+                old_interaction_3,
+                new_interaction_1,
+                new_interaction_2,
+                new_interaction_3
+              ]
+            end
+          end
+        end
+      end
     end
   end
 end

data/spec/config_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe VCR::Config do
   describe '#cassette_library_dir=' do

data/spec/cucumber_tags_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe VCR::CucumberTags do
   subject { described_class.new(self) }
@@ -12,7 +12,8 @@ describe VCR::CucumberTags do
   def test_tag(cassette_attribute, tag, expected_value)
     VCR.current_cassette.should be_nil
 
-    cassette_during_scenario, scenario = nil, lambda { cassette_during_scenario = VCR.current_cassette }
+    cassette_during_scenario = nil
+    scenario = lambda { cassette_during_scenario = VCR.current_cassette }
     blocks_for_tags[tag].call(:scenario_name, scenario)
     cassette_during_scenario.send(cassette_attribute).should == expected_value
 

data/spec/deprecations_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe 'Deprecations' do
   describe VCR::Cassette do

data/spec/extensions/net_http_response_spec.rb

@@ -1,9 +1,7 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe VCR::Net::HTTPResponse do
-  # Disable the VCR/FakeWeb/WebMock Net::HTTP monkey patches so we don't have collisions with these specs
-  before(:all) { MonkeyPatches.disable! }
-  after(:all)  { MonkeyPatches.enable!  }
+  without_monkey_patches :all
 
   def self.it_allows_the_body_to_be_read(expected_regex)
     it 'allows the body to be read using #body' do

data/spec/extensions/net_http_spec.rb

@@ -1,6 +1,8 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe "Net::HTTP Extensions" do
+  without_webmock_callbacks
+
   let(:uri) { URI.parse('http://example.com') }
 
   it 'checks if the request is stubbed using a VCR::Request' do

data/spec/fixtures/1.9.1/cassette_spec/with_localhost_requests.yml

@@ -53,6 +53,29 @@
       - "277"
     :body: 127.0.0.1 response
     :http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  :request: !ruby/struct:VCR::Request 
+    :method: :get
+    :uri: http://0.0.0.0:80/
+    :body: 
+    :headers: 
+  :response: !ruby/struct:VCR::Response 
+    :status: !ruby/struct:VCR::ResponseStatus 
+      :code: 404
+      :message: Not Found
+    :headers: 
+      content-type: 
+      - text/html; charset=iso-8859-1
+      connection: 
+      - close
+      server: 
+      - Apache/2.2.3 (CentOS)
+      date: 
+      - Thu, 25 Feb 2010 07:53:52 GMT
+      content-length: 
+      - "277"
+    :body: 127.0.0.1 response
+    :http_version: "1.1"
 - !ruby/struct:VCR::HTTPInteraction 
   :request: !ruby/struct:VCR::Request 
     :method: :get