breezy_pdf 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22152e31ae48f2787e5860af3c1fbd2f27b1108b
-  data.tar.gz: 461a8f053a29e9a761f4ca645f1545a120a28ae7
+  metadata.gz: f96e0707087a6ec855ab37b985ee3ff85462cd0f
+  data.tar.gz: a194a4f380f659fa12f695ccd83047649a858d17
 SHA512:
-  metadata.gz: dde4a034799d9408d8b7a6206b30532a834cdd35b45f7acdbe2dfc09e9a5f0bf8602157d41b6f6f2c6a773b1049a54ff3bd21fc36b959cecc86c15e4ba1ac054
-  data.tar.gz: cb25cf71e8379d207c5f7811541d47708e12fec3e5f6df173dae8692042d1decf4d7ab3f04a68ec5f153e4b65ed32a1ac63d93e980614bc08c52c20efcf05088
+  metadata.gz: 880c5ba65853fb17df0f3be7893b7e75a2b3542d4b2874fa2df27bd8b61020d1976aeee5469f2b5c6aefac1ce78a9a26a6a2c6a8c19dd545ed65b3d553cc1354
+  data.tar.gz: b747791a6b0c9418e91b027b2244235b86be9337022e279a674cd33fbfbdd6b1d792d3886076c3abfecbd7d136bc99d8904310b9e122d1feab6f27f1816ff06c

data/README.md

@@ -140,7 +140,7 @@ BreezyPDF.setup do |config|
   #
   # Cache asset URL's to prevent re-uploading of assets. Assets are cached based on asset_path,
   # so fingerprinting or digests are recommended before turning on. The default cache store is
-  # a null store, which won't actuall store anything. An in-memory store is also provided, but
+  # a null store, which won't actually store anything. An in-memory store is also provided, but
   # this store won't share values across threads. Alternatively, use an external store which
   # implements a `fetch(key, opts={}, &blk) API, such as the Rails.cache.
   #
@@ -161,7 +161,7 @@ BreezyPDF.setup do |config|
   # Extract Metadata
   #
   # BreezyPDF supports specifying how a page should be rendered through meta tags within
-  # the HTML to be rendered. Contact support@breezypdf.com for more details. Default is
+  # the HTML to be rendered. Visit https://docs.breezypdf.com for metadata information. Default is
   # true.
   #
   # Only applicable when `treat_urls_as_private == true`
@@ -207,6 +207,16 @@ BreezyPDF.setup do |config|
   # Configure the logger, if you're into that sort of thing.
   #
   # config.logger = Logger.new(STDOUT).tap { |logger| logger.level = Logger::FATAL }
+
+  # Default Meta Data
+  #
+  # Define default meta data which will be included with every render. Extracted metadata
+  # will override these values. Visit https://docs.breezypdf.com for metadata information.
+  #
+  # config.default_metadata = {
+  #   width:  23.4,
+  #   height: 33.1
+  # }
 end
 ```
 
@@ -219,48 +229,28 @@ If you want to show a loading animation on the current page, you can simply load
 Here is a contrived example:
 
 ```html
-<a href="/this/path.pdf" class="breezy-pdf-download">Download as PDF</a>
+<a href="/this/path.pdf" class="pdf-link">Download as PDF</a>
 
 <script type="text/javascript">
-  var downloadLinkEls = document.querySelectorAll('.breezy-pdf-download');
-  var loadingEl = document.createElement('div');
-  loadingEl.innerHTML = "<h1>Loading!</h1><p>Loading icon here, maybe?</p><p id='breezy-progress'></p>";
-  loadingEl.style = "position: absolute; width: 100%; height: 100%; text-align: center; background: #fff; top: 0; left: 0; z-index: 10000; display: none;"
-
-  document.body.appendChild(loadingEl);
-  var progressEl = document.getElementById('breezy-progress');
-
-  for (var i = downloadLinkEls.length - 1; i >= 0; i--) {
-    var linkEl = downloadLinkEls[i];
-    var pdfUrl = linkEl.getAttribute('href');
-
-    // Listen for a click on the link, then start handling the change of state
-    linkEl.addEventListener('click', function(ev) {
-      loadingEl.style.display = "block"; // Display ad-hoc loading element
-      ev.preventDefault();
-
-      var i = 1;
-      var interval = setInterval(function() {
-        progressEl.innerText = i / 10.0 + ' waiting seconds so far...';
-        i++;
-      }, 100);
-
-      var ajaxRequest = new XMLHttpRequest();
-
-      ajaxRequest.addEventListener('load', function(ev) {
-        clearInterval(interval);
-        console.log("Done waiting. We'd close modals or remove loading animations here before setting the location.")
-        loadingEl.style.display = "none";
-
-        // Redirect the eventual URL of the PDF
-        // If the browser downloads the file, the current page's HTML will still be shown
-        window.location = ev.currentTarget.responseURL;
-      })
-
-      ajaxRequest.open('GET', pdfUrl);
-      ajaxRequest.send();
+  $('.pdf-link').on('click', function(clickEv) {
+    var startTime     = new Date();
+    var targetEl      = $(clickEv.target);
+    var modalEl       = $('#pdf-loading'); // An existing bootstrap modal in this example
+    var ajaxRequest   = new XMLHttpRequest();
+
+    clickEv.preventDefault();
+
+    ajaxRequest.addEventListener('load', function(ev) {
+      modalEl.modal('hide');
+
+      window.location = ev.currentTarget.responseURL;
     })
-  }
+
+    modalEl.modal('show');
+
+    ajaxRequest.open('GET', targetEl.attr('href'));
+    ajaxRequest.send();
+  })
 </script>
 ```
 
@@ -274,8 +264,10 @@ 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"
 
+  metadata = { width: 8.5, width: 11 }
+
   html = ActionController::Renderer.render(template "invoices/show", assigns: { invoice: invoice }, locals: { current_user: user })
-  pdf = BreezyPDF::HTML2PDF.new(, html)
+  pdf = BreezyPDF::HTML2PDF.new(asset_host, html, metadata)
 
   attachments["invoice-#{invoice.id}.pdf"] = pdf.to_file.read
   @pdf_url = pdf.to_url

data/lib/breezy_pdf.rb

@@ -75,6 +75,22 @@ module BreezyPDF
   mattr_accessor :filter_elements_selectors
   @@filtered_element_selectors = %w[.breezy-pdf-remove]
 
+  mattr_writer :default_metadata
+  @@default_metadata = {
+    width:             8.5,
+    height:            11,
+    cssPageSize:       false,
+    marginTop:         0.04,
+    marginRight:       0.04,
+    marginBottom:      0.04,
+    marginLeft:        0.04,
+    landscape:         false,
+    scale:             1,
+    displayBackground: false,
+    headerTemplate:    "",
+    footerTemplate:    ""
+  }
+
   mattr_accessor :logger
   @@logger = Logger.new(STDOUT)
   @@logger.level = Logger::FATAL
@@ -82,4 +98,9 @@ module BreezyPDF
   def self.setup
     yield self
   end
+
+  # Support proper merging of hash rocket and symbol keys
+  def self.default_metadata
+    @@jsonified_metadata ||= JSON.parse(@@default_metadata.to_json)
+  end
 end

data/lib/breezy_pdf/html/publicize.rb

@@ -14,7 +14,7 @@ module BreezyPDF::HTML
     def public_fragment
       @public_fragment ||= parsed_document.tap do
         publicize!
-        BreezyPDF.logger.info("[BreezyPDF] Replaced assets in `#{timing} seconds`")
+        BreezyPDF.logger.info("[BreezyPDF] Replaced assets in #{timing} seconds")
       end.to_html
     end
 

data/lib/breezy_pdf/html_2_pdf.rb

@@ -4,9 +4,10 @@ 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)
+    def initialize(asset_host, html_string, metadata = {})
       @asset_host  = asset_host
       @html_string = html_string
+      @metadata    = metadata
     end
 
     def to_url
@@ -30,7 +31,11 @@ module BreezyPDF
     end
 
     def url
-      @url ||= BreezyPDF::RenderRequest.new(public_url, html_private_asset.metadata).submit.download_url
+      @url ||= BreezyPDF::RenderRequest.new(public_url, combined_metadata).submit.download_url
+    end
+
+    def combined_metadata
+      @combined_metadata ||= BreezyPDF.default_metadata.merge(@metadata).merge(html_private_asset.metadata)
     end
 
     def io_object

data/lib/breezy_pdf/intercept/base.rb

@@ -18,9 +18,9 @@ module BreezyPDF::Intercept
     end
 
     def metadata
-      {
+      BreezyPDF.default_metadata.merge(
         "requested_url" => requested_url, "rendered_url" => rendered_url
-      }
+      )
     end
 
     def rendered_url

data/lib/breezy_pdf/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: breezy_pdf
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - Daniel Westendorf
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-02 00:00:00.000000000 Z
+date: 2018-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby