grover 0.13.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7084b165657179f7954b473653ff58cb634e0444177c95978168f1a481c2a423
-  data.tar.gz: aa4497878b0d4eb55b0cd5703011db42c9d8f79fd65da906ce770956f59f032e
+  metadata.gz: ec752a494049fb8bfeeb78aec6a5a553f3c6502e869163492556d2bf386b7340
+  data.tar.gz: 8886bbe696f7f6b8510e8cf209c334c67540e560741162e503fb2505da18cc8c
 SHA512:
-  metadata.gz: 95f0001bdba9e31e8025f0e4c693d7d2b60c20c3e51c11b91e8ed9934dfad160f0733db6ed40344b42a4c20a59d5990a346195d08539c7098311f5de095d7b7a
-  data.tar.gz: 14a75499dd49dfa219b3dd914f2cb82601a0151a06c325805f3419a2836a228707cf1e63e9bfbecb0253be850b25134d1b8e2fbb6fe12a769b007c3c77f2f13a
+  metadata.gz: 1f0e2c7d80edc1a037b863ecc14cc117671d030602d1ff243114efd81ccae8e3dbbf31bc98a61b3f63158c68eb87097aaa7feb86215eaff007e336defe9efd5e
+  data.tar.gz: 97aa4ad8721ea2f689af1cb9cbcbeb429c663f35942ebcfcd5007c6e51df66def829965dac16a4a0ec002d93885c8a88a2515784abb024fb097edac922cbcea8

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018-2020 Studiosity
+
+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 NON-INFRINGEMENT. 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/lib/grover.rb

@@ -33,8 +33,8 @@ class Grover
   #   see https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagepdfoptions
   #
   def initialize(url, options = {})
-    @url = url
-    @options = OptionsBuilder.new(options, url)
+    @url = url.to_s
+    @options = OptionsBuilder.new(options, @url)
     @root_path = @options.delete 'root_path'
     @front_cover_path = @options.delete 'front_cover_path'
     @back_cover_path = @options.delete 'back_cover_path'
@@ -50,6 +50,15 @@ class Grover
     processor.convert :pdf, @url, normalized_options(path: path)
   end
 
+  #
+  # Request URL with provided options and render HTML
+  #
+  # @return [String] The resulting HTML string
+  #
+  def to_html
+    processor.convert :content, @url, normalized_options(path: nil)
+  end
+
   #
   # Request URL with provided options and create screenshot
   #
@@ -135,7 +144,7 @@ class Grover
   end
 
   def normalized_options(path:)
-    normalized_options = Utils.normalize_object @options
+    normalized_options = Utils.normalize_object @options, excluding: ['extraHTTPHeaders']
     normalized_options['path'] = path if path.is_a? ::String
     normalized_options
   end

data/lib/grover/configuration.rb

@@ -5,13 +5,14 @@ class Grover
   # Configuration of the options for Grover HTML to PDF conversion
   #
   class Configuration
-    attr_accessor :options, :meta_tag_prefix, :ignore_path,
+    attr_accessor :options, :meta_tag_prefix, :ignore_path, :root_url,
                   :use_pdf_middleware, :use_png_middleware, :use_jpeg_middleware
 
     def initialize
       @options = {}
       @meta_tag_prefix = 'grover-'
       @ignore_path = nil
+      @root_url = nil
       @use_pdf_middleware = true
       @use_png_middleware = false
       @use_jpeg_middleware = false

data/lib/grover/js/processor.js

