pdf_gem 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10af893a52c091022ff0544911751cc04cd09dbd0ce2dd45c3aca4cee493affd
+  data.tar.gz: ec3e961a45fa96c8fbbe45e1d671f84367600b00f1a4dfd0cfc74c50067b3e7e
+SHA512:
+  metadata.gz: fd9be56c9327a4894059cb4a174b485d33c1c1c3c8ab744d5b788abd663311769fab3f87f37cc1c60d2c7f6749640b39308330b3840abb1fbb9d3e64ae3892ea
+  data.tar.gz: caaf28b437e0ba053b8bed3271619d1561ce5cbbc07ec2f93a034b9a8be614498099bfe7613d5bc84730580048a2bae526bd0fe645d94292ddb8e52b12fdb5df

data/README.md

@@ -0,0 +1,141 @@
+# PdfGem
+This is a gem for generating PDF from HTML, and is rendered from Chromium Browser
+
+## Prerequisites
+This package depends on node.js and puppeteer run this command for installing them:
+
+```bash
+$ npm install -g node puppeteer
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pdf_gem'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ gem install pdf_gem
+```
+
+You may need to add 
+```ruby
+Mime::Type.register "application/pdf", :pdf
+```
+to config/initializers/mime_types.rb
+
+
+## Usage
+
+### Usage from controller 
+
+```ruby
+class TestController < ApplicationController
+  def show
+    respond_to do |format|
+      format.html
+      format.pdf do
+        render pdf: "template", options #look options section
+      end
+    end
+  end
+end
+```
+
+### Available lib methods
+
+
+This method generates pdf from url
+
+```ruby
+PdfGem.pdf_from_url(options)
+```
+
+This method generates pdf from html string
+```ruby
+PdfGem.pdf_from_string(options)
+```
+
+
+## Options
+
+- `options` <[Object]> Options object which might have the following properties:
+  - `url` <[string]> (Use only for PdfGem.pdf_from_url) This is the url to render.
+  - `html` <[string]> (Use only for PdfGem.pdf_from_string) This is the html string to render.
+  - `disposition` <[string]> (Use only for controller render) Disposition string (inline/attachment).
+  - `filename` <[string]> (Use only for controller render) Filename of the file.
+  - `destination` <[string]> The file path to save the PDF to. If no destination is provided, will be returned a binary string
+  - `scale` <[number]> Scale of the webpage rendering. Defaults to `1`. Scale amount must be between 0.1 and 2.
+  - `displayHeaderFooter` <[boolean]> Display header and footer. Defaults to `false`.
+  - `headerTemplate` <[string]> HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them:
+    - `date` formatted print date
+    - `title` document title
+    - `url` document location
+    - `pageNumber` current page number
+    - `totalPages` total pages in the document
+  - `footerTemplate` <[string]> HTML template for the print footer. Should use the same format as the `headerTemplate`.
+  - `printBackground` <[boolean]> Print background graphics. Defaults to `false`.
+  - `landscape` <[boolean]> Paper orientation. Defaults to `false`.
+  - `pageRanges` <[string]> Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.
+  - `format` <[string]> Paper format. If set, takes priority over `width` or `height` options. Defaults to 'Letter'.
+  - `width` <[string]|[number]> Paper width, accepts values labeled with units.
+  - `height` <[string]|[number]> Paper height, accepts values labeled with units.
+  - `margin` <[Object]> Paper margins, defaults to none.
+    - `top` <[string]|[number]> Top margin, accepts values labeled with units.
+    - `right` <[string]|[number]> Right margin, accepts values labeled with units.
+    - `bottom` <[string]|[number]> Bottom margin, accepts values labeled with units.
+    - `left` <[string]|[number]> Left margin, accepts values labeled with units.
+  - `preferCSSPageSize` <[boolean]> Give any CSS `@page` size declared in the page priority over what is declared in `width` and `height` or `format` options. Defaults to `false`, which will scale the content to fit the paper size.
+
+> **NOTE** Generating a pdf is currently only supported in Chrome headless.
+
+> **NOTE** By default, generates a pdf with modified colors for printing. Use the [`-webkit-print-color-adjust`](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-print-color-adjust) property to force rendering of exact colors.
+
+
+
+> Example of working footer template:
+```html
+<div id="footer-template" style="font-size:10px !important; color:#808080; padding-left:10px">
+  <span class="date"></span>
+  <span class="title"></span>
+  <span class="url"></span>
+  <span class="pageNumber"></span>
+  <span class="totalPages"></span>
+</div>
+```
+
+The `width`, `height`, and `margin` options accept values labeled with units. Unlabeled values are treated as pixels.
+
+All possible units are:
+- `px` - pixel
+- `in` - inch
+- `cm` - centimeter
+- `mm` - millimeter
+
+The `format` options are:
+- `Letter`: 8.5in x 11in
+- `Legal`: 8.5in x 14in
+- `Tabloid`: 11in x 17in
+- `Ledger`: 17in x 11in
+- `A0`: 33.1in x 46.8in
+- `A1`: 23.4in x 33.1in
+- `A2`: 16.54in x 23.4in
+- `A3`: 11.7in x 16.54in
+- `A4`: 8.27in x 11.7in
+- `A5`: 5.83in x 8.27in
+- `A6`: 4.13in x 5.83in
+
+> **NOTE** `headerTemplate` and `footerTemplate` markup have the following limitations:
+> 1. Script tags inside templates are not evaluated.
+> 2. Page styles are not visible inside templates.
+
+
+## License
+The gem is available as open source under the terms of the [Apach e2.0 License](https://opensource.org/licenses/Apache-2.0).

data/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PdfGem'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/pdf_gem.rb

@@ -0,0 +1,38 @@
+require "pdf_gem/railtie"
+require 'open3'
+require 'base64'
+require 'renderer'
+
+module PdfGem 
+  def self.pdf_from_url(params)
+    stdout, stderr = Open3.capture3("node #{File.join(File.dirname(__FILE__), 'pdf_generator.js').to_s} #{Base64.strict_encode64(params.to_json).to_s}")  
+    if(stdout.present? and stderr.empty?)
+      if(params[:destination].present?)
+        self.save_to_file(params[:destination], stdout)
+      else
+        return Base64.decode64(stdout)
+      end
+    else
+      raise stderr.present? ? stderr : "error"
+    end   
+  end
+
+  def self.pdf_from_string(params)
+    tmp = File.join(File.dirname(__FILE__), 'tmp')
+    Dir.mkdir(tmp) unless File.exist?(tmp)
+    html_file = File.join(tmp, "#{rand(36**40).to_s(36)}.html")   
+    File.open(html_file, "w+") do |f|        
+      f.write(params[:html])
+    end
+    params[:url] = "file:#{html_file}"
+    result = self.pdf_from_url(params)
+    File.delete(html_file) if File.exist?(html_file)
+    return result
+  end
+
+  def self.save_to_file(destination, data)   
+    File.open(destination, "wb") do |f|
+      f.write(Base64.decode64(data))
+    end
+  end
+end

data/lib/pdf_gem/railtie.rb

@@ -0,0 +1,4 @@
+module PdfGem
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/pdf_gem/version.rb

@@ -0,0 +1,3 @@
+module PdfGem
+  VERSION = '1.0.1'
+end

data/lib/pdf_generator.js

@@ -0,0 +1,24 @@
+const puppeteer = require('puppeteer');
+const fs = require('fs');
+const crypto = require('crypto');
+const path = require('path');
+(async () => {    
+    const filename = path.join(path.dirname(__filename), 'tmp', crypto.randomBytes(40).toString('hex')+ '.pdf');
+    const browser = await puppeteer.launch();
+    try{
+	const params = {...JSON.parse(Buffer.from(process.argv.slice(2)[0], 'base64').toString('utf-8')), ...{path: filename}};	
+	const page = await browser.newPage();
+	await page.goto(params.url);
+	await page.pdf(params);
+	console.log(Buffer.from(fs.readFileSync(filename, 'binary'), 'binary').toString('base64'))	
+    }
+    catch(e){
+	console.error(e)
+	process.exit(1);
+    }
+    finally{
+	fs.unlinkSync(filename)
+	await browser.close();
+	process.exit(0);
+    }
+})();

data/lib/renderer.rb

@@ -0,0 +1,11 @@
+module PdfGem 
+  ActionController::Renderers.add :pdf do |template, options|
+    params = options.except(:prefixes, :template, :disposition, :url, :html, :filename)
+    params[:html] = render_to_string(template.present? ? template : options.template)
+    send_data PdfGem::pdf_from_string(params), type: Mime[:pdf],  disposition: (params[:disposition].present? ? params[:disposition] : 'inline'), :filename => options[:filename]
+  end
+
+  if Mime::Type.lookup_by_extension(:pdf).nil?
+    Mime::Type.register('application/pdf', :pdf)
+  end
+end

data/lib/tmp/1zlgz1o22datkhezl9dp5j803ocavkyc6wtpmbiz.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Test HTML File</title>
+
+</head>
+<body>
+
+<p>This is a simple HTML file.</p>
+
+
+
+</body></html>

data/lib/tmp/512m1i0cteoydwdoju0e6qdjbm0qttswr711igtr.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Test HTML File</title>
+
+</head>
+<body>
+
+<p>This is a simple HTML file.</p>
+
+
+
+</body></html>

data/lib/tmp/evziomgjof3tg36lz6t6x429rbni8ipjefmxjilq.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Test HTML File</title>
+
+</head>
+<body>
+
+<p>This is a simple HTML file.</p>
+
+
+
+</body></html>

data/lib/tmp/j56oa22hog5nnt1wwebf1xv5nbieeitn5l1nshws.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Test HTML File</title>
+
+</head>
+<body>
+
+<p>This is a simple HTML file.</p>
+
+
+
+</body></html>

data/lib/tmp/kjn1jl9z22l3kdl1vgjdezivta47rlgos30wxx1q.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Test HTML File</title>
+
+</head>
+<body>
+
+<p>This is a simple HTML file.</p>
+
+
+
+</body></html>

data/lib/tmp/nllfaomxczkbqfj470n6r478vva66thutkj7kymn.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Test HTML File</title>
+
+</head>
+<body>
+
+<p>This is a simple HTML file.</p>
+
+
+
+</body></html>

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: pdf_gem
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Daniel Blasina
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem based on chrome browser
+email:
+- blzk100@gmailcom
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/pdf_gem.rb
+- lib/pdf_gem/railtie.rb
+- lib/pdf_gem/version.rb
+- lib/pdf_generator.js
+- lib/renderer.rb
+- lib/tmp/1zlgz1o22datkhezl9dp5j803ocavkyc6wtpmbiz.html
+- lib/tmp/512m1i0cteoydwdoju0e6qdjbm0qttswr711igtr.html
+- lib/tmp/evziomgjof3tg36lz6t6x429rbni8ipjefmxjilq.html
+- lib/tmp/j56oa22hog5nnt1wwebf1xv5nbieeitn5l1nshws.html
+- lib/tmp/kjn1jl9z22l3kdl1vgjdezivta47rlgos30wxx1q.html
+- lib/tmp/nllfaomxczkbqfj470n6r478vva66thutkj7kymn.html
+homepage: https://github.com/blasko03/pdf_gem
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Gem for creating pdf from html
+test_files: []