puffing-billy 3.0.1 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec02ea3b7f01e33d68df684db911886bacb0b9c92f1fbe3d9931df42218dd78f
-  data.tar.gz: 9ea280821375f4ba83429c33aa2d17035a3269e580fbb52c6a26e5db968eed25
+  metadata.gz: 16bed8180bba7ace31cc3516c9b30bddbce8531cfe5f4a1effd93572219f2952
+  data.tar.gz: d47667758e923263a1e98e2bb60c6ab1bf3962fa38722259addc4e59b4af129e
 SHA512:
-  metadata.gz: 9b1680023f9b58ee65995bc91471d11f4d1a9fd96dbee00a9635edb23775bbe2824b3234414c5d87aa33709a10b8c71729079bb0bd885db7023958aa4da77859
-  data.tar.gz: f42c4227325d9dcab48a50eed2f5470db36c90e5fc8aff2618cfd37531fe15e23345b7bff92080053a130b0e9755a8f43c46cdf958d45ece795e8cd4ac7e7c51
+  metadata.gz: e7a47d5b299bb1b5ba9b6979317e383b498116cabfb6cf8bc924c75b0a2fd97684beafac596ee728b7c393b74f92229090b13fba5a06140846992c7234a50f4f
+  data.tar.gz: b7bb0f1fb51747f935c26fc3c4c455900c5a0971676ce4bba1ee8ddfe87740f7e5771ed529b22735687f15ad423da436dc8f7fd940e7179fb4d62e609641d669

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+v3.0.4, 2022-08-07
+------------------
+  * Adds a configurable Cuprite driver [#327](https://github.com/oesmith/puffing-billy/pull/327)
+
+v3.0.3, 2022-05-31
+-------------------
+  * Only calculate cache scope and key if request is cacheable [#324](https://github.com/oesmith/puffing-billy/pull/324)
+
+v3.0.2, 2022-02-16
+-------------------
+  * Add rake tasks inside files DSL in gemspec [#321](https://github.com/oesmith/puffing-billy/pull/321)
+
 v3.0.1, 2022-02-15
 -------------------
   * Adapt to newer versions selenium webdriver [#314](https://github.com/oesmith/puffing-billy/pull/314)

data/README.md

@@ -65,6 +65,7 @@ Capybara.javascript_driver = :selenium_billy # Uses Firefox
 # Capybara.javascript_driver = :apparition_billy
 # Capybara.javascript_driver = :webkit_billy
 # Capybara.javascript_driver = :poltergeist_billy
+# Capybara.javascript_driver = :cuprite_billy
 ```
 
 > __Note__: `:poltergeist_billy` doesn't support proxying any localhosts, so you must use
@@ -154,6 +155,20 @@ And /^a stub for google$/ do
 end
 ```
 
+### Setup remote Chrome
+
+In the case you are using a Chrome instance, running on another machine, or in
+another Docker container, you need to :
+* Fix the Billy proxy host and port
+* Passes the `--proxy-server=<billy host>:<billy port>`
+
+#### WebSockets
+
+Puffing billy doesn't support websockets, so if you are using them,
+or ActionCable for the Ruby On Rails developers, you can tell Chrome to bypass
+the proxy for websockets by adding the flag `--proxy-bypass-list=ws://*` to
+your remote chrome intance or Docker container.
+
 ## Minitest Usage
 
 Please see [this link](https://gist.github.com/sauy7/1b081266dd453a1b737b) for

data/lib/billy/browsers/capybara.rb

@@ -8,7 +8,8 @@ module Billy
         poltergeist: 'capybara/poltergeist',
         webkit: 'capybara/webkit',
         selenium: 'selenium/webdriver',
-        apparition: 'capybara/apparition'
+        apparition: 'capybara/apparition',
+        cuprite: 'capybara/cuprite'
       }
 
       def self.register_drivers
@@ -108,6 +109,20 @@ module Billy
         end
       end
 
+      def self.register_cuprite_driver
+        driver_otions = {
+          browser_options: {
+            'ignore-certificate-errors' => nil
+          }
+        }.deep_merge(Billy.config.cuprite_options)
+
+        ::Capybara.register_driver :cuprite_billy do |app|
+          ::Capybara::Cuprite::Driver.new(app, **driver_otions).tap do |driver|
+            driver.set_proxy(Billy.proxy.host, Billy.proxy.port)
+          end
+        end
+      end
+
       def self.build_selenium_options_for_firefox
         profile = Selenium::WebDriver::Firefox::Profile.new.tap do |prof|
           prof.proxy = Selenium::WebDriver::Proxy.new(

data/lib/billy/cache.rb

@@ -15,6 +15,8 @@ module Billy
     end
 
     def cached?(method, url, body)
+      return false unless Billy.config.cache
+
       # Only log the key the first time it's looked up (in this method)
       key = key(method, url, body, true)
       !@cache[key].nil? || persisted?(key)

data/lib/billy/config.rb

@@ -11,7 +11,8 @@ module Billy
                   :non_whitelisted_requests_disabled, :cache_path, :certs_path, :verify_peer, :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, :before_handle_request
+                  :cache_simulates_network_delays, :cache_simulates_network_delay_time, :record_requests, :record_stub_requests, :use_ignore_params,
+                  :before_handle_request, :cuprite_options
 
     def initialize
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
@@ -53,6 +54,7 @@ module Billy
       @record_stub_requests = false
       @use_ignore_params = true
       @before_handle_request = nil
+      @cuprite_options = {}
     end
   end
 

data/lib/billy/handlers/proxy_handler.rb

@@ -25,9 +25,6 @@ module Billy
                                  port: Billy.config.proxied_request_port }} )
         end
 
-        cache_scope = Billy::Cache.instance.scope
-        cache_key = Billy::Cache.instance.key(method.downcase, url, body)
-
         req = EventMachine::HttpRequest.new(url, opts)
         req = req.send(method.downcase, build_request_options(url, headers, body))
 
@@ -47,6 +44,9 @@ module Billy
           end
 
           if cacheable?(url, response[:headers], response[:status])
+            cache_scope = Billy::Cache.instance.scope
+            cache_key = Billy::Cache.instance.key(method.downcase, url, body)
+
             Billy::Cache.instance.store(
               cache_key,
               cache_scope,

data/lib/billy/version.rb

@@ -1,3 +1,3 @@
 module Billy
-  VERSION = '3.0.1'
+  VERSION = '3.0.4'
 end

data/lib/tasks/billy.rake

@@ -0,0 +1,87 @@
+require 'addressable/uri'
+
+namespace :cache do
+  desc 'Print out all cache file information'
+  task :print_all do
+    cache_array = load_cache
+
+    sort_cache(cache_array).each do |cache|
+      print_cache_details(cache)
+    end
+  end
+
+  desc 'Print out specific cache file information'
+  task :print_details, :sha do |_t, args|
+    fail "Missing sha; usage: rake cache:print_details['<sha>']" unless args[:sha]
+    cache_array = load_cache(Billy.config.cache_path, '*' + args[:sha] + '*.yml')
+
+    sort_cache(cache_array).each do |cache|
+      print_cache_details(cache)
+    end
+  end
+
+  desc 'Find specific cache files by URL'
+  task :find_by_url, :api_path do |_t, args|
+    fail "Missing api path; usage: rake cache:find_by_url['<api_path>']" unless args[:api_path]
+    cache_array = load_cache
+    filtered_cache_array = cache_array.select { |f| f[:url_path].include?(args[:api_path]) }
+
+    sort_cache(filtered_cache_array).each do |cache|
+      print_cache_details(cache)
+    end
+  end
+
+  desc 'Find specific cache files by scope'
+  task :find_by_scope, :scope do |_t, args|
+    fail "Missing scope; usage: rake cache:find_by_scope['<scope>']" unless args[:scope]
+    cache_array = load_cache
+    filtered_cache_array = cache_array.select { |f| f[:scope] && f[:scope].include?(args[:scope]) }
+
+    sort_cache(filtered_cache_array).each do |cache|
+      print_cache_details(cache)
+    end
+  end
+
+  desc 'Find cache files with non-successful status codes'
+  task :find_non_successful do
+    cache_array = load_cache
+    filtered_cache_array = cache_array.select { |f| !(200..299).include?(f[:status]) }
+
+    sort_cache(filtered_cache_array).each do |cache|
+      print_cache_details(cache)
+    end
+  end
+
+  def load_cache(cache_directory = Billy.config.cache_path, file_pattern = '*.yml')
+    cache_path  = Rails.root.join(cache_directory)
+    cache_array = []
+
+    Dir.glob(cache_path + file_pattern) do |filename|
+      data = load_cache_file(filename)
+      url = Addressable::URI.parse(data[:url])
+      data[:url_path] = "#{url.path}#{url.query ? '?' + url.query : ''}#{url.fragment ? '#' + url.fragment : ''}"
+      data[:filename] = filename.gsub(Rails.root.to_s + '/', '')
+      cache_array << data
+    end
+    cache_array
+  end
+
+  def load_cache_file(filename)
+    YAML.load_file(filename)
+  rescue ArgumentError => e
+    puts "Could not parse YAML: #{e.message}"
+  end
+
+  def print_cache_details(cache)
+    puts "   Scope: #{cache[:scope]}" if cache[:scope]
+    puts "     URL: #{cache[:url]}"
+    puts "    Body: #{cache[:body]}" if Billy.config.cache_request_body_methods.include?(cache[:method])
+    puts " Details: Request method '#{cache[:method]}' returned response status code: '#{cache[:status]}'"
+    puts "Filename: #{cache[:filename]}"
+    puts "\n\n"
+  end
+
+  def sort_cache(cache, key = :url_path)
+    cache.sort_by { |hsh| hsh[key] }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puffing-billy
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.4
 platform: ruby
 authors:
 - Olly Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-15 00:00:00.000000000 Z
+date: 2022-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -366,6 +366,7 @@ files:
 - lib/billy/watir/rspec.rb
 - lib/puffing-billy.rb
 - lib/puffing-billy/rspec.rb
+- lib/tasks/billy.rake
 homepage: https://github.com/oesmith/puffing-billy
 licenses:
 - MIT