puffing-billy 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfd7317180cc078b689374dabb6dc2e0321a075fca60751bb20aa5ea0b8e6198
-  data.tar.gz: c4452386eb8e867598930b0734b4fbcad4f3d092fe6f6b5ac844dc2349cab27d
+  metadata.gz: 6445deb6e30f295a1f15a5f4b1a094be474a587b375ecc6f23023baf0c74a9a0
+  data.tar.gz: b1da2a249c2d37d679f4134714ee1c33f6f6eb77fabefdb34637d1ebdf88b655
 SHA512:
-  metadata.gz: e3d719b6b412b4c9e2d63fcf82055a6d0ca3bbe5b6150f24bbe24fff16f660882a0d00f882be18595756b046c2f327fc1ecb5655bcbaf67bc9750e642ec052c5
-  data.tar.gz: 52817fd2b4d8ef53078841f7a65945e1ca5f36414a4fd066820c005dfca4d2e1c13801731033d5ff3a26bfbd9066eebcc5ab0f7df6ba394c1e7cbcdab25c75fc
+  metadata.gz: fde48ead48a81d1f6b98e307aac098f3fd5357629a147fda05800120708e86f51a78433d15266e559ac856d22dd99f931e7a6c3a3ae10e158eb786b9d095381b
+  data.tar.gz: d4e2312af4c9a8e67c5d7316b0c9a0384d451974a78b3c9b3077d5392a492710460df32c08e4767a17f3e9e6f883e6ce98a9b81168e2e6dced1250ba6204104a

data/.travis.yml

@@ -1,23 +1,36 @@
 language: ruby
-cache: bundler
-before_install:
-  - gem install bundler -v '< 2'
-  - export PHANTOMJS_VERSION='2.1.1'
-  - export PHANTOMJS_URL='https://github.com/Medium/phantomjs'
-  - export PHANTOMJS_URL+="/releases/download/v${PHANTOMJS_VERSION}"
-  - export PHANTOMJS_URL+="/phantomjs-${PHANTOMJS_VERSION}-linux-x86_64.tar.bz2"
-  - >
-    wget -q ${PHANTOMJS_URL} &&
-    tar xfv phantomjs-${PHANTOMJS_VERSION}-linux-x86_64.tar.bz2 \
-      --wildcards */bin/phantomjs --strip-components=2
-  - export PATH="`pwd`:${PATH}"
-before_script:
-  - phantomjs --version
-  - bundle --version
+
 rvm:
   - 2.3
   - 2.4
   - 2.5
   - 2.6
