ferrum-har 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 140d6f93cceb0ee84d05e449aa1fb5a8680a562002850a6ac6e8aeb475505f12
-  data.tar.gz: 14dbb30ee107b7562e3167c44d8cd6460bb5d52a7dd1856caa849dd2e4c1b0f6
+  metadata.gz: ece6969fb3a3135a534510dbbee3a94544dfceaaebbf7ffdf2ca3b7ef9483a0c
+  data.tar.gz: f1feb7448c4b4cd86b823e22f433f650bcbe7f2bae13b68668d35efaebc427a9
 SHA512:
-  metadata.gz: a157840990fdadd2b2dc4c42a9e0464f3b2ef1206da1c3cbd8c7f703d7e4ce5e309298eb25c43818907099fccb4d92329506fa56399f21edcc1e5f9980769b5c
-  data.tar.gz: dc280c46aa7285b6dbbaa0f11af62a7279e6d4272b9320171d06da3a1059950f307b5b6d294677d75206eac95f46278480062f0f7f2044e3aced3040ecc3ca71
+  metadata.gz: 6f60149634aababca262378cf044e8ffdd9c4dd0f6e34556ce336d3f50aec819ff43a7aea21cac26e30fa8cb7b820cb964d7a9ae9538d22c38c2a1c2d38582b2
+  data.tar.gz: 21cdba221d68c0ae8eebb2ab4d915b33f17d4c9d4058110101a94729ece0bd95080e99d5ddd55943c6ff604e3c31901199c6d54e0c11172d1d8460241c4169e0

data/README.md

@@ -27,6 +27,7 @@ test run. This is mandatory to obtain the HAR from Chrome.
 browser = Ferrum::Browser.new
 page = browser.create_page
 page.go_to("https://www.bbc.co.uk")
+page.network.wait_for_idle
 
 # Returns the HAR as a JSON string
 puts page.har

data/lib/ferrum/har/command_extension.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# This module is prepended to Ferrum::Browser::Command to check options required by ferrum-har
+module Ferrum
+  module Har
+    class ConfigurationError < RuntimeError
+    end
+
+    module BrowserCommandExtension
+      def merge_options
+        super.tap do |options|
+          check_har_related_browser_options(options)
+        end
+      end
+
+      private def check_har_related_browser_options(options)
+        options = options.transform_keys(&:to_s)
+
+        check_disable_extensions_option(options)
+        check_load_extension_option(options)
+        check_auto_open_option(options)
+        check_headless_option(options)
+      end
+
+      private def check_disable_extensions_option(options)
+        disable_extensions_option_value = options.key?("disable-extensions")
+        return unless disable_extensions_option_value
+
+        raise Ferrum::Har::ConfigurationError, <<~MSG
+          The ferrum-har gem requires the 'disable-extensions' browser option to be absent,
+          ie: extensions should be allowed. The gem will do this for you automatically, but if you
+          override the value, then ferrum-har will not work.
+
+          It was found to be set to '#{disable_extensions_option_value}'.
+        MSG
+      end
+
+      private def check_load_extension_option(options)
+        load_extension_option_value = options["load-extension"]
+        return unless load_extension_option_value != "#{Ferrum::Har::GEM_DIR}/extension"
+
+        raise Ferrum::Har::ConfigurationError, <<~MSG
+          The ferrum-har gem requires the 'load-extension' browser option to be set to
+          '#{Ferrum::Har::GEM_DIR}/extension'. It will do this for you automatically, but if you
+          override the value, then ferrum-har will not work.
+
+          It was found to be set to '#{load_extension_option_value}'.
+        MSG
+      end
+
+      private def check_auto_open_option(options)
+        auto_open_value = options["auto-open-devtools-for-tabs"]
+        return if auto_open_value.nil?
+
+        raise Ferrum::Har::ConfigurationError, <<~MSG
+          The ferrum-har gem requires the 'auto-open-devtools-for-tabs' browser option be enabled,
+          '#{Ferrum::Har::GEM_DIR}/extension'. It will do this for you automatically, but if you
+          override the value, then ferrum-har will not work.
+          ie: set to nil.
+
+          It was found to be set to '#{auto_open_value}'.
+        MSG
+      end
+
+      private def check_headless_option(options)
+        headless_value = options["headless"]
+        return unless options.key?("headless") && [false, nil].include?(headless_value)
+
+        raise Ferrum::Har::ConfigurationError, <<~MSG
+          If you are using ferrum headless, the ferrum-har gem requires the browser
+          option 'headless' to be set to 'new' instead of true or nil. Read this for more details:
+          https://developer.chrome.com/docs/chromium/new-headless
+
+          It was found to be set to '#{headless_value}'.
+        MSG
+      end
+    end
+  end
+end

data/lib/ferrum/har/version.rb

@@ -2,6 +2,6 @@
 
 module Ferrum
   module Har
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

data/lib/ferrum/har.rb

@@ -3,6 +3,7 @@
 require "ferrum"
 require "ferrum/browser/options/chrome"
 require "ferrum/har/version"
+require "ferrum/har/command_extension"
 require "ferrum/har/page_extension"
 require "ferrum/har/options_extension"
 
@@ -17,3 +18,6 @@ Ferrum::Page.prepend(Ferrum::Har::PageExtension)
 
 # Add the #merge_default method to Ferrum::Browser::Options::Chrome
 Ferrum::Browser::Options::Chrome.prepend(Ferrum::Har::OptionsExtension)
+
+# Add the #check_har_related_browser_options method to Ferrum::Browser::Command
+Ferrum::Browser::Command.prepend(Ferrum::Har::BrowserCommandExtension)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ferrum-har
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Harry Lascelles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-22 00:00:00.000000000 Z
+date: 2024-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -52,6 +52,7 @@ files:
 - extension/panel.html
 - extension/panel.js
 - lib/ferrum/har.rb
+- lib/ferrum/har/command_extension.rb
 - lib/ferrum/har/options_extension.rb
 - lib/ferrum/har/page_extension.rb
 - lib/ferrum/har/version.rb