webvalve 0.9.10 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e78700063483cd49d8ee34f059f807c6640a002e3380f8f255a742ae01aef042
-  data.tar.gz: f7d1b324e129d5fbe368ef22bd98ddddf83ddf8a9252f8ed539142b3688ab6a9
+  metadata.gz: 3bf83f303a9549cb99552f7fc6810ac73ad574d551247d9b7b00f637290e34e8
+  data.tar.gz: 110b2a233b4abcf9a59a49f0354202b274dd6056561ed9aff9e985c9f8335a7a
 SHA512:
-  metadata.gz: f1781dd8a0d8d64fe570164febfb328f60e3dabf757931fecf16c326bae36a87dd6d1b52dab62bfb588b5e07bb0f0795c61f92b395c5d2e9ea82b16266fd2f49
-  data.tar.gz: 43a431a534c6dd790b05fd7767125b22359fa2d17e2d3fd87a1119bc9f242457ac4e355a069cdb172f5ba61cbe9e2e9225a6cf8072ee7e2c6b328f9d7e2a230c
+  metadata.gz: a62b2b9f6a2956445f9235b88eaa5abd425845da985952394bc0844d951308f556d54d13432df941f59a9047f62dd9ee4053a5b91d770bf6532a403297d0d8cc
+  data.tar.gz: ea441eb2ba4de0f1a84c8ab6648dd1a6c25c6858985b15ebd090bb277a3a9d637df8d439992934bf9671ea99c57625d9abce457d4f2b5a43a96de3b3af9ceb06

data/CHANGELOG.md

