Dhalang 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b5a8f2427673c1a21cbbfcc3f9b3119c11890b9dbb21a1656ec970c14b4faef
-  data.tar.gz: d98cac7a86e5c12c0fc845e71a8810c3adaa3c583fb53a4139f2e1408231cceb
+  metadata.gz: affc5a7a677cade8adf37073ab71155ad812fdb0765c947c560ecb8de50dafc3
+  data.tar.gz: 72a7122ea73080759aef9d5ccd375167da9efffee1836f92df990c7046df08d7
 SHA512:
-  metadata.gz: 142fcef44cc80374790a915356c7eda5b5a5d91e532c44a4a81515f07454b9c2a7a04d34d53b3cb481fb0ed2f58cc6a0ed974a0ad4d244e9622f754e32e47624
-  data.tar.gz: 8379ed46f315e7cf3cfa657c2972fbdc3e34bee4255f2be741e84835c82536d4ace52290fb0197e1638a77667fa0a59309357ce62bca3887ba746c44665d8e9c
+  metadata.gz: a007aa999b92d55b8d10bf6e0683d9f5ddf833f5a3f26914abfbdda562a25bb197ba29595f4d55edbcd9c11ea15eb0a2c57da8bb5595e38f521e5a465c13aa24
+  data.tar.gz: 2bdf23451af29feaa0ba70b78c7af7ca603bc02db2dfffcbbd815dd766b4fc99972328a7cf2d6b15dad23dadfc51aa8f3ea10713652ed087df4fa46890211f3e

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,49 @@
 PATH
   remote: .
   specs:
-    Dhalang (0.6.0)
+    Dhalang (0.6.2)
 
 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
+  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/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,26 +54,34 @@ 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                         |
@@ -79,7 +94,7 @@ 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

data/lib/Dhalang/puppeteer.rb

@@ -13,7 +13,8 @@ module Dhalang
                 isHeadless: true,
                 viewPort: '',
                 httpAuthenticationCredentials: '',
-                isAutoHeight: false
+                isAutoHeight: false,
+                chromeOptions: []
         }
         private_constant :USER_OPTIONS
 
@@ -22,6 +23,8 @@ module Dhalang
             displayHeaderFooter: false,
             headerTemplate: '',
             footerTemplate: '',
+            headerTemplateFile: '',
+            footerTemplateFile: '',
             printBackground: true,
             landscape: false,
             pageRanges: '',

data/lib/Dhalang/version.rb

@@ -1,3 +1,3 @@
 module Dhalang
-  VERSION = "0.6.2"
+  VERSION = "0.6.3"
 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
@@ -107,6 +109,21 @@ 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);

data/package.json

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Dhalang
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Niels Steensma
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-25 00:00:00.000000000 Z
+date: 2022-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,70 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.3.6
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: fastimage
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: 2.2.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: 2.2.6
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pdf-reader
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 2.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
-  name: pdf-reader
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
-  name: fastimage
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '3.0'
 description: 
 email:
 - nielssteensma@yahoo.nl
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Puppeteer. Generate screenshots and PDF's from HTML!