ferrum-har 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 414fff66d2b47e26b96047c18388bde8a698c01809454be9b01f213dcf33de82
-  data.tar.gz: be6b275d34536d3220859ad031a8abf952140a8699211fc48124dbbbafe673f3
+  metadata.gz: 7d8d40ce71b743bf429c007041d4e1df81c0cf82b9765d8cf886249abf882543
+  data.tar.gz: 33c293040e516c1e28fc1ad31c95a8c6e43ed9509b2b773644efcfe0eca74d2a
 SHA512:
-  metadata.gz: a617c9a354448656f0ca8fe3b5a8c58b889b009f3db3535eb0b0f19ac844806141cd3f9d19e3ea84e16fa2d4580abcd86dc851da20d41258606d252cf8055224
-  data.tar.gz: f8e60c45799a5b0654994df861e7890d65ce20871cfccdc343d5449092e1d2d13b37fdb05e1e9c54add2904c53602e1b5bea1ee6c7c9e82252bc52d4145ff552
+  metadata.gz: 6fa0a91fefc4e7a6c14b176257521e9c02941d420e6ad64e0e5681e1efd3b6121b97c33d685338176a0c8c2381213f994f6989fb92ae55f8e44ad68d99bffe4d
+  data.tar.gz: 2e93582b28d0c0ceb59638f3e92c0e3ef74178a27ba6d20d1a08b5578d55e091fefc709d14557abe07824cd778c05d8a97b278d79fd4ab9e62ac763842477f05

data/README.md

@@ -4,9 +4,10 @@ ferrum-har
 [![Gem Version](https://img.shields.io/gem/v/ferrum-har?color=green)](https://img.shields.io/gem/v/ferrum-har?color=green)
 
 [ferrum-har](https://github.com/hlascelles/ferrum-har) is a gem that adds the ability to capture
-HAR files while running tests using [ferrum](https://github.com/rubycdp/ferrum)
+[HAR](https://en.wikipedia.org/wiki/HAR_(file_format)) files while running tests
+using [ferrum](https://github.com/rubycdp/ferrum).
 
-### Installation
+## Installation
 
 Add ferrum-har to your Gemfile and `bundle install`:
 
@@ -14,18 +15,16 @@ Add ferrum-har to your Gemfile and `bundle install`:
 gem "ferrum-har"
 ```
 
-### Usage
+## Usage
 
 Use [ferrum](https://github.com/rubycdp/ferrum) as normal and call the `har` method on
-the `page` (or `browser`) object. Note, you will have to use some of the required browser options
-by using the `Ferrum::Har::REQUIRED_BROWSER_OPTIONS` constant. 
+the `page` (or `browser`) object. Chrome must be used as the browser engine.
 
-Note, the devtools window in Chrome will be opened. This is mandatory to obtain the HAR from Chrome.
+Note, the devtools window in Chrome will be opened by ferrum-har for the duration of the ferrum
+test run. This is mandatory to obtain the HAR from Chrome.
 
 ```ruby
-browser = Ferrum::Browser.new(
-  browser_options: Ferrum::Har::REQUIRED_BROWSER_OPTIONS,
-)
+browser = Ferrum::Browser.new
 page = browser.create_page
 page.go_to("https://www.bbc.co.uk")
 
@@ -33,7 +32,7 @@ page.go_to("https://www.bbc.co.uk")
 puts page.har
 ```
 
-### How it works
+## How it works
 
 Creating a HAR file from [ferrum](https://github.com/rubycdp/ferrum) network objects is complex and
 potentially incompatible with the HAR generated
@@ -51,12 +50,21 @@ One ramification of this is that the Chrome devtools must be open for the extens
 
 To get the extension to be loaded we must pass some switches to the Chrome process via ferrum,
 specifically the `--auto-open-devtools-for-tabs` and `--load-extension` switches. This is done
-by the `Ferrum::Har::REQUIRED_BROWSER_OPTIONS` constant.
+by ferrum-har automatically.
 
 For further reading, a full list of Chrome switches can be found
 [here](https://peter.sh/experiments/chromium-command-line-switches/).
 
-### Further work
+## Upgrading
+
+`ferrum-har` uses [semantic versioning](https://semver.org/), so major version changes will usually 
+require additional actions to be taken upgrading from one major version to another. 
+
+## Changelog
+
+A full changelog can be found here: [CHANGELOG.md](https://github.com/hlascelles/ferrum-har/blob/master/CHANGELOG.md)
+
+## Further work
 
 Some ideas for improvements.
 

data/lib/ferrum/har/options_extension.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This module is prepended to Ferrum::Browser::Options::Chrome to alter the default options so they
+# work with the ferrum-har gem.
+module Ferrum
+  module Har
+    module OptionsExtension
+      def merge_default(flags, options)
+        super
+          # We have to remove the "disable-extensions" option from the default browser extension
+          # list because the ferrum-har gem requires an (internal) extension to work.
+          .except("disable-extensions")
+          .merge(
+            "auto-open-devtools-for-tabs" => nil, # Chrome devtools must be open to invoke getHAR
+            "load-extension" => "#{Ferrum::Har::GEM_DIR}/extension", # Extension that gets the HAR
+          )
+      end
+    end
+  end
+end

data/lib/ferrum/har/page_extension.rb

@@ -14,7 +14,8 @@ module Ferrum
         execute("document.ferrumHarRequested = true;")
         base64_encoded_har = Ferrum::Utils::Attempt.with_retry(
           errors: [HarNotReadyError],
-          max: 200,
+          # 10 seconds
+          max: 20,
           wait: 0.5
         ) do
           found = evaluate("document.ferrumHar;")

data/lib/ferrum/har/version.rb

@@ -2,6 +2,6 @@
 
 module Ferrum
   module Har
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

data/lib/ferrum/har.rb

@@ -1,23 +1,19 @@
 # frozen_string_literal: true
 
 require "ferrum"
+require "ferrum/browser/options/chrome"
 require "ferrum/har/version"
 require "ferrum/har/page_extension"
+require "ferrum/har/options_extension"
 
 module Ferrum
   module Har
     GEM_DIR = File.expand_path("../..", __dir__)
-    REQUIRED_BROWSER_OPTIONS = {
-      "auto-open-devtools-for-tabs" => nil, # The chrome devtools must be open to invoke getHAR
-      "load-extension" => "#{Ferrum::Har::GEM_DIR}/extension", # The extension that gets the HAR
-    }.freeze
   end
 end
 
-# We have to remove the "disable-extensions" option from the default browser extension list because
-# the ferrum-har gem requires an (internal) extension to work.
-Ferrum::Browser::Options::Chrome::DEFAULT_OPTIONS =
-  Ferrum::Browser::Options::Chrome::DEFAULT_OPTIONS.except("disable-extensions")
-
 # Add the #har method to Ferrum::Page
 Ferrum::Page.prepend(Ferrum::Har::PageExtension)
+
+# Add the #merge_default method to Ferrum::Browser::Options::Chrome
+Ferrum::Browser::Options::Chrome.prepend(Ferrum::Har::OptionsExtension)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ferrum-har
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Harry Lascelles
@@ -11,7 +11,7 @@ cert_chain: []
 date: 2024-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ferrum
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: base64
+  name: ferrum
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -47,6 +47,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/ferrum/har.rb
+- lib/ferrum/har/options_extension.rb
 - lib/ferrum/har/page_extension.rb
 - lib/ferrum/har/version.rb
 homepage: https://github.com/hlascelles/ferrum-har