grover 0.12.1 → 0.13.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18d371bdb009b39ba004d06f24c35ddb4f51a0cd253082481d04b1c1dac45b57
-  data.tar.gz: f20bfd80f394ef4c3c7e98128a6d0d5615387af7c1c6733f867ee24ead91c9e5
+  metadata.gz: dc12ff02b99d418681762184d059363cc0a8b313172387bb2e30813804cdbf92
+  data.tar.gz: 7c5287275ae6cb24fbeb52201fc982b54d1766f65d83f5ea21e0e1d63ee563d9
 SHA512:
-  metadata.gz: 280be92cb4f2fd14c94341d75b3564add657ec7acc496fe3cffd0b1d0d7bcde86ab492112fec7522fe6c666cc95045f8f5eaf06e5e6cd6d034abab443c8955ed
-  data.tar.gz: 5a30bf3b21ea80eeb6b6f54c559f0fe7d0fd0559941028cebc71fd96fbd00dae24b2d67ecec29a413931cc0f883b4323282cc3308f69f370649720bd7a64639d
+  metadata.gz: f4397920cf427e04bf3eb904fa94e50e48ce0d09c9e4fd373f25fefd6360fb4cb8a0e3497026dc554fcdd647e387faa516ed6ad215bfb8dca61e2609195c23dc
+  data.tar.gz: b87cf9ebf9caf4d6a2d0bf9d14d0b17f9f6b523b3908b10abddeb1d79b4abd298051e5221f55b8ffa1c3623e8c7419ad6f48831a5f12cc71251bd0f0c6e25fdf

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'

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

@@ -17,13 +17,13 @@ class Grover
 
     def self.translate_relative_paths(html, root_url)
       # Try out this regexp using rubular http://rubular.com/r/hiAxBNX7KE
-      html.gsub(%r{(href|src)=(['"])/([^/"']([^\"']*|[^"']*))?['"]}, "\\1=\\2#{root_url}\\3\\2")
+      html.gsub(%r{(href|src)=(['"])/([^/"']([^"']*|[^"']*))?['"]}, "\\1=\\2#{root_url}\\3\\2")
     end
     private_class_method :translate_relative_paths
 
     def self.translate_relative_protocols(body, protocol)
       # Try out this regexp using rubular http://rubular.com/r/0Ohk0wFYxV
-      body.gsub(%r{(href|src)=(['"])//([^\"']*|[^"']*)['"]}, "\\1=\\2#{protocol}://\\3\\2")
+      body.gsub(%r{(href|src)=(['"])//([^"']*|[^"']*)['"]}, "\\1=\\2#{protocol}://\\3\\2")
     end
     private_class_method :translate_relative_protocols
   end

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());
@@ -107,6 +107,13 @@ const _processPage = (async (convertAction, urlOrHtml, options) => {
       await page.evaluate(executeScript);
     }
 
+    // If specified, wait for selector
+    const waitForSelector = options.waitForSelector; delete options.waitForSelector;
+    const waitForSelectorOptions = options.waitForSelectorOptions; delete options.waitForSelectorOptions;
+    if (waitForSelector !== undefined) {
+      await page.waitForSelector(waitForSelector, waitForSelectorOptions)
+    }
+
     // 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

@@ -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,12 +99,18 @@ 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
-      Grover.new(body, display_url: request_url)
+
+      options = { display_url: request_url }
+      cookies = Rack::Utils.parse_cookies(env).map do |name, value|
+        { name: name, value: Rack::Utils.escape(value), domain: env['HTTP_HOST'] }
+      end
+      options[:cookies] = cookies if cookies.any?
+
+      Grover.new(body, options)
     end
 
     def add_cover_content(grover)
@@ -129,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

@@ -22,7 +22,7 @@ class Grover
 
       result['data'].pack('C*')
     ensure
-      cleanup_process
+      cleanup_process if stdin
     end
 
     private
@@ -76,7 +76,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 +90,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.1'
+  VERSION = '0.13.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grover
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.3
 platform: ruby
 authors:
 - Andrew Bromwich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-12 00:00:00.000000000 Z
+date: 2020-12-14 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: 2.8.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="