vcr 0.4.0 → 0.4.1

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 #Changelog
 
+## 0.4.1 May 11, 2010
+* Fixed a bug: when `Net::HTTPResponse#read_body` was called after VCR had read the body to record a new request,
+  it raised an error (`IOError: Net::HTTPResponse#read_body called twice`).  My fix extends Net::HTTPResponse
+  so that it no longer raises this error.
+
 ## 0.4.0 April 28, 2010
 * Added support for webmock.  All the fakeweb-specific code is now in an adapter (as is the webmock code).
 

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/features/support/env.rb

@@ -32,6 +32,9 @@ VCR.module_eval do
 end
 
 After do |scenario|
+  if raised_error = (@http_requests || {}).values.flatten.detect { |result| result.is_a?(Exception) && result.message !~ /VCR/ }
+    raise raised_error
+  end
   VCR.completed_cucumber_scenarios << scenario
 end
 

data/lib/vcr.rb

@@ -4,6 +4,7 @@ require 'vcr/cucumber_tags'
 require 'vcr/deprecations'
 require 'vcr/structs'
 
+require 'vcr/extensions/net_http_response'
 require 'vcr/extensions/net_read_adapter'
 
 require 'vcr/http_stubbing_adapters/base'

data/lib/vcr/extensions/net_http.rb

@@ -28,6 +28,7 @@ module Net
 
         unless VCR.http_stubbing_adapter.request_stubbed?(method, uri)
           cassette.record_http_interaction(VCR::HTTPInteraction.from_net_http_objects(self, request, response))
+          response.extend VCR::Net::HTTPResponse
         end
       end
     end

data/lib/vcr/extensions/net_http_response.rb

@@ -0,0 +1,48 @@
+# A Net::HTTP response that has already been read raises an IOError when #read_body
+# is called with a destination string or block.
+#
+# This causes a problem when VCR records a response--it reads the body before yielding
+# the response, and if the code that is consuming the HTTP requests uses #read_body, it
+# can cause an error.
+#
+# This is a bit of a hack, but it allows a Net::HTTP response to be "re-read"
+# after it has aleady been read.  This attemps to preserve the behavior of
+# #read_body, acting just as if it had never been read.
+
+module VCR
+  module Net
+    module HTTPResponse
+      def self.extended(object)
+        body_object = object.instance_variable_get(:@body)
+        object.instance_variable_set(:@__orig_body__,
+          case body_object
+            when String then body_object
+            when ::Net::ReadAdapter then body_object.instance_variable_get(:@__body_for_vcr__)
+            else raise ArgumentError.new("Unexpected body object: #{body_object}")
+          end
+        )
+      end
+
+      def read_body(dest = nil, &block)
+        if @__orig_body__
+          if dest && block
+            raise ArgumentError.new("both arg and block given for HTTP method")
+          elsif dest
+            dest << @__orig_body__
+          elsif block
+            @body = ::Net::ReadAdapter.new(block)
+            @body << @__orig_body__
+            @body
+          else
+            @body = @__orig_body__
+          end
+        else
+          super
+        end
+      ensure
+        # allow subsequent calls to #read_body to proceed as normal, without our hack...
+        @__orig_body__ = nil
+      end
+    end
+  end
+end

data/spec/extensions/net_http_response_spec.rb

