pdfgen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60fe8cc6f4d47c8fd5af37261f7fe11079bbbf6d
+  data.tar.gz: e099bdd44342ddcfd71a767bf2fc5a31d3667a6f
+SHA512:
+  metadata.gz: dc69f4ea62cfd5e666a9102bee591621e1dd69c3cb51700bbf215abe9707945b105836cec3f4d07601cf9e42baf387bd647e16ed780059dc35851ec34c401f19
+  data.tar.gz: 5ac4dd0db6eabbf2f162c5eba4ea99de47b59a107d78c92a08884a248fd28ff7d527d1b449faeb0043f788597da4c5946b2b2f88c86a86b91722d173ae6ace98

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Dan Fox
+
+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

@@ -0,0 +1,38 @@
+# Pdfgen
+A tool for creating PDFs using [Puppeteer](https://github.com/GoogleChrome/puppeteer) and headless Chrome.
+
+# Dependencies
+This gem requires that node be installed along with puppeteer.
+
+### OSX (Homebrew)
+To install node on OSX you can use Homebrew:
+```bash
+brew install nodejs
+```
+
+And then install puppeteer with npm:
+```bash
+npm install --save puppeteer
+```
+
+# Usage
+Currently the only use case that is supported is rendering an HTML string. You can do that by using the
+Pdfgen class:
+```ruby
+pdf_as_string = Pdfgen.new(html_to_turn_into_pdf).to_pdf
+```
+`to_pdf` returns the pdf as a string. This makes it easy to send to a client from a web server like
+Rails or to save to a file if that is desired.
+
+If you need to provide options such as page margins you can pass them as a hash to `to_pdf`. Any 
+options that work for [Puppeteer's `pdf` method](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagepdfoptions)
+are accepted as they are passed through without modification.
+```ruby
+pdf_as_string = Pdfgen.new(html_to_turn_into_pdf).to_pdf(margins: { top: '1in', bottom: '1in' })
+``` 
+
+# Future Development
+In the future, allowing use of more features of Puppeteer is desired. These include taking a URL and 
+setting cookies. Instead of using a fixed make_pdf.js script, it will probably make sense to convert
+to generating that javascript file on the fly using templates since additional options like allowing
+the setting of cookies will require calling more functions than are currently being called.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+desc "Run tests"
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/javascript_bin/make_pdf.js

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+
+var stdin = process.stdin,
+    stdout = process.stdout,
+    inputChunks = [];
+
+stdin.resume();
+stdin.setEncoding('utf8');
+
+stdin.on('data', function (chunk) {
+    inputChunks.push(chunk);
+});
+
+stdin.on('end', function () {
+    var options = JSON.parse(inputChunks.join());
+    var pdf_options = options['pdf_options'];
+    var current_path = options['current_path'];
+    var viewport_options = options['viewport_options'];
+    var media_type = options['emulate_media'];
+
+    module.paths.push(current_path + '/node_modules');
+
+    const puppeteer = require('puppeteer');
+    const fs = require('fs');
+    var html = fs.readFileSync(process.argv[2], 'utf8');
+
+    (async() => {
+        const browser = await puppeteer.launch();
+        const page = await browser.newPage();
+
+        await page.setContent(html);
+        if (typeof media_type !== 'undefined' && media_type) {
+            await page.emulateMedia(media_type);
+        }
+
+        if (typeof viewport_options !== 'undefined' && viewport_options) {
+            await page.setViewport(viewport_options);
+        }
+
+        const pdf_output = await page.pdf(pdf_options);
+        stdout.write(pdf_output);
+        await browser.close();
+    })();
+});

data/lib/pdfgen.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'json'
+
+_, status = Open3.capture2('node', '-v')
+raise 'This gem requires node be installed and available on the PATH' unless status.success?
+
+MAKE_PDF_COMMAND = File.expand_path('../javascript_bin/make_pdf.js', __FILE__)
+
+class Pdfgen
+  def initialize(html)
+    @html = html
+    @viewport_options = nil
+    @emulate_media = nil
+  end
+
+  def set_viewport(viewport_options)
+    @viewport_options = viewport_options
+    self
+  end
+
+  def emulate_media(media_type)
+    @emulate_media = media_type
+    self
+  end
+
+  def to_pdf(opts = {})
+    stdin_options = { pdf_options: opts, current_path: Dir.pwd }
+    stdin_options = stdin_options.merge(viewport_options: @viewport_options) if @viewport_options
+    stdin_options = stdin_options.merge(emulate_media: @emulate_media) if @emulate_media
+    file = Tempfile.new('input_html')
+    file.write(@html)
+    file.close
+    pdf_output, status = Open3.capture2(MAKE_PDF_COMMAND, file.path, stdin_data: stdin_options.to_json)
+    file.unlink
+    unless status.success?
+      raise 'There was an unknown error running node to create the pdf. Check your logs for output that might assist in debugging.'
+    end
+    unless pdf_output
+      raise 'There was an error creating the temporary file used to pass the HTML to node.'
+    end
+    pdf_output
+  end
+end
+
+
+# Use a new API that uses method chaining to configure the PDF and that queues up strings to put in a js file to run puppeteer

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: pdfgen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Fox
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+description: Using Puppeteer and headless Chrome, generate PDFs from HTML without
+  needing to install wkhtmltopdf.
+email: romaimperator@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/javascript_bin/make_pdf.js
+- lib/pdfgen.rb
+homepage: https://github.com/romaimperator/pdfgen
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Generate PDFs using Puppeteer and headless Chrome
+test_files: []