breezy_pdf 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c79358f8f51d3ebf15997ad7c33afb65208ba61
-  data.tar.gz: 885a161d944e8660535adef975eb8b2443d60d01
+  metadata.gz: 57bddc027c8cdfec7911f2cc59222a96c6122f87
+  data.tar.gz: 98ab1ae786bfa5b1a9f402ff07d2d3bea9268a8d
 SHA512:
-  metadata.gz: 61d82471163ed28064662b8f453c365d8ac7f36e0e536db7eb418e741b12268a327482a94f6027f03def5cf18ca80c4d85dfe4e6104da67b7e7592c1eff2caa3
-  data.tar.gz: db0752316cabec4f9b04d7ccd82f142bd5ac500bb15616641a977b942f9b2de7fdf9666d6276c2ee07d2ba8d069ae2fee0a02b0cb8b381932289891bf1bcccb9
+  metadata.gz: 4ac74f57b8b524fa6b2c30c940eef02a791a98602739b82133ab71bff13d3e9999743ad5f48c958b44f6d631e81028197944dec6827ecf03d136ba0df36cbc24
+  data.tar.gz: 1b2a275727eeac5f202907d89689053762d1e97eea896cad4710ce782770ff291b0ba32c221c9c8123571dd8302339acb5cb51e19b977d7426dd4e3ae0a3d24d

data/README.md

