breezy_pdf_lite 0.0.3 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ae2792c57054cfa446d22768ad68811dece14a76f1039d591bf7639fd839b26
-  data.tar.gz: 17c7077620ab69408359978aa4ce0dcd95a4e889bd5adcdac3bb449781fbeed6
+  metadata.gz: 8fbaacf2d5f7019593c6e8bc787f9b4b86e00094c8488a530043404ec10879e3
+  data.tar.gz: 9d3705028fb7094808165c1019413eea73cc82b091515a8868e7fb0962e87290
 SHA512:
-  metadata.gz: 2c4d30a30a18af0ae9ad1dedc45d00fd1eaedd186133811f486ce0d03a47c4f98c8ca39366c401998cdfa5b9210edf96898ad118bfdc8d9682676be81a55e182
-  data.tar.gz: 377735a9dfe4755bf5957059426ff3dd8c20be2c130a13cad85d57d2ecd6bf47a154b8159d6876882b96018f44591d508d532e448aa0233a14f75f3960cbb9bd
+  metadata.gz: 83b673d531dfe0c3f610a64917f6f9ac4ca78e0566b24e89d02a59106ce06722b641ebf6f3c483e4455d8d35a31772ac3cbb8ef6b64559504833b49c5d77762a
+  data.tar.gz: 27afdc98b8847fcee7b880ce81494507da83e7c43eebe4d950a6925f44c57ed7cdb43eedb0917025d14c3bdda10c0c950480b65999f2959c72c14fd31f1b5078

data/.github/workflows/ruby.yml

@@ -0,0 +1,44 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake
+  
+  lint:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Rubocop checks
+      uses: gimenete/rubocop-action@1.0
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+

data/.travis.yml

@@ -1,5 +1,9 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.2
+  - 2.7
+  - 2.6
+  - 2.5
+  - jruby
 before_install: gem install bundler
+install: bundle install --jobs=3 --retry=3

data/Gemfile.lock

@@ -1,29 +1,35 @@
 PATH
   remote: .
   specs:
