vcr_cable 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4914b147c7f4d7934be9b87366a4c731f1ee4870
-  data.tar.gz: ddf96eac16c7d512efa4c95f18e240a568c31dcb
+  metadata.gz: fe1ff17449e0a3663ecc995c7b4c839ee822edb2
+  data.tar.gz: 9aea8f382fd1ccb05ba7aaf1f6bf7987cf670232
 SHA512:
-  metadata.gz: 904b5ffe6ebfecdcc1144c0ccd44a3ef8e25f3440fb14564fd98ea60fde7f56b82f7b76a39be1e1b15d8af1f461247eacaeaefe5e41fdd14ea665a36253357dd
-  data.tar.gz: d845a1376a8062f0f1ec9c922ac2055440042750a7cac0fd1a770f63659df016cec09e5a187525160709001a0647fbba0f5fd2b1bf5eca29df81372faf90afc4
+  metadata.gz: 4c8397872b0c8482ee88d9d39d64e0f082e45498550259999ecd2fcd0928d5aeb1bd5d3330650182f183bbcf3fd337f3cb76b45f91fbaaa3553220c7a7a4a96f
+  data.tar.gz: cbc5df15d80cf206a0d5a68dc7ddf284e20d04b5c70f311e0ab63ad676367fc3fec68be0718dbbc271a47589ca002f8267c266b19cabef69d0acff0f1a970763

data/README.md

@@ -19,6 +19,14 @@ 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:
+
+```bash
+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
@@ -29,11 +37,13 @@ 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
-  disable_vcr_cable: false
+  enable_vcr_cable: false
 ```
 
-If you want to override those values or configure vcr_cable to work in some
+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
@@ -42,7 +52,19 @@ bundle exec rails generate vcr_cable
 
 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.
+## 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:
+
+```ruby
+WebMock.allow_net_connect! if defined? WebMock
+```
+
+It will prevent exceptions when you disable `vcr_cable`.
 
 ## Contributing
 

data/lib/generators/templates/vcr_cable.yml

@@ -1,5 +1,7 @@
 development:
   hook_into: fakeweb
   cassette_library_dir: development_cassettes
+  enable_erb: false
+  allow_playback_repeats: false
   allow_http_connections_when_no_cassette: true
-  disable_vcr_cable: false 
+  enable_vcr_cable: false

data/lib/vcr_cable.rb

@@ -9,32 +9,37 @@ module VcrCable
   DEFAULT_CONFIG = {
     'development' => {
       'cassette_library_dir' => 'development_cassettes',
-      'allow_http_connections_when_no_cassette' => true
+      'allow_http_connections_when_no_cassette' => true,
+      'allow_playback_repeats' => false
     }
   }
 
   def configure_vcr
     VCR.configure do |c|
       c.hook_into config['hook_into']
+      c.default_cassette_options = {
+         :erb => config['enable_erb'],
+         :allow_playback_repeats => config['allow_playback_repeats']
+      }
       c.cassette_library_dir = config['cassette_library_dir']
       c.allow_http_connections_when_no_cassette = config['allow_http_connections_when_no_cassette']
     end
   end
 
   def config
-    @config ||= default_config.merge local_config
+    @config ||= default_config.merge(local_config).merge(env_config)
   end
 
   def enabled?
-    config.present? && !config['disable_vcr_cable']
+    config.present? && config['enable_vcr_cable']
   end
 
-  def disabled_by_env?
-    %w(true 1).include?(ENV['DISABLE_VCR_CABLE'])
+  def enabled_by_env?
+    %w(true 1).include?(ENV['ENABLE_VCR_CABLE']).presence
   end
 
   def reset_config
-    %w[local_config config_file default_config config].each do |name|
+    %w[local_config config_file default_config env_config config].each do |name|
       instance_variable_set "@#{name}", nil
     end
   end
@@ -61,13 +66,18 @@ module VcrCable
     @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 env_config
+    @env_config ||= {
+      'enable_vcr_cable' => enabled_by_env?,
+    }.select { |_, value| !value.nil? }
+  end
+
   def select_default_mocking_library
     if gem_available? 'fakeweb'
       :fakeweb

data/lib/vcr_cable/version.rb

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

data/test/dummy/log/test.log

@@ -1152,3 +1152,171 @@ Connecting to database specified by database.yml
    (0.0ms)  rollback transaction
    (0.0ms)  begin transaction
    (0.0ms)  rollback transaction
