grover 0.7.4 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b65f94b265a2cff7033dd91d10ca2d1cad51c0b4e447e644d4ccdcbb8df14b30
-  data.tar.gz: 170d807936eb67a6d805717545548ffc5650a200c6dd2a06cf503411d87d00d4
+  metadata.gz: 3a0324b73710864e876853e8de3ffe71974b5544015b1f602d203b4b409cb6fc
+  data.tar.gz: 7c27e1acd0b266a69f71c2c2af90d8f0c14ff103ccbc1a28ccf3248854081b56
 SHA512:
-  metadata.gz: 841ac6e650d6427cece6e3c1be1d21ed433d42bb3b5c1366efafd4dff29244a9bba2f5ccc606d51888e537bcfb6dc2ddbd43d87a680e73cc300c3ca74ff4aa18
-  data.tar.gz: e87b7f047c77048d5b8b35dfd38dadff2cb3e1c7d40df699ea09bb51edfd0282ca47119ba5c6e8562b7eef70416098ecc02dfd6a5837818ed673e7172bcafa69
+  metadata.gz: df27ae8e1291e8d071afdbc7d6eb249776481c245b8f663261bb199f385e712132b6647d6a3e75c46508aec8dc6ed03a8a1b17b10adaaf08154bf97deef5875f
+  data.tar.gz: 211d0e9eb2ac4d033e9a9bae46fc4319cf618e62f6c380e5f600f80968621bef40365bbebadf93b2451a7ea8964b6abda83b11278edc08426b952ec3e5f297db

data/lib/grover/configuration.rb

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

data/lib/grover/middleware.rb

@@ -12,21 +12,18 @@ class Grover
   class Middleware
     def initialize(app)
       @app = app
-      @render_pdf = false
+      @pdf_request = false
+      @png_request = false
+      @jpeg_request = false
     end
 
     def call(env)
       @request = Rack::Request.new(env)
-      @render_pdf = pdf_request?
+      identify_request_type
 
-      configure_env_for_pdf_request(env) if rendering_pdf?
+      configure_env_for_grover_request(env) if grover_request?
       status, headers, response = @app.call(env)
-
-      if rendering_pdf? && html_content?(headers)
-        pdf = convert_to_pdf response
-        response = [pdf]
-        update_headers headers, pdf
-      end
+      response = update_response response, headers if grover_request? && html_content?(headers)
 
       [status, headers, response]
     end
@@ -34,21 +31,57 @@ class Grover
     private
 
     PDF_REGEX = /\.pdf$/i.freeze
+    PNG_REGEX = /\.png$/i.freeze
+    JPEG_REGEX = /\.jpe?g$/i.freeze
+
+    attr_reader :pdf_request, :png_request, :jpeg_request
+
+    def identify_request_type
+      @pdf_request = Grover.configuration.use_pdf_middleware && path_matches?(PDF_REGEX)
+      @png_request = Grover.configuration.use_png_middleware && path_matches?(PNG_REGEX)
+      @jpeg_request = Grover.configuration.use_jpeg_middleware && path_matches?(JPEG_REGEX)
+    end
 
-    def rendering_pdf?
-      @render_pdf
+    def path_matches?(regex)
+      !@request.path.match(regex).nil?
     end
 
-    def pdf_request?
-      !@request.path.match(PDF_REGEX).nil?
+    def grover_request?
+      (pdf_request || png_request || jpeg_request) && !ignore_request?
+    end
+
+    def ignore_request?
+      ignore_path = Grover.configuration.ignore_path
+      case ignore_path
+      when String then @request.path.start_with? ignore_path
+      when Regexp then !ignore_path.match(@request.path).nil?
+      when Proc then ignore_path.call @request.path
+      end
     end
 
     def html_content?(headers)
       headers['Content-Type'] =~ %r{text/html|application/xhtml\+xml}
     end
 
-    def convert_to_pdf(response)
+    def update_response(response, headers)
+      body, content_type = convert_response response
+      assign_headers headers, body, content_type
+      [body]
+    end
+
+    def convert_response(response)
       grover = create_grover_for_response(response)
+
+      if pdf_request
+        [convert_to_pdf(grover), 'application/pdf']
+      elsif png_request
+        [grover.to_png, 'image/png']
+      elsif jpeg_request
+        [grover.to_jpeg, 'image/jpeg']
+      end
+    end
+
+    def convert_to_pdf(grover)
       if grover.show_front_cover? || grover.show_back_cover?
         add_cover_content grover
       else
@@ -80,16 +113,16 @@ class Grover
       CombinePDF.parse grover.to_pdf
     end
 
-    def update_headers(headers, body)
-      # Do not cache PDFs
+    def assign_headers(headers, body, content_type)
+      # Do not cache results
       headers.delete 'ETag'
       headers.delete 'Cache-Control'
 
       headers['Content-Length'] = (body.respond_to?(:bytesize) ? body.bytesize : body.size).to_s
