Dhalang 0.6.0 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2357c5cdfe5dd841c64329fdab12478c719c6839fce8567520916eefc487f4e
-  data.tar.gz: c2507de8a15eed19c3807ad43c4f64d58cd7f1a6c32a1a61a37f828fed08cab3
+  metadata.gz: 70f9719f301ba33dc769df19417b0b597adc574a9c7df54ed710f4f23d19e2a0
+  data.tar.gz: d7d6b46261a0dc227e9fb26cc79a8c7377c9148d464c2ab8e3e383d2f7115c7a
 SHA512:
-  metadata.gz: d127ec4402220b31566af6ef16a12e375329515c60d7d6070663379e8f90315340cc0cadf9c0aa89604b5cea371c75a6f8f90af0f87ba98535125e59a614e965
-  data.tar.gz: '055953f266b9ad18c24405e1cd8d9c455722d8dfc23ca20e0c0a3224710b5bf91e0d0b31a555403cb7f70ddd20e927de1d325e3d477b56ced98112a6a7fa2f88'
+  metadata.gz: 69b4cede399f0200064ec2ed56df24e42826f7b112d67d3026ba04f40139d02a72ff62bc407be94d10116adffc701ff8977a253e9ac56783402c3220d5d9989d
+  data.tar.gz: ea4f6c687f7fa8ab3951883ae8cbec53f0a23a71c118c3f742605e3ca4dad9b398c2d718c776718cf89ab43fb331cebe2442d7db9e1ee0f5cf9e25815567120d

data/.travis.yml

@@ -1,13 +1,21 @@
 language: ruby
 node_js:
- - node
+- node
 rvm:
- - 2.6
+- 2.6
 addons:
   chrome: stable
 before_install:
- - nvm install v15.0.1
+- nvm install v15.0.1
 install:
- - bundle install
- - npm install
-script: bundle exec rake spec
+- bundle install
+- npm install
+script: bundle exec rake spec
+deploy:
+  provider: rubygems    
+  gemspec: Dhalang.gemspec
+  api_key:
+    secure: PMiaYF8Xtyyl9Kuhf9WwDRaUzUcqbe430DF8Rwk2qYM1oI8eiYbESswHVavAnrT+ZLKZVzp0+avXJ1TFjoz2tHBa7YVmmz76+RvECozwBXFVofK0GX8c6PVZTuuHgoanr1RVv0KTJOZXs5Aa+372Er31ESuwaaRPU2y/d8aotxtoe7MUoVle67S7Z28H53jwDCut54WFq6hKi+gNO/B+7y/e2efPgrqSktHxaPDGcaUaX9v8fAYBJgAulJLYMeRj+m7IQccajIjppr7vWDE1m9XEDAK71i3EZis96/z+KexB2bo3+Qc+TvpTWP5NeKw61uhtPn9HU4+XCaOV8Vz0e6PH2JfS82h333BcSifXjcFb9iQU8aEMpSpcjraUvvvu8JZepUUO//vtGEJLyOJ0L4f9XiUPhQ15OYjBsJ2ADFdNcqyFeASDuLoeKbAQrWunyTStb+wFrr5TzAoQp9ItZbEt6eHaI6WSd4qhJfzqU7NOzE06Ns03J1jMdmzMxREl8ENJFle65fQouQfRnfcZTS6qW7UX/7YZUiMw60Cpa15qHW+92glCkOuiZUhr4D999ejqMFY5Jd3tHGVBX0/1MWc2jl0fPk2/fueA/YW8xLd3xKP9p0KhbqWZhiMxIct5w718nfOLuSoL1VLJRImj4HAKmoCFKP4RE+1Vl95UwEY=
+  on:
+    branch: master
+    tags: true

data/Dhalang.gemspec

@@ -22,9 +22,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 13.0.1"
+  spec.add_development_dependency "bundler", "~> 2.3.6"
+  spec.add_development_dependency "fastimage", "~> 2.2.6"
+  spec.add_development_dependency "pdf-reader", "~> 2.9.0"
+  spec.add_development_dependency "rake", "~> 13.0.6"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pdf-reader", "~> 2.2"
-  spec.add_development_dependency "fastimage", "~> 1.8"
 end

data/Gemfile.lock

@@ -1,52 +1,50 @@
 PATH
   remote: .
   specs:
