Dhalang 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 976f451a66958a17261f84b2f79c2740323f74efc48c2e003fdb95b3f72111fd
-  data.tar.gz: 75e517eea1ec5a62a26a7beccdd3ee5adcf6c257e4cc5eb96782548728e00868
+  metadata.gz: a2357c5cdfe5dd841c64329fdab12478c719c6839fce8567520916eefc487f4e
+  data.tar.gz: c2507de8a15eed19c3807ad43c4f64d58cd7f1a6c32a1a61a37f828fed08cab3
 SHA512:
-  metadata.gz: 3ae7a907a31cf50d0bd5e6f78a27b4ccd77e2a9c6baa13b8430f48f00944af5160844a84ae428f1f0db8cba9afa083560f22d50de1f492052702773d1464ce77
-  data.tar.gz: 1244560c1a4cd3b2ae2a1020c79c99f30bfa6ce1b2fe413dabc5d24e7ba66f16101c8f1460b69d35edfbffcaa86c22e6687fed1cef39f2c785bc822bd03bbe66
+  metadata.gz: d127ec4402220b31566af6ef16a12e375329515c60d7d6070663379e8f90315340cc0cadf9c0aa89604b5cea371c75a6f8f90af0f87ba98535125e59a614e965
+  data.tar.gz: '055953f266b9ad18c24405e1cd8d9c455722d8dfc23ca20e0c0a3224710b5bf91e0d0b31a555403cb7f70ddd20e927de1d325e3d477b56ced98112a6a7fa2f88'

data/.gitignore

@@ -1,51 +1,52 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-.idea/*
-
-# Used by dotenv library to load environment variables.
-# .env
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/node_modules/
+/tmp/
+.idea/*
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -1,9 +1,13 @@
-language: ruby
-rvm:
- - 2.6
-addons:
-  chrome: stable
-install:
- - bundle install
- - npm install
+language: ruby
+node_js:
+ - node
+rvm:
+ - 2.6
+addons:
+  chrome: stable
+before_install:
+ - nvm install v15.0.1
+install:
+ - bundle install
+ - npm install
 script: bundle exec rake spec

data/Dhalang.gemspec

@@ -1,39 +1,30 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "Dhalang/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "Dhalang"
-  spec.version       = Dhalang::VERSION
-  spec.authors       = ["Niels Steensma"]
-  spec.email         = ["nielssteensma@yahoo.nl"]
-  spec.licenses      = ['MIT']
-
-  spec.summary       = "Ruby wrapper for Puppeteer. Generate screenshots and PDF's from HTML!"
-  spec.homepage      = "https://github.com/NielsSteensma/Dhalang"
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "https://rubygems.org"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = "exe"
-  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", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pdf-reader", "~> 2.2"
-  spec.add_development_dependency "fastimage", "~> 1.8"
-end
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "Dhalang/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "Dhalang"
+  spec.version       = Dhalang::VERSION
+  spec.authors       = ["Niels Steensma"]
+  spec.email         = ["nielssteensma@yahoo.nl"]
+  spec.licenses      = ['MIT']
+
+  spec.summary       = "Ruby wrapper for Puppeteer. Generate screenshots and PDF's from HTML!"
+  spec.homepage      = "https://github.com/NielsSteensma/Dhalang"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  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 "rspec", "~> 3.0"
+  spec.add_development_dependency "pdf-reader", "~> 2.2"
+  spec.add_development_dependency "fastimage", "~> 1.8"
+end

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in Dhalang.gemspec
-gemspec
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in Dhalang.gemspec
+gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    Dhalang (0.1.0)
+    Dhalang (0.6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -13,30 +13,31 @@ GEM
     fastimage (1.9.0)
       addressable (~> 2.3.5)
     hashery (2.1.2)
-    pdf-reader (2.2.0)
+    pdf-reader (2.4.0)
       Ascii85 (~> 1.0.0)
       afm (~> 0.2.1)
       hashery (~> 2.0)
       ruby-rc4
       ttfunk
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
     ruby-rc4 (0.1.5)
-    ttfunk (1.5.1)
+    ttfunk (1.6.2.1)
 
 PLATFORMS
+  ruby
   x64-mingw32
 
 DEPENDENCIES
@@ -44,8 +45,8 @@ DEPENDENCIES
   bundler (~> 1.16)
   fastimage (~> 1.8)
   pdf-reader (~> 2.2)
-  rake (~> 10.0)
+  rake (~> 13.0.1)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.1
+   1.17.3

data/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2019 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
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2019 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,42 +1,108 @@
-# Dhalang [![Build Status](https://travis-ci.com/NielsSteensma/Dhalang.svg?token=XZgKAByw2KZjcrsCh8gW&branch=master)](https://travis-ci.com/NielsSteensma/Dhalang)
-
-> Dhalang is a Ruby wrapper for Google's Puppeteer.
-
-
-## Features
-* Generate PDFs from pages
-* Generate PDFs from html ( external images/stylesheets supported )  
-  
-More will come.
-
-## Installation
-Add this line to your application's Gemfile:
-
-    gem 'Dhalang'
-
-And then execute:
-
-    $ bundle update
-
-Install puppeteer in your application's root directory:
-
-    $ npm install puppeteer
-
-<sub>NodeJS v7.6.0 or greater is required</sub>
-## Usage
-__Get a PDF of a website url__  
-`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>")`  
-
-Both methods return a string containing the PDF in binary.   
-  
-To return the 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')  
-end
-```
+# Dhalang [![Build Status](https://travis-ci.com/NielsSteensma/Dhalang.svg?token=XZgKAByw2KZjcrsCh8gW&branch=master)](https://travis-ci.com/NielsSteensma/Dhalang)
+
+> Dhalang is a Ruby wrapper for Google's Puppeteer.
+
+
+
+## Features
+* Generate PDFs from pages
+* Generate PDFs from html ( external images/stylesheets supported )  
+* Capture a screenshot of a webpage
+
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+    gem 'Dhalang'
+
+And then execute:
+
+    $ bundle update
+
+Install puppeteer in your application's root directory:
+
+    $ npm install puppeteer
+
+<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")`  
+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>")`  
+
+__Get a PNG screenshot of a website__  
+`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")`  
+
+All methods return a string containing the PDF or JPEG/PNG in binary.   
+  
+  
+  
+## Custom PDF/screenshot options
+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}})
+`
+
+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})
+`
+
+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
+
+
+
+
+## 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})`  
+
+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                           |
+| 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           |
+| isHeadless         | Indicates if Chromium should be launched headless                                       | true                            |
+| 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                            |
+
+
+
+## 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')  
+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')   
+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')   
+end
+```