vcr 2.0.1 → 2.1.0

data/.gitignore

@@ -23,6 +23,8 @@ pkg
 ## PROJECT::SPECIFIC
 features/fixtures/vcr_cassettes/**/temp/
 *.rbc
+.rbc
+.rbx
 .bundle
 tmp
 rerun.txt

data/.travis.yml

@@ -11,17 +11,13 @@ rvm:
   - jruby-19mode
   - rbx-18mode
   - rbx-19mode
-  - ruby-head
 branches:
   only:
     - master
     - 1-x-stable
     - travis-testing
-    - 2-0-stable
 matrix:
   allow_failures:
     - rvm: jruby-19mode
-    - rvm: rbx-18mode
     - rvm: rbx-19mode
-    - rvm: ruby-head
 

data/CHANGELOG.md

@@ -1,6 +1,22 @@
 ## In git
 
-[Full Changelog](http://github.com/myronmarston/vcr/compare/v2.0.0...2-0-stable)
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v2.0.1...master)
+
+* Add new `:use_scenario_name` option to the cucumber tags API. This
+  allows you to use a generic tag (such as `@vcr`) and have the
+  cassettes named based on the feature and scenario rather than based on
+  the tag. Thanks to [Omer Rauchwerger](https://github.com/rauchy) for
+  the implementation and [Chad Jolly](https://github.com/cjolly) for the
+  initial idea and feedback.
+* Add new `:decode_compressed_response` cassette option. When set to
+  true, VCR will decompress a gzipped or deflated response before
+  recording the cassette, in order to make it more human readable.
+  Thanks to [Mislav Marohnić](https://github.com/mislav) for the
+  idea and implementation.
+
+## 2.0.1 (March 30, 2012)
+
+[Full Changelog](http://github.com/myronmarston/vcr/compare/v2.0.0...v2.0.1)
 
 * Fix encoding logic to not attempt to encode the request or response
   body on deserialization if there is no encoding specified. This should

data/README.md

@@ -112,6 +112,7 @@ Note that as of VCR 2, 1.8.6 and 1.9.1 are not supported.
   and create a topic branch for every separate change you make.
 * See the [Contributing](https://github.com/myronmarston/vcr/blob/master/CONTRIBUTING.md)
   guide for instructions on running the specs and features.
+* Code quality metrics are checked by [Code Climate](https://codeclimate.com/github/myronmarston/vcr).
 * Documentation is generated with [YARD](http://yardoc.org/) ([cheat sheet](http://cheat.errtheblog.com/s/yard/)).
   To generate while developing:
 
@@ -119,8 +120,6 @@ Note that as of VCR 2, 1.8.6 and 1.9.1 are not supported.
 yard server --reload
 ```
 
-If you find VCR useful, please recommend me on [working with rails](http://workingwithrails.com/person/16590-myron-marston).
-
 ## Thanks
 
 * [Aslak Hellesøy](http://github.com/aslakhellesoy) for [Cucumber](http://github.com/aslakhellesoy/cucumber).
@@ -142,14 +141,18 @@ Thanks also to the following people who have contributed patches or helpful sugg
 * [Ben Hutton](http://github.com/benhutton)
 * [Bradley Isotope](https://github.com/bradleyisotope)
 * [Carlos Kirkconnell](https://github.com/kirkconnell)
+* [Chad Jolly](https://github.com/cjolly)
 * [Eric Allam](http://github.com/rubymaverick)
+* [Ezekiel Templin](https://github.com/ezkl)
 * [Flaviu Simihaian](https://github.com/closedbracket)
 * [Jeff Pollard](https://github.com/Fluxx)
 * [Justin Smestad](https://github.com/jsmestad)
 * [Karl Baum](https://github.com/kbaum)
 * [Michael Lavrisha](https://github.com/vrish88)
+* [Mislav Marohnić](https://github.com/mislav)
 * [Nathaniel Bibler](https://github.com/nbibler)
 * [Oliver Searle-Barnes](https://github.com/opsb)
+* [Omer Rauchwerger](https://github.com/rauchy)
 * [Paco Guzmán](https://github.com/pacoguzman)
 * [Ryan Bates](https://github.com/ryanb)
 * [Sathya Sekaran](https://github.com/sfsekaran)

data/features/.nav

@@ -12,6 +12,7 @@
   - automatic_re_recording.feature
   - exclusive.feature
   - update_content_length_header.feature
+  - decompress.feature
 - record_modes:
   - once.feature
   - new_episodes.feature

data/features/cassettes/decompress.feature

@@ -0,0 +1,70 @@
+Feature: Decode compressed response
+
+  When the `:decode_compressed_response` option is set to a truthy value, VCR
+  will decompress "gzip" and "deflate" response bodies before recording.  This
+  ensures that these interactions become readable and editable after being
+  serialized.
+
+  This option should be avoided if the actual decompression of response bodies
+  is part of the functionality of the library or app being tested.
+
+  Background:
+    Given a file named "decompress.rb" with:
+      """ruby
+      require 'zlib'
+      require 'stringio'
+
+      start_sinatra_app(:port => 7777) do
+        get('/') {
+          content = 'The quick brown fox jumps over the lazy dog'
+          io = StringIO.new
+
+          writer = Zlib::GzipWriter.new(io)
+          writer << content
+          writer.close
+
+          headers['Content-Encoding'] = 'gzip'
+          io.string
+        }
+      end
+
+      require 'vcr'
+
+      VCR.configure do |c|
+        c.cassette_library_dir = 'cassettes'
+        c.hook_into :fakeweb
+        c.default_cassette_options = { :serialize_with => :syck }
+      end
+      """
+
+  Scenario: The option is not set by default
+    When I append to file "decompress.rb":
+      """ruby
+      VCR.use_cassette(:decompress) do
+        Net::HTTP.get_response('localhost', '/', 7777)
+      end
+      """
+    And I run `ruby decompress.rb`
+    Then the file "cassettes/decompress.yml" should contain a YAML fragment like:
+      """
+      content-encoding:
+      - gzip
+      """
+
+  Scenario: The option is enabled
+    When I append to file "decompress.rb":
+      """ruby
+      VCR.use_cassette(:decompress, :decode_compressed_response => true) do
+        Net::HTTP.get_response('localhost', '/', 7777)
+      end
+      """
+    And I run `ruby decompress.rb`
+    Then the file "cassettes/decompress.yml" should contain a YAML fragment like:
+      """
+      content-length:
+      - '43'
+      """
+    And the file "cassettes/decompress.yml" should contain:
+      """
+      string: The quick brown fox jumps over the lazy dog
+      """

data/features/step_definitions/cli_steps.rb

@@ -96,6 +96,10 @@ When /^I modify the file "([^"]*)" to replace "([^"]*)" with "([^"]*)"$/ do |fil
   modify_file(file_name, orig_text, new_text)
 end
 
+When /^I append to file "([^"]*)":$/ do |file_name, content|
+  append_to_file(file_name, "\n" + content)
+end
+
 When /^I set the "([^"]*)" environment variable to "([^"]*)"$/ do |var, value|
   set_env(var, value)
 end
@@ -149,7 +153,8 @@ Then /^the file "([^"]*)" should contain a YAML fragment like:$/ do |file_name,
 
     # Normalize by removing leading and trailing whitespace...
     file_content = file_content.split("\n").map do |line|
-      line.strip
+      # Different versions of psych use single vs. double quotes
+      line.strip.gsub('"', "'")
     end.join("\n")
 
     file_content.should include(fragment)

data/features/support/env.rb

@@ -1,8 +1,8 @@
 require 'rubygems'
 require 'bundler'
 Bundler.setup
-require 'limited_red/plugins/cucumber'
 
+require 'limited_red/plugins/cucumber'
 require 'ruby-debug' if !defined?(RUBY_ENGINE) && RUBY_VERSION != '1.9.3' && !ENV['CI']
 
 require 'aruba/cucumber'

data/features/test_frameworks/cucumber.feature

@@ -15,13 +15,18 @@ Feature: Usage with Cucumber
 
     t.tag  '@tag3', :cassette => :options
     t.tags '@tag4, '@tag5', :cassette => :options
+    t.tag  '@vcr', :use_scenario_name => true
   end
   ```
 
   VCR will use a cassette named "cucumber_tags/<tag_name>" for scenarios
-  with each of these tags.  The configured `default_cassette_options` will
-  be used, or you can override specific options by passing a hash as the
-  last argument to `#tag` or `#tags`.
+  with each of these tags (Unless the :use_scenario_name option is provided. See below).
+  The configured `default_cassette_options` will be used, or you can override specific
+  options by passing a hash as the last argument to `#tag` or `#tags`.
+
+  You can also have VCR name your cassettes automatically according to the feature
+  and scenario name by providing :use_scenario_name => true to '#tag' or '#tags'.
+  In this case, the cassette will be named "<feature_name>/<scenario_name>".
 
   @exclude-jruby
   Scenario: Record HTTP interactions in a scenario by tagging it
@@ -47,6 +52,7 @@ Feature: Usage with Cucumber
       VCR.cucumber_tags do |t|
         t.tag  '@localhost_request' # uses default record mode since no options are given
         t.tags '@disallowed_1', '@disallowed_2', :record => :none
+        t.tag  '@vcr', :use_scenario_name => true
       end
       """
     And a file named "features/step_definitions/steps.rb" with:
@@ -78,6 +84,11 @@ Feature: Usage with Cucumber
           When a request is made to "http://localhost:7777/localhost_request_2"
           Then the response should be "Hello localhost_request_2"
 
+        @vcr
+        Scenario: tagged scenario
+          When a request is made to "http://localhost:7777/localhost_request_1"
+          Then the response should be "Hello localhost_request_1"
+
         @disallowed_1
         Scenario: tagged scenario
           When a request is made to "http://localhost:7777/allowed" within a cassette named "allowed"
@@ -90,7 +101,7 @@ Feature: Usage with Cucumber
       """
     And the directory "features/cassettes" does not exist
     When I run `cucumber WITH_SERVER=true features/vcr_example.feature`
-    Then it should fail with "3 scenarios (2 failed, 1 passed)"
+    Then it should fail with "4 scenarios (2 failed, 2 passed)"
     And the output should contain each of the following:
       | An HTTP request has been made that VCR does not know how to handle:               |
       |   GET http://localhost:7777/disallowed_1                                          |
@@ -100,11 +111,12 @@ Feature: Usage with Cucumber
     And the file "features/cassettes/cucumber_tags/localhost_request.yml" should contain "Hello localhost_request_2"
     And the file "features/cassettes/nested_cassette.yml" should contain "Hello nested_cassette"
     And the file "features/cassettes/allowed.yml" should contain "Hello allowed"
+    And the file "features/cassettes/VCR_example/tagged_scenario.yml" should contain "Hello localhost_request_1"
 
     # Run again without the server; we'll get the same responses because VCR
     # will replay the recorded responses.
     When I run `cucumber features/vcr_example.feature`
-    Then it should fail with "3 scenarios (2 failed, 1 passed)"
+    Then it should fail with "4 scenarios (2 failed, 2 passed)"
     And the output should contain each of the following:
       | An HTTP request has been made that VCR does not know how to handle:               |
       |   GET http://localhost:7777/disallowed_1                                          |
@@ -114,4 +126,4 @@ Feature: Usage with Cucumber
     And the file "features/cassettes/cucumber_tags/localhost_request.yml" should contain "Hello localhost_request_2"
     And the file "features/cassettes/nested_cassette.yml" should contain "Hello nested_cassette"
     And the file "features/cassettes/allowed.yml" should contain "Hello allowed"
-
+    And the file "features/cassettes/VCR_example/tagged_scenario.yml" should contain "Hello localhost_request_1"

data/lib/vcr.rb

@@ -74,6 +74,9 @@ module VCR
   # @option options :update_content_length_header [Boolean] Whether or
   #  not to overwrite the Content-Length header of the responses to
   #  match the length of the response body. Defaults to false.
+  # @option options :decode_compressed_response [Boolean] Whether or
+  #  not to decode compressed responses before recording the cassette.
+  #  This makes the cassette more human readable. Defaults to false.
   # @option options :allow_playback_repeats [Boolean] Whether or not to
   #  allow a single HTTP interaction to be played back multiple times.
   #  Defaults to false.
@@ -144,6 +147,12 @@ module VCR
   # @see #insert_cassette
   # @see #eject_cassette
   def use_cassette(name, options = {}, &block)
+    unless block
+      raise ArgumentError, "`VCR.use_cassette` requires a block. " +
+                           "If you cannot wrap your code in a block, use " +
+                           "`VCR.insert_cassette` / `VCR.eject_cassette` instead."
+    end
+
     cassette = insert_cassette(name, options)
 
     begin

data/lib/vcr/cassette.rb

@@ -50,7 +50,7 @@ module VCR
       invalid_options = options.keys - [
         :record, :erb, :match_requests_on, :re_record_interval, :tag, :tags,
         :update_content_length_header, :allow_playback_repeats, :exclusive,
-        :serialize_with, :preserve_exact_body_bytes
+        :serialize_with, :preserve_exact_body_bytes, :decode_compressed_response
       ]
 
       if invalid_options.size > 0
@@ -65,6 +65,7 @@ module VCR
       @tags                         = Array(options.fetch(:tags) { options[:tag] })
       @tags                         << :update_content_length_header if options[:update_content_length_header]
       @tags                         << :preserve_exact_body_bytes if options[:preserve_exact_body_bytes]
+      @tags                         << :decode_compressed_response if options[:decode_compressed_response]
       @allow_playback_repeats       = options[:allow_playback_repeats]
       @exclusive                    = options[:exclusive]
       @serializer                   = VCR.cassette_serializers[options[:serialize_with]]

data/lib/vcr/configuration.rb

@@ -442,6 +442,10 @@ module VCR
         interaction.response.update_content_length_header
       end
 
+      before_record(:decode_compressed_response) do |interaction|
+        interaction.response.decompress if interaction.response.compressed?
+      end
+
       preserve_exact_body_bytes do |http_message, cassette|
         cassette && cassette.tags.include?(:preserve_exact_body_bytes)
       end

data/lib/vcr/errors.rb

@@ -40,6 +40,11 @@ module VCR
     # @see VCR::Configuration#around_http_request
     class NotSupportedError          < Error; end
 
+    # Error raised when you ask VCR to decode a compressed response
+    # body but the content encoding isn't one of the known ones.
+    # @see VCR::Response#decompress
+    class UnknownContentEncodingError < Error; end
+
     # Error raised when an HTTP request is made that VCR is unable to handle.
     # @note VCR will raise this to force you to do something about the
     #  HTTP request. The idea is that you want to handle _every_ HTTP

data/lib/vcr/structs.rb

@@ -100,6 +100,7 @@ module VCR
 
       def normalize_headers
         new_headers = {}
+        @normalized_header_keys = Hash.new {|h,k| k }
 
         headers.each do |k, v|
           val_array = case v
@@ -109,11 +110,36 @@ module VCR
           end
 
           new_headers[k] = convert_to_raw_strings(val_array)
+          @normalized_header_keys[k.downcase] = k
         end if headers
 
         self.headers = new_headers
       end
 
+      def header_key(key)
+        key = @normalized_header_keys[key.downcase]
+        key if headers.has_key? key
+      end
+
+      def get_header(key)
+        key = header_key(key)
+        headers[key] if key
+      end
+
+      def edit_header(key, value = nil)
+        if key = header_key(key)
+          value ||= yield headers[key]
+          headers[key] = Array(value)
+        end
+      end
+
+      def delete_header(key)
+        if key = header_key(key)
+          @normalized_header_keys.delete key.downcase
+          headers.delete key
+        end
+      end
+
       def convert_to_raw_strings(array)
         # Ensure the values are raw strings.
         # Apparently for Paperclip uploads to S3, headers
@@ -268,15 +294,6 @@ module VCR
       undef method
     end
 
-    # Transforms the request into a fiber aware one by extending
-    # the {FiberAware} module onto the instance. Necessary for the
-    # {VCR::Configuration#around_http_request} hook.
-    #
-    # @return [Request] the request instance
-    def fiber_aware
-      extend FiberAware
-    end
-
   private
 
     def without_standard_port(uri)
@@ -326,9 +343,65 @@ module VCR
     # Updates the Content-Length response header so that it is
     # accurate for the response body.
     def update_content_length_header
-      value = body ? body.bytesize.to_s : '0'
-      key = %w[ Content-Length content-length ].find { |k| headers.has_key?(k) }
-      headers[key] = [value] if key
+      edit_header('Content-Length') { body ? body.bytesize.to_s : '0' }
+    end
+
+    # The type of encoding.
+    #
+    # @return [String] encoding type
+    def content_encoding
+      enc = get_header('Content-Encoding') and enc.first
+    end
+
+    # Checks if the type of encoding is one of "gzip" or "deflate".
+    def compressed?
+      %w[ gzip deflate ].include? content_encoding
+    end
+
+    # Decodes the compressed body and deletes evidence that it was ever compressed.
+    #
+    # @return self
+    # @raise [VCR::Errors::UnknownContentEncodingError] if the content encoding
+    #  is not a known encoding.
+    def decompress
+      self.class.decompress(body, content_encoding) { |new_body|
+        self.body = new_body
+        update_content_length_header
+        delete_header('Content-Encoding')
+      }
+      return self
+    end
+
+    begin
+      require 'zlib'
+      require 'stringio'
+      HAVE_ZLIB = true
+    rescue LoadError
+      HAVE_ZLIB = false
+    end
+
+    # Decode string compressed with gzip or deflate
+    #
+    # @raise [VCR::Errors::UnknownContentEncodingError] if the content encoding
+    #  is not a known encoding.
+    def self.decompress(body, type)
+      unless HAVE_ZLIB
+        warn "VCR: cannot decompress response; Zlib not available"
+        return
+      end
+
+      case type
+      when 'gzip'
+        args = [StringIO.new(body)]
+        args << { :encoding => 'ASCII-8BIT' } if ''.respond_to?(:encoding)
+        yield Zlib::GzipReader.new(*args).read
+      when 'deflate'
+        yield Zlib::Inflate.inflate(body)
+      when 'identity', NilClass
+        return
+      else
+        raise Errors::UnknownContentEncodingError, "unknown content encoding: #{type}"
+      end
     end
   end
 

data/lib/vcr/test_frameworks/cucumber.rb

@@ -24,7 +24,7 @@ module VCR
     # will cause a VCR cassette to be used for scenarios with matching tags.
     #
     # @param [Array<String>] tag_names the cucumber scenario tags
-    # @param [(optional) Hash] options the cassette options
+    # @param [(optional) Hash] options the cassette options. Specify :use_scenario_name => true to automatically name the cassette according to the scenario name.
     def tags(*tag_names)
       options = tag_names.last.is_a?(::Hash) ? tag_names.pop : {}
       tag_names.each do |tag_name|
@@ -35,7 +35,9 @@ module VCR
         # cucumber has a bug: background steps do not run
         # within an around hook.
         # https://gist.github.com/652968
-        @main_object.Before(tag_name) do
+        @main_object.Before(tag_name) do |scenario|
+          options = options.dup
+          cassette_name = "#{scenario.feature.name}/#{scenario.name}" if options.delete(:use_scenario_name)
           VCR.insert_cassette(cassette_name, options)
         end
 

data/lib/vcr/version.rb

@@ -10,7 +10,7 @@ module VCR
   #   * `parts` [Array<Integer>] List of the version parts.
   def version
     @version ||= begin
-      string = '2.0.1'
+      string = '2.1.0'
 
       def string.parts
         split('.').map { |p| p.to_i }

data/spec/spec_helper.rb

@@ -1,20 +1,23 @@
 require 'rubygems'
-require 'simplecov'
 
-SimpleCov.start do
-  add_filter "/spec"
-  add_filter "/features"
+if RUBY_VERSION =~ /1.9/ && RUBY_ENGINE == 'ruby'
+  require 'simplecov'
 
-  # internet_connection mostly contains logic copied from the ruby 1.8.7
-  # stdlib for which I haven't written tests.
-  add_filter "internet_connection"
-end
+  SimpleCov.start do
+    add_filter "/spec"
+    add_filter "/features"
+
+    # internet_connection mostly contains logic copied from the ruby 1.8.7
+    # stdlib for which I haven't written tests.
+    add_filter "internet_connection"
+  end
 
-SimpleCov.at_exit do
-  File.open(File.join(SimpleCov.coverage_path, 'coverage_percent.txt'), 'w') do |f|
-    f.write SimpleCov.result.covered_percent
+  SimpleCov.at_exit do
+    File.open(File.join(SimpleCov.coverage_path, 'coverage_percent.txt'), 'w') do |f|
+      f.write SimpleCov.result.covered_percent
+    end
+    SimpleCov.result.format!
   end
-  SimpleCov.result.format!
 end
 
 using_git = File.exist?(File.expand_path('../../.git/', __FILE__))

data/spec/vcr/middleware/faraday_spec.rb

@@ -11,7 +11,6 @@ describe VCR::Middleware::Faraday do
 
   context 'when making parallel requests' do
     include VCRStubHelpers
-    let(:parallel_manager)   { ::Faraday::Adapter::Typhoeus.setup_parallel_manager }
     let(:connection)         { ::Faraday.new { |b| b.adapter :typhoeus } }
     let(:request_url) { "http://localhost:#{VCR::SinatraApp.port}/" }
 
@@ -20,7 +19,7 @@ describe VCR::Middleware::Faraday do
         responses = []
 
         VCR.use_cassette("multiple_parallel") do
-          connection.in_parallel(parallel_manager) do
+          connection.in_parallel do
             responses << connection.get(request_url)
             responses << connection.get(request_url)
           end
@@ -36,7 +35,7 @@ describe VCR::Middleware::Faraday do
 
     shared_examples_for "exclusive library hook" do
       def make_request
-        connection.in_parallel(parallel_manager) { connection.get(request_url) }
+        connection.in_parallel { connection.get(request_url) }
       end
 
       it 'makes the faraday middleware exclusively enabled for the duration of the request' do
@@ -78,7 +77,7 @@ describe VCR::Middleware::Faraday do
         undef make_request
         def make_request
           expect {
-            connection.in_parallel(parallel_manager) { connection.get(request_url) }
+            connection.in_parallel { connection.get(request_url) }
           }.to raise_error(VCR::Errors::UnhandledHTTPRequestError)
         end
       end
@@ -90,7 +89,7 @@ describe VCR::Middleware::Faraday do
       undef make_request
       def make_request(disabled = false)
         response = nil
-        connection.in_parallel(parallel_manager) do
+        connection.in_parallel do
           response = connection.get(request_url)
         end
         response

data/spec/vcr/structs_spec.rb

@@ -2,6 +2,10 @@
 
 require 'yaml'
 require 'vcr/structs'
+require 'vcr/errors'
+require 'zlib'
+require 'stringio'
+require 'uri'
 
 shared_examples_for "a header normalizer" do
   let(:instance) do
@@ -520,6 +524,76 @@ module VCR
         end
       end
     end
+
+    describe '#decompress' do
+      %w[ content-encoding Content-Encoding ].each do |header|
+        context "for the #{header} header" do
+          define_method :instance do |body, content_encoding|
+            headers = { 'content-type' => 'text',
+                        'content-length' => body.bytesize.to_s }
+            headers[header] = content_encoding if content_encoding
+            described_class.new(VCR::ResponseStatus.new, headers, body)
+          end
+
+          let(:content) { 'The quick brown fox jumps over the lazy dog' }
+
+          it "does nothing when no compression" do
+            resp = instance('Hello', nil)
+            resp.should_not be_compressed
+            expect {
+              resp.decompress.should equal(resp)
+            }.to_not change { resp.headers['content-length'] }
+          end
+
+          it "does nothing when encoding is 'identity'" do
+            resp = instance('Hello', 'identity')
+            resp.should_not be_compressed
+            expect {
+              resp.decompress.should equal(resp)
+            }.to_not change { resp.headers['content-length'] }
+          end
+
+          it "raises error for unrecognized encoding" do
+            resp = instance('Hello', 'flabbergaster')
+            resp.should_not be_compressed
+            expect { resp.decompress }.
+              to raise_error(Errors::UnknownContentEncodingError, 'unknown content encoding: flabbergaster')
+          end
+
+          it "unzips gzipped response" do
+            io = StringIO.new
+
+            writer = Zlib::GzipWriter.new(io)
+            writer << content
+            writer.close
+
+            gzipped = io.string
+            resp = instance(gzipped, 'gzip')
+            resp.should be_compressed
+            expect {
+              resp.decompress.should equal(resp)
+              resp.should_not be_compressed
+              resp.body.should eq(content)
+            }.to change { resp.headers['content-length'] }.
+              from([gzipped.bytesize.to_s]).
+              to([content.bytesize.to_s])
+          end
+
+          it "inflates deflated response" do
+            deflated = Zlib::Deflate.deflate(content)
+            resp = instance(deflated, 'deflate')
+            resp.should be_compressed
+            expect {
+              resp.decompress.should equal(resp)
+              resp.should_not be_compressed
+              resp.body.should eq(content)
+            }.to change { resp.headers['content-length'] }.
+              from([deflated.bytesize.to_s]).
+              to([content.bytesize.to_s])
+          end
+        end
+      end
+    end
   end
 end
 

data/spec/vcr/test_frameworks/cucumber_spec.rb

@@ -4,6 +4,8 @@ describe VCR::CucumberTags do
   subject { described_class.new(self) }
   let(:before_blocks_for_tags) { {} }
   let(:after_blocks_for_tags) { {} }
+  let(:current_scenario) { stub(:name => "My scenario name",
+                                :feature => stub(:name => "My feature name")) }
 
   # define our own Before/After so we can test this in isolation from cucumber's implementation.
   def Before(tag, &block)
@@ -17,9 +19,9 @@ describe VCR::CucumberTags do
   def test_tag(cassette_attribute, tag, expected_value)
     VCR.current_cassette.should be_nil
 
-    before_blocks_for_tags[tag].call
+    before_blocks_for_tags[tag].call(current_scenario)
     VCR.current_cassette.send(cassette_attribute).should eq(expected_value)
-    after_blocks_for_tags[tag].call
+    after_blocks_for_tags[tag].call(current_scenario)
 
     VCR.current_cassette.should be_nil
   end
@@ -47,6 +49,31 @@ describe VCR::CucumberTags do
         test_tag(:record_mode, 'tag1', :none)
         test_tag(:record_mode, 'tag2', :new_episodes)
       end
+
+      context 'with :use_scenario_name as an option' do
+        it "uses the scenario's name as the cassette name" do
+          subject.send(tag_method, 'tag1', :use_scenario_name => true)
+
+          test_tag(:name, 'tag1', 'My feature name/My scenario name')
+        end
+
+        it 'does not pass :use_scenario_name along the given options to the cassette' do
+          subject.send(tag_method, 'tag1', :use_scenario_name => true)
+
+          VCR::Cassette.should_receive(:new).with(anything, hash_not_including(:use_scenario_name))
+          before_blocks_for_tags['tag1'].call(current_scenario)
+        end
+
+        it 'does not modify the options passed to the cassette' do
+          original_options = { :use_scenario_name => true, :record => :none }
+          subject.send(tag_method, 'tag1', original_options)
+          before_blocks_for_tags['tag1'].call(current_scenario)
+
+          original_options.should have(2).items
+          original_options[:use_scenario_name].should eq(true)
+          original_options[:record].should eq(:none)
+        end
+      end
     end
   end
 

data/spec/vcr_spec.rb

@@ -95,6 +95,12 @@ describe VCR do
       VCR.should_not_receive(:eject_cassette)
       expect { VCR.use_cassette(:test) { } }.to raise_error(StandardError, 'Boom!')
     end
+
+    it 'raises a helpful error if no block is given' do
+      expect {
+        VCR.use_cassette(:test)
+      }.to raise_error(/requires a block/)
+    end
   end
 
   describe '.http_interactions' do

data/vcr.gemspec

@@ -38,7 +38,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'sinatra', '~> 1.3.2'
   s.add_development_dependency 'multi_json', '~> 1.0.3'
   s.add_development_dependency 'json', '~> 1.6.5'
-  s.add_development_dependency 'limited_red', '~> 0.3.8'
+  s.add_development_dependency 'limited_red', '~> 0.3.9'
   s.add_development_dependency 'simplecov', '~> 0.5.3'
 
   unless RUBY_PLATFORM == 'java'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: vcr
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: 
   segments: 
   - 2
-  - 0
   - 1
-  version: 2.0.1
+  - 0
+  version: 2.1.0
 platform: ruby
 authors: 
 - Myron Marston
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-30 00:00:00 Z
+date: 2012-04-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -289,12 +289,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 1
         segments: 
         - 0
         - 3
-        - 8
-        version: 0.3.8
+        - 9
+        version: 0.3.9
   name: limited_red
   type: :development
   prerelease: false
@@ -404,7 +404,6 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- .document
 - .gemtest
 - .gitignore
 - .gitmodules
@@ -425,6 +424,7 @@ files:
 - features/.nav
 - features/about_these_examples.md
 - features/cassettes/automatic_re_recording.feature
+- features/cassettes/decompress.feature
 - features/cassettes/dynamic_erb.feature
 - features/cassettes/exclusive.feature
 - features/cassettes/format.feature
@@ -597,6 +597,7 @@ summary: Record your test suite's HTTP interactions and replay them during futur
 test_files: 
 - features/about_these_examples.md
 - features/cassettes/automatic_re_recording.feature
+- features/cassettes/decompress.feature
 - features/cassettes/dynamic_erb.feature
 - features/cassettes/exclusive.feature
 - features/cassettes/format.feature

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE