Dhalang 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7392a94eca6e888d2a81b779cde341fd7a9be0bbddd2d254e708e93aa18b7fe3
-  data.tar.gz: dc520a25fcaf30ad5584820bb45b9bcf72b35531024676e77d9ce0f54291f91f
+  metadata.gz: 737f66adc02fc8014c5351e4b679a4d709931c43729fdba71c161e1b55a38551
+  data.tar.gz: a4c5721dda854821f3e705654c550a7edd80f2e51a0200ed64245899faa1e571
 SHA512:
-  metadata.gz: 3b75659edee50ba18a726be62a32d39336d5cb8ce6ac94625e529a75015ba7dee45fb396bc292a34604c602369ebba39842c127753d537fc882665a48aacf249
-  data.tar.gz: 965cbdae8bc88057c4d7a7a366940a5bb8deedf367893fab5d2c7c437bf96dc9530caf96a138ae7b19ef87ce190c9e8740d83f36cf2a411ec745c3c18b5d208b
+  metadata.gz: eca69779f1f79d082dc78dfacb059b4078583aa9adb3e71082f08cee9eab63eb787773be4b93633944f229c302a6c812cbc909ac89df6608e1018466eeb427df
+  data.tar.gz: 3447cf8432a31e3f6e0e4d4edb9ed722c981bd16d659c542f1a82091cade222c65328b0764e73da540cb543188f413f4a82c57bcb851c7d500a2c76e1e7b7fe9

data/README.md

@@ -1,4 +1,4 @@
-# Dhalang [![Build](https://github.com/NielsSteensma/Dhalang/actions/workflows/build.yml/badge.svg)](https://github.com/NielsSteensma/Dhalang/actions/workflows/build.yml)
+# Dhalang [![Build](https://github.com/NielsSteensma/Dhalang/actions/workflows/build.yml/badge.svg)](https://github.com/NielsSteensma/Dhalang/actions/workflows/build.yml) [![Gem Version](https://badge.fury.io/rb/Dhalang.svg)](https://badge.fury.io/rb/Dhalang)
 
 > Dhalang is a Ruby wrapper for Google's Puppeteer.
 
@@ -11,7 +11,11 @@
 * Scrape HTML from webpages
 
 
-
+## Prerequisites
+* Node ≥ 18
+* Puppeteer ≥ 22
+* Unix shell ( Dhalang will not work on Windows shells )
+  
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -21,11 +25,12 @@ And then execute:
 
     $ bundle update
 
-Install puppeteer in your application's root directory:
+Install puppeteer or puppeteer-core in your application's root directory:
 
-    $ npm install puppeteer
+    $ npm install puppeteer 
+    or
+    $ npm install puppeteer-core
 
-<sub>Dhalang and Puppeteer require Node ≥ 18 and Puppeteer ≥ 22</sub>
 ## Usage
 __PDF of a website url__  
 ```ruby
@@ -86,18 +91,10 @@ A list of all possible screenshot options that can be set, can be found at: http
 >
 > For example: `Dhalang::PDF.get_from_url("https://www.google.com", {headerTemplateFile: '/tmp/header.html', footerTemplateFile: '/tmp/footer.html'})`
 
-
-## Custom user options
-You may want to change the way Dhalang interacts with Puppeteer in general. User options can be set by providing them in a hash as last argument to any calls you make to the library. Are you setting both custom PDF and user options? Then they should be passed as a single hash. 
-
-For example to set a custom navigation timeout:
-```ruby
-Dhalang::Screenshot.get_from_url("https://www.google.com", :jpeg, {navigationTimeout: 20000})  
-```
-
-Below table lists all possible configuration parameters that can be set:
+Below table lists more configuration parameters that can be set:
 | Key                | Description                                                                             | Default                         |
 |--------------------|-----------------------------------------------------------------------------------------|---------------------------------|
+| browserWebsocketUrl | Websocket url of remote chromium browser to use                                        | None                            |
 | navigationTimeout  | Amount of milliseconds until Puppeteer while timeout when navigating to the given page  | 10000                           |
 | printToPDFTimeout  | Amount of milliseconds until Puppeteer while timeout when calling Page.printToPDF       | 0 (unlimited)                   |
 | navigationWaitForSelector | If set, Dhalang will wait for the specified selector to appear before creating the screenshot or PDF | None        |
@@ -125,4 +122,4 @@ def example_controller_method
   binary_png = Dhalang::Screenshot.get_from_url("https://www.google.com", :png)
   send_data(binary_png, filename: 'screenshotofgoogle.png', type: 'image/png')   
 end
-```
+```

data/lib/Dhalang/configuration.rb

@@ -3,6 +3,7 @@ module Dhalang
   class Configuration
     NODE_MODULES_PATH = Dir.pwd + '/node_modules/'.freeze
     USER_OPTIONS = {
+      browserWebsocketUrl: '',
       navigationTimeout: 10000,
       printToPDFTimeout: 0, # unlimited
       navigationWaitUntil: 'load',
@@ -48,6 +49,7 @@ module Dhalang
     private_constant :DEFAULT_JPEG_OPTIONS
 
     private attr_accessor :page_url
+    private attr_accessor :browser_websocket_url
     private attr_accessor :temp_file_path
     private attr_accessor :temp_file_extension
     private attr_accessor :user_options

data/lib/Dhalang/version.rb

@@ -1,3 +1,3 @@
 module Dhalang
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

data/lib/js/dhalang.js

@@ -14,6 +14,7 @@ const fs = require('fs')
 
 /**
  * @typedef {Object} UserOptions
+ * @property {string} browserWebsocketUrl           - The websocket url of remote Chromium browser to use.
  * @property {number} navigationTimeout             - Maximum in milliseconds until navigation times out, we use a default of 10 seconds as timeout.
  * @property {string} navigationWaitUntil           - Determines when the navigation was finished, we wait here until the Window.load event is fired ( meaning all images, stylesheet, etc was loaded ).
  * @property {string} navigationWaitForSelector     - If set, specifies the selector Puppeteer should wait for to appear before continuing.
@@ -47,7 +48,7 @@ exports.getConfiguration = function () {
 
 /**
  * Launches Puppeteer and returns its instance.
- * @param {UserOptions} configuration - The configuration to use.
+ * @param {Configuration} configuration - The configuration to use.
  * @returns {Promise<Object>}
  * The launched instance of Puppeteer.
  */
@@ -55,10 +56,17 @@ exports.launchPuppeteer = async function (configuration) {
     module.paths.push(configuration.puppeteerPath);
     const puppeteer = require('puppeteer');
     const launchArgs = ['--no-sandbox', '--disable-setuid-sandbox'].concat(configuration.userOptions.chromeOptions).filter((item, index, self) => self.indexOf(item) === index);
-    return await puppeteer.launch({
-        args: launchArgs,
-        headless: configuration.userOptions.isHeadless
-    });
+
+    if (configuration.userOptions['browserWebsocketUrl'] !== "") {
+        return await puppeteer.connect( {
+            "browserWSEndpoint": configuration.userOptions.browserWebsocketUrl
+        })
+    } else {
+        return await puppeteer.launch({
+            args: launchArgs,
+            headless: configuration.userOptions.isHeadless
+        });
+    }
 }
 
 /**

data/lib/js/html-scraper.js

@@ -6,9 +6,10 @@ const scrapeHtml = async () => {
     const configuration = dhalang.getConfiguration();
 
     let browser;
+    let page;
     try {
         browser = await dhalang.launchPuppeteer(configuration);
-        const page = await browser.newPage();
+        page = await browser.newPage();
         await dhalang.configure(page, configuration.userOptions);
         await dhalang.navigate(page, configuration);
         const html = await page.content();
@@ -17,8 +18,10 @@ const scrapeHtml = async () => {
         console.error(error.message);
         process.exit(1);
     } finally {
-        if (browser) {
+        if (browser && configuration.userOptions['browserWebsocketUrl'] === "") {
             browser.close();
+        } else {
+            page.close();
         }
         process.exit(0);
     }

data/lib/js/pdf-generator.js

@@ -5,9 +5,10 @@ const createPdf = async () => {
     const configuration = dhalang.getConfiguration();
 
     let browser;
+    let page;
     try {
         browser = await dhalang.launchPuppeteer(configuration);
-        const page = await browser.newPage();
+        page = await browser.newPage();
         await dhalang.configure(page, configuration.userOptions);
         await dhalang.navigate(page, configuration);
         const pdfOptions = await dhalang.getConfiguredPdfOptions(page, configuration);
@@ -21,8 +22,10 @@ const createPdf = async () => {
         console.error(error.message);
         process.exit(1);
     } finally {
-        if (browser) {
+        if (browser && configuration.userOptions['browserWebsocketUrl'] === "") {
             browser.close();
+        } else {
+            page.close();
         }
         process.exit();
     }

data/lib/js/screenshot-generator.js

@@ -5,9 +5,10 @@ const createScreenshot = async () => {
     const configuration = dhalang.getConfiguration();
 
     let browser;
+    let page;
     try {
         browser = await dhalang.launchPuppeteer(configuration);
-        const page = await browser.newPage();
+        page = await browser.newPage();
         await dhalang.configure(page, configuration.userOptions);
         await dhalang.navigate(page, configuration);
 
@@ -23,8 +24,10 @@ const createScreenshot = async () => {
         console.error(error.message);
         process.exit(1);
     } finally {
-        if (browser) {
+        if (browser && configuration.userOptions['browserWebsocketUrl'] === "") {
             browser.close();
+        } else {
+            page.close();
         }
         process.exit();
     }

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "dhalang",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "dhalang",
-      "version": "0.7.0",
+      "version": "0.7.1",
       "license": "MIT",
       "dependencies": {
         "puppeteer": "^22.5.0"

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dhalang",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "",
   "main": "index.js",
   "directories": {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Dhalang
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Niels Steensma
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-29 00:00:00.000000000 Z
+date: 2024-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler