VCR
1.0.0
1.0.0
  • Initial page
  • record_modes
    • :none
    • :new_episodes
    • :all
    • :once
  • test_frameworks
    • Usage with Test::Unit
    • Usage with Cucumber
    • Usage with RSpec metadata
  • request_matching
    • Matching on Headers
    • Matching on Body
    • Matching on Method
    • URI without param(s)
    • Identical requests are replayed in sequence
    • Matching on Body
    • Playback repeats
    • Matching on URI
    • Matching on Host
    • Matching on Path
    • Matching on Query string
    • Register and use a custom matcher
  • cassettes
    • exclusive cassette
    • Update content_length header
    • Error for HTTP request made when no cassette is in use
    • Naming
    • Allow Unused HTTP Interactions
    • Freezing Time
    • Decode compressed response
    • Dynamic ERB cassettes
    • Automatic Re-recording
    • Cassette format
  • configuration
    • hook_into
    • cassette_library_dir
    • Filter sensitive data
    • Ignore Request
    • Debug Logging
    • default_cassette_options
    • query_parser
    • uri_parser
    • Allow HTTP connections when no cassette
    • Preserve Exact Body Bytes
  • http_libraries
    • EM HTTP Request
    • Net::HTTP
  • hooks
    • before_playback hook
    • after_http_request hook
    • before_http_request hook
    • before_record hook
    • around_http_request hook
  • middleware
    • Faraday middleware
    • Rack
Powered by GitBook
On this page
  • Background ()
  • cassettes get default values from configured default_cassette_options
  • :match_requests_on defaults to [:method, :uri] when it has not been set
  • :record defaults to :once when it has not been set
  • cassettes can set their own options
  • cassettes can override default options

Was this helpful?

  1. configuration

default_cassette_options

The default_cassette_options configuration option takes a hash that provides defaults for each cassette you use. Any cassette can override the defaults as well as set additional options.

The :match_requests_on option defaults to [:method, :uri] when it has not been set.

The :record option defaults to :once when it has not been set.

Background ()

Given a file named "vcr_setup.rb" with:

require 'vcr'

VCR.configure do |c|
  c.default_cassette_options = { :record => :new_episodes, :erb => true }

  # not important for this example, but must be set to something
  c.hook_into :webmock
  c.cassette_library_dir = 'cassettes'
end

cassettes get default values from configured default_cassette_options

Given a file named "default_cassette_options.rb" with:

require 'vcr_setup.rb'

VCR.use_cassette('example') do
  puts "Record Mode: #{VCR.current_cassette.record_mode}"
  puts "ERB: #{VCR.current_cassette.erb}"
end

When I run ruby default_cassette_options.rb

Then the output should contain:

Record Mode: new_episodes
ERB: true

:match_requests_on defaults to [:method, :uri] when it has not been set

Given a file named "default_cassette_options.rb" with:

require 'vcr_setup.rb'

VCR.use_cassette('example') do
  puts "Match Requests On: #{VCR.current_cassette.match_requests_on.inspect}"
end

When I run ruby default_cassette_options.rb

Then the output should contain "Match Requests On: [:method, :uri]".

:record defaults to :once when it has not been set

Given a file named "default_record_mode.rb" with:

require 'vcr'

VCR.configure do |c|
  # not important for this example, but must be set to something
  c.hook_into :webmock
  c.cassette_library_dir = 'cassettes'
end

VCR.use_cassette('example') do
  puts "Record mode: #{VCR.current_cassette.record_mode.inspect}"
end

When I run ruby default_record_mode.rb

Then the output should contain "Record mode: :once".

cassettes can set their own options

Given a file named "default_cassette_options.rb" with:

require 'vcr_setup.rb'

VCR.use_cassette('example', :re_record_interval => 10000) do
  puts "Re-record Interval: #{VCR.current_cassette.re_record_interval}"
end

When I run ruby default_cassette_options.rb

Then the output should contain "Re-record Interval: 10000".

cassettes can override default options

Given a file named "default_cassette_options.rb" with:

require 'vcr_setup.rb'

VCR.use_cassette('example', :record => :none, :erb => false) do
  puts "Record Mode: #{VCR.current_cassette.record_mode}"
  puts "ERB: #{VCR.current_cassette.erb}"
end

When I run ruby default_cassette_options.rb

Then the output should contain:

Record Mode: none
ERB: false
PreviousDebug LoggingNextquery_parser

Last updated 5 years ago

Was this helpful?