pdfgen 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a73f59d301df367f103e141312e3a32b05f62b0
-  data.tar.gz: 80fc53102a85db8f1faeaed2767096abe6d3a858
+  metadata.gz: 45448b8e51eeefad7bc03b038ee898858bac2ac1
+  data.tar.gz: ca91ce8dc5d9935e9826be88d07e606110cce11d
 SHA512:
-  metadata.gz: eb03e8ffc7351e7297ccbd13d80b5589694534cbc568e8b1df3d925472030daf9bd8cf1366f8fa3794e8116efbb8c36173390ed581af78aad6381b3fbc19b2b8
-  data.tar.gz: b2da59c15ea2dbb0450557f152839f4ee12eb3e3732949e2bf742add35e33b02c2e91e447a9d328f274c1be8ef7931c59267c0144fdf46f74b93910d653219b4
+  metadata.gz: cce5490b833405690e1ee9f306d54cba65d36b634e262b8a234150d305212b284a745a38537ee337d649295573df3c64fff00fd19ea3ee9b1d2027a4254e400b
+  data.tar.gz: '009f9f2a12c02ae43de9fb28743baf42b7ad653c23c6a0434a9c371d9d0452758434ea9fa5f87c66c38ce937f1057d86f13726dbd9ee90302102f3e62009c0bd'

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+## Pdfgen 0.4.0 (May 12, 2018)
+
+* Can now provide a URL to the initializer.
+
+  Providing a URL to the initializer will now nagivate to the URL and then render the
+  page to a PDF.
+
+* Adds a debug mode.
+
+  Calling debug_mode and passing in a time in milliseconds to wait with the browser
+  not headless. This may change to be forever in the future but that would cause weird
+  issues since the Ruby code expects the Javascript to return the PDF on stdout and
+  there isn't yet a good way to indicate that you are done debugging and the rendering
+  can continue.
+
+## Pdfgen 0.3.1 (April 23, 2018)
+
+* Fixes bug by passing the wait_for_timeout to the Javascript script.
+
+## Pdfgen 0.3.0 (April 23, 2018)
+
+* Allows optional period in milliseconds to wait for the page to finish rendering.
+
+  A new optional wait timeout that will occur after the content has been set,
+  the media emulation set, and the viewport has been set to allow for javascript
+  and rendering to run before printing to a pdf

data/README.md

@@ -24,15 +24,120 @@ 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 
+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' })
-``` 
+```
+
+# Reference
+
+All methods other than `to_pdf` are chainable. This allows for setting multiple configuration options before rendering the PDF.
+It also does not matter the order that they are called in except that `to_pdf` must be last since it returns the PDF.
+
+Example:
+```ruby
+Pdfgen.new(html).set_viewport(width: 1024, height: 768).wait_for_timeout(1000).emulate_media('screen').to_pdf(format: 'Letter')
+```
+
+## Initialize
+
+### new(html_or_url)
+
+Takes a string of HTML to put into the page or a URL to nagivate to. If it is a URL, extra options for the navigation can be
+provided with [`url_options`](#url_optionsurl_options). If a string of HTML, the assets must be inlined to work. See [Limitations](#limitations)
+
+## Chainable configuration methods
+
+### debug_mode(debug_time)
+
+Sets a couple of options so the browser window used to print the PDF can be seen and inspected. *debug_time* is
+the amount of time in milliseconds to leave the browser window open before the PDF will be printed and the browser
+closed. It also disables headless mode.
+
+Example: Turns on debug mode and waits for 5 minutes.
+```ruby
+Pdfgen.new(html).debug_mode(300_000).to_pdf
+```
+
+### emulate_media(media_type)
+
+Configure the media type for the browser used to render the PDF. Media type can be `'screen'`, `'print'`, or `null`.
+See [emulateMedia](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pageemulatemediamediatype) for more info.
+
+Example: Set the media emulation type to print.
+```ruby
+Pdfgen.new(html).emulate_media('print').to_pdf
+```
+
+### launch_options(launch_options)
+
+Configure the options used to launch the browser. Can be used to set extra args for the browser such as `--no-sandbox` or to
+disable headless mode. *launch_options* is a hash that is passed directly to the [launch](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions)
+Puppeteer method and as such takes the same arguments.
+
+Example: Adds '--no-sandbox' flag and turns off headless mode.
+```ruby
+Pdfgen.new(html).launch_options(args: ['--no-sandbox'], headless: false).to_pdf
+```
+
+### set_viewport(viewport_options)
+
+Configure the viewport. *viewport_options* is a hash that is passed directly to the
+[setViewport](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagesetviewportviewport)
+Puppeteer method and as such takes the same arguments.
+
+Example: Sets the viewport width and height to 1024x768.
+```ruby
+Pdfgen.new(html).set_viewport(width: 1024, height: 768).to_pdf
+```
+
+### url_options(url_options)
+
+When using a URL, this configures the navigation options. It is mainly used to configure what to wait for. *url_options* is
+a hash that is passed directly as the second argument to [goto](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagegotourl-options)
+Puppeteer method and as such takes the same arguments. Defaults to `waitUntil: 'networkidle0'` which will wait until there are
+0 active network connections in the past 500 milliseconds.
+
+Example:
+```ruby
+Pdfgen.new('https://www.google.com').url_options(waitUntil: 'networkidle0').to_pdf
+```
+
+### wait_for_timeout(wait_for_timeout)
+
+Configure an optional timeout to wait for with the browser loaded before the PDF will be saved specified in
+milliseconds. Used to allow the page to finish rendering if the default prints the PDF to fast.
+
+Example: Sets the wait timeout to 1.5 seconds.
+```ruby
+Pdfgen.new(html).wait_for_timeout(1500).to_pdf
+```
+
+## PDF rendering methods
+
+### to_pdf(opts)
+
+Configure the options for making the PDF. It allows for setting margins, a scale, specific page ranges, configuring
+the paper type, and more. *opts* is a hash that is passed directly to the [pdf](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagepdfoptions)
+Puppeteer method and as such takes the same arguments.
+
+Example: Configures the margins to be 1 inch all around.
+```ruby
+Pdfgen.new(html).to_pdf(margin: {top: '1in', right: '1in', bottom: '1in', left: '1in'})
+```
+
+# Limitations
+
+#### It only works with inline Javascript, CSS, and images.
+
+  Currently, there is a limitation that requires inline assets. This is because the setContent method in Puppeteer does not load links to
+  assets. There is a workaround possible since Puppeteer allows adding script tags and style tags and those methods do take URLs but Pdfgen
+  does not yet support them.
 
 # Future Development
-In the future, allowing use of more features of Puppeteer is desired. These include taking a URL and 
+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.
+the setting of cookies will require calling more functions than are currently being called.

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/lib/javascript_bin/make_pdf.js

@@ -19,18 +19,28 @@ stdin.on('end', function () {
     var media_type = options['emulate_media'];
     var launch_options = options['launch_options'];
     var wait_for_timeout = options['wait_for_timeout'];
+    var url = options['url'];
+    var url_options = options['url_options'];
+    var debug_mode = options['debug_mode'];
 
     module.paths.push(current_path + '/node_modules');
 
     const puppeteer = require('puppeteer');
     const fs = require('fs');
-    var html = fs.readFileSync(process.argv[2], 'utf8');
+
+    if (typeof url === 'undefined') {
+        var html = fs.readFileSync(process.argv[2], 'utf8');
+    }
 
     (async() => {
         const browser = await puppeteer.launch(launch_options);
         const page = await browser.newPage();
 
-        await page.setContent(html);
+        if (typeof url !== 'undefined' && url) {
+            await page.goto(url, url_options);
+        } else {
+            await page.setContent(html);
+        }
 
         if (typeof media_type !== 'undefined' && media_type) {
             await page.emulateMedia(media_type);
@@ -44,8 +54,11 @@ stdin.on('end', function () {
             await page.waitFor(wait_for_timeout);
         }
 
-        const pdf_output = await page.pdf(pdf_options);
-        stdout.write(pdf_output);
+        if (typeof debug_mode === 'undefined') {
+            const pdf_output = await page.pdf(pdf_options);
+            stdout.write(pdf_output);
+        }
+        
         await browser.close();
     })();
 });

data/lib/pdfgen.rb

@@ -9,12 +9,20 @@ raise 'This gem requires node be installed and available on the PATH' unless sta
 MAKE_PDF_COMMAND = File.expand_path('../javascript_bin/make_pdf.js', __FILE__)
 
 class Pdfgen
-  def initialize(html)
-    @html = html
+  def initialize(html_or_url)
+    if html_or_url =~ /^http/
+      @url = html_or_url
+      @html = nil
+    else
+      @url = nil
+      @html = html_or_url
+    end
     @viewport_options = nil
     @emulate_media = nil
     @launch_options = Hash.new
     @wait_for_timeout = nil
+    @debug_time = nil
+    @url_options = { waitUntil: 'networkidle0' }
   end
 
   def set_viewport(viewport_options)
@@ -38,16 +46,42 @@ class Pdfgen
     self
   end
 
+  def debug_mode(debug_time)
+    raise TypeError.new("Timeout must be an integer or respond to #to_i") unless debug_time.kind_of?(Integer) || (debug_time.respond_to?(:to_i) && debug_time.to_i)
+    @debug_time = debug_time
+    self
+  end
+
+  def url_options(url_options)
+    @url_options = @url_options.merge(url_options)
+    self
+  end
+
   def to_pdf(opts = {})
-    stdin_options = { pdf_options: opts, current_path: Dir.pwd, launch_options: @launch_options }
+    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
     stdin_options = stdin_options.merge(wait_for_timeout: @wait_for_timeout) if @wait_for_timeout
-    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
+    if @debug_time
+      stdin_options = stdin_options.merge(wait_for_timeout: @debug_time)
+      stdin_options = stdin_options.merge(launch_options: @launch_options.merge(headless: false))
+      stdin_options = stdin_options.merge(debug_mode: true)
+    end
+
+    pdf_output = nil
+    status = nil
+    if @html
+      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
+    else
+      stdin_options = stdin_options.merge(url: @url)
+      stdin_options = stdin_options.merge(url_options: @url_options)
+      pdf_output, status = Open3.capture2(MAKE_PDF_COMMAND, stdin_data: stdin_options.to_json)
+    end
+
     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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfgen
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Daniel Fox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-23 00:00:00.000000000 Z
+date: 2018-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -31,6 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - Rakefile