pdfkit 0.5.2 → 0.5.3

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+- 1.8.7
+- 1.9.2
+- 1.9.3

data/Gemfile

@@ -1,3 +1,3 @@
 source :gemcutter
 
-gemspec
+gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pdfkit (0.5.2)
+    pdfkit (0.5.3)
 
 GEM
   remote: http://rubygems.org/
@@ -12,6 +12,7 @@ GEM
     rack (1.3.0)
     rack-test (0.6.0)
       rack (>= 1.0)
+    rake (0.9.2)
     rspec (2.2.0)
       rspec-core (~> 2.2)
       rspec-expectations (~> 2.2)
@@ -20,6 +21,7 @@ GEM
     rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.6.0)
+    wkhtmltopdf-binary (0.9.5.3)
 
 PLATFORMS
   ruby
@@ -29,4 +31,6 @@ DEPENDENCIES
   mocha (>= 0.9.10)
   pdfkit!
   rack-test (>= 0.5.6)
+  rake (~> 0.9.2)
   rspec (~> 2.2.0)
+  wkhtmltopdf-binary (~> 0.9.5)

data/POST_INSTALL

@@ -4,7 +4,7 @@ Install wkhtmltopdf:
 
 1. Install by hand (recomended):
 
-        https://github.com/jdpace/PDFKit/wiki/Installing-WKHTMLTOPDF
+        https://github.com/pdfkit/PDFKit/wiki/Installing-WKHTMLTOPDF
 
 2. Try using the wkhtmltopdf-binary gem (mac + linux i386)
 

data/README.md

