grover 1.0.4 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49f70f988f01666e9141fc0ad9584468d3efb06e6a82042460b3d403b94966e3
-  data.tar.gz: 3a87cb41b36398d56f48930da0df266cc87435d85aa41c520de0759175793131
+  metadata.gz: 5ed292a1f0bbc16c0df46a6f55a2fc93e7eac292add527b5cccdac16cadb7d6a
+  data.tar.gz: c9845b8d717409406b62ffa4f73e6e639617d9006f7dfdfec349c123515e11c8
 SHA512:
-  metadata.gz: a24f664083b90c1e5666c6800a7b8ed8fce43c27c91763c1f2c5ffac797d8c29c77fe37489186ea1567ef0667da88d85d8519fefea31b2bd4ae583af4832d1cb
-  data.tar.gz: 9a90bd6c19b5f09e1a90b9b998df5a7446e87915abe326e94ae4e75ddefa5bd592460dbad406e25dbc2c6714899ea77122ceea938cc294e46f447fcbc64cafa0
+  metadata.gz: 1c2c17127f2cada74be6759f08d8c38969c2c4268ba0e0c5f05170b6105360fd55e4bfb94921085a6b9335c897a7d4e37c7647e1cf5e4c5a2f71a030b0dd5cc7
+  data.tar.gz: 160da07aceb8a1d277d0ea0099b3243b02dd72d1dba8cd3b22d53a6cc7bdec006c7a9430c913d9121069f516b3838d82c3099624cb22526b647fc5001f74a651

data/lib/grover/configuration.rb

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

data/lib/grover/js/processor.js

@@ -61,9 +61,10 @@ const _processPage = (async (convertAction, urlOrHtml, options) => {
 
     // Setup timeout option (if provided)
     let requestOptions = {};
-    const timeout = options.timeout; delete options.timeout;
-    if (timeout !== undefined) {
-      requestOptions.timeout = timeout;
+    let requestTimeout = options.requestTimeout; delete options.requestTimeout;
+    if (requestTimeout === undefined) requestTimeout = options.timeout;
+    if (requestTimeout !== undefined) {
+      requestOptions.timeout = requestTimeout;
     }
 
     // Setup user agent (if provided)
@@ -91,7 +92,7 @@ const _processPage = (async (convertAction, urlOrHtml, options) => {
     // Emulate the media features, if specified
     const mediaFeatures = options.mediaFeatures; delete options.mediaFeatures;
     if (Array.isArray(mediaFeatures)) {
-      page.emulateMediaFeatures(mediaFeatures);
+      await page.emulateMediaFeatures(mediaFeatures);
     }
 
     // Emulate timezone (if provided)
@@ -100,34 +101,28 @@ const _processPage = (async (convertAction, urlOrHtml, options) => {
       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);
+      await page.setBypassCSP(bypassCSP);
     }
 
     // Add extra HTTP headers (if provided)
     const extraHTTPHeaders = options.extraHTTPHeaders; delete options.extraHTTPHeaders;
     if (extraHTTPHeaders !== undefined) {
-      page.setExtraHTTPHeaders(extraHTTPHeaders);
+      await page.setExtraHTTPHeaders(extraHTTPHeaders);
     }
 
     // Set geolocation (if provided)
     const geolocation = options.geolocation; delete options.geolocation;
     if (geolocation !== undefined) {
-      page.setGeolocation(geolocation);
+      await page.setGeolocation(geolocation);
     }
 
     const raiseOnRequestFailure = options.raiseOnRequestFailure; delete options.raiseOnRequestFailure;
     if (raiseOnRequestFailure) {
       page.on('requestfinished', (request) => {
-        if (request.response() && !(request.response().ok() || request.response().status() == 304) && !request.redirectChain().length > 0) {
+        if (request.response() && !(request.response().ok() || request.response().status() === 304) && !request.redirectChain().length > 0) {
           errors.push(request);
         }
       });
@@ -201,6 +196,12 @@ const _processPage = (async (convertAction, urlOrHtml, options) => {
       await page.waitForTimeout(waitForTimeout);
     }
 
+    // Emulate vision deficiency (if provided)
+    const visionDeficiency = options.visionDeficiency; delete options.visionDeficiency;
+    if (visionDeficiency !== undefined) {
+      await page.emulateVisionDeficiency(visionDeficiency);
+    }
+
     // If specified, focus on the specified selector
     const focusSelector = options.focus; delete options.focus;
     if (focusSelector !== undefined) {
@@ -230,6 +231,12 @@ const _processPage = (async (convertAction, urlOrHtml, options) => {
       throw new RequestFailedError(errors);
     }
 
+    // Setup conversion timeout
+    if (options.convertTimeout !== undefined) {
+      options.timeout = options.convertTimeout;
+      delete options.convertTimeout;
+    }
+
     // If we're running puppeteer in headless mode, return the converted PDF
     if (debug === undefined || (typeof debug === 'object' && (debug.headless === undefined || debug.headless))) {
       return await page[convertAction](options);

data/lib/grover/middleware.rb

@@ -56,10 +56,10 @@ class Grover
     end
 
     def grover_request?
-      (pdf_request || png_request || jpeg_request) && !ignore_request?
+      (pdf_request || png_request || jpeg_request) && !ignore_path? && !ignore_request?
     end
 
-    def ignore_request?
+    def ignore_path?
       ignore_path = Grover.configuration.ignore_path
       case ignore_path
       when String then @request.path.start_with? ignore_path
@@ -68,6 +68,13 @@ class Grover
       end
     end
 
+    def ignore_request?
+      ignore_request = Grover.configuration.ignore_request
+      return unless ignore_request.is_a?(Proc)
+
+      ignore_request.call @request
+    end
+
     def html_content?(headers)
       headers['Content-Type'] =~ %r{text/html|application/xhtml\+xml}
     end

data/lib/grover/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grover
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.1
 platform: ruby
 authors:
 - Andrew Bromwich
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-27 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: combine_pdf
@@ -181,7 +181,7 @@ homepage: https://github.com/Studiosity/grover
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -189,18 +189,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
   - - "<"
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: A Ruby gem to transform HTML into PDF, PNG or JPEG by wrapping the NodeJS
   Google Puppeteer driver for Chromium