@@ -9,9 +9,13 @@ and this project aims to adhere to [Semantic Versioning](http://semver.org/spec/
 ### Added
 ### Removed
 
+## [0.10.0] - 2019-09-23
+### Changed
+- `Webvalve.register` no longer accepts classes; you must provide class names as strings. Fixes a Rails 6 deprecation warning. (https://github.com/Betterment/webvalve/pull/35)
+
 ## [0.9.10] - 2019-09-09
 ### Changed
-- rename `whitelist_url` to `allow_url` (https://github.com/Betterment/retail/pull/4424)
+- rename `whitelist_url` to `allow_url` (https://github.com/Betterment/webvalve/pull/33)
 
 ## [0.9.9] - 2019-05-24
 ### Changed
@@ -34,7 +38,8 @@ and this project aims to adhere to [Semantic Versioning](http://semver.org/spec/
 ### Changed
 - WebMock 3+ support from @messanjah (https://github.com/Betterment/webvalve/pull/22)
 
-[Unreleased]: https://github.com/Betterment/webvalve/compare/v0.9.9...HEAD
+[Unreleased]: https://github.com/Betterment/webvalve/compare/v0.10.0...HEAD
+[0.10.0]: https://github.com/Betterment/webvalve/compare/v0.9.10...v0.10.0
 [0.9.10]: https://github.com/Betterment/webvalve/compare/v0.9.9...v0.9.10
 [0.9.9]: https://github.com/Betterment/webvalve/compare/v0.9.8...v0.9.9
 [0.9.8]: https://github.com/Betterment/webvalve/compare/v0.9.7...v0.9.8

data/README.md

@@ -40,13 +40,13 @@ is a warning that the requested URL was not mocked. This behavior comes
 straight outta WebMock.
 
 ```ruby
-irb(main):007:0> Net::HTTP.get(URI('http://bank.dev'))
+irb(main):007:0> Net::HTTP.get(URI('http://bank.test'))
 
-WebMock::NetConnectNotAllowedError: Real HTTP connections are disabled. Unregistered request: GET http://bank.dev/ with headers {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}
+WebMock::NetConnectNotAllowedError: Real HTTP connections are disabled. Unregistered request: GET http://bank.test/ with headers {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}
 
 You can stub this request with the following snippet:
 
-stub_request(:get, "http://bank.dev/").
+stub_request(:get, "http://bank.test/").
   with(:headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
   to_return(:status => 200, :body => "", :headers => {})
 
@@ -68,12 +68,12 @@ This will drop a new file in your config directory.
 
 # # register services
 #
-# WebValve.register FakeBank
-# WebValve.register FakeExample, url: 'https://api.example.org'
+# WebValve.register "FakeBank"
+# WebValve.register "FakeExample", url: "https://api.example.org"
 #
 # # add urls to allowlist
 #
-# WebValve.allow_url 'https://example.com'
+# WebValve.allow_url "https://example.com"
 ```
 
 If you're not using Rails, you can create this file for yourself.
@@ -113,7 +113,7 @@ And it will automatically register it in `config/webvalve.rb`
 
 ```ruby
 # config/webvalve.rb
-WebValve.register FakeBank
+WebValve.register "FakeBank"
 ```
 
 Again, if you're not using Rails, you'll have to create this file
@@ -123,7 +123,7 @@ You'll also want to define an environment variable for the base url of
 your service.
 
 ```bash
-export BANK_API_URL='http://bank.dev'
+export BANK_API_URL='http://bank.test'
 ```
 
 That's it. Now when you hit your service again, it will route your
@@ -189,10 +189,10 @@ endpoint in a test, we can just use WebMock™.
 # in an rspec test...
 
 it 'handles 404s by returning nil' do
-  fake_req = stub_request('http://bank.dev/some/url/1234')
+  fake_req = stub_request('http://bank.test/some/url/1234')
     .to_return(status: 404, body: nil)
 
-  response = Faraday.get 'http://bank.dev/some/url/1234'
+  response = Faraday.get 'http://bank.test/some/url/1234'
   expect(response.body).to be_nil
   expect(fake_req).to have_been_requested
 end

data/lib/generators/webvalve/fake_service_generator.rb

@@ -37,7 +37,7 @@ module Webvalve
 
       def register_fake_in_config
         append_to_file config_file_path do <<~RUBY
-          WebValve.register #{fake_service_class_name}
+          WebValve.register "#{fake_service_class_name}"
         RUBY
         end
       end

data/lib/generators/webvalve/install_generator.rb

@@ -16,12 +16,12 @@ module Webvalve
         create_file full_file_path, <<-FILE.strip_heredoc
           # # register services
           #
-          # WebValve.register FakeThing
-          # WebValve.register FakeExample, url: 'https://api.example.org'
+          # WebValve.register "FakeThing"
+          # WebValve.register "FakeExample", url: "https://api.example.org"
           #
           # # add urls to the allowlist
           #
-          # WebValve.allow_url 'https://example.com'
+          # WebValve.allow_url "https://example.com"
         FILE
       end
 

data/lib/webvalve/fake_service_config.rb

@@ -1,9 +1,9 @@
 module WebValve
   class FakeServiceConfig
-    attr_reader :service
+    attr_reader :service_class_name
 
-    def initialize(service:, url: nil)
-      @service = service
+    def initialize(service_class_name:, url: nil)
+      @service_class_name = service_class_name
       @custom_service_url = url
     end
 
@@ -26,9 +26,9 @@ module WebValve
 
     def missing_url_message
       <<~MESSAGE
-        There is no URL defined for #{service.name}.
+        There is no URL defined for #{service_class_name}.
         Configure one by setting the ENV variable "#{service_name.to_s.upcase}_API_URL"
-        or by using WebValve.register #{service.name}, url: "http://something.dev"
+        or by using WebValve.register "#{service_class_name}", url: "http://something.dev"
       MESSAGE
     end
 
@@ -45,7 +45,7 @@ module WebValve
     end
 
     def service_name
-      @service_name ||= service.name.demodulize.underscore.sub 'fake_', ''
+      @service_name ||= service_class_name.demodulize.underscore.sub 'fake_', ''
     end
   end
 end

data/lib/webvalve/fake_service_wrapper.rb

@@ -1,8 +1,8 @@
 module WebValve
   class FakeServiceWrapper
     # lazily resolve the app constant to leverage rails class reloading
-    def initialize(app)
-      @app_klass_name = app.name
+    def initialize(app_class_name)
+      @app_class_name = app_class_name
     end
 
     def call(env)
@@ -12,7 +12,7 @@ module WebValve
     private
 
     def app
-      @app_klass_name.constantize
+      @app_class_name.constantize
     end
   end
 end

data/lib/webvalve/manager.rb

@@ -7,9 +7,10 @@ module WebValve
   class Manager
     include Singleton
 
-    def register(fake_service, **args)
-      raise "#{fake_service.inspect} already registered" if fake_service_configs.any? { |c| c.service == fake_service }
-      fake_service_configs << FakeServiceConfig.new(service: fake_service, **args)
+    def register(fake_service_class_name, **args)
+      raise "register must be called with a string to comply with Rails autoloading" unless fake_service_class_name.is_a?(String)
+      raise "#{fake_service_class_name.inspect} already registered" if fake_service_configs.any? { |c| c.service_class_name == fake_service_class_name }
+      fake_service_configs << FakeServiceConfig.new(service_class_name: fake_service_class_name, **args)
     end
 
     def allow_url(url)
@@ -62,7 +63,7 @@ module WebValve
       WebMock.stub_request(
         :any,
         url_to_regexp(config.service_url)
-      ).to_rack(FakeServiceWrapper.new(config.service))
+      ).to_rack(FakeServiceWrapper.new(config.service_class_name))
     end
 
     def allowlist_service(config)

data/lib/webvalve/version.rb

@@ -1,3 +1,3 @@
 module WebValve
-  VERSION = "0.9.10"
+  VERSION = "0.10.0"
 end

data/spec/dummy/log/test.log

@@ -0,0 +1,8 @@
+  WebValve Request Captured (10.6ms)  dummy.dev GET /widgets [200]
+  WebValve Request Captured (0.4ms)  dummy.dev GET /foos []
+  WebValve Request Captured (0.8ms)  dummy.dev GET /foos []
+  WebValve Request Captured (2.1ms)  dummy.dev GET /widgets [200]
+  WebValve Request Captured (0.3ms)  dummy.dev GET /foos []
+  WebValve Request Captured (19.5ms)  dummy.dev GET /widgets [200]
+  WebValve Request Captured (0.4ms)  dummy.dev GET /foos []
+  WebValve Request Captured (1.8ms)  dummy.dev GET /widgets [200]

data/spec/examples.txt

@@ -1,32 +1,32 @@
 example_id                                             | status | run_time        |
 ------------------------------------------------------ | ------ | --------------- |
-./spec/webvalve/fake_service_config_spec.rb[1:1:1:1]   | passed | 0.00013 seconds |
-./spec/webvalve/fake_service_config_spec.rb[1:1:1:2]   | passed | 0.00013 seconds |
-./spec/webvalve/fake_service_config_spec.rb[1:1:2:1]   | passed | 0.00013 seconds |
-./spec/webvalve/fake_service_config_spec.rb[1:1:2:2]   | passed | 0.00016 seconds |
-./spec/webvalve/fake_service_config_spec.rb[1:1:2:3]   | passed | 0.00017 seconds |
-./spec/webvalve/fake_service_config_spec.rb[1:1:3:1]   | passed | 0.00019 seconds |
-./spec/webvalve/fake_service_config_spec.rb[1:1:3:2]   | passed | 0.00014 seconds |
+./spec/webvalve/fake_service_config_spec.rb[1:1:1:1]   | passed | 0.00011 seconds |
+./spec/webvalve/fake_service_config_spec.rb[1:1:1:2]   | passed | 0.00014 seconds |
+./spec/webvalve/fake_service_config_spec.rb[1:1:2:1]   | passed | 0.00012 seconds |
+./spec/webvalve/fake_service_config_spec.rb[1:1:2:2]   | passed | 0.00014 seconds |
+./spec/webvalve/fake_service_config_spec.rb[1:1:2:3]   | passed | 0.00015 seconds |
+./spec/webvalve/fake_service_config_spec.rb[1:1:3:1]   | passed | 0.00012 seconds |
+./spec/webvalve/fake_service_config_spec.rb[1:1:3:2]   | passed | 0.00011 seconds |
 ./spec/webvalve/fake_service_config_spec.rb[1:1:3:3:1] | passed | 0.00016 seconds |
-./spec/webvalve/fake_service_config_spec.rb[1:1:3:3:2] | passed | 0.00016 seconds |
-./spec/webvalve/fake_service_config_spec.rb[1:2:1]     | passed | 0.00015 seconds |
-./spec/webvalve/fake_service_config_spec.rb[1:2:2]     | passed | 0.00013 seconds |
-./spec/webvalve/fake_service_config_spec.rb[1:2:3]     | passed | 0.00013 seconds |
-./spec/webvalve/fake_service_spec.rb[1:1]              | passed | 0.00273 seconds |
-./spec/webvalve/fake_service_spec.rb[1:2:1]            | passed | 0.0183 seconds  |
-./spec/webvalve/fake_service_spec.rb[1:2:2]            | passed | 0.01809 seconds |
-./spec/webvalve/manager_spec.rb[1:1]                   | passed | 0.00069 seconds |
-./spec/webvalve/manager_spec.rb[1:2:1]                 | passed | 0.00233 seconds |
-./spec/webvalve/manager_spec.rb[1:3:1]                 | passed | 0.00182 seconds |
-./spec/webvalve/manager_spec.rb[1:4:1]                 | passed | 0.00134 seconds |
-./spec/webvalve/manager_spec.rb[1:5:1]                 | passed | 0.03628 seconds |
-./spec/webvalve/manager_spec.rb[1:5:2]                 | passed | 0.00118 seconds |
-./spec/webvalve/manager_spec.rb[1:5:3]                 | passed | 0.00128 seconds |
-./spec/webvalve/manager_spec.rb[1:5:4:1]               | passed | 0.00141 seconds |
-./spec/webvalve/manager_spec.rb[1:5:5:1]               | passed | 0.00147 seconds |
-./spec/webvalve/manager_spec.rb[1:5:5:2]               | passed | 0.00148 seconds |
-./spec/webvalve/manager_spec.rb[1:5:5:3]               | passed | 0.00347 seconds |
-./spec/webvalve_spec.rb[1:1]                           | passed | 0.00008 seconds |
-./spec/webvalve_spec.rb[1:2]                           | passed | 0.00011 seconds |
-./spec/webvalve_spec.rb[1:3]                           | passed | 0.00209 seconds |
+./spec/webvalve/fake_service_config_spec.rb[1:1:3:3:2] | passed | 0.00024 seconds |
+./spec/webvalve/fake_service_config_spec.rb[1:2:1]     | passed | 0.00132 seconds |
+./spec/webvalve/fake_service_config_spec.rb[1:2:2]     | passed | 0.00061 seconds |
+./spec/webvalve/fake_service_config_spec.rb[1:2:3]     | passed | 0.00016 seconds |
+./spec/webvalve/fake_service_spec.rb[1:1]              | passed | 0.0031 seconds  |
+./spec/webvalve/fake_service_spec.rb[1:2:1]            | passed | 0.00281 seconds |
+./spec/webvalve/fake_service_spec.rb[1:2:2]            | passed | 0.02529 seconds |
+./spec/webvalve/manager_spec.rb[1:1]                   | passed | 0.00005 seconds |
+./spec/webvalve/manager_spec.rb[1:2:1]                 | passed | 0.00622 seconds |
+./spec/webvalve/manager_spec.rb[1:3:1]                 | passed | 0.00033 seconds |
+./spec/webvalve/manager_spec.rb[1:4:1]                 | passed | 0.00018 seconds |
+./spec/webvalve/manager_spec.rb[1:5:1]                 | passed | 0.02341 seconds |
+./spec/webvalve/manager_spec.rb[1:5:2]                 | passed | 0.00039 seconds |
+./spec/webvalve/manager_spec.rb[1:5:3]                 | passed | 0.00063 seconds |
+./spec/webvalve/manager_spec.rb[1:5:4:1]               | passed | 0.00038 seconds |
+./spec/webvalve/manager_spec.rb[1:5:5:1]               | passed | 0.00122 seconds |
+./spec/webvalve/manager_spec.rb[1:5:5:2]               | passed | 0.00129 seconds |
+./spec/webvalve/manager_spec.rb[1:5:5:3]               | passed | 0.00181 seconds |
+./spec/webvalve_spec.rb[1:1]                           | passed | 0.0001 seconds  |
+./spec/webvalve_spec.rb[1:2]                           | passed | 0.00449 seconds |
+./spec/webvalve_spec.rb[1:3]                           | passed | 0.00014 seconds |
 ./spec/webvalve_spec.rb[1:4]                           | passed | 0.00009 seconds |

data/spec/webvalve/fake_service_config_spec.rb

@@ -17,7 +17,7 @@ RSpec.describe WebValve::FakeServiceConfig do
     stub_const('FakeDummy', fake_service)
   end
 
-  subject { described_class.new service: fake_service }
+  subject { described_class.new service_class_name: fake_service.name }
 
   describe '.should_intercept?' do
     context 'in test env' do
@@ -136,7 +136,7 @@ RSpec.describe WebValve::FakeServiceConfig do
       expect { subject.service_url }.to raise_error <<~MESSAGE
         There is no URL defined for FakeDummy.
         Configure one by setting the ENV variable "DUMMY_API_URL"
-        or by using WebValve.register FakeDummy, url: "http://something.dev"
+        or by using WebValve.register "FakeDummy", url: "http://something.dev"
       MESSAGE
     end
 

data/spec/webvalve/fake_service_spec.rb

@@ -28,7 +28,7 @@ RSpec.describe WebValve::FakeService do
 
     it 'raise a useful error when an unmapped route is requested' do
       with_env 'DUMMY_API_URL' => 'http://dummy.dev' do
-        WebValve.register subject
+        WebValve.register subject.name
         WebValve.setup
 
         expect { Net::HTTP.get(URI('http://dummy.dev/foos')) }.to raise_error(RuntimeError, /route not defined for GET/)
@@ -37,7 +37,7 @@ RSpec.describe WebValve::FakeService do
 
     it 'returns the result from the fake when a mapped route is requested' do
       with_env 'DUMMY_API_URL' => 'http://dummy.dev' do
-        WebValve.register subject
+        WebValve.register subject.name
         WebValve.setup
 
         expect(Net::HTTP.get(URI('http://dummy.dev/widgets'))).to eq({ result: 'it works!' }.to_json)

data/spec/webvalve/manager_spec.rb

@@ -17,22 +17,22 @@ RSpec.describe WebValve::Manager do
     end
   end
 
-  describe '#register(fake_service)' do
+  describe '#register(fake_service_class_name)' do
     it 'raises on duplicates' do
-      fake = class_double(WebValve::FakeService)
+      fake = class_double(WebValve::FakeService, name: "FooService")
 
-      subject.register fake
-      expect { subject.register fake }.to raise_error(/already registered/)
+      subject.register fake.name
+      expect { subject.register fake.name }.to raise_error(/already registered/)
       expect(subject.fake_service_configs.count).to eq 1
-      expect(subject.fake_service_configs.first.service).to eq fake
+      expect(subject.fake_service_configs.first.service_class_name).to eq fake.name
     end
   end
 
-  describe '#register(fake_service, url:)' do
+  describe '#register(fake_service_class_name, url:)' do
     it 'stores the url' do
-      fake = class_double(WebValve::FakeService)
+      fake = class_double(WebValve::FakeService, name: "FooService")
 
-      subject.register fake, url: 'http://manual.dev'
+      subject.register fake.name, url: 'http://manual.dev'
       expect(subject.fake_service_configs.first.service_url).to eq 'http://manual.dev'
     end
   end
@@ -109,7 +109,7 @@ RSpec.describe WebValve::Manager do
         allow(WebMock).to receive(:stub_request).and_return(web_mock_stubble)
 
         with_env 'SOMETHING_API_URL' => 'http://fake.dev' do
-          subject.register disabled_service
+          subject.register disabled_service.name
           subject.setup
         end
 
@@ -121,7 +121,7 @@ RSpec.describe WebValve::Manager do
         enabled_service = class_double(WebValve::FakeService, name: 'FakeSomething')
 
         with_env 'SOMETHING_ENABLED' => '1', 'SOMETHING_API_URL' => 'http://real.dev' do
-          subject.register enabled_service
+          subject.register enabled_service.name
           subject.setup
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webvalve
 version: !ruby/object:Gem::Version
-  version: 0.9.10
+  version: 0.10.0
 platform: ruby
 authors:
 - Sam Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-09 00:00:00.000000000 Z
+date: 2019-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -190,6 +190,7 @@ files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/config/secrets.yml
+- spec/dummy/log/test.log
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
@@ -220,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A library for faking http service integrations in development and test
@@ -259,6 +260,7 @@ test_files:
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/404.html
+- spec/dummy/log/test.log
 - spec/dummy/README.rdoc
 - spec/examples.txt
 - spec/webvalve/fake_service_spec.rb