vcr_cable 0.2.3 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4914b147c7f4d7934be9b87366a4c731f1ee4870
+  data.tar.gz: ddf96eac16c7d512efa4c95f18e240a568c31dcb
+SHA512:
+  metadata.gz: 904b5ffe6ebfecdcc1144c0ccd44a3ef8e25f3440fb14564fd98ea60fde7f56b82f7b76a39be1e1b15d8af1f461247eacaeaefe5e41fdd14ea665a36253357dd
+  data.tar.gz: d845a1376a8062f0f1ec9c922ac2055440042750a7cac0fd1a770f63659df016cec09e5a187525160709001a0647fbba0f5fd2b1bf5eca29df81372faf90afc4

data/README.md

@@ -2,51 +2,53 @@
 
 [![Build Status](https://secure.travis-ci.org/spaghetticode/vcr_cable.png)](http://travis-ci.org/spaghetticode/vcr_cable)
 
-This gem allows to use VCR in development. This is quite handy when your app
+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 happent to have no connection
+or when you want to save bandwidth, or when you happen to have no connection
 at all.
 
 
 ## Usage
 
-Add required gems to your Gemfile:
+Add the required gem(s) to your Gemfile:
 
 ```ruby
 gem 'vcr_cable'
-gem 'webmock' # or fakeweb
+gem 'fakeweb' # or webmock
 ```
-Now all external requests will hit the remote servers only one time, and the
-application will subsequently use the recorded data.
 
+*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.*
+
+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 values are (extracted from ```lib/vcr_cable.rb```):
+The default VCR configuration is:
 
-```ruby
-  DEFAULT_CONFIG = {
-    'hook_into' => :fakeweb,
-    'cassette_library_dir' => 'development_cassettes',
-    'allow_http_connections_when_no_cassette' => true
-  }
+```yaml
+development:
+  hook_into: fakeweb
+  cassette_library_dir: development_cassettes
+  allow_http_connections_when_no_cassette: true
+  disable_vcr_cable: false
 ```
 
-If you want to override those values you can generate the vcr_cable.yml config
-file and edit its params:
+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:
 
 ```bash
 bundle exec rails generate vcr_cable
 ```
 
-You will find the generated file in the ```config``` folder of your rails
-application.
+The file will be located in the ```config``` folder of your rails application.
+
+You can also disable vcr_cable by setting `DISABLE_VCR_CABLE=true` in your environment. This would allow each developer to opt into or out of vcr_cable on his/her own machine, for example.
 
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Add your feature tests to the rspec/cucumber test suite
+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

data/lib/generators/templates/vcr_cable.yml

@@ -2,3 +2,4 @@ development:
   hook_into: fakeweb
   cassette_library_dir: development_cassettes
   allow_http_connections_when_no_cassette: true
+  disable_vcr_cable: false 

data/lib/vcr_cable.rb

@@ -2,12 +2,12 @@ require 'vcr'
 require 'vcr_cable/railtie' if defined? Rails
 
 module VcrCable
+  class InvalidMockingLibraryError < ArgumentError; end;
   extend self
 
   CONFIG_FILE = 'vcr_cable.yml'
   DEFAULT_CONFIG = {
     'development' => {
-      'hook_into' => :fakeweb,
       'cassette_library_dir' => 'development_cassettes',
       'allow_http_connections_when_no_cassette' => true
     }
@@ -22,30 +22,70 @@ module VcrCable
   end
 
   def config
-    @config ||= global_config[env] || {}
+    @config ||= default_config.merge local_config
   end
 
   def enabled?
-    config.present?
+    config.present? && !config['disable_vcr_cable']
+  end
+
+  def disabled_by_env?
+    %w(true 1).include?(ENV['DISABLE_VCR_CABLE'])
   end
 
   def reset_config
-    %w[global_config env_config config_file  config].each do |name|
+    %w[local_config config_file default_config config].each do |name|
       instance_variable_set "@#{name}", nil
     end
   end
 
-  def global_config
-    @global_config ||= File.file?(config_file) ? YAML.load_file(config_file) : DEFAULT_CONFIG
-  end
-
   private
 
   def env
     Rails.env
   end
 
+  def local_config
+    @local_config ||= if File.file? config_file
+      YAML.load(ERB.new(config_file.read).result).fetch env, {}
+    else
+      {}
+    end
+  end
+
   def config_file
     @config_file ||= Rails.root.join 'config', CONFIG_FILE
   end
+
+  def default_config
+    @default_config ||= if DEFAULT_CONFIG.has_key? env
+      DEFAULT_CONFIG[env].merge({
+        'hook_into' => select_default_mocking_library,
+        'disable_vcr_cable' => disabled_by_env?
+      })
+    else
+      {}
+    end
+  end
+
+  def select_default_mocking_library
+    if gem_available? 'fakeweb'
+      :fakeweb
+    elsif gem_available? 'webmock'
+      :webmock
+    else
+      raise InvalidMockingLibraryError.new(
+        "A valid mocking framework was not supplied - Add FakeWeb or WebMock to Gemfile"
+      )
+    end
+  end
+
+  # http://stackoverflow.com/questions/1032114/check-for-ruby-gem-availability#answer-7455576
+  def gem_available?(name)
+    Gem::Specification.find_by_name(name)
+  rescue Gem::LoadError
+    false
+  rescue
+    Gem.available?(name)
+  end
 end

data/lib/vcr_cable/version.rb

@@ -1,3 +1,3 @@
 module VcrCable
-  VERSION = '0.2.3'
+  VERSION = '0.3.0'
 end

data/test/dummy/config/vcr_cable.yml

@@ -1,9 +1,2 @@
 development:
-  hook_into: fakeweb
-  cassette_library_dir: development_cassettes
-  allow_http_connections_when_no_cassette: true
-
-test:
-  hook_into: fakeweb
   cassette_library_dir: custom_named_cassettes
-  allow_http_connections_when_no_cassette: false

data/test/dummy/log/test.log

@@ -1106,3 +1106,49 @@ Connecting to database specified by database.yml
    (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
    (0.1ms)  rollback transaction
+Connecting to database specified by database.yml
+   (0.5ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+Connecting to database specified by database.yml
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction

data/test/vcr_cable_test.rb

@@ -13,36 +13,49 @@ class VcrCableTest < ActiveSupport::TestCase
     assert !VcrCable.enabled?
   end
 
-  test 'loads the default config when current env has configuration' do
-    File.stubs(:file?).returns(false)
+  test 'is not enabled when config disables it' do
+    VcrCable.stubs(:config).returns({'disable_vcr_cable' => true})
+    assert !VcrCable.enabled?
+  end
+
+  test 'is not enabled when DISABLE_VCR_CABLE is present in ENV' do
+    ENV.stubs(:[]).with('DISABLE_VCR_CABLE').returns(true)
+    assert !VcrCable.enabled?
+  end
+
+  test 'loads FakeWeb or WebMock based on which is installed' do
     VcrCable.stubs(:env).returns('development')
-    VcrCable.configure_vcr
-    assert_match /development_cassettes$/, VCR.configuration.cassette_library_dir
+    assert_equal :fakeweb, VcrCable.config['hook_into']
+  end
+
+  test 'raises an error when no mocking library is available' do
+    VcrCable.stubs(:env).returns('development')
+    VcrCable.stubs(:gem_available?).returns(false)
+    assert_raises(VcrCable::InvalidMockingLibraryError) { VcrCable.config['hook_into'] }
   end
 
   test 'has no config when the current env has no configuration' do
-    VcrCable.stubs(:env).returns('without_vcr_cable')
     assert !VcrCable.config.present?
   end
 
-  test 'config in config/vcr_cable.yml overwrites default values' do
+  test 'loads config from config/vcr_cable.yml over default values' do
+    VcrCable.stubs(:env).returns('development')
     VcrCable.configure_vcr
     assert_match /custom_named_cassettes$/, VCR.configuration.cassette_library_dir
   end
 
-  test 'global_config contains all env specific configs' do
-    %w[test development].each do |env_name|
-      VcrCable.global_config.keys.include?(env_name)
-    end
+  test 'loads default values when not specified in config/vcr_cable.yml' do
+    VcrCable.stubs(:env).returns('development')
+    VcrCable.configure_vcr
+    assert VcrCable.config['allow_http_connections_when_no_cassette']
   end
 
   test 'adds VCR::Middleware::Rack to the middleware stack' do
-    assert Rails.configuration.middleware.any? {|name| name == 'VCR::Middleware::Rack'}
+    list = Dir.chdir(Rails.root) {`bundle exec rake middleware RAILS_ENV=development`}
+    assert_match /VCR::Middleware::Rack/, list
   end
 
   test 'it does not add VCR::Middleware::Rack to environments that are not enabled' do
-    list = Dir.chdir(Rails.root) {`bundle exec rake middleware RAILS_ENV=no_vcr`}
-    assert_not_match /VCR::Middleware::Rack/, list
+    assert !Rails.configuration.middleware.any? {|name| name == 'VCR::Middleware::Rack'}
   end
-
 end

metadata

@@ -1,110 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: vcr_cable
 version: !ruby/object:Gem::Version
-  version: 0.2.3
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - andrea longhi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-29 00:00:00.000000000 Z
+date: 2014-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-test
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: use VCR in development (or whatever Rails environment you want)
@@ -164,33 +151,26 @@ files:
 - test/vcr_cable_test.rb
 homepage: https://github.com/spaghetticode/vcr_cable
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2234079835404851201
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2234079835404851201
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: use VCR in development
 test_files:
 - test/dummy/app/assets/javascripts/application.js