Dhalang 0.6.4 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70f9719f301ba33dc769df19417b0b597adc574a9c7df54ed710f4f23d19e2a0
-  data.tar.gz: d7d6b46261a0dc227e9fb26cc79a8c7377c9148d464c2ab8e3e383d2f7115c7a
+  metadata.gz: 580f62daf557818f3de686d07fc10f3fa07705025ea562e9e29130a7d0387660
+  data.tar.gz: e237333306eac8cfc4c5a9fd0d1cd6d59a1f99dcee0a632cc71e0e5ae4b44b8a
 SHA512:
-  metadata.gz: 69b4cede399f0200064ec2ed56df24e42826f7b112d67d3026ba04f40139d02a72ff62bc407be94d10116adffc701ff8977a253e9ac56783402c3220d5d9989d
-  data.tar.gz: ea4f6c687f7fa8ab3951883ae8cbec53f0a23a71c118c3f742605e3ca4dad9b398c2d718c776718cf89ab43fb331cebe2442d7db9e1ee0f5cf9e25815567120d
+  metadata.gz: 8054c0e43bd1ff71d6072ccf2cc4f3c98cf2a0a5f073c5e4b8cd75c2fc00c63cca60ab505d461533fae147e4da4b6786109ab0f00e70eaa4cfca520c19f1874e
+  data.tar.gz: 7e5a64263595fec4f5e3c47a13f4a68507b94ee8f3b79e1fa2c4445b13e756deeb374944f1d406f65c2fae6e1ccf76de20a5a8b0f7ce5b8691592265f1523fa2

data/.github/workflows/build.yml

@@ -0,0 +1,20 @@
+name: Build
+on:
+  - push
+  - pull_request
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.3
+          bundler-cache: true
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: 'npm'
+          cache-dependency-path: '**/package-lock.json'
+      - run: npm ci
+      - run: bundle exec rake spec

data/.github/workflows/publish.yml

@@ -0,0 +1,23 @@
+name: Publish
+on:
+  release:
+    types:
+      - published
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    env:
+      GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.3
+          bundler-cache: true
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+      - run: npm ci
+      - run: bundle exec rake spec
+      - run: gem build -o Dhalang.gem Dhalang.gemspec
+      - run: gem push Dhalang.gem

data/.gitignore

@@ -50,3 +50,4 @@ build-iPhoneSimulator/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+.npmrc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    Dhalang (0.6.4)
+    Dhalang (0.6.6)
 
 GEM
   remote: https://rubygems.org/
@@ -11,32 +11,34 @@ GEM
     diff-lcs (1.5.0)
     fastimage (2.2.6)
     hashery (2.1.2)
-    pdf-reader (2.9.0)
+    pdf-reader (2.9.2)
       Ascii85 (~> 1.0)
       afm (~> 0.2.1)
       hashery (~> 2.0)
       ruby-rc4
       ttfunk
     rake (13.0.6)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.2)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.2)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.3)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
     ruby-rc4 (0.1.5)
     ttfunk (1.7.0)
 
 PLATFORMS
   arm64-darwin-21
   x86-mingw32
+  x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   Dhalang!

data/README.md

@@ -1,4 +1,4 @@
-# Dhalang [![Build Status](https://travis-ci.com/NielsSteensma/Dhalang.svg?token=XZgKAByw2KZjcrsCh8gW&branch=master)](https://travis-ci.com/NielsSteensma/Dhalang)
+# Dhalang [![Build](https://github.com/NielsSteensma/Dhalang/actions/workflows/build.yml/badge.svg)](https://github.com/NielsSteensma/Dhalang/actions/workflows/build.yml)
 
 > Dhalang is a Ruby wrapper for Google's Puppeteer.
 
@@ -24,7 +24,7 @@ Install puppeteer in your application's root directory:
 
     $ npm install puppeteer
 
-<sub>NodeJS v10.18.1 or greater is required</sub>
+<sub>Dhalang and Puppeteer require Node ≥ 18 and Puppeteer ≥ 22</sub>
 ## Usage
 __Get a PDF of a website url__  
 ```ruby
@@ -39,14 +39,20 @@ Dhalang::PDF.get_from_html("<html><head></head><body><h1>examplestring</h1></bod
 
 __Get a PNG screenshot of a website__  
 ```ruby
-Dhalang::Screenshot.get_from_url_as_png("https://www.google.com")  
+Dhalang::Screenshot.get_from_url("https://www.google.com", :png)  
 ```
 
 __Get a JPEG screenshot of a website__  
 ```ruby