@@ -66,12 +66,64 @@ const _processPage = (async (convertAction, urlOrHtml, options) => {
       requestOptions.timeout = timeout;
     }
 
+    // Setup user agent (if provided)
+    const userAgent = options.userAgent; delete options.userAgent;
+    if (userAgent !== undefined) {
+      await page.setUserAgent(userAgent);
+    }
+
     // Setup viewport options (if provided)
     const viewport = options.viewport; delete options.viewport;
     if (viewport !== undefined) {
       await page.setViewport(viewport);
     }
 
+    // If specified, emulate the media type
+    const emulateMedia = options.emulateMedia; delete options.emulateMedia;
+    if (emulateMedia !== undefined) {
+      if (typeof page.emulateMediaType === 'function') {
+        await page.emulateMediaType(emulateMedia);
+      } else {
+        await page.emulateMedia(emulateMedia);
+      }
+    }
+
+    // Emulate the media features, if specified
+    const mediaFeatures = options.mediaFeatures; delete options.mediaFeatures;
+    if (Array.isArray(mediaFeatures)) {
+      page.emulateMediaFeatures(mediaFeatures);
+    }
+
+    // Emulate timezone (if provided)
+    const timezone = options.timezone; delete options.timezone;
+    if (timezone !== undefined) {
+      await page.emulateTimezone(timezone);
+    }
+
+    // Emulate vision deficiency (if provided)
+    const visionDeficiency = options.visionDeficiency; delete options.visionDeficiency;
+    if (visionDeficiency !== undefined) {
+      page.emulateVisionDeficiency(type);
+    }
+
+    // Bypass CSP (content security policy), if provided
+    const bypassCSP = options.bypassCSP; delete options.bypassCSP;
+    if (bypassCSP !== undefined) {
+      page.setBypassCSP(bypassCSP);
+    }
+
+    // Add extra HTTP headers (if provided)
+    const extraHTTPHeaders = options.extraHTTPHeaders; delete options.extraHTTPHeaders;
+    if (extraHTTPHeaders !== undefined) {
+      page.setExtraHTTPHeaders(extraHTTPHeaders);
+    }
+
+    // Set geolocation (if provided)
+    const geolocation = options.geolocation; delete options.geolocation;
+    if (geolocation !== undefined) {
+      page.setGeolocation(geolocation);
+    }
+
     const waitUntil = options.waitUntil; delete options.waitUntil;
     if (urlOrHtml.match(/^http/i)) {
       // Request is for a URL, so request it
@@ -82,7 +134,7 @@ const _processPage = (async (convertAction, urlOrHtml, options) => {
       requestOptions.waitUntil = waitUntil || 'networkidle0';
       await page.setRequestInterception(true);
       page.once('request', request => {
-        request.respond({ body: urlOrHtml });
+        request.respond({ body: urlOrHtml === '' ? ' ' : urlOrHtml });
         // Reset the request interception
         // (we only want to intercept the first request - ie our HTML)
         page.on('request', request => request.continue());
@@ -91,13 +143,19 @@ const _processPage = (async (convertAction, urlOrHtml, options) => {
       await page.goto(displayUrl || 'http://example.com', requestOptions);
     }
 
-    // If specified, emulate the media type
-    const emulateMedia = options.emulateMedia; delete options.emulateMedia;
-    if (emulateMedia !== undefined) {
-      if (typeof page.emulateMediaType == 'function') {
-        await page.emulateMediaType(emulateMedia);
-      } else {
-        await page.emulateMedia(emulateMedia);
+    // add styles (if provided)
+    const styleTagOptions = options.styleTagOptions; delete options.styleTagOptions;
+    if (Array.isArray(styleTagOptions)) {
+      for (const styleTagOption of styleTagOptions) {
+        await page.addStyleTag(styleTagOption);
+      }
+    }
+
+    // add scripts (if provided)
+    const scriptTagOptions = options.scriptTagOptions; delete options.scriptTagOptions;
+    if (Array.isArray(scriptTagOptions)) {
+      for (const scriptTagOption of scriptTagOptions) {
+        await page.addScriptTag(scriptTagOption);
       }
     }
 
@@ -111,7 +169,25 @@ const _processPage = (async (convertAction, urlOrHtml, options) => {
     const waitForSelector = options.waitForSelector; delete options.waitForSelector;
     const waitForSelectorOptions = options.waitForSelectorOptions; delete options.waitForSelectorOptions;
     if (waitForSelector !== undefined) {
-      await page.waitForSelector(waitForSelector, waitForSelectorOptions)
+      await page.waitForSelector(waitForSelector, waitForSelectorOptions);
+    }
+
+    // If specified, wait for timeout
+    const waitForTimeout = options.waitForTimeout; delete options.waitForTimeout;
+    if (waitForTimeout !== undefined) {
+      await page.waitForTimeout(waitForTimeout);
+    }
+
+    // If specified, focus on the specified selector
+    const focusSelector = options.focus; delete options.focus;
+    if (focusSelector !== undefined) {
+      await page.focus(focusSelector);
+    }
+
+    // If specified, hover on the specified selector
+    const hoverSelector = options.hover; delete options.hover;
+    if (hoverSelector !== undefined) {
+      await page.hover(hoverSelector);
     }
 
     // If we're running puppeteer in headless mode, return the converted PDF

data/lib/grover/middleware.rb

@@ -10,11 +10,14 @@ class Grover
   # @see https://github.com/pdfkit/pdfkit
   #
   class Middleware # rubocop:disable Metrics/ClassLength
-    def initialize(app)
+    def initialize(app, *args)
       @app = app
       @pdf_request = false
       @png_request = false
       @jpeg_request = false
+
+      @root_url =
+        args.last.is_a?(Hash) && args.last.key?(:root_url) ? args.last[:root_url] : Grover.configuration.root_url
     end
 
     def call(env)

data/lib/grover/options_fixer.rb

@@ -34,13 +34,13 @@ class Grover
     def fix_boolean_options!
       fix_options!(
         'display_header_footer', 'full_page', 'landscape', 'omit_background', 'prefer_css_page_size',
-        'print_background', 'viewport.has_touch', 'viewport.is_landscape', 'viewport.is_mobile'
+        'print_background', 'viewport.has_touch', 'viewport.is_landscape', 'viewport.is_mobile', 'bypass_csp'
       ) { |value| !FALSE_VALUES.include?(value) }
     end
 
     def fix_integer_options!
       fix_options!(
-        'viewport.height', 'viewport.width',
+        'viewport.height', 'viewport.width', 'wait_for_timeout',
         &:to_i
       )
     end
@@ -48,6 +48,7 @@ class Grover
     def fix_float_options!
       fix_options!(
         'clip.height', 'clip.width', 'clip.x', 'clip.y', 'quality', 'scale', 'viewport.device_scale_factor',
+        'geolocation.latitude', 'geolocation.longitude',
         &:to_f
       )
     end

data/lib/grover/processor.rb

@@ -19,6 +19,7 @@ class Grover
       ensure_packages_are_initiated
       result = call_js_method method, url_or_html, options
       return unless result
+      return result if result.is_a?(String)
 
       result['data'].pack('C*')
     ensure
@@ -76,7 +77,7 @@ class Grover
       @package_json ||= JSON.parse(File.read(package_json_path))
     end
 
-    def call_js_method(method, url_or_html, options) # rubocop:disable Metrics/MethodLength
+    def call_js_method(method, url_or_html, options) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       stdin.puts JSON.dump([method, url_or_html, options])
       input = stdout.gets
       raise Errno::EPIPE, "Can't read from worker" if input.nil?
@@ -90,6 +91,8 @@ class Grover
       else
         raise Grover::JavaScript.const_get(error_class, false), message
       end
+    rescue JSON::ParserError
+      raise Grover::Error, 'Malformed worker response'
     rescue Errno::EPIPE, IOError
       raise Grover::Error, "Worker process failed:\n#{stderr.read}"
     end

data/lib/grover/utils.rb

@@ -6,7 +6,9 @@ class Grover
   #
   class Utils
     ACRONYMS = {
-      'css' => 'CSS'
+      'css' => 'CSS',
+      'csp' => 'CSP',
+      'http' => 'HTTP'
     }.freeze
     private_constant :ACRONYMS
 
@@ -41,11 +43,12 @@ class Grover
     # Copied from active support
     # @see active_support/core_ext/hash/keys.rb
     #
-    def self.deep_transform_keys_in_object(object, &block)
+    def self.deep_transform_keys_in_object(object, excluding: [], &block) # rubocop:disable Metrics/MethodLength
       case object
       when Hash
         object.each_with_object({}) do |(key, value), result|
-          result[yield(key)] = deep_transform_keys_in_object(value, &block)
+          new_key = yield(key)
+          result[new_key] = excluding.include?(new_key) ? value : deep_transform_keys_in_object(value, &block)
         end
       when Array
         object.map { |e| deep_transform_keys_in_object(e, &block) }
@@ -80,8 +83,8 @@ class Grover
     #
     # Recursively normalizes hash objects with camelized string keys
     #
-    def self.normalize_object(object)
-      deep_transform_keys_in_object(object) { |k| normalize_key(k) }
+    def self.normalize_object(object, excluding: [])
+      deep_transform_keys_in_object(object, excluding: excluding) { |k| normalize_key(k) }
     end
 
     #

data/lib/grover/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Grover
-  VERSION = '0.13.1'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grover
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrew Bromwich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-29 00:00:00.000000000 Z
+date: 2021-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: combine_pdf
@@ -163,6 +163,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - lib/active_support_ext/object/deep_dup.rb
 - lib/active_support_ext/object/duplicable.rb
 - lib/grover.rb
@@ -191,7 +192,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
   - - "<"
     - !ruby/object:Gem::Version
-      version: 2.8.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="