grover 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26c7ccbc8a629084f409b83b07f3aa3f59018b93
-  data.tar.gz: 7b2bbb83563b7b142f99115a36cb061eeea54e29
+  metadata.gz: 0f700a9f110114c8de7c64f68ada3c60b183e002
+  data.tar.gz: 10038b11d2dc0e3a7deb9c8be59c17ce9fe75f5a
 SHA512:
-  metadata.gz: 7274a0c0591d9b8bd03fdf583686a6fc52bca590dc76989ad732462e0424b2516ed9575bf136615b7ca6959625f9ea06ada6898435a8f90ff717044ce2f140dc
-  data.tar.gz: 75213b2235ff0ede9fc0a17421fc28badbf546615806055d2a650eac3616c3af68f644d21a63e51f51a620a18d2953fe9605d9de03344a4318ccb9f860f2b99c
+  metadata.gz: '08d9ea6100709712c0ac3a3adaf6c00c80ae45fca0fe38176d808e4f4c89efe8b900128d750056ca9b4a7db73dae1f099cec4d5f97851501459728480d181ab4'
+  data.tar.gz: df95c29b666dd3eb53bbb5c23acfd328f3750cdd2931dd08a9432805ec4089a9f13f17303b7f3a1cffe7655179f1ea97fb16d270f51287736692dc38fc085227

data/lib/grover/configuration.rb

@@ -0,0 +1,12 @@
+class Grover
+  #
+  # Configuration of the options for Grover HTML to PDF conversion
+  #
+  class Configuration
+    attr_accessor :options
+
+    def initialize
+      @options = {}
+    end
+  end
+end

data/lib/grover/middleware.rb

@@ -29,12 +29,14 @@ class Grover
 
     private
 
+    PDF_REGEX = /\.pdf$/i
+
     def rendering_pdf?
       @render_pdf
     end
 
     def render_as_pdf?
-      @request.path.end_with?('.pdf')
+      !@request.path.match(PDF_REGEX).nil?
     end
 
     def html_content?(headers)
@@ -61,7 +63,7 @@ class Grover
     def configure_env_for_pdf_request(env)
       @render_pdf = true
 
-      path = @request.path.sub(/\.pdf$/, '')
+      path = @request.path.sub(PDF_REGEX, '')
       path = path.sub(@request.script_name, '')
 
       %w[PATH_INFO REQUEST_URI].each { |e| env[e] = path }

data/lib/grover/utils.rb

@@ -3,11 +3,46 @@ class Grover
   # Utility class for Grover helper methods
   #
   class Utils
+    ACRONYMS = {
+      'css' => 'CSS'
+    }.freeze
+    private_constant :ACRONYMS
+
+    #
+    # Removes leading/trailing whitespaces and squishes inner whitespace with a single space
+    #
+    # N.B. whitespace includes all 'blank' characters as well as newlines/carriage returns etc.
+    #
     def self.squish(string)
       string.
         gsub(/\A[[:space:]]+/, '').
         gsub(/[[:space:]]+\z/, '').
         gsub(/[[:space:]]+/, ' ')
     end
+
+    #
+    # Recursively normalizes hash objects with camelized string keys
+    #
+    def self.normalize_object(object)
+      if object.is_a? Hash
+        object.each_with_object({}) do |(k, v), acc|
+          acc[normalize_key(k)] = normalize_object(v)
+        end
+      else
+        object
+      end
+    end
+
+    #
+    # Normalizes hash keys into camelized strings, including up-casing known acronyms
+    #
+    # Regex sourced from ActiveSupport camelize
+    #
+    def self.normalize_key(key)
+      key.to_s.downcase.gsub(%r{(?:_|(/))([a-z\d]*)}) do
+        "#{Regexp.last_match(1)}#{ACRONYMS[Regexp.last_match(2)] || Regexp.last_match(2).capitalize}"
+      end
+    end
+    private_class_method :normalize_key
   end
 end

data/lib/grover/version.rb

@@ -1,3 +1,3 @@
 class Grover
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/grover.rb

@@ -1,14 +1,48 @@
 require 'grover/version'
 
 require 'grover/utils'
-require 'grover/processor'
 require 'grover/html_preprocessor'
 require 'grover/middleware'