-Dhalang::Screenshot.get_from_url_as_jpeg("https://www.google.com")  
+Dhalang::Screenshot.get_from_url("https://www.google.com", :jpeg)  
 ```
-All methods return a string containing the PDF or JPEG/PNG in binary.   
+
+__Get a WEBP screenshot of a website__  
+```ruby
+Dhalang::Screenshot.get_from_url("https://www.google.com", :webp)  
+```
+
+All methods return a string containing the PDF or JPEG/PNG/WEBP in binary.   
   
   
   
@@ -60,7 +66,7 @@ Dhalang::PDF.get_from_url("https://www.google.com", {margin: { top: 100, right:
 
 For example to only take a screenshot of the visible part of the page:
 ```ruby
-Dhalang::Screenshot.get_from_url_as_png("https://www.google.com", {fullPage: false})
+Dhalang::Screenshot.get_from_url("https://www.google.com", :webp, {fullPage: false})
 ```
 
 A list of all possible PDF options that can be set, can be found at: https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#pagepdfoptions
@@ -80,7 +86,7 @@ You may want to change the way Dhalang interacts with Puppeteer in general. User
 
 For example to set a custom navigation timeout:
 ```ruby
-Dhalang::Screenshot.get_from_url_as_jpeg("https://www.google.com", {navigationTimeout: 20000})  
+Dhalang::Screenshot.get_from_url("https://www.google.com", :jpeg, {navigationTimeout: 20000})  
 ```
 
 Below table lists all possible configuration parameters that can be set:
@@ -107,18 +113,10 @@ def example_controller_method
 end
 ```
 
