pdfkit 0.8.3 → 0.8.4.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bed642993a544476d0b9ed06d2b6dcdb6bcac722eee1c3decbc0a6c0d307668d
-  data.tar.gz: 4ad6010df3d11509774cee9d74477c463258db0e4a845e77243d42ad1d517353
+  metadata.gz: a9763236251a08873c269bb76fa8cbc81e64111a9bd94ea7a167c0e96ad1e0dc
+  data.tar.gz: ab65d5b9648ec671a22191cf7eca7b14d6c4b07917e45adf479046360f7adfd7
 SHA512:
-  metadata.gz: 7dd8eee00c8793c11011056b7cc4f4ae83f487972aabddd3a55f14341d75b2263baf09501202ace3921417d50bc902be616fd75268bc0c395fcab0a071b041c4
-  data.tar.gz: 4b0ecd0f3ca2ba8ad8b5eb7beca56a1c15ba72902664dfe602daeb8e3fb8bf880496e77566d5bfe0d1159b5690599001fd6c4523a95aa2c3b73aa39abbdc9c50
+  metadata.gz: 8ce66b221fce28fb3be395a199fdb4fc3c660a1702302c4b453bc40f39033cadc41fff9ea8a5f0e612f12a1040fbdad31e738823c6d9cf3ea2456a9ebf55b999
+  data.tar.gz: 73827642f8a0d5a87745eb9d853f9a9a9e0d62ea7ab9f31e552be71cba2c4ce7b340da992ab0eabd145a0fbb6395a30d953396fc1bf25f7410db5df9572eb6e1

data/.github/workflows/release-drafter.yml

@@ -0,0 +1,19 @@
+name: Release Drafter
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - master
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      # Drafts your next Release notes as Pull Requests are merged into "master"
+      - uses: release-drafter/release-drafter@v5
+        with:
+          # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
+          # config-name: my-config.yml
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/stale.yml

@@ -0,0 +1,19 @@
+name: Mark stale issues and pull requests
+
+on:
+  schedule:
+  - cron: "0 0 * * *"
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/stale@v1
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        stale-issue-message: 'This issue has been marked as stale and will be automatically closed.'
+        stale-pr-message: 'This pull request has been marked as stale and will be automatically closed.'
+        stale-issue-label: 'no-issue-activity'
+        stale-pr-label: 'no-pr-activity'

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.6.4

data/.travis.yml

@@ -1,16 +1,16 @@
+language: ruby
+
 rvm:
-- 1.9.2
-- 1.9.3
-- 2.0
-- 2.1
+- 2.3
+- 2.4
+- 2.5
+- 2.6
 
 before_install:
   - gem update --system
   - gem update bundler
 
 before_script:
-  - "export DISPLAY=:99.0"
-  - "sh -e /etc/init.d/xvfb start"
   - "sudo apt-get -qq -y install fontconfig libxrender1"
-  - "wget http://download.gna.org/wkhtmltopdf/0.12/0.12.1/wkhtmltox-0.12.1_linux-precise-amd64.deb"
-  - "sudo dpkg -i wkhtmltox-0.12.1_linux-precise-amd64.deb"
+  - "wget https://github.com/wkhtmltopdf/wkhtmltopdf/releases/download/0.12.5/wkhtmltox_0.12.5-1.xenial_amd64.deb"
+  - "sudo apt-get install ./wkhtmltox_0.12.5-1.xenial_amd64.deb"

data/CHANGELOG.md

