hssc_pdfkit 0.5.4

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/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+2013-06-12
+==================
+  * Bump to 0.5.4
+  * Fix broken page numbers (https://github.com/pdfkit/pdfkit/pull/181)
+
+2013-02-21
+==================
+  * Bump to 0.5.3
+  * Fix security vulnerability due to unsanitized strings being passed to `wkhtmltopdf` (https://github.com/pdfkit/pdfkit/issues/164)
+
+2011-07-02
+==================
+  * Bump to 0.5.2
+  * Fix of dealing with ActiveSupport::SafeBuffer >= 3.0.8.
+  * Fix for meta tag options getting dropped in REE 1.8.7.
+  * Fix on bundler environment detection.
+
+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/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    pdfkit (0.5.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.0.9)
+    diff-lcs (1.1.2)
+    json (1.7.7)
+    mocha (0.9.12)
+    rack (1.3.0)
+    rack-test (0.6.0)
+      rack (>= 1.0)
+    rake (0.9.2)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    wkhtmltopdf-binary (0.9.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 3.0.8)
+  mocha (>= 0.9.10)
+  pdfkit!
+  rack-test (>= 0.5.6)
+  rake (~> 0.9.2)
+  rdoc (~> 4.0.1)
+  rspec (~> 2.2.0)
+  wkhtmltopdf-binary (~> 0.9.5)

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/pdfkit/PDFKit/wiki/Installing-WKHTMLTOPDF
+
+2. Try using the wkhtmltopdf-binary gem (mac + linux i386)
+
+        gem install wkhtmltopdf-binary
+
+
+******************************************************************

data/README.md

@@ -0,0 +1,146 @@
+# What makes this version different
+
+Works with Mac OSX 10.8.4
+
+# 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/pdfkit/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
+```ruby
+# 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'
+
+# Get 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:
+```ruby
+# 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**
+```ruby
+# in config.ru
+require 'pdfkit'
+use PDFKit::Middleware
+```
+**Rails apps**
+```ruby
+# in application.rb(Rails3) or environment.rb(Rails2)
+require 'pdfkit'
+config.middleware.use PDFKit::Middleware
+```
+**With PDFKit options**
+```ruby
+# 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**
+```ruby
+# 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']
+
+# 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
+   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.
+   
+   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
+   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.
+
+*  **Mangled output in the browser:** Be sure that your HTTP response
+   headers specify "Content-Type: application/pdf" 
+
+## 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 'rdoc/task'
+RDoc::Task.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::GemfileError) ? `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,94 @@
+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)
+        body = PDFKit.new(translate_paths(body, env), @options).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
+      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
+    end
+
+    def set_request_to_render_as_pdf(env)
+      @render_pdf = true
+
+      path = @request.path.sub(%r{\.pdf$}, '')
+      path = path.sub(@request.script_name, '')
+
+      %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,143 @@
+require 'shellwords'
+
+class PDFKit
+
+  class NoExecutableError < StandardError
+    def initialize
+      msg  = "No wkhtmltopdf executable found at #{PDFKit.configuration.wkhtmltopdf}\n"
+      msg << ">> Please install wkhtmltopdf - https://github.com/pdfkit/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.shelljoin
+  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
+
+    invoke = command(path)
+
+    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
+
+    # $? is thread safe per http://stackoverflow.com/questions/2164887/thread-safe-external-process-in-ruby-plus-checking-exitstatus
+    raise "command failed: #{invoke}" if result.to_s.strip.empty? or !$?.success?
+    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.to_sym] = 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 = Source.new(@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 #ie, ==true, see http://www.ruby-doc.org/core-1.9.3/TrueClass.html
+        nil
+      when Hash
+        value.to_a.flatten.collect{|x| x.to_s}
+      when Array
+        value.flatten.collect{|x| x.to_s}
+      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.4"
+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,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "pdfkit/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hssc_pdfkit"
+  s.version     = PDFKit::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Andrew Cates", "Jared Pace", "Relevance"]
+  s.email       = ["catesa@musc.edu"]
+  s.homepage    = "https://github.com/HSSC/pdfkit"
+  s.summary     = "HTML+CSS -> PDF"
+  s.description = "Uses wkhtmltopdf to create PDFs using HTML"
+
+  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<rake>, ["~>0.9.2"])
+  s.add_development_dependency(%q<rdoc>, ["~> 4.0.1"])
+  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/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>