Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 2.38 KB

README.md

File metadata and controls

76 lines (51 loc) · 2.38 KB
Raw

VcrCable

Build Status

This gem allows you to use VCR in development. This is quite handy when your app interacts frequently with external services and you're on a sloppy connection, or when you want to save bandwidth, or when you happen to have no connection at all.

Usage

Add the required gem(s) to your Gemfile:

gem 'vcr_cable'
gem 'fakeweb' # or webmock

Note: You can choose between the FakeWeb and WebMock gems for faking web requests. If one of those gems is already loaded by your application it will be used automatically.

By default vcr_cable is disabled. In order to enable it you need to start the server with the ENV variable ENABLE_VCR_CABLE=true like this:

ENABLE_VCR_CABLE=true bundle exec rails s

Or you can enable vcr_cable in the yaml config file (check the section below).

That's it! Now all external requests will hit the remote servers only one time, and the application will subsequently use the recorded data.

Custom VCR Configuration

The default VCR configuration is:

development:
  hook_into: fakeweb
  cassette_library_dir: development_cassettes
  enable_erb: false
  allow_playback_repeats: false
  allow_http_connections_when_no_cassette: true
  enable_vcr_cable: false

If you want to override those values or configure vcr_cable to work in some other environment you can generate the vcr_cable.yml config file and update it:

bundle exec rails generate vcr_cable

The file will be located in the config folder of your rails application.

Config via env

You can also enable/disable vcr_cable by setting ENABLE_VCR_CABLE=true or ENABLE_VCR_CABLE=false in your environment. This allows each developer to opt in or opt out for vcr_cable on their own machine.

Extra

If you use vcr_cable in development I recommend to enable http requests for webmock or fakeweb. Just create an initializer, for example:

WebMock.allow_net_connect! if defined? WebMock

It will prevent exceptions when you disable vcr_cable.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Add your feature tests to the test suite
  4. Commit your changes (git commit -am 'Added some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create new Pull Request