+Connecting to database specified by database.yml
+   (0.2ms)  begin transaction
+   (0.1ms)  rollback transaction
+Connecting to database specified by database.yml
+   (0.1ms)  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
+   (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.2ms)  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
+   (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.1ms)  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
+   (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.1ms)  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
+   (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.1ms)  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
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  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

data/test/vcr_cable_test.rb

@@ -3,26 +3,50 @@ require 'test_helper'
 class VcrCableTest < ActiveSupport::TestCase
   setup { VcrCable.reset_config }
 
-  test 'is enabled when config is present' do
-    VcrCable.stubs(:config).returns({:some => :conf})
-    assert VcrCable.enabled?
+  test 'is disabled by default' do
+    assert !VcrCable.enabled?
   end
 
-  test 'is not enabled when config is not present' do
-    VcrCable.stubs(:config).returns({})
-    assert !VcrCable.enabled?
+  test 'is enabled when config enables it' do
+    VcrCable.stubs(:config).returns({'enable_vcr_cable' => true})
+    assert VcrCable.enabled?
   end
 
   test 'is not enabled when config disables it' do
-    VcrCable.stubs(:config).returns({'disable_vcr_cable' => true})
+    VcrCable.stubs(:config).returns({'enable_vcr_cable' => false})
     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)
+  test 'is enabled when ENABLE_VCR_CABLE is present in ENV and set to true' do
+    ENV['ENABLE_VCR_CABLE'] = 'true'
+    assert VcrCable.enabled?
+  end
+
+  test 'is not enabled when ENABLE_VCR_CABLE is present in ENV and set to false' do
+    ENV['ENABLE_VCR_CABLE'] = 'false'
     assert !VcrCable.enabled?
   end
 
+  test 'erb is not enabled when config disables it' do
+    VcrCable.stubs(:config).returns({'enable_erb' => false})
+    assert !VcrCable.config['enable_erb']
+  end
+
+  test 'erb is enabled when config enables it' do
+    VcrCable.stubs(:config).returns({'enable_erb' => true})
+    assert VcrCable.config['enable_erb']
+  end
+
+  test 'allow_playback_repeats is not enabled when config disables it' do
+    VcrCable.stubs(:config).returns({'allow_playback_repeats' => false})
+    assert !VcrCable.config['allow_playback_repeats']
+  end
+
+  test 'allow_playback_repeats is enabled when config enables it' do
+    VcrCable.stubs(:config).returns({'allow_playback_repeats' => true})
+    assert VcrCable.config['allow_playback_repeats']
+  end
+
   test 'loads FakeWeb or WebMock based on which is installed' do
     VcrCable.stubs(:env).returns('development')
     assert_equal :fakeweb, VcrCable.config['hook_into']
@@ -51,7 +75,7 @@ class VcrCableTest < ActiveSupport::TestCase
   end
 
   test 'adds VCR::Middleware::Rack to the middleware stack' do
-    list = Dir.chdir(Rails.root) {`bundle exec rake middleware RAILS_ENV=development`}
+    list = Dir.chdir(Rails.root) {`bundle exec rake middleware RAILS_ENV=development ENABLE_VCR_CABLE=true`}
     assert_match /VCR::Middleware::Rack/, list
   end
 

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: vcr_cable
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - andrea longhi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-04 00:00:00.000000000 Z
+date: 2015-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: use VCR in development (or whatever Rails environment you want)
@@ -101,20 +101,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.md
+- Rakefile
 - lib/generators/templates/vcr_cable.yml
 - lib/generators/vcr_cable_generator.rb
 - lib/tasks/vcr_cable_tasks.rake
+- lib/vcr_cable.rb
 - lib/vcr_cable/railtie.rb
 - lib/vcr_cable/version.rb
-- lib/vcr_cable.rb
-- MIT-LICENSE
-- Rakefile
-- README.md
+- test/dummy/README.rdoc
+- test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/views/layouts/application.html.erb
+- test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
 - test/dummy/config/database.yml
@@ -132,7 +135,6 @@ files:
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config/vcr_cable.yml
-- test/dummy/config.ru
 - test/dummy/db/development.sqlite3
 - test/dummy/db/schema.rb
 - test/dummy/db/test.sqlite3
@@ -144,8 +146,6 @@ files:
 - test/dummy/public/422.html
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
-- test/dummy/Rakefile
-- test/dummy/README.rdoc
 - test/dummy/script/rails
 - test/test_helper.rb
 - test/vcr_cable_test.rb
@@ -158,17 +158,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: use VCR in development