@@ -1,3 +1,38 @@
+2020-08-16
+=================
+  * Bump to 0.8.4.3.2
+  * Reduce scope of middleware exception handling (#476)
+
+2020-07-05
+=================
+  * Bump to 0.8.4.3.1
+  * Don't override request level Content-Disposition header if it exists (#466)
+  * Update rake (#471)
+  * Add missing require statements for tempfile (#467)
+  * Only grab last line of bundle exec which output (#464)
+  * Return 500 status when an exception is caught in middleware (#469)
+  * Update Travis CI URL for wkhtmltopf (#473)
+  
+2020-04-01
+=================
+  * Bump to 0.8.4.2
+  * Improve path detection feedback (#460)
+  * Fix typos (#444)
+  * Update readme (#439)
+  
+2019-02-22
+=================
+  * Bump to 0.8.4.1
+  * Make PDFkit threadsafe (#377)
+  * Update activesupport (#434)
+
+2019-02-21
+=================
+  * Bump to 0.8.4
+  * Removed support for Ruby < 2.2
+  * Xvfb support (#277)
+  * Remove 'config.protocol' from the README (#389)
+
 2015-08-26
 =================
   * Bump to 0.8.2

data/Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 
 group :test do
-  gem 'activesupport', '~> 3.0'
+  gem 'activesupport', '~> 4.1'
   gem 'simplecov', require: false
 end
 

data/README.md

@@ -14,7 +14,7 @@ gem install pdfkit
 
     <https://github.com/pdfkit/pdfkit/wiki/Installing-WKHTMLTOPDF>
 
-2.  Try using the `wkhtmltopdf-binary` gem (mac + linux i386)
+2.  Try using the `wkhtmltopdf-binary-edge` gem (mac + linux i386)
 ```
 gem install wkhtmltopdf-binary
 ```
@@ -34,7 +34,7 @@ pdf = kit.to_pdf
 file = kit.to_file('/path/to/save/pdf')
 
 # PDFKit.new can optionally accept a URL or a File.
-# Stylesheets can not be added when source is provided as a URL of File.
+# Stylesheets can not be added when source is provided as a URL or File.
 kit = PDFKit.new('http://google.com')
 kit = PDFKit.new(File.new('/path/to/html'))
 
@@ -76,7 +76,6 @@ PDFKit.configure do |config|
   }
   # Use only if your external hostname is unavailable on the server.
   config.root_url = "http://localhost"
-  config.protocol = 'http'
   config.verbose = false
 end
 ```
@@ -117,6 +116,13 @@ config.middleware.use PDFKit::Middleware, {}, :except => [%r[^/prawn], %r[^/secr
 # conditions can be strings (either one or an array)
 config.middleware.use PDFKit::Middleware, {}, :except => ['/secret']
 ```
+**With conditions to force download**
+```ruby
+# force download with attachment disposition
+config.middleware.use PDFKit::Middleware, {}, :disposition => 'attachment'
+# conditions can force a filename
+config.middleware.use PDFKit::Middleware, {}, :disposition => 'attachment; filename=report.pdf'
+```
 **Saving the generated .pdf to disk**
 
 Setting the `PDFKit-save-pdf` header will cause PDFKit to write the generated .pdf to the file indicated by the value of the header.
@@ -126,7 +132,7 @@ For example:
 headers['PDFKit-save-pdf'] = 'path/to/saved.pdf'
 ```
 
-Will cause the .pdf to be saved to `path/to/saved.pdf` in addition to being sent back to the client.  If the path is not writable/non-existant the write will fail silently.  The `PDFKit-save-pdf` header is never sent back to the client.
+Will cause the .pdf to be saved to `path/to/saved.pdf` in addition to being sent back to the client.  If the path is not writable/non-existent the write will fail silently.  The `PDFKit-save-pdf` header is never sent back to the client.
 
 ## Troubleshooting
 
@@ -141,13 +147,13 @@ Will cause the .pdf to be saved to `path/to/saved.pdf` in addition to being sent
    around this issue you may want to run a server with multiple workers
    like Passenger or try to embed your resources within your HTML to
    avoid extra HTTP requests.
-   
+
    Example solution (rails / bundler), add unicorn to the development
    group in your Gemfile `gem 'unicorn'` then run `bundle`. Next, add a
    file `config/unicorn.conf` with
-   
+
         worker_processes 3
-   
+
    Then to run the app `unicorn_rails -c config/unicorn.conf` (from rails_root)
 
 *  **Resources aren't included in the PDF:** Images, CSS, or JavaScript

data/lib/pdfkit/configuration.rb

@@ -1,10 +1,12 @@
 class PDFKit
   class Configuration
-    attr_accessor :meta_tag_prefix, :default_options, :root_url
-    attr_writer :verbose
+    attr_accessor :meta_tag_prefix, :root_url
+    attr_writer :use_xvfb, :verbose
+    attr_reader :default_options
 
     def initialize
       @verbose         = false
+      @use_xvfb        = false
       @meta_tag_prefix = 'pdfkit-'
       @default_options = {
         :disable_smart_shrinking => false,
@@ -23,18 +25,31 @@ class PDFKit
     end
 
     def default_wkhtmltopdf
-      @default_command_path ||= (defined?(Bundler::GemfileError) && File.exists?('Gemfile') ? `bundle exec which wkhtmltopdf` : `which wkhtmltopdf`).chomp
+      return @default_command_path if @default_command_path
+      if defined?(Bundler::GemfileError) && File.exists?('Gemfile')
+        @default_command_path = `bundle exec which wkhtmltopdf`.chomp.lines.last
+      end
+      @default_command_path = `which wkhtmltopdf`.chomp if @default_command_path.nil? || @default_command_path.empty?
+      @default_command_path
     end
 
     def wkhtmltopdf=(path)
       if File.exist?(path)
         @wkhtmltopdf = path
       else
-        warn "No executable found at #{path}. Will fall back to #{default_wkhtmltopdf}" unless File.exist?(path)
+        warn "No executable found at #{path}. Will fall back to #{default_wkhtmltopdf}"
         @wkhtmltopdf = default_wkhtmltopdf
       end
     end
 
+    def executable
+      using_xvfb? ? "xvfb-run #{wkhtmltopdf}" : wkhtmltopdf
+    end
+
+    def using_xvfb?
+      @use_xvfb
+    end
+
     def quiet?
       !@verbose
     end
@@ -42,6 +57,10 @@ class PDFKit
     def verbose?
       @verbose
     end
+
+    def default_options=(options)
+      @default_options.merge!(options)
+    end
   end
 
   class << self
@@ -54,6 +73,7 @@ class PDFKit
   # @example
   #   PDFKit.configure do |config|
   #     config.wkhtmltopdf = '/usr/bin/wkhtmltopdf'
+  #     config.use_xvfb    = true
   #     config.verbose     = true
   #   end
 

data/lib/pdfkit/middleware.rb

@@ -9,40 +9,50 @@ class PDFKit
     end
 
     def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
       @request    = Rack::Request.new(env)
       @render_pdf = false
 
       set_request_to_render_as_pdf(env) if render_as_pdf?
       status, headers, response = @app.call(env)
 
-      if rendering_pdf? && headers['Content-Type'] =~ /text\/html|application\/xhtml\+xml/
-        body = response.respond_to?(:body) ? response.body : response.join
-        body = body.join if body.is_a?(Array)
+      begin
+        if rendering_pdf? && headers['Content-Type'] =~ /text\/html|application\/xhtml\+xml/
+          body = response.respond_to?(:body) ? response.body : response.join
+          body = body.join if body.is_a?(Array)
 
-        root_url = root_url(env)
-        protocol = protocol(env)
-        options = @options.merge(root_url: root_url, protocol: protocol)
+          root_url = root_url(env)
+          protocol = protocol(env)
+          options = @options.merge(root_url: root_url, protocol: protocol)
 
-        if headers['PDFKit-javascript-delay']
-          options.merge!(javascript_delay: headers.delete('PDFKit-javascript-delay').to_i)
-        end
+          if headers['PDFKit-javascript-delay']
+            options.merge!(javascript_delay: headers.delete('PDFKit-javascript-delay').to_i)
+          end
 
-        body = PDFKit.new(body, options).to_pdf
-        response = [body]
+          body = PDFKit.new(body, options).to_pdf
+          response = [body]
 
-        if headers['PDFKit-save-pdf']
-          File.open(headers['PDFKit-save-pdf'], 'wb') { |file| file.write(body) } rescue nil
-          headers.delete('PDFKit-save-pdf')
-        end
+          if headers['PDFKit-save-pdf']
+            File.open(headers['PDFKit-save-pdf'], 'wb') { |file| file.write(body) } rescue nil
+            headers.delete('PDFKit-save-pdf')
+          end
 
-        unless @caching
-          # Do not cache PDFs
-          headers.delete('ETag')
-          headers.delete('Cache-Control')
-        end
+          unless @caching
+            # Do not cache PDFs
+            headers.delete('ETag')
+            headers.delete('Cache-Control')
+          end
 
-        headers['Content-Length'] = (body.respond_to?(:bytesize) ? body.bytesize : body.size).to_s
-        headers['Content-Type']   = 'application/pdf'
+          headers['Content-Length'] = (body.respond_to?(:bytesize) ? body.bytesize : body.size).to_s
+          headers['Content-Type']   = 'application/pdf'
+          headers['Content-Disposition'] ||= @conditions[:disposition] || 'inline'
+        end
+      rescue StandardError => e
+        status = 500
+        response = [e.message]
       end
 
       [status, headers, response]

data/lib/pdfkit/pdfkit.rb

@@ -1,7 +1,10 @@
 require 'shellwords'
+require 'tempfile'
 
 class PDFKit
-  class NoExecutableError < StandardError
+  class Error < StandardError; end
+
+  class NoExecutableError < Error
     def initialize
       msg  = "No wkhtmltopdf executable found at #{PDFKit.configuration.wkhtmltopdf}\n"
       msg << ">> Please install wkhtmltopdf - https://github.com/pdfkit/PDFKit/wiki/Installing-WKHTMLTOPDF"
@@ -9,12 +12,18 @@ class PDFKit
     end
   end
 
-  class ImproperSourceError < StandardError
+  class ImproperSourceError < Error
     def initialize(msg)
       super("Improper Source: #{msg}")
     end
   end
 
+  class ImproperWkhtmltopdfExitStatus < Error
+    def initialize(invoke)
+      super("Command failed (exitstatus=#{$?.exitstatus}): #{invoke}")
+    end
+  end
+
   attr_accessor :source, :stylesheets
   attr_reader :renderer
 
@@ -31,7 +40,7 @@ class PDFKit
     @renderer = WkHTMLtoPDF.new options
     @renderer.normalize_options
 
-    raise NoExecutableError.new unless File.exists?(PDFKit.configuration.wkhtmltopdf)
+    raise NoExecutableError unless File.exists?(PDFKit.configuration.wkhtmltopdf)
   end
 
   def command(path = nil)
@@ -53,7 +62,7 @@ class PDFKit
   end
 
   def executable
-    PDFKit.configuration.wkhtmltopdf
+    PDFKit.configuration.executable
   end
 
   def to_pdf(path=nil)
@@ -70,7 +79,7 @@ class PDFKit
 
     # $? is thread safe per
     # http://stackoverflow.com/questions/2164887/thread-safe-external-process-in-ruby-plus-checking-exitstatus
-    raise "command failed (exitstatus=#{$?.exitstatus}): #{invoke}" if empty_result?(path, result) or !successful?($?)
+    raise ImproperWkhtmltopdfExitStatus, invoke if empty_result?(path, result) || !successful?($?)
     return result
   end
 
@@ -83,7 +92,7 @@ class PDFKit
 
   def find_options_in_meta(content)
     # Read file if content is a File
-    content = content.read if content.is_a?(File)
+    content = content.read if content.is_a?(File) || content.is_a?(Tempfile)
 
     found = {}
     content.scan(/<meta [^>]*>/) do |meta|
@@ -116,7 +125,7 @@ class PDFKit
   end
 
   def append_stylesheets
-    raise ImproperSourceError.new('Stylesheets may only be added to an HTML source') if stylesheets.any? && !@source.html?
+    raise ImproperSourceError, 'Stylesheets may only be added to an HTML source' if stylesheets.any? && !@source.html?
 
     stylesheets.each do |stylesheet|
       if @source.to_s.match(/<\/head>/)

data/lib/pdfkit/source.rb

@@ -1,3 +1,4 @@
+require 'tempfile'
 require 'uri'
 
 class PDFKit
@@ -13,7 +14,7 @@ class PDFKit
     end
 
     def file?
-      @is_file ||= @source.kind_of?(File)
+      @is_file ||= @source.kind_of?(File) || @source.kind_of?(Tempfile)
     end
 
     def html?

data/lib/pdfkit/version.rb

@@ -1,3 +1,3 @@
 class PDFKit
-  VERSION = "0.8.3"
+  VERSION = '0.8.4.3.2'
 end

data/pdfkit.gemspec

@@ -13,8 +13,6 @@ Gem::Specification.new do |s|
   s.description = "Uses wkhtmltopdf to create PDFs using HTML"
   s.license     = "MIT"
 
-  s.rubyforge_project = "pdfkit"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -23,11 +21,10 @@ Gem::Specification.new do |s|
   s.requirements << "wkhtmltopdf"
 
   # Development Dependencies
-  s.add_development_dependency(%q<activesupport>, [">= 3.0.8"])
+  s.add_development_dependency(%q<activesupport>, [">= 4.1.11"])
   s.add_development_dependency(%q<mocha>, [">= 0.9.10"])
   s.add_development_dependency(%q<rack-test>, [">= 0.5.6"])
-  s.add_development_dependency(%q<i18n>, ["~>0.6.11"]) # Ruby 1.9.2 compatibility
-  s.add_development_dependency(%q<rake>, ["~>0.9.2"])
+  s.add_development_dependency(%q<rake>, ["~>12.3.3"])
   s.add_development_dependency(%q<rdoc>, ["~> 4.0.1"])
   s.add_development_dependency(%q<rspec>, ["~> 3.0"])
 end

data/spec/configuration_spec.rb

@@ -3,12 +3,71 @@ require 'spec_helper'
 describe PDFKit::Configuration do
   subject { PDFKit::Configuration.new }
   describe "#wkhtmltopdf" do
+    context "when explicitly configured" do
+      it "uses configured value and don't detect" do
+        expect(subject).not_to receive(:default_wkhtmltopdf)
+        subject.wkhtmltopdf = "./Gemfile" # Need a file which exists
+        expect(subject.wkhtmltopdf).to eq("./Gemfile")
+      end
+
+      it "falls back to detected binary if configured path doesn't exists" do
+        expect(subject).to receive(:default_wkhtmltopdf).twice.and_return("/bin/fallback")
+        expect(subject).to receive(:warn).with(/No executable found/)
+        subject.wkhtmltopdf = "./missing-file" # Need a file which doesn't exist
+        expect(subject.wkhtmltopdf).to eq("/bin/fallback")
+      end
+    end
+
     context "when not explicitly configured" do
-      it "detects the existance of bundler" do
-        # Test assumes bundler is installed in your test environment
-        expect(subject).to receive(:`).with('bundle exec which wkhtmltopdf').and_return('c:\windows\path.exe')
-        subject.wkhtmltopdf
+      context "when running inside bundler" do
+        # Simulate the presence of bundler even if it's not here
+        before { stub_const("Bundler::GemfileError", Class) }
+
+        it "detects the existance of bundler" do
+          expect(subject).to receive(:`).with('bundle exec which wkhtmltopdf').and_return("c:\\windows\\path.exe\n")
+          expect(subject.wkhtmltopdf).to eq('c:\windows\path.exe')
+        end
+
+        it "falls back if bundler path fails" do
+          # This happens when there is a wrong (buggy) version of bundler for example
+          expect(subject).to receive(:`).with('bundle exec which wkhtmltopdf').and_return("")
+          expect(subject).to receive(:`).with('which wkhtmltopdf').and_return("c:\\windows\\path.exe\n")
+          expect(subject.wkhtmltopdf).to eq('c:\windows\path.exe')
+        end
+
+        it "returns last line of 'bundle exec which' output" do
+          # Happens when the user does not have a HOME directory on their system and runs bundler < 2
+          expect(subject).to receive(:`).with('bundle exec which wkhtmltopdf').and_return(<<~EOT
+            `/home/myuser` is not a directory.
+            Bundler will use `/tmp/bundler/home/myuser' as your home directory temporarily.
+            /usr/bin/wkhtmltopdf
+          EOT
+          )
+          expect(subject.wkhtmltopdf).to eq('/usr/bin/wkhtmltopdf')
+        end
       end
+
+      context "when running without bundler" do
+        # Simulate the absence of bundler even if it's there
+        before { hide_const("Bundler::GemfileError") }
+
+        it "detects the existance of bundler" do
+          expect(subject).not_to receive(:`).with('bundle exec which wkhtmltopdf')
+          expect(subject).to receive(:`).with('which wkhtmltopdf').and_return('c:\windows\path.exe')
+          expect(subject.wkhtmltopdf).to eq('c:\windows\path.exe')
+        end
+      end
+    end
+  end
+
+  describe "#executable" do
+    it "returns wkhtmltopdf by default" do
+      expect(subject.executable).to eql subject.wkhtmltopdf
+    end
+
+    it "uses xvfb-run wrapper when option of using xvfb is configured" do
+      expect(subject).to receive(:using_xvfb?).and_return(true)
+      expect(subject.executable).to include 'xvfb-run'
     end
   end
 
@@ -29,6 +88,13 @@ describe PDFKit::Configuration do
       expect(subject.default_options[:quiet]).to eql false
       expect(subject.default_options[:is_awesome]).to eql true
     end
+
+    it "merges additional options with existing defaults" do
+      subject.default_options = { quiet: false, is_awesome: true }
+      expect(subject.default_options[:quiet]).to eql false
+      expect(subject.default_options[:is_awesome]).to eql true
+      expect(subject.default_options[:disable_smart_shrinking]).to eql false
+    end
   end
 
   describe "#root_url" do
@@ -53,6 +119,22 @@ describe PDFKit::Configuration do
     end
   end
 
+  describe "#using_xvfb?" do
+    it "can be configured to true" do
+      subject.use_xvfb = true
+      expect(subject.using_xvfb?).to eql true
+    end
+
+    it "defaults to false" do
+      expect(subject.using_xvfb?).to eql false
+    end
+
+    it "can be configured to false" do
+      subject.use_xvfb = false
+      expect(subject.using_xvfb?).to eql false
+    end
+  end
+
   describe "#verbose?" do
     it "can be configured to true" do
       subject.verbose = true

data/spec/middleware_spec.rb

@@ -21,6 +21,35 @@ describe PDFKit::Middleware do
   end
 
   describe "#call" do
+
+    describe 'threadsafety' do
+      before { mock_app }
+      it 'is threadsafe' do
+        n = 30
+        extensions = Array.new(n) { rand > 0.5 ? 'html' : 'pdf' }
+        actual_content_types = Hash.new
+
+        threads = (0...n).map { |i|
+          Thread.new do
+            resp = get("http://www.example.org/public/test.#{extensions[i]}")
+            actual_content_types[i] = resp.content_type
+          end
+        }
+
+        threads.each(&:join)
+
+        extensions.each_with_index do |extension, index|
+          result = actual_content_types[index]
+          case extension
+          when 'html', 'txt', 'csv'
+            expect(result).to eq("text/#{extension}")
+          when 'pdf'
+            expect(result).to eq('application/pdf')
+          end
+        end
+      end
+    end
+
     describe "caching" do
       let(:headers) do
         {
@@ -312,6 +341,83 @@ describe PDFKit::Middleware do
           end
         end
       end
+
+      describe ":disposition" do
+        describe "doesn't overwrite existing value" do
+          let(:headers) do
+            super().merge({
+              'Content-Disposition' => 'attachment; filename=report-20200101.pdf'
+            })
+          end
+
+          specify do
+            mock_app({}, { :disposition => 'inline' })
+            get 'http://www.example.org/public/test.pdf'
+            expect(last_response.headers["Content-Disposition"]).to eq('attachment; filename=report-20200101.pdf')
+          end
+        end
+
+        describe "inline or blank" do
+          context "default" do
+            specify do
+              mock_app
+              get 'http://www.example.org/public/test.pdf'
+              expect(last_response.headers["Content-Disposition"]).to eq("inline")
+            end
+          end
+
+          context "inline" do
+            specify do
+              mock_app({}, { :disposition => 'inline'  })
+              get 'http://www.example.org/public/test.pdf'
+              expect(last_response.headers["Content-Disposition"]).to eq("inline")
+            end
+          end
+        end
+
+        describe "attachment" do
+          context "attachment" do
+            specify do
+              mock_app({}, { :disposition => 'attachment'  })
+              get 'http://www.example.org/public/test.pdf'
+              expect(last_response.headers["Content-Disposition"]).to eq("attachment")
+            end
+          end
+
+          context "attachment with filename" do
+            specify do
+              mock_app({}, { :disposition => 'attachment; filename=report.pdf'  })
+              get 'http://www.example.org/public/test.pdf'
+              expect(last_response.headers["Content-Disposition"]).to eq("attachment; filename=report.pdf")
+            end
+          end
+        end
+      end
+
+      describe "error handling" do
+        let(:error) { StandardError.new("Something went wrong") }
+
+        context "errors raised by PDF generation" do
+          specify do
+            mock_app
+            allow(PDFKit).to receive(:new).and_raise(error)
+            get 'http://www.example.org/public/test.pdf'
+            expect(last_response.status).to eq(500)
+            expect(last_response.body).to eq(error.message)
+          end
+        end
+
+        context "errors raised upstream" do
+          specify do
+            mock_app
+            allow(@app).to receive(:call).and_raise(error)
+
+            expect {
+              get 'http://www.example.org/public/test.pdf'
+            }.to raise_error(error)
+          end
+        end
+      end
     end
 
     describe "remove .pdf from PATH_INFO and REQUEST_URI" do
@@ -397,22 +503,4 @@ describe PDFKit::Middleware do
       end
     end
   end
-
-  it "does not get stuck rendering each request as pdf" do
-    mock_app
-    # false by default. No requests.
-    expect(@app.send(:rendering_pdf?)).to eq(false)
-
-    # Remain false on a normal request
-    get 'http://www.example.org/public/file'
-    expect(@app.send(:rendering_pdf?)).to eq(false)
-
-    # Return true on a pdf request.
-    get 'http://www.example.org/public/file.pdf'
-    expect(@app.send(:rendering_pdf?)).to eq(true)
-
-    # Restore to false on any non-pdf request.
-    get 'http://www.example.org/public/file'
-    expect(@app.send(:rendering_pdf?)).to eq(false)
-  end
 end

data/spec/pdfkit_spec.rb

@@ -23,6 +23,13 @@ describe PDFKit do
       expect(pdfkit.source.to_s).to eq(file_path)
     end
 
+    it "accepts a Tempfile as the source" do
+      file_path = File.join(SPEC_ROOT,'fixtures','example.html')
+      pdfkit = PDFKit.new(Tempfile.new(file_path))
+      expect(pdfkit.source).to be_file
+      expect(pdfkit.source.to_s).to match /^#{Dir.tmpdir}/
+    end
+
     # Options
     ## options keys
     it "drops options without values" do
@@ -252,6 +259,12 @@ describe PDFKit do
       expect(pdfkit.command).to match /#{file_path} -$/
     end
 
+    it "specifies the path to the source if it is a tempfile" do
+      file_path = File.join(SPEC_ROOT,'fixtures','example.html')
+      pdfkit = PDFKit.new(Tempfile.new(file_path))
+      expect(pdfkit.command).to match /#{Dir.tmpdir}\S+ -$/
+    end
+
     it "specifies the path for the ouput if a path is given" do
       file_path = "/path/to/output.pdf"
       pdfkit = PDFKit.new("html")
@@ -384,6 +397,24 @@ describe PDFKit do
       end
     end
 
+    it "does not use xvfb-run wrapper by default" do
+      pdfkit = PDFKit.new('html')
+      expect(pdfkit.command).not_to include 'xvfb-run'
+    end
+
+    it "uses xvfb-run wrapper when option of using xvfb is configured" do
+      PDFKit.configure do |config|
+        config.use_xvfb = true
+      end
+
+      pdfkit = PDFKit.new('html')
+      expect(pdfkit.command).to include 'xvfb-run'
+
+      PDFKit.configure do |config|
+        config.use_xvfb = false
+      end
+    end
+
     context "on windows" do
       before do
         allow(PDFKit::OS).to receive(:host_is_windows?).and_return(true)
@@ -481,7 +512,7 @@ describe PDFKit do
     #NOTICE: This test is failed if use wkhtmltopdf-binary (0.9.9.1)
     it "throws an error if it is unable to connect" do
       pdfkit = PDFKit.new("http://google.com/this-should-not-be-found/404.html")
-      expect { pdfkit.to_pdf }.to raise_error /exitstatus=1/
+      expect { pdfkit.to_pdf }.to raise_error PDFKit::ImproperWkhtmltopdfExitStatus, /exitstatus=1/
     end
 
     it "does not throw an error if it is unable to connect", pending: 'this test works for wkhtmltopdf-binary (0.9.9.1)' do

data/spec/source_spec.rb

@@ -12,6 +12,11 @@ describe PDFKit::Source do
       expect(source).not_to be_url
     end
 
+    it "returns false if passed a tempfile" do
+      source = PDFKit::Source.new(::Tempfile.new(__FILE__))
+      expect(source).not_to be_url
+    end
+
     it "returns false if passed HTML" do
       source = PDFKit::Source.new('<blink>Oh Hai!</blink>')
       expect(source).not_to be_url
@@ -29,6 +34,11 @@ describe PDFKit::Source do
       expect(source).to be_file
     end
 
+    it "returns true if passed a tempfile" do
+      source = PDFKit::Source.new(::Tempfile.new(__FILE__))
+      expect(source).to be_file
+    end
+
     it "returns false if passed a url like string" do
       source = PDFKit::Source.new('http://google.com')
       expect(source).not_to be_file
@@ -51,6 +61,11 @@ describe PDFKit::Source do
       expect(source).not_to be_html
     end
 
+    it "returns false if passed a tempfile" do
+      source = PDFKit::Source.new(::Tempfile.new(__FILE__))
+      expect(source).not_to be_html
+    end
+
     it "returns false if passed a url like string" do
       source = PDFKit::Source.new('http://google.com')
       expect(source).not_to be_html
@@ -77,6 +92,11 @@ describe PDFKit::Source do
       source = PDFKit::Source.new(::File.new(__FILE__))
       expect(source.to_input_for_command).to match 'spec/source_spec.rb'
     end
+
+    it "returns the file path for tempfile sources" do
+      source = PDFKit::Source.new(file = ::Tempfile.new(__FILE__))
+      expect(source.to_input_for_command).to match file.path
+    end
   end
 
   describe "#to_s" do
@@ -90,6 +110,11 @@ describe PDFKit::Source do
       expect(source.to_s).to eq(__FILE__)
     end
 
+    it "returns a path if passed a tempfile" do
+      source = PDFKit::Source.new(file = ::Tempfile.new(__FILE__))
+      expect(source.to_s).to eq(file.path)
+    end
+
     it "returns the url if passed a url like string" do
       source = PDFKit::Source.new('http://google.com')
       expect(source.to_s).to eq('http://google.com')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pdfkit
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4.3.2
 platform: ruby
 authors:
 - Jared Pace
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-14 00:00:00.000000000 Z
+date: 2020-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.8
+        version: 4.1.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.8
+        version: 4.1.11
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -53,34 +53,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.6
-- !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.11
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.11
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +103,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".document"
+- ".github/workflows/release-drafter.yml"
+- ".github/workflows/stale.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-gemset"
@@ -168,8 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - wkhtmltopdf
-rubyforge_project: pdfkit
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: HTML+CSS -> PDF