grover 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6380a1db564715e3ab864d55c55d10fa989fa0f4
-  data.tar.gz: 0c3675a41430560d602413f1221835a026a5ea19
+  metadata.gz: 1ffddd7bbedda30ce0a9012ddb9bf2ad8cca7b31
+  data.tar.gz: '052654614238c49a142f05a4e723b3551a0f728e'
 SHA512:
-  metadata.gz: af32f4e2bb16b6a991ea8c93b5135acabdc991392a18f8e39112e14c821a8cc5df4b400e3ceb18fff256395da89e85372252731f134080578a01f4344d42e922
-  data.tar.gz: 1e732cb5773661324a94d2fe7f4506e868a68893dd6473b20fbf675a2747a3690c9b1c453e07dc40dbbe187bec225c49ab67fb7e9c0af252cc875cc0b89b4bb6
+  metadata.gz: fa584f02ecff16ce4fc95f03a99fce1911c919e6b1957b49fe79430504ae6564962d1108d39114f4f4f1cf6df3ae99920a8da9d7d2f0bcbc445edd0cdb09ca5c
+  data.tar.gz: 0d47f71cd8b25638cfd3cc64831a3efaedbe6caa7ab69fafc25965aa1de3a086fe4cb98466ef873478f23ef58eab762dc28025b1bb911ee024947f25fce51f9a

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'grover'
+
+require 'irb'
+IRB.start

data/lib/grover.rb

@@ -0,0 +1,5 @@
+require 'grover/version'
+
+require 'grover/utils'
+require 'grover/processor'
+require 'grover/grover'

data/lib/grover/grover.rb

@@ -0,0 +1,42 @@
+#
+# Grover interface for converting HTML to PDF
+#
+class Grover
+  #
+  # @param [String] url URL of the page to convert
+  # @param [Hash] options Optional parameters to pass to PDF processor
+  #   see https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagepdfoptions
+  #
+  def initialize(url, options = {})
+    @url = url
+    @options = options
+  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
+  #
+  def to_pdf(path = nil)
+    options = @options.dup
+    options[:path] = path if path
+    result = Grover::Processor.new(root_path).convert_pdf(@url, options)
+    result['data'].pack('c*')
+  end
+
+  def inspect
+    format(
+      '#<%<class_name>s:0x%<object_id>p @url="%<url>s">',
+      class_name: self.class.name,
+      object_id: object_id,
+      url: url
+    )
+  end
+
+  private
+
+  def root_path
+    File.expand_path(__dir__)
+  end
+end

data/lib/grover/processor.rb

@@ -0,0 +1,31 @@
+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();
+          await page.goto(url, { waitUntil: 'networkidle2' });
+          return await page.pdf(options);
+        } finally {
+          if (browser) {
+            await browser.close();
+          }
+        }
+      }
+    FUNCTION
+  end
+end

data/lib/grover/utils.rb

@@ -0,0 +1,13 @@
+class Grover
+  #
+  # Utility class for Grover helper methods
+  #
+  class Utils
+    def self.squish(string)
+      string.
+        gsub(/\A[[:space:]]+/, '').
+        gsub(/[[:space:]]+\z/, '').
+        gsub(/[[:space:]]+/, ' ')
+    end
+  end
+end

data/lib/grover/version.rb

@@ -1,3 +1,3 @@
 class Grover
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.1.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grover
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Bromwich
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2018-08-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: schmooze
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -83,18 +97,16 @@ dependencies:
 description: A Ruby gem to transform HTML into PDFs using Google Puppeteer/Chromium
 email:
 - abromwich@studiosity.com
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
-- Gemfile
-- LICENSE
-- README.md
-- Rakefile
-- grover.gemspec
+- bin/console
+- lib/grover.rb
+- lib/grover/grover.rb
+- lib/grover/processor.rb
+- lib/grover/utils.rb
 - lib/grover/version.rb
 homepage: http://github.com/Studiosity/grover
 licenses:

data/.gitignore

@@ -1,2 +0,0 @@
-*.gem
-Gemfile.lock

data/.rubocop.yml

@@ -1,2 +0,0 @@
-Metrics/LineLength:
-  Max: 120

data/.travis.yml

@@ -1,29 +0,0 @@
-env:
-  global:
-    - CC_TEST_REPORTER_ID=5cfed40102c670b5c9e509730782b751939ddbe53fc57c317b718f635bab1ce8
-
-language: ruby
-rvm:
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
-
-before_install:
-  - gem update bundler
-
-install:
-  - bundle install --jobs=3 --retry=3
-  - gem install rubocop
-
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-
-script:
-  - rubocop
-  - bundle exec rspec
-
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in grover.gemspec
-gemspec

data/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2018 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 NONINFRINGEMENT. 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/README.md

@@ -1,8 +0,0 @@
-[![Travis Build Status](http://img.shields.io/travis/Studiosity/grover.svg?style=flat)](https://travis-ci.org/Studiosity/grover)
-[![Maintainability](https://api.codeclimate.com/v1/badges/37609653789bcf2c8d94/maintainability)](https://codeclimate.com/github/Studiosity/grover/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/37609653789bcf2c8d94/test_coverage)](https://codeclimate.com/github/Studiosity/grover/test_coverage)
-[![Gem Version](http://img.shields.io/gem/v/grover.svg?style=flat)](#)
-
-# Grover
-
-A Ruby gem to transform HTML into PDFs using Google Puppeteer

data/Rakefile

@@ -1,8 +0,0 @@
-#!/usr/bin/env rake
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new 'spec'
-
-task default: :spec

data/grover.gemspec

@@ -1,26 +0,0 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'grover/version'
-
-Gem::Specification.new do |spec|
-  spec.name        = 'grover'
-  spec.version     = Grover::VERSION
-  spec.authors     = ['Andrew Bromwich']
-  spec.email       = %w[abromwich@studiosity.com]
-  spec.description = 'A Ruby gem to transform HTML into PDFs using Google Puppeteer/Chromium'
-  spec.summary     = 'A Ruby gem to transform HTML into PDFs wrapper the NodeJS Google Puppeteer project using Chromium'
-  spec.homepage    = 'http://github.com/Studiosity/grover'
-  spec.license     = 'MIT'
-
-  spec.files         = `git ls-files`.split("\n")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'rspec', '~> 3.7'
-  spec.add_development_dependency 'rubocop', '~> 0.53'
-  spec.add_development_dependency 'simplecov', '~> 0.15'
-end