-script: bundle exec rspec spec
+
+cache:
+  bundler: true
+  directories:
+  - $HOME/.webdrivers
+
+addons:
+  chrome: stable
+  apt:
+    update: true
+
+sudo: false
+dist: xenial
+
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+
+matrix:
+  fast_finish: true
+
+bundler_args: --jobs 3 --retry 3
+
+before_install:
+  - gem update --system
+  - gem install bundler
 

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+v2.2.0, 2019-10-26
+-------------------
+  * Before handle request method [#273](https://github.com/oesmith/puffing-billy/pull/273)
+  * Add Selenium headless driver [#272](https://github.com/oesmith/puffing-billy/pull/272)
+
 v2.1.1, 2019-06-15
 -------------------
   * Add driver registration for chrome headless [#267](https://github.com/oesmith/puffing-billy/pull/267)

data/README.md

@@ -55,7 +55,9 @@ require 'billy/capybara/rspec'
 
 # select a driver for your chosen browser environment
 Capybara.javascript_driver = :selenium_billy # Uses Firefox
+# Capybara.javascript_driver = :selenium_headless_billy # Uses Firefox in headless mode
 # Capybara.javascript_driver = :selenium_chrome_billy
+# Capybara.javascript_driver = :selenium_chrome_headless_billy
 # Capybara.javascript_driver = :apparition_billy
 # Capybara.javascript_driver = :webkit_billy
 # Capybara.javascript_driver = :poltergeist_billy
@@ -246,7 +248,8 @@ In your `rails_helper.rb`:
 
 ```ruby
 Billy.configure do |c|
-  c.whitelist = ['test.host', 'localhost', '127.0.0.1']
+  c.whitelist = ['test.host', 'localhost', '127.0.0.1'] # To replace the default whitelist, OR
+  c.whitelist << 'mynewhost.local' # to append a host without overriding the defaults.
 end
 ```
 
@@ -434,9 +437,6 @@ internally on this request, or your test ended before it could complete successf
 
 `c.after_cache_handles_request` is used to configure a callback that can operate on the response after it has been retrieved from the cache but before it is returned. The callback receives the request and response as arguments, with a request object like: `{ method: method, url: url, headers: headers, body: body }`. An example usage would be manipulating the Access-Control-Allow-Origin header so that your test server doesn't always have to run on the same port in order to accept cached responses to CORS requests:
 
-`c.use_ignore_params` is used to choose whether to use the ignore_params blacklist or the allow_params whitelist. Set to `true` to use `c.ignore_params`,
-`false` to use `c.allow_params`
-
 ```
 Billy.configure do |c|
   ...
@@ -454,6 +454,18 @@ Billy.configure do |c|
 end
 ```
 
+`c.use_ignore_params` is used to choose whether to use the ignore_params blacklist or the allow_params whitelist. Set to `true` to use `c.ignore_params`,
+`false` to use `c.allow_params`
+
+`c.before_handle_request` is used to modify `method`, `url`, `headers`, `body` before handle request by `stubs`, `cache` or `proxy`. Method accept 4 argumens and must return array of this arguments:
+
+```
+c.before_handle_request = proc { |method, url, headers, body|
+  filtered_body = JSON.dump(filter_secret_data(JSON.load(body)))
+  [method, url, headers, filtered_body]
+}
+```
+
 `c.cache_simulates_network_delays` is used to add some delay before cache returns response. When set to `true`, cached requests will wait from configured delay time before responding. This allows to catch various race conditions in asynchronous front-end requests. The default is `false`.
 
 `c.cache_simulates_network_delay_time` is used to configure time (in seconds) to wait until responding from cache. The default is `0.1`.

data/Rakefile

@@ -1,2 +1,11 @@
 #!/usr/bin/env rake
 require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+desc 'Run all tests'
+task default: [:spec]

data/lib/billy/browsers/capybara.rb

@@ -47,12 +47,19 @@ module Billy
 
       def self.register_selenium_driver
         ::Capybara.register_driver :selenium_billy do |app|
-          profile = Selenium::WebDriver::Firefox::Profile.new
-          profile.assume_untrusted_certificate_issuer = false
-          profile.proxy = Selenium::WebDriver::Proxy.new(
-            http: "#{Billy.proxy.host}:#{Billy.proxy.port}",
-            ssl: "#{Billy.proxy.host}:#{Billy.proxy.port}")
-          ::Capybara::Selenium::Driver.new(app, profile: profile)
+          options = build_selenium_options_for_firefox
+          capabilities = Selenium::WebDriver::Remote::Capabilities.firefox(accept_insecure_certs: true)
+
+          ::Capybara::Selenium::Driver.new(app, options: options, desired_capabilities: capabilities)
+        end
+
+        ::Capybara.register_driver :selenium_headless_billy do |app|
+          options = build_selenium_options_for_firefox.tap do |opts|
+            opts.add_argument '-headless'
+          end
+          capabilities = Selenium::WebDriver::Remote::Capabilities.firefox(accept_insecure_certs: true)
+          
+          ::Capybara::Selenium::Driver.new(app, options: options, desired_capabilities: capabilities)
         end
 
         ::Capybara.register_driver :selenium_chrome_billy do |app|
@@ -60,19 +67,28 @@ module Billy
           options.add_argument("--proxy-server=#{Billy.proxy.host}:#{Billy.proxy.port}")
 
           ::Capybara::Selenium::Driver.new(
-            app, browser: :chrome,
-            options: options
+            app,
+            browser: :chrome,
+            options: options,
+            clear_local_storage: true,
+            clear_session_storage: true
           )
         end
-        
+
         ::Capybara.register_driver :selenium_chrome_headless_billy do |app|
-          options = Selenium::WebDriver::Chrome::Options.new(args: %w[headless disable-gpu no-sandbox
-                                                                      enable-features=NetworkService,NetworkServiceInProcess])
-          options.add_argument("--proxy-server=#{Billy.proxy.host}:#{Billy.proxy.port}")
+            options = Selenium::WebDriver::Chrome::Options.new
+            options.headless!
+            options.add_argument('--enable-features=NetworkService,NetworkServiceInProcess')
+            options.add_argument("--proxy-server=#{Billy.proxy.host}:#{Billy.proxy.port}")
+            options.add_argument('--disable-gpu') if Gem.win_platform?
+            options.add_argument('--no-sandbox') if ENV['CI']
 
           ::Capybara::Selenium::Driver.new(
-            app, browser: :chrome,
-            options: options
+            app,
+            browser: :chrome,
+            options: options,
+            clear_local_storage: true,
+            clear_session_storage: true
           )
         end
       end
@@ -84,6 +100,17 @@ module Billy
           end
         end
       end
+
+      def self.build_selenium_options_for_firefox
+        profile = Selenium::WebDriver::Firefox::Profile.new.tap do |prof|
+          prof.assume_untrusted_certificate_issuer = false
+          prof.proxy = Selenium::WebDriver::Proxy.new(
+            http: "#{Billy.proxy.host}:#{Billy.proxy.port}",
+            ssl: "#{Billy.proxy.host}:#{Billy.proxy.port}")
+        end
+
+        Selenium::WebDriver::Firefox::Options.new(profile: profile)
+      end
     end
   end
 end

data/lib/billy/browsers/watir.rb

@@ -19,6 +19,7 @@ module Billy
       private
 
       def configure_chrome(args)
+        args[:headless] = true
         args[:switches] ||= []
         args[:switches] += %W[--proxy-server=#{Billy.proxy.host}:#{Billy.proxy.port}]
         args

data/lib/billy/config.rb

@@ -11,7 +11,7 @@ module Billy
                   :non_whitelisted_requests_disabled, :cache_path, :certs_path, :proxy_host, :proxy_port, :proxied_request_inactivity_timeout,
                   :proxied_request_connect_timeout, :dynamic_jsonp, :dynamic_jsonp_keys, :dynamic_jsonp_callback_name, :merge_cached_responses_whitelist,
                   :strip_query_params, :proxied_request_host, :proxied_request_port, :cache_request_body_methods, :after_cache_handles_request,
-                  :cache_simulates_network_delays, :cache_simulates_network_delay_time, :record_requests, :record_stub_requests, :use_ignore_params
+                  :cache_simulates_network_delays, :cache_simulates_network_delay_time, :record_requests, :record_stub_requests, :use_ignore_params, :before_handle_request
 
     def initialize
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
@@ -50,6 +50,7 @@ module Billy
       @record_requests = false
       @record_stub_requests = false
       @use_ignore_params = true
+      @before_handle_request = nil
     end
   end
 

data/lib/billy/handlers/request_handler.rb

@@ -17,6 +17,10 @@ module Billy
     def handle_request(method, url, headers, body)
       request = request_log.record(method, url, headers, body)
 
+      if Billy.config.before_handle_request
+        method, url, headers, body = Billy.config.before_handle_request.call(method, url, headers, body)
+      end
+
       # Process the handlers by order of importance
       [:stubs, :cache, :proxy].each do |key|
         if (response = handlers[key].handle_request(method, url, headers, body))

data/lib/billy/version.rb

@@ -1,3 +1,3 @@
 module Billy
-  VERSION = '2.1.1'
+  VERSION = '2.2.0'
 end

data/puffing-billy.gemspec

@@ -18,18 +18,17 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'thin'
   gem.add_development_dependency 'faraday'
-  gem.add_development_dependency 'poltergeist'
   gem.add_development_dependency 'apparition'
-  # selenium-webdriver 3.8 drops support for PhantomJS
-  gem.add_development_dependency 'selenium-webdriver', '<= 3.7.0'
   gem.add_development_dependency 'capybara'
-  gem.add_development_dependency 'capybara-webkit', '~> 1.0'
+  gem.add_development_dependency 'selenium-webdriver'
   gem.add_development_dependency 'rack'
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'guard'
   gem.add_development_dependency 'rb-inotify'
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'cucumber'
   gem.add_development_dependency 'watir', '~> 6.10.0'
+  gem.add_development_dependency 'webdrivers'
   gem.add_runtime_dependency 'addressable', '~> 2.5'
   gem.add_runtime_dependency 'eventmachine', '~> 1.2'
   gem.add_runtime_dependency 'em-synchrony'

data/spec/lib/billy/handlers/request_handler_spec.rb

@@ -128,6 +128,28 @@ describe Billy::RequestHandler do
         allow(stub_handler).to receive(:handle_request).and_raise("Any Stub Error")
         expect(subject.handle_request(*args)).to eql(error: "Any Stub Error")
       end
+
+      context 'before_handle_request activated' do
+        before do
+          handle_request = proc { |method, url, headers, body|
+            [method, url, headers, "#{body}_modified"]
+          }
+          allow(Billy::config).to receive(:before_handle_request).and_return(handle_request)
+        end
+
+        after do
+          allow(Billy::config).to receive(:before_handle_request).and_call_original
+        end
+
+        it 'modify request before handling' do
+          new_args = %w(get url headers body_modified)
+          expect(stub_handler).to receive(:handle_request).with(*new_args)
+          expect(cache_handler).to receive(:handle_request).with(*new_args).and_return('bar')
+          expect(proxy_handler).to_not receive(:handle_request)
+          expect(subject.handle_request(*args)).to eql 'bar'
+          expect(subject.requests).to eql([{status: :complete, handler: :cache, method: 'get', url: 'url', headers: 'headers', body: 'body'}])
+        end
+      end
     end
 
     describe '#stubs' do

data/spec/spec_helper.rb

@@ -6,11 +6,17 @@ require 'billy/watir/rspec'
 require 'rack'
 require 'logger'
 require 'fileutils'
+require 'webdrivers'
 
-browser = Billy::Browsers::Watir.new :phantomjs
-Capybara.app = Rack::Directory.new(File.expand_path('../../examples', __FILE__))
-Capybara.server = :webrick
-Capybara.javascript_driver = :poltergeist_billy
+$stdout.puts `#{::Selenium::WebDriver::Chrome::Service.driver_path.call} --version` if ENV['CI']
+
+browser = Billy::Browsers::Watir.new :chrome
+
+Capybara.configure do |config|
+  config.app = Rack::Directory.new(File.expand_path('../../examples', __FILE__))
+  config.server = :webrick
+  config.javascript_driver = :selenium_chrome_headless_billy
+end
 
 Billy.configure do |config|
   config.logger = Logger.new(File.expand_path('../../log/test.log', __FILE__))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puffing-billy
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Olly Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-16 00:00:00.000000000 Z
+date: 2019-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: poltergeist
+  name: apparition
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: apparition
+  name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,20 +82,6 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 3.7.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 3.7.0
-- !ruby/object:Gem::Dependency
-  name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,21 +95,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: capybara-webkit
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -206,6 +192,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 6.10.0
+- !ruby/object:Gem::Dependency
+  name: webdrivers
+  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: addressable
   requirement: !ruby/object:Gem::Requirement