grover 0.14.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dae47620d2a732cab442444c25a6954f103c669fa7eea7c092b34297f1d71c0
-  data.tar.gz: 84d886147feff66e75276b00d5e6529883396763dcc424d6e42186c5dbb9b9d0
+  metadata.gz: ec752a494049fb8bfeeb78aec6a5a553f3c6502e869163492556d2bf386b7340
+  data.tar.gz: 8886bbe696f7f6b8510e8cf209c334c67540e560741162e503fb2505da18cc8c
 SHA512:
-  metadata.gz: bad7d5f4c5a15b8a9bc7ea7041ad1184c72416944b4c837c16592197e5105cebccee53eae564b9fbf8776884fb4b4e1d7d888de7c2018b0040c085979c65e55f
-  data.tar.gz: b8837766f459146e6349df80952f655dc330c7d9ca7cdebcbdd2a69fe17a10701addb1ff029ebfacd3458780b1d134679128df8766c1b017904c76dd876e43d2
+  metadata.gz: 1f0e2c7d80edc1a037b863ecc14cc117671d030602d1ff243114efd81ccae8e3dbbf31bc98a61b3f63158c68eb87097aaa7feb86215eaff007e336defe9efd5e
+  data.tar.gz: 97aa4ad8721ea2f689af1cb9cbcbeb429c663f35942ebcfcd5007c6e51df66def829965dac16a4a0ec002d93885c8a88a2515784abb024fb097edac922cbcea8

data/lib/grover.rb

@@ -144,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/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
@@ -91,16 +143,6 @@ 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)) {
@@ -127,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/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/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.14.2'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grover
 version: !ruby/object:Gem::Version
-  version: 0.14.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrew Bromwich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-22 00:00:00.000000000 Z
+date: 2021-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: combine_pdf