+require 'grover/configuration'
+
+require 'schmooze'
 
 #
 # Grover interface for converting HTML to PDF
 #
 class Grover
+  #
+  # Processor helper class for calling out to Puppeteer NodeJS library
+  #
+  class Processor < Schmooze::Base
+    dependencies puppeteer: 'puppeteer'
+
+    def self.launch_params
+      ENV['CI'] == 'true' ? "{args: ['--no-sandbox', '--disable-setuid-sandbox']}" : ''
+    end
+
+    method :convert_pdf, Utils.squish(<<-FUNCTION)
+      async (url, options) => {
+        let browser;
+        try {
+          browser = await puppeteer.launch(#{launch_params});
+          const page = await browser.newPage();
+          if (url.match(/^http/i)) {
+            await page.goto(url, { waitUntil: 'networkidle2' });
+          } else {
+            await page.goto(`data:text/html,${url}`, { waitUntil: 'networkidle0' });
+          }
+          return await page.pdf(options);
+        } finally {
+          if (browser) {
+            await browser.close();
+          }
+        }
+      }
+    FUNCTION
+  end
+  private_constant :Processor
+
   #
   # @param [String] url URL of the page to convert
   # @param [Hash] options Optional parameters to pass to PDF processor
@@ -16,32 +50,44 @@ class Grover
   #
   def initialize(url, options = {})
     @url = url
-    @root_path = options.delete :root_path
-    @options = options
+    @options = Grover.configuration.options.merge options
+    @root_path = @options.delete :root_path
   end
 
   #
   # Request URL with provided options and create PDF
   #
   # @param [String] path Optional path to write the PDF to
-  # @return [Array<Integer>] Byte array of the resulting PDF
+  # @return [String] The resulting PDF data
   #
   def to_pdf(path = nil)
-    options = @options.dup
-    options[:path] = path if path
-    result = processor.convert_pdf @url, options
+    result = processor.convert_pdf @url, normalized_options(path)
     result['data'].pack('c*')
   end
 
+  #
+  # Instance inspection
+  #
   def inspect
     format(
       '#<%<class_name>s:0x%<object_id>p @url="%<url>s">',
       class_name: self.class.name,
       object_id: object_id,
-      url: url
+      url: @url
     )
   end
 
+  #
+  # Configuration for the conversion
+  #
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
   private
 
   def root_path
@@ -49,6 +95,12 @@ class Grover
   end
 
   def processor
-    Grover::Processor.new(root_path)
+    Processor.new(root_path)
+  end
+
+  def normalized_options(path)
+    options = Utils.normalize_object @options
+    options['path'] = path if path
+    options
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grover
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Bromwich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-23 00:00:00.000000000 Z
+date: 2018-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: schmooze
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.53'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.28'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.28'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -102,9 +144,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/grover.rb
+- lib/grover/configuration.rb
 - lib/grover/html_preprocessor.rb
 - lib/grover/middleware.rb
-- lib/grover/processor.rb
 - lib/grover/utils.rb
 - lib/grover/version.rb
 homepage: http://github.com/Studiosity/grover

data/lib/grover/processor.rb

@@ -1,35 +0,0 @@
-require 'schmooze'
-
-class Grover
-  #
-  # Processor helper class for calling out to Puppeteer NodeJS library
-  #
-  class Processor < Schmooze::Base
-    dependencies puppeteer: 'puppeteer'
-
-    def self.launch_params
-      ENV['CI'] == 'true' ? "{args: ['--no-sandbox', '--disable-setuid-sandbox']}" : ''
-    end
-    private_class_method :launch_params
-
-    method :convert_pdf, Utils.squish(<<-FUNCTION)
-      async (url, options) => {
-        let browser;
-        try {
-          browser = await puppeteer.launch(#{launch_params});
-          const page = await browser.newPage();
-          if (url.match(/^http/i)) {
-            await page.goto(url, { waitUntil: 'networkidle2' });
-          } else {
-            await page.goto(`data:text/html,${url}`, { waitUntil: 'networkidle0' });
-          }
-          return await page.pdf(options);
-        } finally {
-          if (browser) {
-            await browser.close();
-          }
-        }
-      }
-    FUNCTION
-  end
-end