-    Dhalang (0.6.0)
+    Dhalang (0.6.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    Ascii85 (1.0.3)
-    addressable (2.3.8)
+    Ascii85 (1.1.0)
     afm (0.2.2)
-    diff-lcs (1.3)
-    fastimage (1.9.0)
-      addressable (~> 2.3.5)
+    diff-lcs (1.5.0)
+    fastimage (2.2.6)
     hashery (2.1.2)
-    pdf-reader (2.4.0)
-      Ascii85 (~> 1.0.0)
+    pdf-reader (2.9.0)
+      Ascii85 (~> 1.0)
       afm (~> 0.2.1)
       hashery (~> 2.0)
       ruby-rc4
       ttfunk
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
     ruby-rc4 (0.1.5)
-    ttfunk (1.6.2.1)
+    ttfunk (1.7.0)
 
 PLATFORMS
-  ruby
-  x64-mingw32
+  arm64-darwin-21
+  x86-mingw32
 
 DEPENDENCIES
   Dhalang!
-  bundler (~> 1.16)
-  fastimage (~> 1.8)
-  pdf-reader (~> 2.2)
-  rake (~> 13.0.1)
+  bundler (~> 2.3.6)
+  fastimage (~> 2.2.6)
+  pdf-reader (~> 2.9.0)
+  rake (~> 13.0.6)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.17.3
+   2.3.6

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 NielsS
+Copyright (c) 2021 NielsS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -27,18 +27,25 @@ Install puppeteer in your application's root directory:
 <sub>NodeJS v10.18.1 or greater is required</sub>
 ## Usage
 __Get a PDF of a website url__  
-`Dhalang::PDF.get_from_url("https://www.google.com")`  
+```ruby
+Dhalang::PDF.get_from_url("https://www.google.com")
+```
 It is important to pass the complete url, leaving out https://, http:// or www. will result in an error.
-  
+
 __Get a PDF of a HTML string__  
-`Dhalang::PDF.get_from_html("<html><head></head><body><h1>examplestring</h1></body></html>")`  
+```ruby
+Dhalang::PDF.get_from_html("<html><head></head><body><h1>examplestring</h1></body></html>") 
+```
 
 __Get a PNG screenshot of a website__  
-`Dhalang::Screenshot.get_from_url_as_png("https://www.google.com")`  
+```ruby
+Dhalang::Screenshot.get_from_url_as_png("https://www.google.com")  
+```
 
 __Get a JPEG screenshot of a website__  
-`Dhalang::Screenshot.get_from_url_as_jpeg("https://www.google.com")`  
-
+```ruby
+Dhalang::Screenshot.get_from_url_as_jpeg("https://www.google.com")  
+```
 All methods return a string containing the PDF or JPEG/PNG in binary.   
   
   
@@ -47,31 +54,40 @@ All methods return a string containing the PDF or JPEG/PNG in binary.
 To override the default options that are set by Dhalang you can pass as last argument a hash with the custom options you want to set.
 
 For example to set custom margins for PDFs:
-
-`Dhalang::PDF.get_from_url("https://www.google.com", {margin: { top: 100, right: 100, bottom: 100, left: 100}})
-`
+```ruby
+Dhalang::PDF.get_from_url("https://www.google.com", {margin: { top: 100, right: 100, bottom: 100, left: 100}})
+```
 
 For example to only take a screenshot of the visible part of the page:
-`Dhalang::Screenshot.get_from_url_as_png("https://www.google.com", {fullPage: false})
-`
+```ruby
+Dhalang::Screenshot.get_from_url_as_png("https://www.google.com", {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
 
 A list of all possible screenshot options that can be set, can be found at: https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#pagescreenshotoptions
 
-
+> The default Puppeteer options contain the options `headerTemplate` and `footerTemplate`. Puppeteer expects these to be HTML strings. By default, the Dhalang
+> gem passes all options as arguments in a `node ...` shell command.  In case the HTML strings are too long they might surpass the maximum
+> argument length of the host.  For example, on Linux the `MAX_ARG_LEN` is 128kB. Therefore, you can also pass the headers and footers as file path using the
+> options `headerTemplateFile` and `footerTemplateFile`. These non-Puppeteer-options will be used to populate the Puppeteer-options `headerTemplate` and `footerTemplate`.
+>
+> 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:
-`Dhalang::Screenshot.get_from_url_as_jpeg("https://www.google.com", {navigationTimeout: 20000})`  
+```ruby
+Dhalang::Screenshot.get_from_url_as_jpeg("https://www.google.com", {navigationTimeout: 20000})  
+```
 
 Below table lists all possible configuration parameters that can be set:
 | Key                | Description                                                                             | Default                         |
 |--------------------|-----------------------------------------------------------------------------------------|---------------------------------|
 | 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        |
 | navigationWaitForXPath | If set, Dhalang will wait for the specified XPath to appear before creating the screenshot or PDF | None              |
 | userAgent          | User agent to send with the request                                                     | Default Puppeteer one           |
@@ -79,30 +95,30 @@ Below table lists all possible configuration parameters that can be set:
 | isAutoHeight       | When set to true the height of generated PDFs will be based on the scrollHeight property of the document body | false     |
 | viewPort           | Custom viewport to use for the request                                                  | Default Puppeteer one           |
 | httpAuthenticationCredentials | Custom HTTP authentication credentials to use for the request                | None                            |
-
+| chromeOptions  | A array of [options](https://peter.sh/experiments/chromium-command-line-switches/) that can be passed to puppeteer in addition to the mandatory `['--no-sandbox', '--disable-setuid-sandbox']` | []                           |
 
 
 ## Examples of using Dhalang
 To return a PDF from a Rails controller you can do the following:  
-```
-def example_controller_method  
-    binary_pdf = Dhalang::PDF.get_from_url("https://www.google.com")  
-    send_data(binary_pdf, filename: 'pdfofgoogle.pdf', type: 'application/pdf')  
+```ruby
+def example_controller_method
+  binary_pdf = Dhalang::PDF.get_from_url("https://www.google.com")  
+  send_data(binary_pdf, filename: 'pdfofgoogle.pdf', type: 'application/pdf')  
 end
 ```
 
 To return a PNG from a Rails controller you can do the following:  
-```
-def example_controller_method  
-    binary_png = Dhalang::Screenshot.get_from_url_as_png("https://www.google.com")
-    send_data(binary_png, filename: 'screenshotofgoogle.png', type: 'image/png')   
+```ruby
+def example_controller_method
+  binary_png = Dhalang::Screenshot.get_from_url_as_png("https://www.google.com")
+  send_data(binary_png, filename: 'screenshotofgoogle.png', type: 'image/png')   
 end
 ```
 
 To return a JPEG from a Rails controller you can do the following:  
-```
-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')   
+```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

@@ -5,15 +5,17 @@ module Dhalang
         private_constant :NODE_MODULES_PATH
 
         USER_OPTIONS = {
-                navigationTimeout: 10000,
-                navigationWaitUntil: 'load',
-                navigationWaitForSelector: '',
-                navigationWaitForXPath: '',
-                userAgent: '',
-                isHeadless: true,
-                viewPort: '',
-                httpAuthenticationCredentials: '',
-                isAutoHeight: false
+            navigationTimeout: 10000,
+            printToPDFTimeout: 0, # unlimited
+            navigationWaitUntil: 'load',
+            navigationWaitForSelector: '',
+            navigationWaitForXPath: '',
+            userAgent: '',
+            isHeadless: true,
+            viewPort: '',
+            httpAuthenticationCredentials: '',
+            isAutoHeight: false,
+            chromeOptions: []
         }
         private_constant :USER_OPTIONS
 
@@ -22,6 +24,8 @@ module Dhalang
             displayHeaderFooter: false,
             headerTemplate: '',
             footerTemplate: '',
+            headerTemplateFile: '',
+            footerTemplateFile: '',
             printBackground: true,
             landscape: false,
             pageRanges: '',
@@ -29,7 +33,8 @@ module Dhalang
             width: '',
             height: '',
             margin: { top: 36, right: 36, bottom: 20, left: 36 },
-            preferCSSPageSiz: false
+            preferCSSPageSize: true,
+            omitBackground: false
         }
         private_constant :DEFAULT_PDF_OPTIONS
 

data/lib/Dhalang/version.rb

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

data/lib/js/dhalang.js

@@ -1,3 +1,5 @@
+const fs = require('fs')
+
 /**
  * @typedef {Object} Configuration
  * @property {string} webPageUrl            - The url of the webpage to visit.
@@ -52,7 +54,7 @@ exports.getConfiguration = function () {
 exports.launchPuppeteer = async function (configuration) {
     module.paths.push(configuration.puppeteerPath);
     const puppeteer = require('puppeteer');
-    const launchArgs = ['--no-sandbox', '--disable-setuid-sandbox'];
+    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
@@ -74,7 +76,7 @@ exports.configure = async function (page, userOptions) {
     }
 
     if (userOptions.httpAuthenticationCredentials !== "") {
-        await page.authenticate(userOptions.authenticationCredentials)
+        await page.authenticate(userOptions.httpAuthenticationCredentials)
     }
 }
 
@@ -107,6 +109,22 @@ exports.navigate = async function (page, configuration) {
 exports.getConfiguredPdfOptions = async function (page, configuration) {
     const pdfOptions = configuration.pdfOptions
 
+    if (pdfOptions['headerTemplateFile'] !== '') {
+        try {
+            pdfOptions['headerTemplate'] = fs.readFileSync(pdfOptions['headerTemplateFile'], 'utf8')
+        } catch(err) {
+            // ignoring file related errors
+        }
+    }
+
+    if (pdfOptions['footerTemplateFile'] !== '') {
+        try {
+            pdfOptions['footerTemplate'] = fs.readFileSync(pdfOptions['footerTemplateFile'], 'utf8')
+        } catch(err) {
+            // ignoring file related errors
+        }
+    }
+
     if (configuration.userOptions.isAutoHeight === true) {
         const pageHeight = await page.evaluate(() => {
             return Math.max(document.body.scrollHeight, document.body.offsetHeight);
@@ -116,6 +134,8 @@ exports.getConfiguredPdfOptions = async function (page, configuration) {
         }
     }
 
+    pdfOptions['timeout'] = configuration.userOptions.printToPDFTimeout
+
     return pdfOptions
 }
 
@@ -143,4 +163,4 @@ exports.getWaitingParameters = function (configuration) {
     return {
         timeout: configuration.userOptions.navigationTimeout
     }
-}
+}