pdfkit-middleware-to-file 0.5.2 → 0.5.3

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.bundle
+spec/custom_wkhtmltopdf_path.rb

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    pdfkit (0.5.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    mocha (0.9.10)
+      rake
+    rack (1.2.1)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rake (0.8.7)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.2.1)
+    rspec-expectations (2.2.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha (>= 0.9.10)
+  pdfkit!
+  rack-test (>= 0.5.6)
+  rspec (~> 2.2.0)

data/History.md

@@ -0,0 +1,19 @@
+2011-06-17
+==================
+  * Bump to 0.5.1
+  * Fix for response body coming through as an array.
+  * Added root_url configuration for setup where a host my not know its own name.
+  * Awareness of Bundler when looking for the wkhtmltopdf executable.
+  * Fix for file data getting truncated in Ruby 1.8.6
+  * Fix for 0.5.0 release getting stuck rendering all requests as PDFs.
+  * More robust meta tag detection.
+
+2010-12-27
+==================
+  * Bump to 0.5.0
+  * Switched to popen - adds support for JRuby and Windows
+  * Pulled in support for pdf rendering conditions in middleware via Rémy Coutable
+  * Use `which` to try and determine path to wkhtmltopdf
+  * Removed wkhtmltopdf auto installer
+  * Changed :disable\_smart\_shrinking to false for default options.
+  * Added History.md

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 jdpace
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/POST_INSTALL

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

data/README.md

@@ -0,0 +1,131 @@
+# PDFKit
+
+Create PDFs using plain old HTML+CSS. Uses [wkhtmltopdf](http://github.com/antialize/wkhtmltopdf) on the back-end which renders HTML using Webkit.
+
+## Install
+
+### PDFKit
+
+    gem install pdfkit
+
+### wkhtmltopdf
+
+1. Install by hand (recommended):
+
+    <https://github.com/jdpace/PDFKit/wiki/Installing-WKHTMLTOPDF>
+
+2.  Try using the wkhtmltopdf-binary gem (mac + linux i386)
+
+        gem install wkhtmltopdf-binary
+
+*Note:* The automated installer has been removed.
+
+## Usage
+
+    # PDFKit.new takes the HTML and any options for wkhtmltopdf
+    # run `wkhtmltopdf --extended-help` for a full list of options
+    kit = PDFKit.new(html, :page_size => 'Letter')
+    kit.stylesheets << '/path/to/css/file'
+
+    # Git an inline PDF
+    pdf = kit.to_pdf
+
+    # Save the PDF to a file
+    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.
+    kit = PDFKit.new('http://google.com')
+    kit = PDFKit.new(File.new('/path/to/html'))
+
+    # Add any kind of option through meta tags
+    PDFKit.new('<html><head><meta name="pdfkit-page_size" content="Letter")
+
+## Configuration
+
+If you're on Windows or you installed wkhtmltopdf by hand to a location other than /usr/local/bin you will need to tell PDFKit where the binary is. You can configure PDFKit like so:
+
+    # config/initializers/pdfkit.rb
+    PDFKit.configure do |config|
+      # config.wkhtmltopdf = '/path/to/wkhtmltopdf'
+      # config.default_options = {
+      #   :page_size => 'Legal',
+      #   :print_media_type => true
+      # }
+      # config.root_url = "http://localhost" # Use only if your external hostname is unavailable on the server.
+    end
+
+## Middleware
+
+PDFKit comes with a middleware that allows users to get a PDF view of any page on your site by appending .pdf to the URL.
+
+### Middleware Setup
+
+**Non-Rails Rack apps**
+
+    # in config.ru
+    require 'pdfkit'
+    use PDFKit::Middleware
+
+**Rails apps**
+
+    # in application.rb(Rails3) or environment.rb(Rails2)
+    require 'pdfkit'
+    config.middleware.use PDFKit::Middleware
+
+**With PDFKit options**
+
+    # options will be passed to PDFKit.new
+    config.middleware.use PDFKit::Middleware, :print_media_type => true
+
+**With conditions to limit routes that can be generated in pdf**
+
+    # conditions can be regexps (either one or an array)
+    config.middleware.use PDFKit::Middleware, {}, :only => %r[^/public]
+    config.middleware.use PDFKit::Middleware, {}, :only => [%r[^/invoice], %r[^/public]]
+
+    # conditions can be strings (either one or an array)
+    config.middleware.use PDFKit::Middleware, {}, :only => '/public'
+    config.middleware.use PDFKit::Middleware, {}, :only => ['/invoice', '/public']
+
+## Troubleshooting
+
+*  **Single thread issue:** In development environments it is common to run a
+   single server process. This can cause issues when rendering your pdf
+   requires wkhtmltopdf to hit your server again (for images, js, css).
+   This is because the resource requests will get blocked by the initial
+   request and the initial request will be waiting on the resource
+   requests causing a deadlock.
+
+   This is usually not an issue in a production environment. To get
+   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.
+
+*  **Resources aren't included in the PDF:** Images, CSS, or JavaScript
+   does not seem to be downloading correctly in the PDF. This is due
+   to the fact that wkhtmltopdf does not know where to find those files.
+   Make sure you are using absolute paths (start with forward slash) to
+   your resources. If you are using PDFKit to generate PDFs from a raw
+   HTML source make sure you use complete paths (either file paths or
+   urls including the domain). In restrictive server environments the
+   root_url configuration may be what you are looking for change your
+   asset host.
+
+## TODO
+ - add amd64 support in --install-wkhtmltopdf
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Setup your development environment with: gem install bundler; bundle install
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Jared Pace. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'rake'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "PDFKit #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/pdfkit/configuration.rb

@@ -0,0 +1,43 @@
+class PDFKit
+  class Configuration
+    attr_accessor :meta_tag_prefix, :default_options, :root_url
+    attr_writer :wkhtmltopdf
+
+    def initialize
+      @meta_tag_prefix = 'pdfkit-'
+      @default_options = {
+        :disable_smart_shrinking => false,
+        :page_size => 'Letter',
+        :margin_top => '0.75in',
+        :margin_right => '0.75in',
+        :margin_bottom => '0.75in',
+        :margin_left => '0.75in',
+        :encoding => "UTF-8"
+      }
+    end
+
+    def wkhtmltopdf
+      @wkhtmltopdf ||= (defined?(Bundler) ? `bundle exec which wkhtmltopdf` : `which wkhtmltopdf`).chomp
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Configure PDFKit someplace sensible,
+  # like config/initializers/pdfkit.rb
+  #
+  # @example
+  #   PDFKit.configure do |config|
+  #     config.wkhtmltopdf = '/usr/bin/wkhtmltopdf'
+  #   end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/pdfkit/middleware.rb

@@ -0,0 +1,81 @@
+class PDFKit
+
+  class Middleware
+
+    def initialize(app, options = {}, conditions = {})
+      @app        = app
+      @options    = options
+      @conditions = conditions
+    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)
+        pdf = PDFKit.new(translate_paths(body, env), @options)
+        file = pdf.to_file( "~/myballs.pdf" )
+        body = pdf.to_pdf
+        response = [body]
+
+        # Do not cache PDFs
+        headers.delete('ETag')
+        headers.delete('Cache-Control')
+
+        headers["Content-Length"]         = (body.respond_to?(:bytesize) ? body.bytesize : body.size).to_s
+        headers["Content-Type"]           = "application/pdf"
+      end
+
+      [status, headers, response]
+    end
+
+    private
+
+    # Change relative paths to absolute
+    def translate_paths(body, env)
+      # Host with protocol
+      root = PDFKit.configuration.root_url || "#{env['rack.url_scheme']}://#{env['HTTP_HOST']}/"
+
+      body.gsub(/(href|src)=(['"])\/([^\"']*|[^"']*)['"]/, '\1=\2' + root + '\3\2')
+    end
+
+    def rendering_pdf?
+      @render_pdf
+    end
+
+    def render_as_pdf?
+      request_path_is_pdf = @request.path.match(%r{\.pdf$})
+
+      if request_path_is_pdf && @conditions[:only]
+        rules = [@conditions[:only]].flatten
+        rules.any? do |pattern|
+          if pattern.is_a?(Regexp)
+            @request.path =~ pattern
+          else
+            @request.path[0, pattern.length] == pattern
+          end
+        end
+      else
+        request_path_is_pdf
+      end
+    end
+
+    def set_request_to_render_as_pdf(env)
+      @render_pdf = true
+      path = @request.path.sub(%r{\.pdf$}, '')
+      %w[PATH_INFO REQUEST_URI].each { |e| env[e] = path }
+      env['HTTP_ACCEPT'] = concat(env['HTTP_ACCEPT'], Rack::Mime.mime_type('.html'))
+      env["Rack-Middleware-PDFKit"] = "true"
+    end
+
+    def concat(accepts, type)
+      (accepts || '').split(',').unshift(type).compact.join(',')
+    end
+
+  end
+end

data/lib/pdfkit/pdfkit.rb

@@ -0,0 +1,137 @@
+class PDFKit
+
+  class NoExecutableError < StandardError
+    def initialize
+      msg  = "No wkhtmltopdf executable found at #{PDFKit.configuration.wkhtmltopdf}\n"
+      msg << ">> Please install wkhtmltopdf - https://github.com/jdpace/PDFKit/wiki/Installing-WKHTMLTOPDF"
+      super(msg)
+    end
+  end
+
+  class ImproperSourceError < StandardError
+    def initialize(msg)
+      super("Improper Source: #{msg}")
+    end
+  end
+
+  attr_accessor :source, :stylesheets
+  attr_reader :options
+
+  def initialize(url_file_or_html, options = {})
+    @source = Source.new(url_file_or_html)
+
+    @stylesheets = []
+
+    @options = PDFKit.configuration.default_options.merge(options)
+    @options.merge! find_options_in_meta(url_file_or_html) unless source.url?
+    @options = normalize_options(@options)
+
+    raise NoExecutableError.new unless File.exists?(PDFKit.configuration.wkhtmltopdf)
+  end
+
+  def command(path = nil)
+    args = [executable]
+    args += @options.to_a.flatten.compact
+    args << '--quiet'
+
+    if @source.html?
+      args << '-' # Get HTML from stdin
+    else
+      args << @source.to_s
+    end
+
+    args << (path || '-') # Write to file or stdout
+
+    args.map {|arg| %Q{"#{arg.gsub('"', '\"')}"}}
+  end
+
+  def executable
+    default = PDFKit.configuration.wkhtmltopdf
+    return default if default !~ /^\// # its not a path, so nothing we can do
+    if File.exist?(default)
+      default
+    else
+      default.split('/').last
+    end
+  end
+
+  def to_pdf(path=nil)
+    append_stylesheets
+
+    args = command(path)
+    invoke = args.join(' ')
+
+    result = IO.popen(invoke, "wb+") do |pdf|
+      pdf.puts(@source.to_s) if @source.html?
+      pdf.close_write
+      pdf.gets(nil)
+    end
+    result = File.read(path) if path
+
+    raise "command failed: #{invoke}" if result.to_s.strip.empty?
+    return result
+  end
+
+  def to_file(path)
+    self.to_pdf(path)
+    File.new(path)
+  end
+
+  protected
+
+    def find_options_in_meta(content)
+      # Read file if content is a File
+      content = content.read if content.is_a?(File)
+
+      found = {}
+      content.scan(/<meta [^>]*>/) do |meta|
+        if meta.match(/name=["']#{PDFKit.configuration.meta_tag_prefix}/)
+          name = meta.scan(/name=["']#{PDFKit.configuration.meta_tag_prefix}([^"']*)/)[0][0]
+          found[name] = meta.scan(/content=["']([^"']*)/)[0][0]
+        end
+      end
+
+      found
+    end
+
+    def style_tag_for(stylesheet)
+      "<style>#{File.read(stylesheet)}</style>"
+    end
+
+    def append_stylesheets
+      raise ImproperSourceError.new('Stylesheets may only be added to an HTML source') if stylesheets.any? && !@source.html?
+
+      stylesheets.each do |stylesheet|
+        if @source.to_s.match(/<\/head>/)
+          @source.to_s.gsub!(/(<\/head>)/, style_tag_for(stylesheet)+'\1')
+        else
+          @source.to_s.insert(0, style_tag_for(stylesheet))
+        end
+      end
+    end
+
+    def normalize_options(options)
+      normalized_options = {}
+
+      options.each do |key, value|
+        next if !value
+        normalized_key = "--#{normalize_arg key}"
+        normalized_options[normalized_key] = normalize_value(value)
+      end
+      normalized_options
+    end
+
+    def normalize_arg(arg)
+      arg.to_s.downcase.gsub(/[^a-z0-9]/,'-')
+    end
+
+    def normalize_value(value)
+      case value
+      when TrueClass
+        nil
+      else
+        value.to_s
+      end
+    end
+
+end

data/lib/pdfkit/source.rb

@@ -0,0 +1,23 @@
+class PDFKit
+  class Source
+    def initialize(url_file_or_html)
+      @source = url_file_or_html
+    end
+    
+    def url?
+      @source.is_a?(String) && @source.match(/\Ahttp/)
+    end
+    
+    def file?
+      @source.kind_of?(File)
+    end
+    
+    def html?
+      !(url? || file?)
+    end
+    
+    def to_s
+      file? ? @source.path : @source
+    end
+  end
+end

data/lib/pdfkit/version.rb

@@ -0,0 +1,3 @@
+class PDFKit
+  VERSION = "0.5.1"
+end

data/lib/pdfkit.rb

@@ -0,0 +1,4 @@
+require 'pdfkit/source'
+require 'pdfkit/pdfkit'
+require 'pdfkit/middleware'
+require 'pdfkit/configuration'

data/pdfkit.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "pdfkit/version"
+
+Gem::Specification.new do |s|
+  s.name        = "pdfkit-middleware-to-file"
+  s.version     = "0.5.3" # PDFKit::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jared Pace", "Relevance", "Ashish"]
+  # s.email       = ["jared@codewordstudios.com"]
+  # s.homepage    = "http://github.com/jdpace/PDFKit"
+  s.summary     = "HTML+CSS -> PDF"
+  s.description = "Uses wkhtmltopdf to create PDFs using HTML - and save file -> from Ashish post on stack overflow"
+
+  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) }
+  s.require_paths = ["lib"]
+
+  # Developmnet Dependencies
+  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"])
+end
+

data/spec/fixtures/example.css

@@ -0,0 +1 @@
+body { font-size: 20px; }

data/spec/fixtures/example.html

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <h1>Oh Hai!</h1>
+  </body>
+</html>

data/spec/middleware_spec.rb

@@ -0,0 +1,195 @@
+require 'spec_helper'
+
+def app; Rack::Lint.new(@app); end
+
+def mock_app(options = {}, conditions = {})
+  main_app = lambda { |env|
+    @env = env
+    headers = {'Content-Type' => "text/html"}
+    [200, headers, @body || ['Hello world!']]
+  }
+
+  builder = Rack::Builder.new
+  builder.use PDFKit::Middleware, options, conditions
+  builder.run main_app
+  @app = builder.to_app
+end
+
+describe PDFKit::Middleware do
+
+  describe "#call" do
+    describe "conditions" do
+      describe ":only" do
+
+        describe "regex" do
+          describe "one" do
+            before { mock_app({}, :only => %r[^/public]) }
+
+            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({}, :only => [%r[^/invoice], %r[^/public]]) }
+
+            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({}, :only => '/public') }
+
+            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({}, :only => ['/invoice', '/public']) }
+
+            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
+      before { mock_app }
+
+      context "matching" do
+        specify do
+          get 'http://www.example.org/public/file.pdf'
+          @env["PATH_INFO"].should == "/public/file"
+          @env["REQUEST_URI"].should == "/public/file"
+        end
+        specify do
+          get 'http://www.example.org/public/file.txt'
+          @env["PATH_INFO"].should == "/public/file.txt"
+          @env["REQUEST_URI"].should be_nil
+        end
+      end
+
+    end
+  end
+
+  describe "#translate_paths" 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
+      body.should == "<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
+      body.should == "<link href=\"http://example.com/stylesheets/application.css\" media=\"screen\" rel=\"stylesheet\" type=\"text/css\" />"
+    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
+      body.should == "NO MATCH"
+    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/"
+      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
+      body.should == "<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
+    
+    after do
+      PDFKit.configure do |config|
+        config.root_url = nil
+      end
+    end
+  end
+
+  it "should not get stuck rendering each request as pdf" do
+    mock_app
+    # false by default. No requests.
+    @app.send(:rendering_pdf?).should be_false
+
+    # Remain false on a normal request
+    get 'http://www.example.org/public/file'
+    @app.send(:rendering_pdf?).should be_false
+
+    # Return true on a pdf request.
+    get 'http://www.example.org/public/file.pdf'
+    @app.send(:rendering_pdf?).should be_true
+
+    # Restore to false on any non-pdf request.
+    get 'http://www.example.org/public/file'
+    @app.send(:rendering_pdf?).should be_false
+  end
+
+end

data/spec/pdfkit_spec.rb

@@ -0,0 +1,227 @@
+#encoding: UTF-8
+require 'spec_helper'
+
+describe PDFKit do
+
+  context "initialization" do
+    it "should accept HTML as the source" do
+      pdfkit = PDFKit.new('<h1>Oh Hai</h1>')
+      pdfkit.source.should be_html
+      pdfkit.source.to_s.should == '<h1>Oh Hai</h1>'
+    end
+
+    it "should accept a URL as the source" do
+      pdfkit = PDFKit.new('http://google.com')
+      pdfkit.source.should be_url
+      pdfkit.source.to_s.should == 'http://google.com'
+    end
+
+    it "should accept a File as the source" do
+      file_path = File.join(SPEC_ROOT,'fixtures','example.html')
+      pdfkit = PDFKit.new(File.new(file_path))
+      pdfkit.source.should be_file
+      pdfkit.source.to_s.should == file_path
+    end
+
+    it "should parse the options into a cmd line friedly format" do
+      pdfkit = PDFKit.new('html', :page_size => 'Letter')
+      pdfkit.options.should have_key('--page-size')
+    end
+
+    it "should provide default options" do
+      pdfkit = PDFKit.new('<h1>Oh Hai</h1>')
+      ['--margin-top', '--margin-right', '--margin-bottom', '--margin-left'].each do |option|
+        pdfkit.options.should have_key(option)
+      end
+    end
+
+    it "should default to 'UTF-8' encoding" do
+      pdfkit = PDFKit.new('Captación')
+      pdfkit.options['--encoding'].should == 'UTF-8'
+    end
+
+    it "should not have any stylesheedt by default" do
+      pdfkit = PDFKit.new('<h1>Oh Hai</h1>')
+      pdfkit.stylesheets.should be_empty
+    end
+  end
+
+  context "command" do
+    it "should contstruct the correct command" do
+      pdfkit = PDFKit.new('html', :page_size => 'Letter', :toc_l1_font_size => 12)
+      pdfkit.command[0].should include('wkhtmltopdf')
+      pdfkit.command[pdfkit.command.index('"--page-size"') + 1].should == '"Letter"'
+      pdfkit.command[pdfkit.command.index('"--toc-l1-font-size"') + 1].should == '"12"'
+    end
+
+    it "will not include default options it is told to omit" do
+      PDFKit.configure do |config|
+        config.default_options[:disable_smart_shrinking] = true
+      end
+
+      pdfkit = PDFKit.new('html')
+      pdfkit.command.should include('"--disable-smart-shrinking"')
+      pdfkit = PDFKit.new('html', :disable_smart_shrinking => false)
+      pdfkit.command.should_not include('"--disable-smart-shrinking"')
+    end
+
+    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]"'
+    end
+
+    it "read the source from stdin if it is html" do
+      pdfkit = PDFKit.new('html')
+      pdfkit.command[-2..-1].should == ['"-"', '"-"']
+    end
+
+    it "specify the URL to the source if it is a url" do
+      pdfkit = PDFKit.new('http://google.com')
+      pdfkit.command[-2..-1].should == ['"http://google.com"', '"-"']
+    end
+
+    it "should specify the path to the source if it is a file" do
+      file_path = File.join(SPEC_ROOT,'fixtures','example.html')
+      pdfkit = PDFKit.new(File.new(file_path))
+      pdfkit.command[-2..-1].should == [%Q{"#{file_path}"}, '"-"']
+    end
+
+    it "should specify the path for the ouput if a apth is given" do
+      file_path = "/path/to/output.pdf"
+      pdfkit = PDFKit.new("html")
+      pdfkit.command(file_path).last.should == %Q{"#{file_path}"}
+    end
+
+    it "should detect special pdfkit meta tags" do
+      body = %{
+        <html>
+          <head>
+            <meta name="pdfkit-page_size" content="Legal"/>
+            <meta name="pdfkit-orientation" content="Landscape"/>
+          </head>
+        </html>
+      }
+      pdfkit = PDFKit.new(body)
+      pdfkit.command[pdfkit.command.index('"--page-size"') + 1].should == '"Legal"'
+      pdfkit.command[pdfkit.command.index('"--orientation"') + 1].should == '"Landscape"'
+    end
+
+    it "should detect special pdfkit meta tags despite bad markup" do
+      body = %{
+        <html>
+          <head>
+            <meta name="pdfkit-page_size" content="Legal"/>
+            <meta name="pdfkit-orientation" content="Landscape"/>
+          </head>
+          <br>
+        </html>
+      }
+      pdfkit = PDFKit.new(body)
+      pdfkit.command[pdfkit.command.index('"--page-size"') + 1].should == '"Legal"'
+      pdfkit.command[pdfkit.command.index('"--orientation"') + 1].should == '"Landscape"'
+    end
+
+    it "should skip non-pdfkit meta tags" do
+      body = %{
+        <html>
+          <head>
+            <meta name="test-page_size" content="Legal"/>
+            <meta name="pdfkit-orientation" content="Landscape"/>
+          </head>
+          <br>
+        </html>
+      }
+      pdfkit = PDFKit.new(body)
+      pdfkit.command[pdfkit.command.index('"--orientation"') + 1].should == '"Landscape"'
+    end
+
+  end
+
+  context "#to_pdf" do
+    it "should generate a PDF of the HTML" do
+      pdfkit = PDFKit.new('html', :page_size => 'Letter')
+      pdf = pdfkit.to_pdf
+      pdf[0...4].should == "%PDF" # PDF Signature at beginning of file
+    end
+
+    it "should generate a PDF with a numerical parameter" do
+      pdfkit = PDFKit.new('html', :header_spacing => 1)
+      pdf = pdfkit.to_pdf
+      pdf[0...4].should == "%PDF" # PDF Signature at beginning of file
+    end
+
+    it "should generate a PDF with a symbol parameter" do
+      pdfkit = PDFKit.new('html', :page_size => :Letter)
+      pdf = pdfkit.to_pdf
+      pdf[0...4].should == "%PDF" # PDF Signature at beginning of file
+    end
+
+    it "should have the stylesheet added to the head if it has one" do
+      pdfkit = PDFKit.new("<html><head></head><body>Hai!</body></html>")
+      css = File.join(SPEC_ROOT,'fixtures','example.css')
+      pdfkit.stylesheets << css
+      pdfkit.to_pdf
+      pdfkit.source.to_s.should include("<style>#{File.read(css)}</style>")
+    end
+
+    it "should prepend style tags if the HTML doesn't have a head tag" do
+      pdfkit = PDFKit.new("<html><body>Hai!</body></html>")
+      css = File.join(SPEC_ROOT,'fixtures','example.css')
+      pdfkit.stylesheets << css
+      pdfkit.to_pdf
+      pdfkit.source.to_s.should include("<style>#{File.read(css)}</style><html>")
+    end
+
+    it "should throw an error if the source is not html and stylesheets have been added" do
+      pdfkit = PDFKit.new('http://google.com')
+      css = File.join(SPEC_ROOT,'fixtures','example.css')
+      pdfkit.stylesheets << css
+      lambda { pdfkit.to_pdf }.should raise_error(PDFKit::ImproperSourceError)
+    end
+  end
+
+  context "#to_file" do
+    before do
+      @file_path = File.join(SPEC_ROOT,'fixtures','test.pdf')
+      File.delete(@file_path) if File.exist?(@file_path)
+    end
+
+    after do
+      File.delete(@file_path)
+    end
+
+    it "should create a file with the PDF as content" do
+      pdfkit = PDFKit.new('html', :page_size => 'Letter')
+      file = pdfkit.to_file(@file_path)
+      file.should be_instance_of(File)
+      File.read(file.path)[0...4].should == "%PDF" # PDF Signature at beginning of file
+    end
+
+    it "should not truncate data (in Ruby 1.8.6)" do
+      file_path = File.join(SPEC_ROOT,'fixtures','example.html')
+      pdfkit = PDFKit.new(File.new(file_path))
+      pdf_data = pdfkit.to_pdf
+      file = pdfkit.to_file(@file_path)
+      file_data = open(@file_path, 'rb') {|io| io.read }
+      pdf_data.size.should == file_data.size
+    end
+  end
+
+  context "security" do
+    before do
+      @test_path = File.join(SPEC_ROOT,'fixtures','security-oops')
+      File.delete(@test_path) if File.exist?(@test_path)
+    end
+
+    after do
+      File.delete(@test_path) if File.exist?(@test_path)
+    end
+
+    it "should not allow shell injection in options" do
+      pdfkit = PDFKit.new('html', :header_center => "a title\"; touch #{@test_path} #")
+      pdfkit.to_pdf
+      File.exist?(@test_path).should be_false
+    end
+  end
+
+end

data/spec/source_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe PDFKit::Source do
+  
+  describe "#url?" do
+    it "should return true if passed a url like string" do
+      source = PDFKit::Source.new('http://google.com')
+      source.should be_url
+    end
+    
+    it "should return false if passed a file" do
+      source = PDFKit::Source.new(File.new(__FILE__))
+      source.should_not be_url
+    end
+    
+    it "should return false if passed HTML" do
+      source = PDFKit::Source.new('<blink>Oh Hai!</blink>')
+      source.should_not be_url
+    end
+
+    it "should return false if passed HTML with embedded urls at the beginning of a line" do
+      source = PDFKit::Source.new("<blink>Oh Hai!</blink>\nhttp://www.google.com")
+      source.should_not be_url
+    end
+  end
+  
+  describe "#file?" do
+    it "should return true if passed a file" do
+      source = PDFKit::Source.new(File.new(__FILE__))
+      source.should be_file
+    end
+    
+    it "should return false if passed a url like string" do
+      source = PDFKit::Source.new('http://google.com')
+      source.should_not be_file
+    end
+    
+    it "should return false if passed HTML" do
+      source = PDFKit::Source.new('<blink>Oh Hai!</blink>')
+      source.should_not be_file
+    end
+  end
+  
+  describe "#html?" do
+    it "should return true if passed HTML" do
+      source = PDFKit::Source.new('<blink>Oh Hai!</blink>')
+      source.should be_html
+    end
+    
+    it "should return false if passed a file" do
+      source = PDFKit::Source.new(File.new(__FILE__))
+      source.should_not be_html
+    end
+    
+    it "should return false if passed a url like string" do
+      source = PDFKit::Source.new('http://google.com')
+      source.should_not be_html
+    end
+  end
+  
+  describe "#to_s" do
+    it "should return the HTML if passed HTML" do
+      source = PDFKit::Source.new('<blink>Oh Hai!</blink>')
+      source.to_s.should == '<blink>Oh Hai!</blink>'
+    end
+    
+    it "should return a path if passed a file" do
+      source = PDFKit::Source.new(File.new(__FILE__))
+      source.to_s.should == __FILE__
+    end
+    
+    it "should return the url if passed a url like string" do
+      source = PDFKit::Source.new('http://google.com')
+      source.to_s.should == 'http://google.com'
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+SPEC_ROOT = File.dirname(__FILE__)
+$LOAD_PATH.unshift(SPEC_ROOT)
+$LOAD_PATH.unshift(File.join(SPEC_ROOT, '..', 'lib'))
+require 'pdfkit'
+require 'rspec'
+require 'rspec/autorun'
+require 'mocha'
+require 'rack'
+require 'rack/test'
+require 'custom_wkhtmltopdf_path' if File.exists?(File.join(SPEC_ROOT, 'custom_wkhtmltopdf_path.rb'))
+
+RSpec.configure do |config|
+  include Rack::Test::Methods
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pdfkit-middleware-to-file
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-15 00:00:00.000000000 Z
+date: 2013-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -67,7 +67,32 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- History.md
+- LICENSE
+- POST_INSTALL
+- README.md
+- Rakefile
+- lib/pdfkit.rb
+- lib/pdfkit/configuration.rb
+- lib/pdfkit/middleware.rb
+- lib/pdfkit/pdfkit.rb
+- lib/pdfkit/source.rb
+- lib/pdfkit/version.rb
+- pdfkit-middleware-to-file-0.5.1.gem
+- pdfkit-middleware-to-file-0.5.2.gem
+- pdfkit.gemspec
+- spec/fixtures/example.css
+- spec/fixtures/example.html
+- spec/middleware_spec.rb
+- spec/pdfkit_spec.rb
+- spec/source_spec.rb
+- spec/spec_helper.rb
 homepage: 
 licenses: []
 post_install_message: 
@@ -92,4 +117,10 @@ rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: HTML+CSS -> PDF
-test_files: []
+test_files:
+- spec/fixtures/example.css
+- spec/fixtures/example.html
+- spec/middleware_spec.rb
+- spec/pdfkit_spec.rb
+- spec/source_spec.rb
+- spec/spec_helper.rb