@@ -0,0 +1,86 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Net::HTTP Response extensions" do
+  context 'extending an already read response' do
+    # disable VCR for this spec...
+    before(:each) { VCR.insert_cassette('response_extension', :allow_real_http => lambda { |uri| true }) }
+    after(:each)  { VCR.eject_cassette }
+
+    def self.it_allows_the_body_to_be_read_again
+      let(:expected_regex) { /You have reached this web page by typing.*example\.com/ }
+
+      it 'allows the body to be read using #body' do
+        subject.body.to_s.should =~ expected_regex
+      end
+
+      it 'allows the body to be read using #read_body' do
+        subject.read_body.to_s.should =~ expected_regex
+      end
+
+      it 'allows the body to be read using #read_body with a block' do
+        yielded_body = ''
+        ret_val = subject.read_body { |s| yielded_body << s }
+        yielded_body.should =~ expected_regex
+        ret_val.should be_instance_of(Net::ReadAdapter)
+      end
+
+      it 'allows the body to be read by passing a destination string to #read_body' do
+        dest = ''
+        ret_val = subject.read_body(dest)
+        dest.should =~ expected_regex
+        ret_val.should == dest
+      end
+
+      it 'raises an ArgumentError if both a destination string and a block is given to #read_body' do
+        dest = ''
+        expect { subject.read_body(dest) { |s| } }.should raise_error(ArgumentError, 'both arg and block given for HTTP method')
+      end
+
+      it 'raises an IOError when #read_body is called twice with a block' do
+        subject.read_body { |s| }
+        expect { subject.read_body { |s| } }.to raise_error(IOError, /read_body called twice/)
+      end
+
+      it 'raises an IOError when #read_body is called twice with a destination string' do
+        dest = ''
+        subject.read_body(dest)
+        expect { subject.read_body(dest) }.to raise_error(IOError, /read_body called twice/)
+      end
+    end
+
+    context 'when the body has already been read using #read_body and a block' do
+      subject do
+        http = Net::HTTP.new('example.com', 80)
+        response = http.request_get('/') { |res| res.read_body { |s| } }
+        response.extend VCR::Net::HTTPResponse
+        response
+      end
+
+      it_allows_the_body_to_be_read_again
+    end
+
+    context 'when the body has already been read using #read_body and a dest string' do
+      subject do
+        http = Net::HTTP.new('example.com', 80)
+        dest = ''
+        response = http.request_get('/') { |res| res.read_body(dest) }
+        response.extend VCR::Net::HTTPResponse
+        response
+      end
+
+      it_allows_the_body_to_be_read_again
+    end
+
+    context 'when the body has already been read using #body' do
+      subject do
+        http = Net::HTTP.new('example.com', 80)
+        response = http.request_get('/')
+        response.body
+        response.extend VCR::Net::HTTPResponse
+        response
+      end
+
+      it_allows_the_body_to_be_read_again
+    end
+  end
+end

data/vcr.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{vcr}
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Myron Marston"]
-  s.date = %q{2010-04-28}
+  s.date = %q{2010-05-11}
   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 = [
@@ -51,6 +51,7 @@ Gem::Specification.new do |s|
      "lib/vcr/deprecations.rb",
      "lib/vcr/extensions/fake_web.rb",
      "lib/vcr/extensions/net_http.rb",
+     "lib/vcr/extensions/net_http_response.rb",
      "lib/vcr/extensions/net_read_adapter.rb",
      "lib/vcr/http_stubbing_adapters/base.rb",
      "lib/vcr/http_stubbing_adapters/fakeweb.rb",
@@ -62,6 +63,7 @@ Gem::Specification.new do |s|
      "spec/config_spec.rb",
      "spec/cucumber_tags_spec.rb",
      "spec/deprecations_spec.rb",
+     "spec/extensions/net_http_response_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",
@@ -105,6 +107,7 @@ Gem::Specification.new do |s|
      "spec/config_spec.rb",
      "spec/cucumber_tags_spec.rb",
      "spec/deprecations_spec.rb",
+     "spec/extensions/net_http_response_spec.rb",
      "spec/extensions/net_http_spec.rb",
      "spec/extensions/net_read_adapter_spec.rb",
      "spec/http_stubbing_adapters/fakeweb_spec.rb",

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Myron Marston
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-28 00:00:00 -07:00
+date: 2010-05-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -117,6 +117,7 @@ files:
 - lib/vcr/deprecations.rb
 - lib/vcr/extensions/fake_web.rb
 - lib/vcr/extensions/net_http.rb
+- lib/vcr/extensions/net_http_response.rb
 - lib/vcr/extensions/net_read_adapter.rb
 - lib/vcr/http_stubbing_adapters/base.rb
 - lib/vcr/http_stubbing_adapters/fakeweb.rb
@@ -128,6 +129,7 @@ files:
 - spec/config_spec.rb
 - spec/cucumber_tags_spec.rb
 - spec/deprecations_spec.rb
+- spec/extensions/net_http_response_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
@@ -195,6 +197,7 @@ test_files:
 - spec/config_spec.rb
 - spec/cucumber_tags_spec.rb
 - spec/deprecations_spec.rb
+- spec/extensions/net_http_response_spec.rb
 - spec/extensions/net_http_spec.rb
 - spec/extensions/net_read_adapter_spec.rb
 - spec/http_stubbing_adapters/fakeweb_spec.rb