grover 0.12.3 → 0.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7376874743ddb5f08d3fc68c02f84a72eb6cbe98c63306b2ce2a5f57d37867c9
-  data.tar.gz: 546007fe354d88c117f70469c8cf80ba88fd22415ebb350aa79512c64592be3f
+  metadata.gz: 5dae47620d2a732cab442444c25a6954f103c669fa7eea7c092b34297f1d71c0
+  data.tar.gz: 84d886147feff66e75276b00d5e6529883396763dcc424d6e42186c5dbb9b9d0
 SHA512:
-  metadata.gz: 010bb2d49e78af9cfe56cc0480d803f217dd1f644d99d36640fad060e8a70a2be7b4d422057a761a5d0710347649dd44d3da9efde553b4ff23bff62838973af0
-  data.tar.gz: 5879e39b9d00a6b1c5904a4e71cdf00fc695caa29de7b85ca4dbcbf7ec857d87822c2be42ded362efd3ef2466f8c5db338182e8115cbe6b4b822a6114d5e50d8
+  metadata.gz: bad7d5f4c5a15b8a9bc7ea7041ad1184c72416944b4c837c16592197e5105cebccee53eae564b9fbf8776884fb4b4e1d7d888de7c2018b0040c085979c65e55f
+  data.tar.gz: b8837766f459146e6349df80952f655dc330c7d9ca7cdebcbdd2a69fe17a10701addb1ff029ebfacd3458780b1d134679128df8766c1b017904c76dd876e43d2

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
   #

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

@@ -82,7 +82,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());
@@ -101,6 +101,22 @@ const _processPage = (async (convertAction, urlOrHtml, options) => {
       }
     }
 
+    // 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);
+      }
+    }
+
     // If specified, evaluate script on the page
     const executeScript = options.executeScript; delete options.executeScript;
     if (executeScript !== undefined) {

data/lib/grover/middleware.rb

@@ -9,12 +9,15 @@ class Grover
   # Much of this code was sourced from the PDFKit project
   # @see https://github.com/pdfkit/pdfkit
   #
-  class Middleware
-    def initialize(app)
+  class Middleware # rubocop:disable Metrics/ClassLength
+    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)
@@ -30,6 +33,8 @@ class Grover
       response = update_response response, headers if grover_request? && html_content?(headers)
 
       [status, headers, response]
+    ensure
+      restore_env_from_grover_request(env) if grover_request?
     end
 
     private
@@ -94,7 +99,7 @@ class Grover
       end
     end
 
-    def create_grover_for_response(response)
+    def create_grover_for_response(response) # rubocop:disable Metrics/AbcSize
       body = response.respond_to?(:body) ? response.body : response.join
       body = body.join if body.is_a?(Array)
       body = HTMLPreprocessor.process body, root_url, protocol
@@ -135,11 +140,24 @@ class Grover
     end
 
     def configure_env_for_grover_request(env)
-      env['PATH_INFO'] = env['REQUEST_URI'] = path_without_extension
+      # Save the env params we're overriding so we can restore them after the response is fetched
+      @pre_request_env_params = env.slice('PATH_INFO', 'REQUEST_URI', 'HTTP_ACCEPT')
+
+      # Override path/URI so any downstream middleware/app doesn't try actioning the request as PDF
+      env['PATH_INFO'] = path_without_extension
+      env['REQUEST_URI'] = @request.url
       env['HTTP_ACCEPT'] = concat(env['HTTP_ACCEPT'], Rack::Mime.mime_type('.html'))
       env['Rack-Middleware-Grover'] = 'true'
     end
 
+    def restore_env_from_grover_request(env)
+      return unless @pre_request_env_params.is_a? Hash
+
+      # Restore the path/URI so any upstream middleware doesn't get confused
+      env.merge! @pre_request_env_params
+      env['REQUEST_URI'] = @request.url unless @pre_request_env_params.key? 'REQUEST_URI'
+    end
+
     def concat(accepts, type)
       (accepts || '').split(',').unshift(type).compact.join(',')
     end

data/lib/grover/options_builder.rb

@@ -8,7 +8,7 @@ class Grover
   # Build options from Grover.configuration, meta_options, and passed-in options
   #
   class OptionsBuilder < Hash
-    def initialize(options, url)
+    def initialize(options, url) # rubocop:disable Lint/MissingSuper
       @url = url
       combined = grover_configuration
       Utils.deep_merge! combined, Utils.deep_stringify_keys(options)

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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grover
 version: !ruby/object:Gem::Version
-  version: 0.12.3
+  version: 0.14.2
 platform: ruby
 authors:
 - Andrew Bromwich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2021-02-22 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
@@ -188,7 +189,10 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="