vcr 0.3.1 → 0.4.0

data/spec/http_stubbing_adapters/fakeweb_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe VCR::HttpStubbingAdapters::FakeWeb do
+  it_should_behave_like 'an http stubbing adapter'
+
+  describe '#check_version!' do
+    before(:each) { @orig_version = FakeWeb::VERSION }
+    after(:each)  { FakeWeb::VERSION = @orig_version }
+
+    %w( 1.2.8 1.2.9 1.2.10 1.3.0 1.10.0 2.0.0 ).each do |version|
+      it "does nothing when FakeWeb's version is #{version}" do
+        FakeWeb::VERSION = version
+        expect { described_class.check_version! }.to_not raise_error
+      end
+    end
+
+    %w( 1.2.7 1.1.30 0.30.30 ).each do |version|
+      it "raises an error when FakeWeb's version is #{version}" do
+        FakeWeb::VERSION = version
+        expect { described_class.check_version! }.to raise_error(/You are using FakeWeb #{version}.  VCR requires version .* or greater/)
+      end
+    end
+  end
+end

data/spec/http_stubbing_adapters/webmock_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe VCR::HttpStubbingAdapters::WebMock do
+  it_should_behave_like 'an http stubbing adapter'
+
+  describe '#check_version!' do
+    before(:each) { WebMock.should respond_to(:version) }
+
+    %w( 1.1.0 1.1.1 1.2.0 2.0.0 ).each do |version|
+      it "does nothing when WebMock's version is #{version}" do
+        WebMock.stub!(:version).and_return(version)
+        expect { described_class.check_version! }.to_not raise_error
+      end
+    end
+
+    %w( 0.9.9 0.9.10 0.1.30 1.0.30 ).each do |version|
+      it "raises an error when WebMock's version is #{version}" do
+        WebMock.stub!(:version).and_return(version)
+        expect { described_class.check_version! }.to raise_error(/You are using WebMock #{version}.  VCR requires version .* or greater/)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -24,6 +24,11 @@ Spec::Runner.configure do |config|
 
   config.before(:each) do
     VCR::Config.default_cassette_options = { :record => :new_episodes }
+    VCR::Config.http_stubbing_library = :fakeweb
+
+    WebMock.allow_net_connect!
+    WebMock.reset_webmock
+
     FakeWeb.allow_net_connect = true
     FakeWeb.clean_registry
   end

data/spec/structs_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe VCR::Request do
+  describe '.from_net_http_request' do
+    let(:net_http) { YAML.load(File.read(File.dirname(__FILE__) + "/fixtures/#{RUBY_VERSION}/example_net_http.yml")) }
+    let(:request)  { YAML.load(File.read(File.dirname(__FILE__) + "/fixtures/#{RUBY_VERSION}/example_net_http_request.yml")) }
+    subject { described_class.from_net_http_request(net_http, request) }
+
+    before(:each) do
+      VCR.http_stubbing_adapter.should respond_to(:request_uri)
+      VCR.http_stubbing_adapter.stub!(:request_uri)
+    end
+
+    it            { should be_instance_of(VCR::Request) }
+    its(:method)  { should == :post  }
+    its(:body)    { should == 'id=7'  }
+    its(:headers) { should == {
+      'accept'       => ['*/*'],
+      'content-type' => ['application/x-www-form-urlencoded']
+    } }
+
+    it 'sets the uri using the http_stubbing_adapter.request_uri' do
+      VCR.http_stubbing_adapter.should_receive(:request_uri).with(net_http, request).and_return('foo/bar')
+      subject.uri.should == 'foo/bar'
+    end
+  end
+end
+
+describe VCR::ResponseStatus do
+  describe '.from_net_http_response' do
+    let(:response) { YAML.load(File.read(File.dirname(__FILE__) + "/fixtures/#{RUBY_VERSION}/example_net_http_response.yml")) }
+    subject { described_class.from_net_http_response(response) }
+
+    it            { should be_instance_of(described_class) }
+    its(:code)    { should == 200 }
+    its(:message) { should == 'OK' }
+  end
+end
+
+describe VCR::Response do
+  describe '.from_net_http_response' do
+    let(:response) { YAML.load(File.read(File.dirname(__FILE__) + "/fixtures/#{RUBY_VERSION}/example_net_http_response.yml")) }
+    subject { described_class.from_net_http_response(response) }
+
+    it                 { should be_instance_of(described_class) }
+    its(:body)         { should == 'The response from example.com' }
+    its(:http_version) { should == '1.1' }
+    its(:headers)      { should == {
+      "last-modified"  => ['Tue, 15 Nov 2005 13:24:10 GMT'],
+      "connection"     => ['close'],
+      "etag"           => ["\"24ec5-1b6-4059a80bfd280\""],
+      "content-type"   => ["text/html; charset=UTF-8"],
+      "date"           => ['Wed, 31 Mar 2010 02:43:26 GMT'],
+      "server"         => ['Apache/2.2.3 (CentOS)'],
+      "content-length" => ['438'],
+      "accept-ranges"  => ['bytes']
+    } }
+
+    it 'assigns the status using VCR::ResponseStatus.from_net_http_response' do
+      VCR::ResponseStatus.should respond_to(:from_net_http_response)
+      VCR::ResponseStatus.should_receive(:from_net_http_response).with(response).and_return(:the_status)
+      subject.status.should == :the_status
+    end
+  end
+end
+
+describe VCR::HTTPInteraction do
+  describe '.from_net_http_objects' do
+    let(:response) { YAML.load(File.read(File.dirname(__FILE__) + "/fixtures/#{RUBY_VERSION}/example_net_http_response.yml")) }
+    let(:net_http) { YAML.load(File.read(File.dirname(__FILE__) + "/fixtures/#{RUBY_VERSION}/example_net_http.yml")) }
+    let(:request)  { YAML.load(File.read(File.dirname(__FILE__) + "/fixtures/#{RUBY_VERSION}/example_net_http_request.yml")) }
+    subject { described_class.from_net_http_objects(net_http, request, response) }
+
+    it 'returns a new record with the proper values' do
+      VCR::Request.should respond_to(:from_net_http_request)
+      VCR::Request.should_receive(:from_net_http_request).with(net_http, request).and_return(:the_request)
+
+      VCR::Response.should respond_to(:from_net_http_response)
+      VCR::Response.should_receive(:from_net_http_response).with(response).and_return(:the_response)
+
+      subject.should be_instance_of(VCR::HTTPInteraction)
+      subject.request.should == :the_request
+      subject.response.should == :the_response
+    end
+  end
+
+  %w( uri method ).each do |attr|
+    it "delegates :#{attr} to the request signature" do
+      sig = mock('request signature')
+      sig.should_receive(attr).and_return(:the_value)
+      instance = described_class.new(sig, nil)
+      instance.send(attr).should == :the_value
+    end
+  end
+end

data/spec/support/http_stubbing_adapter.rb

@@ -0,0 +1,113 @@
+shared_examples_for "an http stubbing adapter" do
+  subject { described_class }
+
+  def make_http_request(method, path, body = {})
+    case method
+      when :get
+        Net::HTTP.get_response(URI.parse('http://example.com' + path))
+      when :post
+        Net::HTTP.post_form(URI.parse('http://example.com' + path), body)
+    end
+  end
+
+  def self.test_real_http_request(http_allowed)
+    if http_allowed
+      it 'allows real http requests' do
+        make_http_request(:get, '/foo').body.should =~ /The requested URL \/foo was not found/
+      end
+    else
+      it 'does not allow real HTTP requests' do
+        lambda { make_http_request(:get, '/foo') }.should raise_error(StandardError, /You can use VCR to automatically record this request and replay it later/)
+      end
+    end
+  end
+
+  [true, false].each do |http_allowed|
+    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
+        subject.http_connections_allowed?.should == http_allowed
+      end
+
+      test_real_http_request(http_allowed)
+
+      context 'when some requests are stubbed, after setting a checkpoint' do
+        before(:each) do
+          subject.create_stubs_checkpoint(:my_checkpoint)
+          @recorded_interactions = YAML.load(File.read(File.join(File.dirname(__FILE__), '..', 'fixtures', RUBY_VERSION, 'fake_example.com_responses.yml')))
+          subject.stub_requests(@recorded_interactions)
+        end
+
+        it 'returns true from #request_stubbed? for the requests that are stubbed' do
+          subject.request_stubbed?(:post, 'http://example.com').should be_true
+          subject.request_stubbed?(:get, 'http://example.com/foo').should be_true
+        end
+
+        it 'returns false from #request_stubbed? for requests that are not stubbed' do
+          subject.request_stubbed?(:post, 'http://example.com/foo').should be_false
+          subject.request_stubbed?(:get, 'http://google.com').should be_false
+        end
+
+        it 'gets the stubbed responses when multple post requests are made to http://example.com' do
+          make_http_request(:post, '/', { 'id' => '7' }).body.should == 'example.com post response with id=7'
+          make_http_request(:post, '/', { 'id' => '3' }).body.should == 'example.com post response with id=3'
+        end
+
+        it 'gets the stubbed responses when requests are made to http://example.com/foo' do
+          make_http_request(:get, '/foo').body.should == 'example.com get response with path=foo'
+        end
+
+        context 'when we restore our previous check point' do
+          before(:each) { subject.restore_stubs_checkpoint(:my_checkpoint) }
+
+          test_real_http_request(http_allowed)
+
+          it 'returns false from #request_stubbed?' do
+            subject.request_stubbed?(:get, 'http://example.com/foo').should be_false
+            subject.request_stubbed?(:post, 'http://example.com').should be_false
+            subject.request_stubbed?(:get, 'http://google.com').should be_false
+          end
+        end
+      end
+    end
+  end
+
+  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')
+      subject.request_uri(net_http, request).should == 'http://example.com:80/foo/bar'
+    end
+  end
+
+  describe "#with_http_connections_allowed_set_to" do
+    it 'sets http_connections_allowed for the duration of the block to the provided value' do
+      [true, false].each do |expected|
+        yielded_value = :not_set
+        subject.with_http_connections_allowed_set_to(expected) { yielded_value = subject.http_connections_allowed? }
+        yielded_value.should == expected
+      end
+    end
+
+    it 'returns the value returned by the block' do
+      subject.with_http_connections_allowed_set_to(true) { :return_value }.should == :return_value
+    end
+
+    it 'reverts http_connections_allowed when the block completes' do
+      [true, false].each do |expected|
+        subject.http_connections_allowed = expected
+        subject.with_http_connections_allowed_set_to(true) { }
+        subject.http_connections_allowed?.should == expected
+      end
+    end
+
+    it 'reverts http_connections_allowed when the block completes, even if an error is raised' do
+      [true, false].each do |expected|
+        subject.http_connections_allowed = expected
+        lambda { subject.with_http_connections_allowed_set_to(true) { raise RuntimeError } }.should raise_error(RuntimeError)
+        subject.http_connections_allowed?.should == expected
+      end
+    end
+  end
+end

data/spec/task_runner_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'vcr/task_runner'
+
+describe VCR::TaskRunner do
+  describe '.migrate_cassettes' do
+    temp_dir File.expand_path(File.dirname(__FILE__) + '/fixtures/task_runner')
+
+    let(:file_name)      { '0_3_1_cassette.yml' }
+    let(:orig_file_name) { File.dirname(__FILE__) + "/fixtures/#{RUBY_VERSION}/#{file_name}" }
+    let(:test_dir)       { @temp_dir + '/migrate_cassettes' }
+
+    def migrate
+      VCR::TaskRunner.migrate_cassettes(test_dir)
+    end
+
+    before(:each) do
+      FileUtils.mkdir_p(test_dir)
+      FileUtils.cp(orig_file_name, test_dir)
+    end
+
+    it 'makes a backup of the directory' do
+      migrate
+      expected_backup_dir_name = test_dir + '-backup'
+      expected_backup_file_name = expected_backup_dir_name + "/#{file_name}"
+      File.exist?(expected_backup_dir_name).should be_true
+      File.file?(expected_backup_file_name).should be_true
+      File.read(expected_backup_file_name).should == File.read(orig_file_name)
+    end
+
+    it 'does not error out on yaml files with individual records' do
+      YAML.should_receive(:load).and_return(VCR::Request.new(:get, 'http://example.com'))
+      migrate
+    end
+
+    describe 'the structure serialized in the new 0_3_1_cassette_yml file' do
+      subject do
+        migrate
+        YAML.load(File.read(test_dir + "/#{file_name}")).first
+      end
+
+      its(:request) { should be_instance_of(VCR::Request) }
+
+      describe '.request' do
+        def subject; super.request; end
+
+        its(:method)  { should == :post }
+        its(:uri)     { should == 'http://example.com:80/' }
+        its(:body)    { should be_nil }
+        its(:headers) { should be_nil }
+      end
+
+      it 'assigns the response using VCR::Response.from_net_http_response' do
+        VCR::Response.should respond_to(:from_net_http_response)
+        VCR::Response.should_receive(:from_net_http_response).with(an_instance_of(Net::HTTPOK)).and_return(:the_response)
+        subject.response.should == :the_response
+      end
+    end
+  end
+end

data/spec/vcr_spec.rb

@@ -68,6 +68,18 @@ describe VCR do
       end
       yielded_object.should == VCR::Config
     end
+
+    it "disallows http connections" do
+      VCR.http_stubbing_adapter.should respond_to(:http_connections_allowed=)
+      VCR.http_stubbing_adapter.should_receive(:http_connections_allowed=).with(false)
+      VCR.config { }
+    end
+
+    it "checks the adapted library's version to make sure it's compatible with VCR" do
+      VCR.http_stubbing_adapter.should respond_to(:check_version!)
+      VCR.http_stubbing_adapter.should_receive(:check_version!)
+      VCR.config { }
+    end
   end
 
   describe 'cucumber_tags' do
@@ -79,4 +91,29 @@ describe VCR do
       yielded_object.should be_instance_of(VCR::CucumberTags)
     end
   end
+
+  describe '#http_stubbing_adapter' do
+    subject { VCR.http_stubbing_adapter }
+    before(:each) do
+      VCR.instance_variable_set(:@http_stubbing_adapter, nil)
+    end
+
+    {
+      :fakeweb => VCR::HttpStubbingAdapters::FakeWeb,
+      :webmock => VCR::HttpStubbingAdapters::WebMock
+    }.each do |setting, adapter|
+      context "when config http_stubbing_library = :#{setting.to_s}" do
+        before(:each) { VCR::Config.http_stubbing_library = setting }
+
+        it "returns #{adapter}" do
+          subject.should == adapter
+        end
+      end
+    end
+
+    it 'raises an error when library is not set' do
+      VCR::Config.http_stubbing_library = nil
+      lambda { subject }.should raise_error(/The http stubbing library is not configured correctly/)
+    end
+  end
 end

data/vcr.gemspec

@@ -5,25 +5,26 @@
 
 Gem::Specification.new do |s|
   s.name = %q{vcr}
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Myron Marston"]
-  s.date = %q{2010-04-10}
-  s.description = %q{VCR provides helpers to record HTTP requests for URIs that are not registered with fakeweb, and replay them later.  It works with any ruby testing framework, and provides built-in support for cucumber.}
+  s.date = %q{2010-04-28}
+  s.description = %q{VCR provides helpers to record your test suite's HTTP interactions and replay them during future test runs for fast, deterministic, accurate tests.  It works with any ruby testing framework, and provides built-in support for cucumber.}
   s.email = %q{myron.marston@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.md"
   ]
   s.files = [
     ".document",
      ".gitignore",
-     "History.rdoc",
+     "CHANGELOG.md",
      "LICENSE",
-     "README.rdoc",
+     "README.md",
      "Rakefile",
      "VERSION",
+     "benchmarks/http_stubbing_libraries.rb",
      "features/fixtures/vcr_cassettes/1.8.6/cucumber_tags/replay_cassette1.yml",
      "features/fixtures/vcr_cassettes/1.8.6/cucumber_tags/replay_cassette2.yml",
      "features/fixtures/vcr_cassettes/1.8.6/cucumber_tags/replay_cassette3.yml",
@@ -51,23 +52,46 @@ Gem::Specification.new do |s|
      "lib/vcr/extensions/fake_web.rb",
      "lib/vcr/extensions/net_http.rb",
      "lib/vcr/extensions/net_read_adapter.rb",
-     "lib/vcr/recorded_response.rb",
+     "lib/vcr/http_stubbing_adapters/base.rb",
+     "lib/vcr/http_stubbing_adapters/fakeweb.rb",
+     "lib/vcr/http_stubbing_adapters/webmock.rb",
+     "lib/vcr/structs.rb",
+     "lib/vcr/task_runner.rb",
+     "lib/vcr/tasks/vcr.rake",
      "spec/cassette_spec.rb",
      "spec/config_spec.rb",
      "spec/cucumber_tags_spec.rb",
      "spec/deprecations_spec.rb",
-     "spec/extensions/fake_web_spec.rb",
      "spec/extensions/net_http_spec.rb",
      "spec/extensions/net_read_adapter_spec.rb",
+     "spec/fixtures/1.8.6/0_3_1_cassette.yml",
      "spec/fixtures/1.8.6/cassette_spec/example.yml",
+     "spec/fixtures/1.8.6/example_net_http.yml",
+     "spec/fixtures/1.8.6/example_net_http_request.yml",
+     "spec/fixtures/1.8.6/example_net_http_response.yml",
+     "spec/fixtures/1.8.6/fake_example.com_responses.yml",
+     "spec/fixtures/1.8.7/0_3_1_cassette.yml",
      "spec/fixtures/1.8.7/cassette_spec/example.yml",
+     "spec/fixtures/1.8.7/example_net_http.yml",
+     "spec/fixtures/1.8.7/example_net_http_request.yml",
+     "spec/fixtures/1.8.7/example_net_http_response.yml",
+     "spec/fixtures/1.8.7/fake_example.com_responses.yml",
+     "spec/fixtures/1.9.1/0_3_1_cassette.yml",
      "spec/fixtures/1.9.1/cassette_spec/example.yml",
-     "spec/recorded_response_spec.rb",
+     "spec/fixtures/1.9.1/example_net_http.yml",
+     "spec/fixtures/1.9.1/example_net_http_request.yml",
+     "spec/fixtures/1.9.1/example_net_http_response.yml",
+     "spec/fixtures/1.9.1/fake_example.com_responses.yml",
+     "spec/http_stubbing_adapters/fakeweb_spec.rb",
+     "spec/http_stubbing_adapters/webmock_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
+     "spec/structs_spec.rb",
      "spec/support/deprecated.rb",
      "spec/support/disable_warnings.rb",
+     "spec/support/http_stubbing_adapter.rb",
      "spec/support/temp_cassette_library_dir.rb",
+     "spec/task_runner_spec.rb",
      "spec/vcr_spec.rb",
      "vcr.gemspec"
   ]
@@ -75,20 +99,23 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Use VCR to record HTTP responses and replay them using fakeweb.}
+  s.summary = %q{Record your test suite's HTTP interactions and replay them during future test runs for fast, deterministic, accurate tests.}
   s.test_files = [
     "spec/cassette_spec.rb",
      "spec/config_spec.rb",
      "spec/cucumber_tags_spec.rb",
      "spec/deprecations_spec.rb",
-     "spec/extensions/fake_web_spec.rb",
      "spec/extensions/net_http_spec.rb",
      "spec/extensions/net_read_adapter_spec.rb",
-     "spec/recorded_response_spec.rb",
+     "spec/http_stubbing_adapters/fakeweb_spec.rb",
+     "spec/http_stubbing_adapters/webmock_spec.rb",
      "spec/spec_helper.rb",
+     "spec/structs_spec.rb",
      "spec/support/deprecated.rb",
      "spec/support/disable_warnings.rb",
+     "spec/support/http_stubbing_adapter.rb",
      "spec/support/temp_cassette_library_dir.rb",
+     "spec/task_runner_spec.rb",
      "spec/vcr_spec.rb"
   ]
 
@@ -97,18 +124,21 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<fakeweb>, [">= 1.2.8"])
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_development_dependency(%q<cucumber>, [">= 0.6.1"])
+      s.add_development_dependency(%q<fakeweb>, [">= 1.2.8"])
+      s.add_development_dependency(%q<webmock>, [">= 1.1.0"])
     else
-      s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_dependency(%q<cucumber>, [">= 0.6.1"])
+      s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
+      s.add_dependency(%q<webmock>, [">= 1.1.0"])
     end
   else
-    s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
     s.add_dependency(%q<cucumber>, [">= 0.6.1"])
+    s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
+    s.add_dependency(%q<webmock>, [">= 1.1.0"])
   end
 end