@@ -12,7 +12,7 @@ Create PDFs using plain old HTML+CSS. Uses [wkhtmltopdf](http://github.com/antia
 
 1. Install by hand (recommended):
 
-    <https://github.com/jdpace/PDFKit/wiki/Installing-WKHTMLTOPDF>
+    <https://github.com/pdfkit/pdfkit/wiki/Installing-WKHTMLTOPDF>
 
 2.  Try using the wkhtmltopdf-binary gem (mac + linux i386)
 
@@ -27,7 +27,7 @@ Create PDFs using plain old HTML+CSS. Uses [wkhtmltopdf](http://github.com/antia
     kit = PDFKit.new(html, :page_size => 'Letter')
     kit.stylesheets << '/path/to/css/file'
 
-    # Git an inline PDF
+    # Get an inline PDF
     pdf = kit.to_pdf
 
     # Save the PDF to a file
@@ -88,6 +88,12 @@ PDFKit comes with a middleware that allows users to get a PDF view of any page o
     config.middleware.use PDFKit::Middleware, {}, :only => '/public'
     config.middleware.use PDFKit::Middleware, {}, :only => ['/invoice', '/public']
 
+    # conditions can be regexps (either one or an array)
+    config.middleware.use PDFKit::Middleware, {}, :except => [%r[^/prawn], %r[^/secret]]
+
+    # conditions can be strings (either one or an array)
+    config.middleware.use PDFKit::Middleware, {}, :except => ['/secret']
+
 ## Troubleshooting
 
 *  **Single thread issue:** In development environments it is common to run a
@@ -101,6 +107,14 @@ PDFKit comes with a middleware that allows users to get a PDF view of any page o
    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
    does not seem to be downloading correctly in the PDF. This is due
@@ -112,8 +126,8 @@ PDFKit comes with a middleware that allows users to get a PDF view of any page o
    root_url configuration may be what you are looking for change your
    asset host.
 
-## TODO
- - add amd64 support in --install-wkhtmltopdf
+*  **Mangled output in the browser:** Be sure that your HTTP response
+   headers specify "Content-Type: application/pdf" 
 
 ## Note on Patches/Pull Requests
 

data/lib/pdfkit/middleware.rb

@@ -58,6 +58,17 @@ class PDFKit
             @request.path[0, pattern.length] == pattern
           end
         end
+      elsif request_path_is_pdf && @conditions[:except]
+        rules = [@conditions[:except]].flatten
+        rules.map do |pattern|
+          if pattern.is_a?(Regexp)
+            return false if @request.path =~ pattern
+          else
+            return false if @request.path[0, pattern.length] == pattern
+          end
+        end
+
+        return true
       else
         request_path_is_pdf
       end

data/lib/pdfkit/pdfkit.rb

@@ -1,3 +1,5 @@
+require 'shellwords'
+
 class PDFKit
 
   class NoExecutableError < StandardError
@@ -42,7 +44,7 @@ class PDFKit
 
     args << (path || '-') # Write to file or stdout
 
-    args.map {|arg| %Q{"#{arg.gsub('"', '\"')}"}}
+    args.map {|arg| %Q{"#{arg.shellescape}"}}
   end
 
   def executable

data/lib/pdfkit/version.rb

@@ -1,3 +1,3 @@
 class PDFKit
-  VERSION = "0.5.2"
+  VERSION = "0.5.3"
 end

data/pdfkit.gemspec

@@ -20,9 +20,10 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Developmnet Dependencies
+  s.add_development_dependency(%q<rake>, ["~>0.9.2"])
   s.add_development_dependency(%q<rspec>, ["~> 2.2.0"])
   s.add_development_dependency(%q<mocha>, [">= 0.9.10"])
   s.add_development_dependency(%q<rack-test>, [">= 0.5.6"])
   s.add_development_dependency(%q<activesupport>, [">= 3.0.8"])
+  s.add_development_dependency(%q<wkhtmltopdf-binary>, ["~> 0.9.5"])
 end
-

data/spec/middleware_spec.rb

@@ -106,6 +106,94 @@ describe PDFKit::Middleware do
         end # string
 
       end
+
+      describe ":except" do
+
+        describe "regex" do
+          describe "one" do
+            before { mock_app({}, :except => %r[^/secret]) }
+
+            context "matching" do
+              specify do
+                get 'http://www.example.org/public/test.pdf'
+                last_response.headers["Content-Type"].should == "application/pdf"
+                last_response.body.bytesize.should == PDFKit.new("Hello world!").to_pdf.bytesize
+              end
+            end
+
+            context "not matching" do
+              specify do
+                get 'http://www.example.org/secret/test.pdf'
+                last_response.headers["Content-Type"].should == "text/html"
+                last_response.body.should == "Hello world!"
+              end
+            end
+          end # one regex
+
+          describe "multiple" do
+            before { mock_app({}, :except => [%r[^/prawn], %r[^/secret]]) }
+
+            context "matching" do
+              specify do
+                get 'http://www.example.org/public/test.pdf'
+                last_response.headers["Content-Type"].should == "application/pdf"
+                last_response.body.bytesize.should == PDFKit.new("Hello world!").to_pdf.bytesize
+              end
+            end
+
+            context "not matching" do
+              specify do
+                get 'http://www.example.org/secret/test.pdf'
+                last_response.headers["Content-Type"].should == "text/html"
+                last_response.body.should == "Hello world!"
+              end
+            end
+          end # multiple regex
+        end # regex
+
+        describe "string" do
+          describe "one" do
+            before { mock_app({}, :except => '/secret') }
+
+            context "matching" do
+              specify do
+                get 'http://www.example.org/public/test.pdf'
+                last_response.headers["Content-Type"].should == "application/pdf"
+                last_response.body.bytesize.should == PDFKit.new("Hello world!").to_pdf.bytesize
+              end
+            end
+
+            context "not matching" do
+              specify do
+                get 'http://www.example.org/secret/test.pdf'
+                last_response.headers["Content-Type"].should == "text/html"
+                last_response.body.should == "Hello world!"
+              end
+            end
+          end # one string
+
+          describe "multiple" do
+            before { mock_app({}, :except => ['/prawn', '/secret']) }
+
+            context "matching" do
+              specify do
+                get 'http://www.example.org/public/test.pdf'
+                last_response.headers["Content-Type"].should == "application/pdf"
+                last_response.body.bytesize.should == PDFKit.new("Hello world!").to_pdf.bytesize
+              end
+            end
+
+            context "not matching" do
+              specify do
+                get 'http://www.example.org/secret/test.pdf'
+                last_response.headers["Content-Type"].should == "text/html"
+                last_response.body.should == "Hello world!"
+              end
+            end
+          end # multiple string
+        end # string
+
+      end
     end
 
     describe "remove .pdf from PATH_INFO and REQUEST_URI" do

data/spec/pdfkit_spec.rb

@@ -67,7 +67,12 @@ describe PDFKit do
 
     it "should encapsulate string arguments in quotes" do
       pdfkit = PDFKit.new('html', :header_center => "foo [page]")
-      pdfkit.command[pdfkit.command.index('"--header-center"') + 1].should == '"foo [page]"'
+      pdfkit.command[pdfkit.command.index('"--header-center"') + 1].should == '"foo\ \[page\]"'
+    end
+
+    it "should sanitize string arguments" do
+      pdfkit = PDFKit.new('html', :header_center => "$(ls)")
+      pdfkit.command[pdfkit.command.index('"--header-center"') + 1].should == '"\$\(ls\)"'
     end
 
     it "read the source from stdin if it is html" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pdfkit
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-02 00:00:00.000000000Z
+date: 2013-02-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152731540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +38,15 @@ dependencies:
         version: 2.2.0
   type: :development
   prerelease: false
-  version_requirements: *2152731540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2152731020 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +54,15 @@ dependencies:
         version: 0.9.10
   type: :development
   prerelease: false
-  version_requirements: *2152731020
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.10
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &2152730540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +70,15 @@ dependencies:
         version: 0.5.6
   type: :development
   prerelease: false
-  version_requirements: *2152730540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.6
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2152730060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +86,28 @@ dependencies:
         version: 3.0.8
   type: :development
   prerelease: false
-  version_requirements: *2152730060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.8
+- !ruby/object:Gem::Dependency
+  name: wkhtmltopdf-binary
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.5
 description: Uses wkhtmltopdf to create PDFs using HTML
 email:
 - jared@codewordstudios.com
@@ -66,6 +118,7 @@ files:
 - .document
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - History.md
@@ -106,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: pdfkit
-rubygems_version: 1.8.5
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: HTML+CSS -> PDF