@@ -8,6 +8,8 @@ No binaries to install. No reinventing the wheel to match HTML layouts. Just sim
 
 [Sign Up](https://BreezyPDF.com/) for an account to get started.
 
+[View the Demo](https://ruby.demo.breezypdf.com) and the [Demo's Source Code](https://github.com/danielwestendorf/breezy_pdf-ruby-demo)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -134,6 +136,27 @@ BreezyPDF.setup do |config|
   #   src:  %r{^\/\w+}
   # }
 
+  # Asset Cache
+  #
+  # 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
+  # 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.
+  #
+  # Only applicable when `config.treat_urls_as_private == true`
+  # Only applicable when `config.upload_assets == true`
+  #
+  # config.asset_cache = BreezyPDF::Cache::Null.new
+  #
+  # or
+  #
+  # config.asset_cache = BreezyPDF::Cache::InMemory.new
+  #
+  # or
+  #
+  # config.asset_cache = Rails.cache
+
 
   # Extract Metadata
   #
@@ -154,6 +177,10 @@ BreezyPDF.setup do |config|
   # Only applicable when `config.upload_assets == true`
   #
   # config.threads = 1
+  #
+  # or
+  #
+  # config.theads = Concurrent.processor_count
 
 
   # Filter Elements

data/lib/breezy_pdf.rb

@@ -8,6 +8,7 @@ require "securerandom"
 require "zlib"
 require "stringio"
 require "open-uri"
+require "monitor"
 
 require "nokogiri"
 require "concurrent"
@@ -23,6 +24,7 @@ module BreezyPDF
   autoload :Intercept,     "breezy_pdf/_intercept"
   autoload :Resources,     "breezy_pdf/_resources"
   autoload :HTML,          "breezy_pdf/_html"
+  autoload :Cache,         "breezy_pdf/_cache"
 
   autoload :VERSION,       "breezy_pdf/version"
   autoload :RenderRequest, "breezy_pdf/render_request"
@@ -58,6 +60,9 @@ module BreezyPDF
     src:  %r{^\/\w+}
   }
 
+  mattr_accessor :asset_cache
+  @@asset_cache = Cache::Null.new
+
   mattr_accessor :extract_metadata
   @@extract_metadata = true
 

data/lib/breezy_pdf/_cache.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module BreezyPDF
+  # :nodoc
+  module Cache
+    autoload :InMemory, "breezy_pdf/cache/in_memory"
+    autoload :Null,     "breezy_pdf/cache/null"
+  end
+end

data/lib/breezy_pdf/cache/in_memory.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module BreezyPDF::Cache
+  # In Memory cache store for assets
+  class InMemory
+    def initialize
+      @map = {}
+      @monitor = Monitor.new
+    end
+
+    def write(key, value, opts = {})
+      synchronize do
+        write_value(key, value, opts)
+      end
+    end
+
+    def read(key)
+      synchronize do
+        get_value(key)
+      end
+    end
+
+    def fetch(key, opts = {}, &blk)
+      synchronize do
+        fetch_value(key, opts, blk)
+      end
+    end
+
+    private
+
+    def synchronize(&block) # :nodoc:
+      @monitor.synchronize(&block)
+    end
+
+    def write_value(key, value, opts)
+      hash = { value: value, last_accessed: Time.now }
+      hash[:expires_at] = (Time.now + opts[:expires_in].to_f) if opts[:expires_in]
+
+      @map[key] = hash
+      remove_last_accessed!
+
+      true
+    end
+
+    def get_value(key)
+      key_value = read_key(key)
+
+      if key_value && key_value[:expires_at]
+        if key_value[:expires_at] <= Time.now
+          @map.delete(key) # The key has expired
+          BreezyPDF.logger.info("[BreezyPDF] Cache miss for #{key}")
+          nil
+        else
+          BreezyPDF.logger.info("[BreezyPDF] Cache hit for #{key}")
+          key_value[:value]
+        end
+      elsif key_value
+        BreezyPDF.logger.info("[BreezyPDF] Cache hit for #{key}")
+        key_value[:value]
+      else
+        BreezyPDF.logger.info("[BreezyPDF] Cache miss for #{key}")
+        nil
+      end
+    end
+
+    def read_key(key)
+      return unless @map[key]
+
+      @map[key][:last_accessed] = Time.now
+      @map[key]
+    end
+
+    def fetch_value(key, opts, blk)
+      stored_value = read(key)
+      return stored_value if stored_value
+
+      value = blk.call if blk
+      write(key, value, opts)
+
+      value
+    end
+
+    def remove_last_accessed!
+      return if @map.size <= 1000
+
+      sorted_map = @map.sort_by { |_k, v| v[:last_accessed] }
+      @map.delete(sorted_map.first.first)
+    end
+  end
+end

data/lib/breezy_pdf/cache/null.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module BreezyPDF::Cache
+  # Null cache store for assets. Doesn't actually store anything.
+  class Null
+    def write(_key, _value, _opts = {})
+      true
+    end
+
+    def read(key); end
+
+    def fetch(_key, _opts = {})
+      yield if block_given?
+    end
+  end
+end

data/lib/breezy_pdf/html/publicize.rb

@@ -47,11 +47,13 @@ module BreezyPDF::HTML
 
     def replace_asset_element_attr(asset_element, attr)
       thread_pool.post do
-        asset = BreezyPDF::Resources::Asset.new(@base_url, asset_element[attr])
+        asset_element[attr] = BreezyPDF.asset_cache.fetch(asset_element[attr], expires_in: 601_200) do
+          asset = BreezyPDF::Resources::Asset.new(@base_url, asset_element[attr])
 
-        asset_element[attr] = BreezyPDF::Uploads::Base.new(
-          asset.filename, asset.content_type, asset.file_path
-        ).public_url
+          BreezyPDF::Uploads::Base.new(
+            asset.filename, asset.content_type, asset.file_path
+          ).public_url
+        end
       end
     end
 

data/lib/breezy_pdf/uploads/base.rb

@@ -49,13 +49,18 @@ module BreezyPDF::Uploads
     end
 
     def resource
-      BreezyPDF.logger.info(%([BreezyPDF] Initiating presign of private asset upload #{@filename}))
-      @resource ||= client.post("/uploads", filename: @filename, size: file.size, content_type: @content_type)
+      @resource ||= client.post("/uploads", resource_options).tap do
+        BreezyPDF.logger.info(%([BreezyPDF] Initiating presign of private asset upload #{@filename}))
+      end
     rescue Net::HTTP => error
       BreezyPDF.logger.fatal(%([BreezyPDF] Unable to presign private asset upload for #{@filename}))
       raise PresignError, error.message
     end
 
+    def resource_options
+      @resource_options ||= { filename: @filename, size: file.size, content_type: @content_type }
+    end
+
     def upload_uri
       @upload_uri ||= URI.parse(resource.presigned_upload_url)
     end

data/lib/breezy_pdf/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: breezy_pdf
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Daniel Westendorf
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-29 00:00:00.000000000 Z
+date: 2018-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -142,10 +142,13 @@ files:
 - bin/setup
 - breezy_pdf.gemspec
 - lib/breezy_pdf.rb
+- lib/breezy_pdf/_cache.rb
 - lib/breezy_pdf/_html.rb
 - lib/breezy_pdf/_intercept.rb
 - lib/breezy_pdf/_resources.rb
 - lib/breezy_pdf/_uploads.rb
+- lib/breezy_pdf/cache/in_memory.rb
+- lib/breezy_pdf/cache/null.rb
 - lib/breezy_pdf/client.rb
 - lib/breezy_pdf/gzip.rb
 - lib/breezy_pdf/html/publicize.rb