-      headers['Content-Type'] = 'application/pdf'
+      headers['Content-Type'] = content_type
     end
 
-    def configure_env_for_pdf_request(env)
+    def configure_env_for_grover_request(env)
       env['PATH_INFO'] = env['REQUEST_URI'] = path_without_extension
       env['HTTP_ACCEPT'] = concat(env['HTTP_ACCEPT'], Rack::Mime.mime_type('.html'))
       env['Rack-Middleware-Grover'] = 'true'
@@ -108,7 +141,17 @@ class Grover
     end
 
     def path_without_extension
-      @request.path.sub(PDF_REGEX, '').sub(@request.script_name, '')
+      @request.path.sub(request_regex, '').sub(@request.script_name, '')
+    end
+
+    def request_regex
+      if pdf_request
+        PDF_REGEX
+      elsif png_request
+        PNG_REGEX
+      elsif jpeg_request
+        JPEG_REGEX
+      end
     end
 
     def request_url

data/lib/grover/utils.rb

@@ -22,17 +22,6 @@ class Grover
         gsub(/[[:space:]]+/, ' ')
     end
 
-    #
-    # Remove minimum spaces from the front of all lines within a string
-    #
-    # Based on active support
-    # @see active_support/core_ext/string/strip.rb
-    #
-    def self.strip_heredoc(string, inline: false)
-      string = string.gsub(/^#{string.scan(/^[ \t]*(?=\S)/).min}/, '')
-      inline ? string.delete("\n") : string
-    end
-
     #
     # Assign value to a hash using an array of keys to traverse
     #

data/lib/grover/version.rb

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

data/lib/grover.rb

@@ -26,76 +26,87 @@ class Grover
       ENV['GROVER_NO_SANDBOX'] == 'true' ? "{args: ['--no-sandbox', '--disable-setuid-sandbox']}" : '{}'
     end
 
-    method :convert_pdf, Utils.strip_heredoc(<<-FUNCTION)
-      async (url_or_html, options) => {
-        let browser;
-        try {
-          let launchParams = #{launch_params};
-
-          // Configure puppeteer debugging options
-          const debug = options.debug; delete options.debug;
-          if (typeof debug === 'object' && !!debug) {
-            if (debug.headless != undefined) { launchParams.headless = debug.headless; }
-            if (debug.devtools != undefined) { launchParams.devtools = debug.devtools; }
-          }
-
-          // Launch the browser and create a page
-          browser = await puppeteer.launch(launchParams);
-          const page = await browser.newPage();
-
-          // Set caching flag (if provided)
-          const cache = options.cache; delete options.cache;
-          if (cache != undefined) {
-            await page.setCacheEnabled(cache);
-          }
-
-          // Setup timeout option (if provided)
-          let request_options = {};
-          const timeout = options.timeout; delete options.timeout;
-          if (timeout != undefined) {
-            request_options.timeout = timeout;
-          }
-
-          if (url_or_html.match(/^http/i)) {
-            // Request is for a URL, so request it
-            request_options.waitUntil = 'networkidle2';
-            await page.goto(url_or_html, request_options);
-          } else {
-            // Request is some HTML content. Use request interception to assign the body
-            request_options.waitUntil = 'networkidle0';
-            await page.setRequestInterception(true);
-            page.once('request', request => {
-              request.respond({ body: url_or_html });
-              // Reset the request interception
-              // (we only want to intercept the first request - ie our HTML)
-              page.on('request', request => request.continue());
-            });
-            const displayUrl = options.displayUrl; delete options.displayUrl;
-            await page.goto(displayUrl || 'http://example.com', request_options);
-          }
-
-          // If specified, emulate the media type
-          const emulateMedia = options.emulateMedia; delete options.emulateMedia;
-          if (emulateMedia != undefined) {
-            await page.emulateMedia(emulateMedia);
-          }
-
-          // 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.pdf(options);
-          }
-        } finally {
-          if (browser) {
-            await browser.close();
+    def self.convert_function(convert_action)
+      <<~FUNCTION
+        async (url_or_html, options) => {
+          let browser;
+          try {
+            let launchParams = #{launch_params};
+
+            // Configure puppeteer debugging options
+            const debug = options.debug; delete options.debug;
+            if (typeof debug === 'object' && !!debug) {
+              if (debug.headless != undefined) { launchParams.headless = debug.headless; }
+              if (debug.devtools != undefined) { launchParams.devtools = debug.devtools; }
+            }
+
+            // Launch the browser and create a page
+            browser = await puppeteer.launch(launchParams);
+            const page = await browser.newPage();
+
+            // Set caching flag (if provided)
+            const cache = options.cache; delete options.cache;
+            if (cache != undefined) {
+              await page.setCacheEnabled(cache);
+            }
+
+            // Setup timeout option (if provided)
+            let request_options = {};
+            const timeout = options.timeout; delete options.timeout;
+            if (timeout != undefined) {
+              request_options.timeout = timeout;
+            }
+
+            // Setup viewport options (if provided)
+            const viewport = options.viewport; delete options.viewport;
+            if (viewport != undefined) {
+              await page.setViewport(viewport);
+            }
+
+            if (url_or_html.match(/^http/i)) {
+              // Request is for a URL, so request it
+              request_options.waitUntil = 'networkidle2';
+              await page.goto(url_or_html, request_options);
+            } else {
+              // Request is some HTML content. Use request interception to assign the body
+              request_options.waitUntil = 'networkidle0';
+              await page.setRequestInterception(true);
+              page.once('request', request => {
+                request.respond({ body: url_or_html });
+                // Reset the request interception
+                // (we only want to intercept the first request - ie our HTML)
+                page.on('request', request => request.continue());
+              });
+              const displayUrl = options.displayUrl; delete options.displayUrl;
+              await page.goto(displayUrl || 'http://example.com', request_options);
+            }
+
+            // If specified, emulate the media type
+            const emulateMedia = options.emulateMedia; delete options.emulateMedia;
+            if (emulateMedia != undefined) {
+              await page.emulateMedia(emulateMedia);
+            }
+
+            // 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.#{convert_action}(options);
+            }
+          } finally {
+            if (browser) {
+              await browser.close();
+            }
           }
         }
-      }
-    FUNCTION
+      FUNCTION
+    end
+
+    method :convert_pdf, convert_function('pdf')
+    method :convert_screenshot, convert_function('screenshot')
   end
   private_constant :Processor
 
   DEFAULT_HEADER_TEMPLATE = "<div class='date text left'></div><div class='title text center'></div>"
-  DEFAULT_FOOTER_TEMPLATE = Utils.strip_heredoc(<<-HTML).freeze
+  DEFAULT_FOOTER_TEMPLATE = <<~HTML
     <div class='url text left grow'></div>
     <div class='text right'><span class='pageNumber'></span>/<span class='totalPages'></span></div>
   HTML
@@ -123,12 +134,46 @@ class Grover
   # @return [String] The resulting PDF data
   #
   def to_pdf(path = nil)
-    normalized_options = Utils.normalize_object @options
-    normalized_options['path'] = path if path.is_a? ::String
-    result = processor.convert_pdf @url, normalized_options
+    result = processor.convert_pdf @url, normalized_options(path: path)
     return unless result
 
-    result['data'].pack('c*')
+    result['data'].pack('C*')
+  end
+
+  #
+  # Request URL with provided options and create screenshot
+  #
+  # @param [String] path Optional path to write the screenshot to
+  # @param [String] format Optional format of the screenshot
+  # @return [String] The resulting image data
+  #
+  def screenshot(path: nil, format: nil)
+    options = normalized_options(path: path)
+    options['type'] = format if format.is_a? ::String
+    result = processor.convert_screenshot @url, options
+    return unless result
+
+    result['data'].pack('C*')
+  end
+
+  #
+  # Request URL with provided options and create PNG
+  #
+  # @param [String] path Optional path to write the screenshot to
+  # @return [String] The resulting PNG data
+  #
+  def to_png(path = nil)
+    screenshot(path: path, format: 'png')
+  end
+
+  #
+  # Request URL with provided options and create JPEG
+  #
+  # @param [String] path Optional path to write the screenshot to
+  # @return [String] The resulting JPEG data
+  #
+  def to_jpeg(path = nil)
+    screenshot(path: path, format: 'jpeg')
   end
 
   #
@@ -232,4 +277,10 @@ class Grover
 
     options['scale'] = options['scale'].to_f
   end
+
+  def normalized_options(path:)
+    normalized_options = Utils.normalize_object @options
+    normalized_options['path'] = path if path.is_a? ::String
+    normalized_options
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grover
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.8.1
 platform: ruby
 authors:
 - Andrew Bromwich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-09 00:00:00.000000000 Z
+date: 2019-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: combine_pdf
@@ -52,20 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.9'
 - !ruby/object:Gem::Dependency
   name: pdf-reader
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -100,57 +114,57 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.53'
+        version: '0.72'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.53'
+        version: '0.72'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.28'
+        version: '1.33'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.28'
+        version: '1.33'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
-description: Transform HTML into PDFs using Google Puppeteer/Chromium
+        version: '0.17'
+description: Transform HTML into PDF/PNG/JPEG using Google Puppeteer/Chromium
 email:
 - abromwich@studiosity.com
 executables: []
@@ -187,6 +201,6 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: A Ruby gem to transform HTML into PDFs wrapper the NodeJS Google Puppeteer
-  driver for Chromium
+summary: A Ruby gem to transform HTML into PDF, PNG or JPEG by wrapping the NodeJS
+  Google Puppeteer driver for Chromium
 test_files: []