-    breezy_pdf_lite (0.0.2)
+    breezy_pdf_lite (0.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    jaro_winkler (1.5.4)
-    minitest (5.14.0)
-    minitest-stub-const (0.6)
-    parallel (1.19.1)
-    parser (2.7.0.2)
-      ast (~> 2.4.0)
+    ast (2.4.1)
+    minitest (5.14.1)
+    mocha (1.11.2)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.1)
-    rubocop (0.79.0)
-      jaro_winkler (~> 1.5.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rubocop (0.89.1)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
     ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -32,9 +38,10 @@ DEPENDENCIES
   breezy_pdf_lite!
   bundler (~> 2.0)
   minitest (~> 5.0)
-  minitest-stub-const (~> 0.6)
+  mocha (= 1.11.2)
+  rack (~> 2.0)
   rake (~> 13.0)
-  rubocop (= 0.79.0)
+  rubocop (= 0.89.1)
 
 BUNDLED WITH
    2.1.2

data/breezy_pdf_lite.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["daniel@prowestech.com"]
 
   spec.summary       = "Ruby/rack middleware for BreezyPDF Lite. HTML to PDF."
-  spec.license       = "GPLv3"
+  spec.license       = "GPL-3.0"
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -20,9 +20,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency "rack", "~> 2.0"
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "minitest-stub-const", "~> 0.6"
+  spec.add_development_dependency "mocha", "1.11.2"
   spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rubocop", "0.79.0"
+  spec.add_development_dependency "rubocop", "0.89.1"
 end

data/lib/breezy_pdf_lite.rb

@@ -17,7 +17,8 @@ module BreezyPDFLite
   autoload :Middleware,    "breezy_pdf_lite/middleware"
   autoload :RenderRequest, "breezy_pdf_lite/render_request"
 
-  BreezyPDFLiteError = Class.new(StandardError)
+  Error = Class.new(StandardError)
+  RenderError = Class.new(Error)
 
   mattr_accessor :secret_api_key
   @@secret_api_key = nil
@@ -28,6 +29,12 @@ module BreezyPDFLite
   mattr_accessor :middleware_path_matchers
   @@middleware_path_matchers = [/\.pdf/]
 
+  mattr_accessor :open_timeout
+  @@open_timeout = 30
+
+  mattr_accessor :read_timeout
+  @@read_timeout = 30
+
   def self.setup
     yield self
   end

data/lib/breezy_pdf_lite/client.rb

@@ -5,7 +5,12 @@ module BreezyPDFLite
   class Client
     def post(path, body)
       uri = URI.parse(BreezyPDFLite.base_url + path)
-      http = Net::HTTP.new(uri.host, uri.port).tap { |h| h.use_ssl = uri.scheme == "https" }
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.open_timeout = BreezyPDFLite.open_timeout
+      http.read_timeout = BreezyPDFLite.read_timeout
+
       request = Net::HTTP::Post.new(uri.request_uri, headers)
 
       request.body = body

data/lib/breezy_pdf_lite/intercept.rb

@@ -3,7 +3,7 @@
 module BreezyPDFLite
   # :nodoc
   module Intercept
-    UnRenderable = Class.new(BreezyPDFLiteError)
+    UnRenderable = Class.new(BreezyPDFLite::Error)
     autoload :Base, "breezy_pdf_lite/intercept/base"
     autoload :HTML, "breezy_pdf_lite/intercept/html"
   end

data/lib/breezy_pdf_lite/intercept/base.rb

@@ -3,42 +3,10 @@
 module BreezyPDFLite::Intercept
   # :nodoc
   class Base
-    attr_reader :app, :env
+    attr_reader :body
 
-    def initialize(app, env)
-      @app = app
-      @env = env
-    end
-
-    private
-
-    def rendered_url
-      "#{base_url}#{path}#{query_string}"
-    end
-
-    def requested_url
-      "#{env['rack.url_scheme']}://#{env['SERVER_NAME']}#{port}" \
-      "#{env['PATH_INFO']}#{query_string}"
-    end
-
-    def base_url
-      "#{env['rack.url_scheme']}://#{env['SERVER_NAME']}#{port}"
-    end
-
-    def port
-      ":#{env['SERVER_PORT']}" unless [80, 443].include?(env["SERVER_PORT"].to_i)
-    end
-
-    def path
-      BreezyPDFLite.middleware_path_matchers.reduce(env["PATH_INFO"]) do |path, matcher|
-        path.gsub(matcher, "")
-      end
-    end
-
-    def query_string
-      return "" if env["QUERY_STRING"].nil?
-
-      env["QUERY_STRING"] == "" ? "" : "?#{env['QUERY_STRING']}"
+    def initialize(body)
+      @body = body
     end
   end
 end

data/lib/breezy_pdf_lite/intercept/html.rb

@@ -1,49 +1,34 @@
 # frozen_string_literal: true
 
+require "rack/request"
+require "rack/file"
+
 module BreezyPDFLite::Intercept
-  # :nodoc
+  # Takes the App's response body, and submits it to the breezypdf lite endpoint
+  # resulting in a file. File is then served with Rack::File
   class HTML < Base
     def call
-      raise BreezyPDFLite::Intercept::UnRenderable unless (200..299).cover?(status)
-
-      render_request = BreezyPDFLite::RenderRequest.new(body).submit
+      request = Rack::Request.new({})
+      path = render_request_file.path
 
-      [
-        201,
-        {
-          "Content-Type" => "application/pdf",
-          "Content-Length" => render_request.header["Content-Length"],
-          "Content-Disposition" => render_request.header["Content-Disposition"]
-        },
-        [render_request.body]
-      ]
-    rescue BreezyPDFLite::Intercept::UnRenderable
-      response
+      Rack::File.new(path, response_headers).serving(request, path)
     end
 
     private
 
-    def status
-      @status ||= response[0].to_i
-    end
-
-    def headers
-      @headers ||= response[1]
-    end
-
-    def body
-      @body ||= response[2].respond_to?(:body) ? response[2].body : response[2].join
+    def render_request
+      @render_request ||= BreezyPDFLite::RenderRequest.new(body)
     end
 
-    def response
-      @response ||= app.call(doctored_env)
+    def render_request_file
+      @render_request_file ||= render_request.to_file
     end
 
-    def doctored_env
-      env.dup.tap do |hash|
-        hash["HTTP_ACCEPT"] = "text/html"
-        hash["PATH_INFO"]   = path
-      end
+    def response_headers
+      @response_headers ||= {
+        "Content-Type" => "application/pdf",
+        "Content-Disposition" => render_request.response.header["Content-Disposition"]
+      }
     end
   end
 end

data/lib/breezy_pdf_lite/interceptor.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 module BreezyPDFLite
-  # Intercept a Rack request
+  # Intercept a Rack request, determining if the app's response should
+  # be intercepted or simply returned
   class Interceptor
     attr_reader :app, :env
 
@@ -10,34 +11,50 @@ module BreezyPDFLite
       @env = env
     end
 
-    def intercept!
-      if intercept?
-        intercept.new(@app, @env).call
+    def call
+      if (200..299).cover?(app_response_status) # Did the app respond well?
+        Intercept::HTML.new(app_response_body).call # Try to return a PDF
       else
-        app.call(env)
+        app_response # Bad app response, just send respond with that
       end
     end
 
     private
 
-    def intercept?
-      get? && matching_uri?
+    def app_response
+      @app_response ||= app.call(doctored_env)
     end
 
-    def matching_uri?
-      matchers.any? { |regex| env["REQUEST_URI"].match?(regex) }
+    def app_response_status
+      @app_response_status ||= app_response[0].to_i
     end
 
-    def get?
-      env["REQUEST_METHOD"].match?(/get/i)
+    def app_response_headers
+      @app_response_headers ||= app_response[1]
     end
 
-    def matchers
-      @matchers ||= BreezyPDFLite.middleware_path_matchers
+    def app_response_body
+      if app_response[2].respond_to?(:join)
+        app_response[2].join
+      elsif app_response[2].respond_to?(:each)
+        content = []
+        app_response[2].each { |part| content << part }
+
+        content.join
+      else
+        app_response[2]
+      end
+    end
+
+    def doctored_env
+      env.dup.tap do |hash|
+        hash["HTTP_ACCEPT"] = "text/html"
+        hash["PATH_INFO"]   = path
+      end
     end
 
-    def intercept
-      BreezyPDFLite::Intercept::HTML
+    def path
+      env["PATH_INFO"].gsub(/\.pdf/, "")
     end
   end
 end

data/lib/breezy_pdf_lite/middleware.rb

@@ -2,13 +2,31 @@
 
 module BreezyPDFLite
   # Rack Middleware for BreezyPDFLite
+  # Determines if the request should be intercepted or not
   class Middleware
     def initialize(app, _options = {})
       @app = app
     end
 
     def call(env)
-      Interceptor.new(@app, env).intercept!
+      if intercept?(env)
+        Interceptor.new(@app, env).call
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+
+    # Is this request applicable?
+    def intercept?(env)
+      env["REQUEST_METHOD"].match?(/get/i) && matching_uri?(env)
+    end
+
+    def matching_uri?(env)
+      BreezyPDFLite.middleware_path_matchers.any? do |regex|
+        env["REQUEST_URI"].match?(regex)
+      end
     end
   end
 end

data/lib/breezy_pdf_lite/render_request.rb

@@ -2,18 +2,19 @@
 
 module BreezyPDFLite
   # Request conversion of a HTML string to PDF
+  # If the response isn't a 201, raise an error
   class RenderRequest
     def initialize(body)
       @body = body
     end
 
-    def submit
-      client.post("/render/html", @body)
+    def response
+      @response ||= submit.tap do |resp|
+        raise RenderError, "#{resp.code}: #{resp.body}" if resp.code != "201"
+      end
     end
 
     def to_file
-      raise BreezyPDFLiteError, "#{response.code}: #{response.body}" if response.code != "201"
-
       @to_file ||= Tempfile.new(%w[response .pdf]).tap do |file|
         file.binmode
         file.write response.body
@@ -24,8 +25,8 @@ module BreezyPDFLite
 
     private
 
-    def response
-      @response ||= submit
+    def submit
+      client.post("/render/html", @body)
     end
 
     def client

data/lib/breezy_pdf_lite/response.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module BreezyPDFLite
+  # RenderRequest -> Net::HTTPResponse wrapper that is streaming compatable
+  class Response
+    def initialize(response)
+      @response = response
+    end
+
+    def status
+      @status ||= @response.code.to_i
+    end
+
+    def headers
+      {
+        "Content-Type" => "application/pdf",
+        "Content-Length" => @response.header["Content-Length"],
+        "Content-Disposition" => @response.header["Content-Disposition"]
+      }
+    end
+
+    def each(&blk)
+      @response.read_body(&blk)
+    end
+
+    def body
+      io = StringIO.new
+      io.binmode
+
+      each do |chunk|
+        io.write chunk
+      end
+
+      io.flush
+      io.rewind
+
+      io
+    end
+  end
+end

data/lib/breezy_pdf_lite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BreezyPDFLite
-  VERSION = "0.0.3"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: breezy_pdf_lite
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.1
 platform: ruby
 authors:
 - Daniel Westendorf
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-13 00:00:00.000000000 Z
+date: 2020-08-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest-stub-const
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 1.11.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 1.11.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +86,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: 0.89.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: 0.89.1
 description: 
 email:
 - daniel@prowestech.com
@@ -88,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitattributes"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".hound.yml"
 - ".rubocop.yml"
@@ -111,11 +126,12 @@ files:
 - lib/breezy_pdf_lite/interceptor.rb
 - lib/breezy_pdf_lite/middleware.rb
 - lib/breezy_pdf_lite/render_request.rb
+- lib/breezy_pdf_lite/response.rb
 - lib/breezy_pdf_lite/util.rb
 - lib/breezy_pdf_lite/version.rb
 homepage: 
 licenses:
-- GPLv3
+- GPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []