pdfkit 0.8.0 → 0.8.7.1

data/spec/middleware_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 def app; Rack::Lint.new(@app); end
@@ -17,43 +19,72 @@ end
 
 describe PDFKit::Middleware do
   let(:headers) do
-    {'Content-Type' => "text/html"}
+    {'content-type' => "text/html"}
   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
         {
-          'Content-Type' => "text/html",
-          'ETag' => 'foo',
-          'Cache-Control' => 'max-age=2592000, public'
+          'content-type' => "text/html",
+          'etag' => 'foo',
+          'cache-control' => 'max-age=2592000, public'
         }
       end
 
       context "by default" do
         before { mock_app }
 
-        it "deletes ETag" do
+        it "deletes etag" do
           get 'http://www.example.org/public/test.pdf'
-          expect(last_response.headers["ETag"]).to be_nil
+          expect(last_response.headers["etag"]).to be_nil
         end
-        it "deletes Cache-Control" do
+        it "deletes cache-control" do
           get 'http://www.example.org/public/test.pdf'
-          expect(last_response.headers["Cache-Control"]).to be_nil
+          expect(last_response.headers["cache-control"]).to be_nil
         end
       end
 
       context "when on" do
         before { mock_app({}, :caching => true) }
 
-        it "preserves ETag" do
+        it "preserves etag" do
           get 'http://www.example.org/public/test.pdf'
-          expect(last_response.headers["ETag"]).not_to be_nil
+          expect(last_response.headers["etag"]).not_to be_nil
         end
 
-        it "preserves Cache-Control" do
+        it "preserves cache-control" do
           get 'http://www.example.org/public/test.pdf'
-          expect(last_response.headers["Cache-Control"]).not_to be_nil
+          expect(last_response.headers["cache-control"]).not_to be_nil
         end
       end
     end
@@ -68,7 +99,7 @@ describe PDFKit::Middleware do
             context "matching" do
               specify do
                 get 'http://www.example.org/public/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("application/pdf")
+                expect(last_response.headers["content-type"]).to eq("application/pdf")
                 expect(last_response.body.bytesize).to eq(PDFKit.new("Hello world!").to_pdf.bytesize)
               end
             end
@@ -76,7 +107,7 @@ describe PDFKit::Middleware do
             context "not matching" do
               specify do
                 get 'http://www.example.org/secret/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("text/html")
+                expect(last_response.headers["content-type"]).to eq("text/html")
                 expect(last_response.body).to eq("Hello world!")
               end
             end
@@ -88,7 +119,7 @@ describe PDFKit::Middleware do
             context "matching" do
               specify do
                 get 'http://www.example.org/public/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("application/pdf")
+                expect(last_response.headers["content-type"]).to eq("application/pdf")
                 expect(last_response.body.bytesize).to eq(PDFKit.new("Hello world!").to_pdf.bytesize)
               end
             end
@@ -96,7 +127,7 @@ describe PDFKit::Middleware do
             context "not matching" do
               specify do
                 get 'http://www.example.org/secret/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("text/html")
+                expect(last_response.headers["content-type"]).to eq("text/html")
                 expect(last_response.body).to eq("Hello world!")
               end
             end
@@ -110,7 +141,7 @@ describe PDFKit::Middleware do
             context "matching" do
               specify do
                 get 'http://www.example.org/public/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("application/pdf")
+                expect(last_response.headers["content-type"]).to eq("application/pdf")
                 expect(last_response.body.bytesize).to eq(PDFKit.new("Hello world!").to_pdf.bytesize)
               end
             end
@@ -118,7 +149,7 @@ describe PDFKit::Middleware do
             context "not matching" do
               specify do
                 get 'http://www.example.org/secret/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("text/html")
+                expect(last_response.headers["content-type"]).to eq("text/html")
                 expect(last_response.body).to eq("Hello world!")
               end
             end
@@ -130,7 +161,7 @@ describe PDFKit::Middleware do
             context "matching" do
               specify do
                 get 'http://www.example.org/public/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("application/pdf")
+                expect(last_response.headers["content-type"]).to eq("application/pdf")
                 expect(last_response.body.bytesize).to eq(PDFKit.new("Hello world!").to_pdf.bytesize)
               end
             end
@@ -138,7 +169,7 @@ describe PDFKit::Middleware do
             context "not matching" do
               specify do
                 get 'http://www.example.org/secret/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("text/html")
+                expect(last_response.headers["content-type"]).to eq("text/html")
                 expect(last_response.body).to eq("Hello world!")
               end
             end
@@ -156,7 +187,7 @@ describe PDFKit::Middleware do
             context "matching" do
               specify do
                 get 'http://www.example.org/public/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("application/pdf")
+                expect(last_response.headers["content-type"]).to eq("application/pdf")
                 expect(last_response.body.bytesize).to eq(PDFKit.new("Hello world!").to_pdf.bytesize)
               end
             end
@@ -164,7 +195,7 @@ describe PDFKit::Middleware do
             context "not matching" do
               specify do
                 get 'http://www.example.org/secret/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("text/html")
+                expect(last_response.headers["content-type"]).to eq("text/html")
                 expect(last_response.body).to eq("Hello world!")
               end
             end
@@ -176,7 +207,7 @@ describe PDFKit::Middleware do
             context "matching" do
               specify do
                 get 'http://www.example.org/public/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("application/pdf")
+                expect(last_response.headers["content-type"]).to eq("application/pdf")
                 expect(last_response.body.bytesize).to eq(PDFKit.new("Hello world!").to_pdf.bytesize)
               end
             end
@@ -184,7 +215,7 @@ describe PDFKit::Middleware do
             context "not matching" do
               specify do
                 get 'http://www.example.org/secret/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("text/html")
+                expect(last_response.headers["content-type"]).to eq("text/html")
                 expect(last_response.body).to eq("Hello world!")
               end
             end
@@ -198,7 +229,7 @@ describe PDFKit::Middleware do
             context "matching" do
               specify do
                 get 'http://www.example.org/public/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("application/pdf")
+                expect(last_response.headers["content-type"]).to eq("application/pdf")
                 expect(last_response.body.bytesize).to eq(PDFKit.new("Hello world!").to_pdf.bytesize)
               end
             end
@@ -206,7 +237,7 @@ describe PDFKit::Middleware do
             context "not matching" do
               specify do
                 get 'http://www.example.org/secret/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("text/html")
+                expect(last_response.headers["content-type"]).to eq("text/html")
                 expect(last_response.body).to eq("Hello world!")
               end
             end
@@ -218,7 +249,7 @@ describe PDFKit::Middleware do
             context "matching" do
               specify do
                 get 'http://www.example.org/public/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("application/pdf")
+                expect(last_response.headers["content-type"]).to eq("application/pdf")
                 expect(last_response.body.bytesize).to eq(PDFKit.new("Hello world!").to_pdf.bytesize)
               end
             end
@@ -226,7 +257,7 @@ describe PDFKit::Middleware do
             context "not matching" do
               specify do
                 get 'http://www.example.org/secret/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("text/html")
+                expect(last_response.headers["content-type"]).to eq("text/html")
                 expect(last_response.body).to eq("Hello world!")
               end
             end
@@ -236,22 +267,22 @@ describe PDFKit::Middleware do
       end
 
       describe "saving generated pdf to disk" do
-	before do
+        before do
           #make sure tests don't find an old test_save.pdf
-          File.delete('spec/test_save.pdf') if File.exists?('spec/test_save.pdf')
-          expect(File.exists?('spec/test_save.pdf')).to eq(false)
-	end
+          File.delete('spec/test_save.pdf') if File.exist?('spec/test_save.pdf')
+          expect(File.exist?('spec/test_save.pdf')).to eq(false)
+        end
 
         context "when header PDFKit-save-pdf is present" do
-          it "should saved the .pdf to disk" do
-	    headers = { 'PDFKit-save-pdf' => 'spec/test_save.pdf' }
+          it "saves the .pdf to disk" do
+            headers = { 'PDFKit-save-pdf' => 'spec/test_save.pdf' }
             mock_app({}, {only: '/public'}, headers)
-	    get 'http://www.example.org/public/test_save.pdf'
-            expect(File.exists?('spec/test_save.pdf')).to eq(true)
-	  end
+            get 'http://www.example.org/public/test_save.pdf'
+            expect(File.exist?('spec/test_save.pdf')).to eq(true)
+          end
 
-          it "should not raise when target directory does not exist" do
-	    headers = { 'PDFKit-save-pdf' => '/this/dir/does/not/exist/spec/test_save.pdf' }
+          it "does not raise when target directory does not exist" do
+            headers = { 'PDFKit-save-pdf' => '/this/dir/does/not/exist/spec/test_save.pdf' }
             mock_app({}, {only: '/public'}, headers)
             expect {
               get 'http://www.example.com/public/test_save.pdf'
@@ -260,17 +291,162 @@ describe PDFKit::Middleware do
         end
 
         context "when header PDFKit-save-pdf is not present" do
-          it "should not saved the .pdf to disk" do
+          it "does not saved the .pdf to disk" do
             mock_app({}, {only: '/public'}, {} )
-	    get 'http://www.example.org/public/test_save.pdf'
-            expect(File.exists?('spec/test_save.pdf')).to eq(false)
+            get 'http://www.example.org/public/test_save.pdf'
+            expect(File.exist?('spec/test_save.pdf')).to eq(false)
+          end
+        end
+      end
+
+      describe 'javascript delay' do
+        context 'when header PDFKit-javascript-delay is present' do
+          it 'passes header value through to PDFKit initialiser' do
+            expect(PDFKit).to receive(:new).with('Hello world!', {
+              root_url: 'http://www.example.com/', protocol: 'http', javascript_delay: 4321
+            }).and_call_original
+
+            headers = { 'PDFKit-javascript-delay' => '4321' }
+            mock_app({}, { only: '/public' }, headers)
+            get 'http://www.example.com/public/test_save.pdf'
+          end
+
+          it 'handles invalid content in header' do
+            expect(PDFKit).to receive(:new).with('Hello world!', {
+              root_url: 'http://www.example.com/', protocol: 'http', javascript_delay: 0
+            }).and_call_original
+
+            headers = { 'PDFKit-javascript-delay' => 'invalid' }
+            mock_app({}, { only: '/public' }, headers)
+            get 'http://www.example.com/public/test_save.pdf'
+          end
+
+          it 'overrides default option' do
+            expect(PDFKit).to receive(:new).with('Hello world!', {
+              root_url: 'http://www.example.com/', protocol: 'http', javascript_delay: 4321
+            }).and_call_original
+
+            headers = { 'PDFKit-javascript-delay' => '4321' }
+            mock_app({ javascript_delay: 1234 }, { only: '/public' }, headers)
+            get 'http://www.example.com/public/test_save.pdf'
+          end
+        end
+
+        context 'when header PDFKit-javascript-delay is not present' do
+          it 'passes through default option' do
+            expect(PDFKit).to receive(:new).with('Hello world!', {
+              root_url: 'http://www.example.com/', protocol: 'http', javascript_delay: 1234
+            }).and_call_original
+
+            mock_app({ javascript_delay: 1234 }, { only: '/public' }, { })
+            get 'http://www.example.com/public/test_save.pdf'
+          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
-    before { mock_app }
+    describe "content type header" do
+      before { mock_app }
+
+      context "lower case" do
+        specify "header gets correctly updated" do
+          get 'http://www.example.org/public/test.pdf'
+          expect(last_response.headers["content-type"]).to eq("application/pdf")
+        end
+      end
+
+      context "mixed case" do
+        let(:headers) do
+          {'Content-Type' => "text/html"}
+        end
+
+        specify "header gets correctly updated" do
+          pending("this test only applies to rack 2.x and is rejected by rack 3.x") if Rack.release >= "3.0.0"
+          get 'http://www.example.org/public/test.pdf'
+          expect(last_response.headers["Content-Type"]).to eq("application/pdf")
+        end
+      end
+    end
+
+    describe "remove .pdf from PATH_INFO and REQUEST_URI" do
+      before { mock_app }
 
       context "matching" do
 
@@ -293,7 +469,7 @@ describe PDFKit::Middleware do
           main_app = lambda { |env|
             @env = env
             @env['SCRIPT_NAME'] = '/example.org'
-            headers = {'Content-Type' => "text/html"}
+            headers = {'content-type' => "text/html"}
             [200, headers, @body || ['Hello world!']]
           }
 
@@ -319,80 +495,37 @@ describe PDFKit::Middleware do
     end
   end
 
-  describe "#translate_paths" do
+  describe "#root_url and #protocol" do
     before do
       @pdf = PDFKit::Middleware.new({})
       @env = { 'REQUEST_URI' => 'http://example.com/document.pdf', 'rack.url_scheme' => 'http', 'HTTP_HOST' => 'example.com' }
     end
 
-    it "should correctly parse relative url with single quotes" do
-      @body = %{<html><head><link href='/stylesheets/application.css' media='screen' rel='stylesheet' type='text/css' /></head><body><img alt='test' src="/test.png" /></body></html>}
-      body = @pdf.send :translate_paths, @body, @env
-      expect(body).to eq("<html><head><link href='http://example.com/stylesheets/application.css' media='screen' rel='stylesheet' type='text/css' /></head><body><img alt='test' src=\"http://example.com/test.png\" /></body></html>")
-    end
-
-    it "should correctly parse relative url with double quotes" do
-      @body = %{<link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" />}
-      body = @pdf.send :translate_paths, @body, @env
-      expect(body).to eq("<link href=\"http://example.com/stylesheets/application.css\" media=\"screen\" rel=\"stylesheet\" type=\"text/css\" />")
-    end
+    context 'when root_url is not configured' do
+      it "infers the root_url and protocol from the environment" do
+        root_url = @pdf.send(:root_url, @env)
+        protocol = @pdf.send(:protocol, @env)
 
-    it "should correctly parse relative url with double quotes" do
-      @body = %{<link href='//fonts.googleapis.com/css?family=Open+Sans:400,600' rel='stylesheet' type='text/css'>}
-      body = @pdf.send :translate_paths, @body, @env
-      expect(body).to eq("<link href='http://fonts.googleapis.com/css?family=Open+Sans:400,600' rel='stylesheet' type='text/css'>")
-    end
-
-    it "should correctly parse multiple tags where first one is root url" do
-      @body = %{<a href='/'><img src='/logo.jpg' ></a>}
-      body = @pdf.send :translate_paths, @body, @env
-      body.should == "<a href='http://example.com/'><img src='http://example.com/logo.jpg' ></a>"
-    end
-
-    it "should return the body even if there are no valid substitutions found" do
-      @body = "NO MATCH"
-      body = @pdf.send :translate_paths, @body, @env
-      expect(body).to eq("NO MATCH")
+        expect(root_url).to eq('http://example.com/')
+        expect(protocol).to eq('http')
+      end
     end
-  end
 
-  describe "#translate_paths with root_url configuration" do
-    before do
-      @pdf = PDFKit::Middleware.new({})
-      @env = { 'REQUEST_URI' => 'http://example.com/document.pdf', 'rack.url_scheme' => 'http', 'HTTP_HOST' => 'example.com' }
-      PDFKit.configure do |config|
-        config.root_url = "http://example.net/"
+    context 'when root_url is configured' do
+      before do
+        PDFKit.configuration.root_url = 'http://example.net/'
+      end
+      after do
+        PDFKit.configuration.root_url = nil
       end
-    end
 
-    it "should add the root_url" do
-      @body = %{<html><head><link href='/stylesheets/application.css' media='screen' rel='stylesheet' type='text/css' /></head><body><img alt='test' src="/test.png" /></body></html>}
-      body = @pdf.send :translate_paths, @body, @env
-      expect(body).to eq("<html><head><link href='http://example.net/stylesheets/application.css' media='screen' rel='stylesheet' type='text/css' /></head><body><img alt='test' src=\"http://example.net/test.png\" /></body></html>")
-    end
+      it "takes the root_url from the configuration, and infers the protocol from the environment" do
+        root_url = @pdf.send(:root_url, @env)
+        protocol = @pdf.send(:protocol, @env)
 
-    after do
-      PDFKit.configure do |config|
-        config.root_url = nil
+        expect(root_url).to eq('http://example.net/')
+        expect(protocol).to eq('http')
       end
     end
   end
-
-  it "should 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/os_spec.rb

@@ -0,0 +1,67 @@
+#encoding: UTF-8
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'rbconfig'
+
+describe 'OS' do
+  subject { PDFKit::OS }
+
+  describe 'host_is_windows?' do
+    it 'is callable' do
+      expect(subject).to respond_to(:host_is_windows?)
+    end
+
+    def test_is_windows(bool, host_os)
+      allow(RbConfig::CONFIG).to receive(:[]).with('host_os').and_return(host_os)
+
+      expect(subject.host_is_windows?).to be bool
+    end
+
+    it 'returns true if the host_os is set to "mswin"' do
+      test_is_windows(true, 'mswin')
+    end
+
+    it 'returns true if the host_os is set to "msys"' do
+      test_is_windows(true, 'msys')
+    end
+
+    it 'returns false if the host_os is set to "linux-gnu"' do
+      test_is_windows(false, 'linux-gnu')
+    end
+
+    it 'returns false if the host_os is set to "darwin14.1.0"' do
+      test_is_windows(false, 'darwin14.1.0')
+    end
+  end
+
+  describe 'shell_escape_for_os' do
+    it 'is callable' do
+      expect(subject).to respond_to(:shell_escape_for_os)
+    end
+
+    it 'calls shelljoin on linux' do
+      args = double(:shelljoin)
+      allow(RbConfig::CONFIG).to receive(:[]).with('host_os').and_return('linux-gnu')
+
+      expect(args).to receive(:shelljoin)
+      PDFKit::OS.shell_escape_for_os(args)
+    end
+
+    it 'calls shelljoin on darwin14.1.10' do
+      args = double(:shelljoin)
+      allow(RbConfig::CONFIG).to receive(:[]).with('host_os').and_return('darwin14.1.10-gnu')
+
+      expect(args).to receive(:shelljoin)
+      PDFKit::OS.shell_escape_for_os(args)
+    end
+
+    it 'escapes special characters on Windows' do
+      args = ['foo|bar', 'biz(baz)', 'foo<baz>bar', 'hello^world&goodbye']
+      allow(RbConfig::CONFIG).to receive(:[]).with('host_os').and_return('mswin')
+
+      escaped_args = PDFKit::OS.shell_escape_for_os(args)
+      expect(escaped_args).to eq('foo^|bar biz^(baz^) foo^<baz^>bar hello^^world^&goodbye')
+    end
+  end
+end