-To return a PNG from a Rails controller you can do the following:  
+To return a screenshot from a Rails controller you can do the following:  
 ```ruby
 def example_controller_method
-  binary_png = Dhalang::Screenshot.get_from_url_as_png("https://www.google.com")
+  binary_png = Dhalang::Screenshot.get_from_url("https://www.google.com", :png)
   send_data(binary_png, filename: 'screenshotofgoogle.png', type: 'image/png')   
 end
-```
-
-To return a JPEG from a Rails controller you can do the following:  
-```ruby
-def example_controller_method
-  binary_jpeg = Dhalang::Screenshot.get_from_url_as_jpeg("https://www.google.com")
-  send_data(binary_jpeg, filename: 'screenshotofgoogle.jpeg', type: 'image/jpeg')   
-end
-```
+```

data/lib/Dhalang/puppeteer.rb

@@ -38,18 +38,15 @@ module Dhalang
         }
         private_constant :DEFAULT_PDF_OPTIONS
 
-        DEFAULT_PNG_OPTIONS = {
+        DEFAULT_SCREENSHOT_OPTIONS = {
             fullPage: true,
             clip: nil,
             omitBackground: false
         }
-        private_constant :DEFAULT_PNG_OPTIONS
+        private_constant :DEFAULT_SCREENSHOT_OPTIONS
 
         DEFAULT_JPEG_OPTIONS = {
-            quality: 100,
-            fullPage: true,
-            clip: nil,
-            omitBackground: false
+            quality: 100
         }
         private_constant :DEFAULT_JPEG_OPTIONS
 
@@ -92,7 +89,7 @@ module Dhalang
                 imageType: temp_file_extension,
                 userOptions: USER_OPTIONS.map { |option, value| [option, options.has_key?(option) ? options[option] : value]}.to_h,
                 pdfOptions: DEFAULT_PDF_OPTIONS.map { |option, value| [option, options.has_key?(option) ? options[option] : value] }.to_h,
-                pngOptions: DEFAULT_PNG_OPTIONS.map { |option, value| [option, options.has_key?(option) ? options[option] : value] }.to_h,
+                screenshotOptions: DEFAULT_SCREENSHOT_OPTIONS.map { |option, value| [option, options.has_key?(option) ? options[option] : value] }.to_h,
                 jpegOptions: DEFAULT_JPEG_OPTIONS.map { |option, value| [option, options.has_key?(option) ? options[option] : value] }.to_h
             }.to_json
         end

data/lib/Dhalang/version.rb

@@ -1,3 +1,3 @@
 module Dhalang
-  VERSION = "0.6.4"
+  VERSION = "0.6.6"
 end

data/lib/Screenshot.rb

@@ -2,8 +2,11 @@ module Dhalang
   # Allows consumers of this library to take screenshots with Puppeteer. 
   class Screenshot
     PUPPETEER_SCRIPT_PATH = File.expand_path('../js/screenshot-generator.js', __FILE__).freeze
+    IMAGE_TYPES = [:jpeg, :png, :webp].freeze
     private_constant :PUPPETEER_SCRIPT_PATH
+    private_constant :IMAGE_TYPES
     
+    # <b>DEPRECATED:</b> Please use `get_from_url(url, :jpeg)` instead.
     # Captures a full JPEG screenshot of the webpage under the given url.
     #
     # @param  [String] url        The url to take a screenshot of.
@@ -11,9 +14,11 @@ module Dhalang
     #
     # @return [String] the screenshot that was taken as binary.
     def self.get_from_url_as_jpeg(url, options = {})
-      get(url, "jpeg", options)
+      warn "[DEPRECATION] `get_from_url_as_jpeg` is deprecated.  Use `get_from_url(url, :jpeg)` instead."
+      get_from_url(url, :jpeg, options)
     end
 
+    # <b>DEPRECATED:</b> Please use `get_from_url(url, :png)` instead.
     # Captures a full PNG screenshot of the webpage under the given url.
     #
     # @param  [String] url        The url to take a screenshot of.
@@ -21,19 +26,22 @@ module Dhalang
     #
     # @return [String] The screenshot that was taken as binary.
     def self.get_from_url_as_png(url, options = {})
-      get(url, "png", options)
+      warn "[DEPRECATION] `get_from_url_as_png` is deprecated.  Use `get_from_url(url, :png)` instead."
+      get_from_url(url, :png, options)
     end
-    
-    # Groups and executes the logic for taking a screenhot of a webpage.
+
+    # Captures ascreenshot of the webpage under the given url.
     #
     # @param  [String] url        The url to take a screenshot of.
-    # @param  [String] image_type The image type to use for storing the screenshot.
-    # @param  [Hash]   options    Set of options to use, passed by the user of this library.
+    # @param  [String] image_type The image type (JPEG/PNG/WEBP) to use for storing the screenshot.
+    # @param  [Hash]   options    User configurable options.
     #
     # @return [String] The screenshot that was taken as binary.
-    private_class_method def self.get(url, image_type, options)
+    def self.get_from_url(url, image_type, options = {})
       UrlUtils.validate(url)
+      validate_image_type(image_type)
       validate_options(options)
+
       temp_file = FileUtils.create_temp_file(image_type)
       begin
         Puppeteer.visit(url, PUPPETEER_SCRIPT_PATH, temp_file.path, image_type, options)
@@ -44,6 +52,15 @@ module Dhalang
       return binary_image_content
     end
 
+    # Raises an error if the given image type is not supported.
+    #
+    # @param [String] image_type The image_type to validate
+    private_class_method def self.validate_image_type(image_type)
+      if !IMAGE_TYPES.include? image_type.downcase
+        raise DhalangError, 'Unsupported image type' 
+      end
+    end
+
     # Raises an error if the given options might conflict with the Puppeteer configuration.
     #
     # @param [Hash] options The options to validate

data/lib/js/dhalang.js

@@ -8,7 +8,7 @@ const fs = require('fs')
  * @property {string} imageType             - The type of image to save ( undefined for pdfgenerator ).
  * @property {UserOptions} userOptions      - User defined and default parameters to use when navigating to pages.
  * @property {Object} pdfOptions            - User defined and default parameters to use when creating PDFs. Note: Do not use directly, rather use {@link getConfiguredPdfOptions}.
- * @property {Object} pngOptions            - User defined and default parameters to use when creating PNGs.
+ * @property {Object} screenshotOptions     - User defined and default parameters to use when creating screenshots.
  * @property {Object} jpegOptions           - User defined and default parameters to use when creating JPEGs.
  */
 
@@ -96,7 +96,7 @@ exports.navigate = async function (page, configuration) {
     } else if (navigationWaitForXPath !== "") {
         await page.waitForXPath(navigationWaitForXPath, this.getWaitingParameters(configuration));
     } else {
-        await page.waitForTimeout(250);
+        await new Promise(r => setTimeout(r, 250));
     }
 }
 

data/lib/js/screenshot-generator.js

@@ -11,13 +11,13 @@ const createScreenshot = async () => {
         await dhalang.configure(page, configuration.userOptions);
         await dhalang.navigate(page, configuration);
 
-        const screenshotOptions = configuration.imageType === "png" ? configuration.pngOptions : configuration.jpegOptions
         await page.screenshot({
             ...{
                 path: configuration.tempFilePath,
                 type: configuration.imageType,
             },
-            ...screenshotOptions
+            ...(configuration.imageType === "jpeg") && configuration.jpegOptions,
+            ...configuration.screenshotOptions
         });
     } catch (error) {
         console.error(error.message);