breezy_pdf 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b91b8eac90c1bf86deddc2e966c2d50606fcc4fd
-  data.tar.gz: 29095dcc755d6233c8a78cd06339e4364485f289
+  metadata.gz: bab096cd639ab31ef3b100733473563c2f2d5892
+  data.tar.gz: e8fc7df02cc0f40311a136eca9416ba5d48076e0
 SHA512:
-  metadata.gz: 032c38d3690ecce7ced0de58cbf51c16c7c9c28e083e627ea3edd7dd466e9d7f1546b710cfb8c33c24363409c85506f22214b4dba8f55f483fb88cf7427287c7
-  data.tar.gz: d960c94bb564f598bb8b3e5712d527f18cd5d402b308262177e2d3d945dd2a4d66fafbdb2ccc651da0053083c37fb9507bb0db25d7d9b1e117222df86d7bbbe4
+  metadata.gz: cacf0a2a24d3fad7bc333da4088304a865f8d5cdd45ee3ed51ad6025526cfd44de02e319ececd51cc4370a71f859c8986699e038604efe97298b9d0c97c65c15
+  data.tar.gz: 1ca284b117fbb9a91ad8802bbbd34aa646f79105e1ede4eb5aec7cf2a1afd9542ceb83ec7294ec2af868bad363e4b174f8126e6bcf01caf883a1c4f0b5dd7dcd

data/README.md

@@ -237,6 +237,27 @@ Here is a contrived example:
 </script>
 ```
 
+## Pragmatic access
+
+You may want to render a PDF out of the HTTP request cycle like in a background job or mailer. BreezyPDF supports rendering HTML as a PDF pragmatically. BreezyPDF::HTML2PDF expects two arguments, the `asset_host` for assets, and the html fragment. The `asset_host` should be the locally accessible host where external assets (js, css) can be downloaded from. In development, this may be `http://localhost:3000`, while in production it may be your configured `Rails.application.config.action_controller.asset_host`. If `BreezyPDF.upload_assets == false`, then this value has no impact.
+
+Here is an example of how you might do that:
+
+```
+def invoice_mailer(user, invoice)
+  asset_host = Rails.env.production? ? Rails.application.config.action_controller.asset_host : "http://localhost:3000"
+
+  html = ActionController::Renderer.render(template "invoices/show", assigns: { invoice: invoice }, locals: { current_user: user })
+  pdf = BreezyPDF::HTML2PDF.new(, html)
+
+  attachments["invoice-#{invoice.id}.pdf"] = pdf.to_file
+  @pdf_url = pdf.to_url
+end
+```
+
+This example uses [ActionController::Renderer](http://api.rubyonrails.org/classes/ActionController/Renderer.html) to render a controller template's html.
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/breezy_pdf/html_2_pdf.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module BreezyPDF
+  # Transform an HTML slug to a PDF
+  # Access it's URL or download it locally and access it as a Tempfile
+  class HTML2PDF
+    def initialize(asset_host, html_string)
+      @asset_host  = asset_host
+      @html_string = html_string
+    end
+
+    def to_url
+      url
+    end
+
+    def to_file
+      file
+    end
+
+    private
+
+    def file
+      @file ||= if io_object.is_a?(StringIO)
+                  Tempfile.new.tap do |f|
+                    f.write io_object.to_s
+                  end
+                else
+                  io_object
+                end
+    end
+
+    def url
+      @url ||= BreezyPDF::RenderRequest.new(public_url, html_private_asset.metadata).submit.download_url
+    end
+
+    def io_object
+      @io_object ||= open(url)
+    end
+
+    def html_private_asset
+      @html_private_asset ||= BreezyPDF::PrivateAssets::HTML.new(@asset_host, @html_string)
+    end
+
+    def public_url
+      @public_url ||= BreezyPDF::Uploads::Base.new(
+        html_private_asset.filename, html_private_asset.content_type, html_private_asset.file_path
+      ).public_url
+    end
+  end
+end

data/lib/breezy_pdf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BreezyPDF
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/lib/breezy_pdf.rb

@@ -29,6 +29,7 @@ module BreezyPDF
   autoload :Intercept,     "breezy_pdf/intercept"
   autoload :PrivateAssets, "breezy_pdf/private_assets"
   autoload :HTML,          "breezy_pdf/html"
+  autoload :HTML2PDF,      "breezy_pdf/html_2_pdf"
 
   BreezyPDFError = Class.new(StandardError)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: breezy_pdf
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Daniel Westendorf
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-27 00:00:00.000000000 Z
+date: 2018-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -147,6 +147,7 @@ files:
 - lib/breezy_pdf/html.rb
 - lib/breezy_pdf/html/publicize.rb
 - lib/breezy_pdf/html/strip.rb
+- lib/breezy_pdf/html_2_pdf.rb
 - lib/breezy_pdf/intercept.rb
 - lib/breezy_pdf/intercept/base.rb
 - lib/breezy_pdf/intercept/private_url.rb