vcr 2.9.3 → 3.0.0

data/Rakefile

@@ -1,197 +0,0 @@
-using_git = File.exist?(File.expand_path('../.git/', __FILE__))
-
-if using_git
-  require 'bundler/setup'
-  require 'bundler/gem_helper'
-  Bundler::GemHelper.install_tasks
-  require 'appraisal'
-end
-
-require 'rake'
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.verbose = false
-
-  # we require spec_helper so we don't get an RSpec warning about
-  # examples being defined before configuration.
-  t.ruby_opts = "-I./spec -r./spec/capture_warnings -rspec_helper"
-  t.rspec_opts = %w[--format progress] if (ENV['FULL_BUILD'] || !using_git)
-end
-
-require 'cucumber/rake/task'
-Cucumber::Rake::Task.new
-
-task :default => [:submodules, :spec, :cucumber]
-
-desc "Ensures we keep up 100% YARD coverage"
-task :yard_coverage do
-  coverage_stats = `yard stats --list-undoc 2>&1`
-  puts coverage_stats
-  if coverage_stats.include?('100.00% documented')
-    puts "\nNice work! 100% documentation coverage"
-  else
-    raise "Documentation coverage is less than 100%"
-  end
-end
-
-desc "Checks the spec coverage and fails if it is less than 100%"
-task :check_code_coverage do
-  if RUBY_VERSION.to_f < 1.9 || RUBY_ENGINE != 'ruby'
-    puts "Cannot check code coverage--simplecov is not supported on this platform"
-  else
-    percent = File.read("./coverage/coverage_percent.txt").to_f
-    if percent < 98.0
-      abort "Spec coverage was not high enough: #{percent.round(2)}%"
-    else
-      puts "Nice job! Spec coverage is still above 98%"
-    end
-  end
-end
-
-desc "Checkout git submodules"
-task :submodules do
-  sh "git submodule sync"
-  sh "git submodule update --init --recursive"
-end
-
-namespace :ci do
-  desc "Sets things up for a ci build on travis-ci.org"
-  task :setup => :submodules do
-    ENV['TRAVIS'] = 'true'
-  end
-
-  RSpec::Core::RakeTask.new(:spec) do |t|
-    t.verbose = true
-
-    # we require spec_helper so we don't get an RSpec warning about
-    # examples being defined before configuration.
-    t.ruby_opts = "-w -I./spec -r./spec/capture_warnings -rspec_helper"
-    t.rspec_opts = %w[--format progress --backtrace]
-  end
-
-  desc "Run a ci build"
-  task :build => [:setup, :spec, :cucumber, :yard_coverage, :check_code_coverage]
-end
-
-def ensure_relish_doc_symlinked(filename)
-  from_filename = filename.dup
-  from_filename << '.md' unless filename =~ /\.md$/
-  from = File.expand_path("../features/#{from_filename}", __FILE__)
-  to = File.expand_path("../#{filename}", __FILE__)
-
-  if File.symlink?(from)
-    return if File.readlink(from) == to
-
-    # delete the old symlink
-    File.unlink(from)
-  end
-
-  FileUtils.ln_s to, from
-end
-
-desc "Push cukes to relishapp using the relish-client-gem"
-task :relish do
-  unless ENV['SKIP_RELISH']
-    %w[ README.md CHANGELOG.md Upgrade.md LICENSE CONTRIBUTING.md].each do |file|
-      ensure_relish_doc_symlinked(file)
-    end
-
-    require 'vcr/version'
-    sh "relish versions:add vcr/vcr:#{VCR.version}" if ENV['NEW_RELISH_RELEASE'] == 'true'
-    sh "relish push vcr/vcr:#{VCR.version}"
-  end
-end
-
-task :prep_relish_release do
-  ENV['NEW_RELISH_RELEASE'] ||= 'true'
-end
-
-task :release => [:prep_relish_release, :relish]
-
-# For gem-test: http://gem-testers.org/
-task :test => :spec
-
-load './lib/vcr/tasks/vcr.rake'
-namespace :vcr do
-  task :reset_spec_cassettes do
-    ENV['DIR'] = 'spec/fixtures'
-    def VCR.version; "2.0.0"; end
-    sh "git checkout v2.0.0.beta1 -- spec/fixtures"
-  end
-
-  task :migrate_cassettes => :reset_spec_cassettes
-end
-
-desc "Migrate cucumber cassettes"
-task :migrate_cucumber_cassettes do
-  require 'vcr'
-  require 'ruby-debug'
-
-  VCR.configure do |c|
-    c.cassette_library_dir = 'tmp/migrate'
-    c.default_cassette_options = { :serialize_with => :syck }
-  end
-
-  # We want 2.0.0 in the cucumber cassettes instead of 2.0.0.rc1
-  def VCR.version
-    "2.0.0"
-  end
-
-  Dir["features/**/*.feature"].each do |feature_file|
-    # The ERB cassettes can't be migrated automatically.
-    next if feature_file.include?('dynamic_erb')
-
-    puts " - Migrating #{feature_file}"
-    contents = File.read(feature_file)
-
-    # http://rubular.com/r/gjzkoaYX2O
-    contents.scan(/:\n^\s+"""\n([\s\S]+?)"""/).each do |captures|
-      capture = captures.first
-      indentation = capture[/^ +/]
-      cassette_yml = capture.gsub(/^#{indentation}/, '')
-      new_yml = nil
-
-      file_name = "tmp/migrate/cassette.yml"
-      File.open(file_name, 'w') { |f| f.write(cassette_yml) }
-      cassette = VCR::Cassette.new('cassette')
-
-      hash = begin
-        cassette.serializable_hash
-      rescue => e
-        puts "   Skipping #{capture[0, 80]}"
-        next
-      end
-
-      new_yml = VCR::Cassette::Serializers::Syck.serialize(hash)
-
-      new_yml.gsub!(/^/, indentation)
-      new_yml << indentation
-      new_yml.gsub!(/^\s+\n(\s+response:)/, '\1')
-      contents.gsub!(capture, new_yml)
-    end
-
-    File.open(feature_file, 'w') { |f| f.write(contents) }
-  end
-end
-
-desc "Run the last cuke directly"
-task :run_last_cuke do
-  command = ENV.fetch('CMD') do
-    raise "Must pass CMD"
-  end
-
-  Dir.chdir("tmp/aruba") do
-    sh "RUBYOPT='-I.:../../lib -r../../features/support/vcr_cucumber_helpers' ruby #{command}"
-  end
-end
-
-desc "Boot test app"
-task :boot_test_app do
-  require './spec/support/vcr_localhost_server'
-  require './spec/support/sinatra_app'
-  VCR::SinatraApp.boot
-  puts "Booted sinatra app on port: #{VCR::SinatraApp.port}"
-  loop { }
-  puts "Shutting down."
-end

data/Upgrade.md

@@ -1,289 +0,0 @@
-See the [Changelog](changelog) for a complete list of changes from VCR
-1.x to 2.0. This file simply lists the most pertinent ones to upgrading.
-
-## Supported Rubies
-
-Ruby 1.8.6 and 1.9.1 are no longer supported.
-
-## Configuration Changes
-
-In VCR 1.x, your configuration block would be something like this:
-
-``` ruby
-VCR.config do |c|
-  c.cassette_library_dir = 'cassettes'
-  c.stub_with :fakeweb, :typhoeus
-end
-```
-
-This will continue to work in VCR 2.0 but will generate deprecation
-warnings. Instead, you should change this to:
-
-``` ruby
-VCR.configure do |c|
-  c.cassette_library_dir = 'cassettes'
-  c.hook_into :fakeweb, :typhoeus
-end
-```
-
-## New Cassette Format
-
-The cassette format has changed between VCR 1.x and VCR 2.0.
-VCR 1.x cassettes cannot be used with VCR 2.0.
-
-The easiest way to upgrade is to simply delete your cassettes and
-re-record all of them. VCR also provides a rake task that attempts
-to upgrade your 1.x cassettes to the new 2.0 format. To use it, add
-the following line to your Rakefile:
-
-``` ruby
-load 'vcr/tasks/vcr.rake'
-```
-
-Then run `rake vcr:migrate_cassettes DIR=path/to/your/cassettes/directory` to
-upgrade your cassettes. Note that this rake task may be unable to
-upgrade some cassettes that make extensive use of ERB. In addition, now
-that VCR 2.0 does less normalization then before, it may not be able to
-migrate the cassette perfectly. It's recommended that you delete and
-re-record your cassettes if you are able.
-
-## Custom Request Matchers
-
-VCR 2.0 allows you to register custom request matchers:
-
-``` ruby
-VCR.configure do |c|
-  c.register_request_matcher :port do |request_1, request_2|
-    URI(request_1.uri).port == URI(request_2.uri).port
-  end
-end
-```
-
-You can also pass any callable (an object that responds to #call, such as a lambda)
-to the `:match_requests_on` option:
-
-``` ruby
-port_matcher = lambda do |request_1, request_2|
-  URI(request_1.uri).port == URI(request_2.uri).port
-end
-
-VCR.use_cassette("example", :match_requests_on => [:host, port_matcher, :method]) do
-  # make an HTTP request
-end
-```
-
-In addition, a helper method is provided for generating a custom
-matcher that ignores one or more query parameters:
-
-``` ruby
-uri_without_timestamp = VCR.request_matchers.uri_without_param(:timestamp)
-VCR.configure do |c|
-  c.register_request_matcher(:uri_without_timestamp, &uri_without_timestamp)
-end
-```
-
-## Custom Serializers
-
-VCR 2.0 supports multiple serializers. `:yaml`, `:json`, `:psych` and
-`:syck` are supported out of the box, and it's easy to implement your
-own. Custom serializers must implement `#file_extension`, `#serialize`
-and `#deserialize`:
-
-``` ruby
-VCR.use_cassette("example", :serialize_with => :json) do
-  # make an HTTP request
-end
-
-marshal_serializer = Object.new
-marshal_serializer.instance_eval do
-  def file_extension
-    "marsh"
-  end
-
-  def serialize(hash)
-    Marshal.dump(hash)
-  end
-
-  def deserialize(string)
-    Marshal.load(string)
-  end
-end
-
-VCR.configure do |c|
-  c.cassette_serializers[:marshal] = serializer
-  c.default_cassette_options = { :serialize_with => :marshal }
-end
-```
-
-## Request Hooks
-
-VCR 2.0 has new request hooks, allowing you to inject custom logic
-before an HTTP request, after an HTTP request, or around an HTTP
-request:
-
-``` ruby
-VCR.configure do |c|
-  c.before_http_request do |request|
-    # do something with the request
-  end
-
-  c.after_http_request do |request, response|
-    # do something with the request or response
-  end
-
-  # around_http_request only works on ruby 1.9
-  c.around_http_request do |request|
-    uri = URI(request.uri)
-    if uri.host == 'api.geocoder.com'
-      # extract an address like "1700 E Pine St, Seattle, WA"
-      # from a query like "address=1700+E+Pine+St%2C+Seattle%2C+WA"
-      address = CGI.unescape(uri.query.split('=').last)
-      VCR.use_cassette("geocoding/#{address}", &request)
-    else
-      request.proceed
-    end
-  end
-end
-```
-
-## Ignore a Request Based on Anything
-
-You can now define what requests get ignored using a block. This
-gives you the flexibility to ignore a requets based on anything.
-
-``` ruby
-VCR.configure do |c|
-  c.ignore_request do |request|
-    uri = URI(request.uri)
-    uri.host == 'localhost' && uri.port == 7500
-  end
-end
-```
-
-## Integration with RSpec 2 Metadata
-
-VCR can integrate directly with RSpec metadata:
-
-``` ruby
-VCR.configure do |c|
-  c.configure_rspec_metadata!
-end
-
-RSpec.configure do |c|
-  # so we can use `:vcr` rather than `:vcr => true`;
-  # in RSpec 3 this will no longer be necessary.
-  c.treat_symbols_as_metadata_keys_with_true_values = true
-end
-
-# apply it to an example group
-describe MyAPIWrapper, :vcr do
-end
-
-describe MyAPIWrapper do
-  # apply it to an individual example
-  it "does something", :vcr do
-  end
-
-  # set some cassette options
-  it "does something", :vcr => { :record => :new_episodes } do
-  end
-
-  # override the cassette name
-  it "does something", :vcr => { :cassette_name => "something" } do
-  end
-end
-```
-
-## Improved Faraday Integration
-
-VCR 1.x integrated with Faraday but required that you insert
-`VCR::Middleware::Faraday` into your middleware stack and configure
-`stub_with :faraday`. VCR 2 now takes care of inserting itself
-into the Faraday middleware stack if you configure `hook_into :faraday`.
-
-## Improved Unhandled Error Messages
-
-When VCR is unsure how to handle a request, the error message now contains
-suggestions for how you can configure VCR or your test so it can handle
-the request.
-
-## Debug Logger
-
-VCR 2.0 has a new configuration option that will turn on a logging mode
-so you can get more insight into what VCR is doing, for troubleshooting
-purposes:
-
-``` ruby
-VCR.configure do |c|
-  c.debug_logger = File.open('log/vcr.log')
-  # or...
-  c.debug_logger = $stderr
-end
-```
-
-## Playback Changes
-
-In VCR 1.x, a single HTTP interaction could be played back multiple
-times. This was mostly due to how VCR was implemented using FakeWeb
-and WebMock, and was not really by design. It's more in keeping with
-the philosophy of VCR to record the entire sequence of HTTP interactions
-(including the duplicate requests). In VCR 2, each recorded HTTP
-interaction can only be played back once unless you use the new
-`:allow_playback_repeats` option.
-
-In VCR 1.x, request matching was delegated to the HTTP stubbing library
-(typically FakeWeb or WebMock). They contain some normalization logic
-that can treat some URIs that are different strings as equivalent.
-For example, WebMock ignores the ordering of query parameters:
-
-``` ruby
-> require 'webmock'
- => true
-> uri1 = "http://foo.com/bar?a=1&b=2"
- => "http://foo.com/bar?a=1&b=2"
-> uri2 = "http://foo.com/bar?b=2&a=1"
- => "http://foo.com/bar?b=2&a=1"
-> uri1 == uri2
- => false
-> WebMock::Util::URI.normalize_uri(uri1) == WebMock::Util::URI.normalize_uri(uri2)
- => true
-```
-
-VCR 2, the `:uri` matcher simply [uses string
-equality](https://github.com/myronmarston/vcr/blob/v2.0.0/lib/vcr/request_matcher_registry.rb#L111).
-This means that there are some cases of non-deterministic URIs that VCR
-1.x matched but VCR 2.0 will not match. If you need the `:uri` matcher
-to be tolerant of slight variations like these, you can easily override
-it:
-
-``` ruby
-VCR.configure do |c|
-  c.register_request_matcher(:uri) do |r1, r2|
-    WebMock::Util::URI.normalize_uri(r1.uri) == WebMock::Util::URI.normalize_uri(r2.uri)
-  end
-end
-```
-
-## Preserve Exact Body Bytes
-
-Sometimes the request or response body of an HTTP interaction cannot
-be serialized and deserialized properly. Usually this is due to the body
-having invalid UTF-8 bytes. This new option configures VCR to base64
-encode the body in order to preserve the bytes exactly. It can either
-be configured globally with a block, or set on individual cassettes:
-
-``` ruby
-VCR.configure do |c|
-  c.preserve_exact_body_bytes do |http_message|
-    http_message.body.encoding.name == 'ASCII-8BIT' ||
-    !http_message.body.valid_encoding?
-  end
-end
-
-# or....
-
-VCR.use_cassette("my_cassette", :preserve_exact_body_bytes => true) do
-  # ...
-end
-```
-