phantompdf 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17ce8d8da194279be8c3578a6229421e12ac9312
+  data.tar.gz: 1ced8f6dac53b42f7362c6f407ebaf4d00a67e65
+SHA512:
+  metadata.gz: 6eefd81192554a6ad80b75ee9324f0ad48007637bcf1089eb6c6f4862dabec47bcd9257a99da223dc554b56f6558af20b8e3624124859ef45f3adf4f9d805089
+  data.tar.gz: f36cfcce568fcd1e6ff266f6036d7820153504442be8be4d33ae8b9de16d9993644a51c5778215f21f3112dbdcb5c4c98324868181f3261c2a1012976d0261da

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# using phantompdf.gemspec to specify dependencies
+gemspec

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    phantompdf (1.0.0)
+      json
+      phantomjs
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    Ascii85 (1.0.2)
+    afm (0.2.0)
+    byebug (2.0.0)
+      columnize (~> 0.3.6)
+      debugger-linecache (~> 1.2.0)
+    capybara (1.1.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    columnize (0.3.6)
+    debugger-linecache (1.2.0)
+    diff-lcs (1.2.4)
+    eventmachine (1.0.3)
+    faye-websocket (0.4.7)
+      eventmachine (>= 0.12.0)
+    ffi (1.9.0)
+    hashery (2.1.1)
+    http_parser.rb (0.5.3)
+    json (1.8.0)
+    mime-types (1.24)
+    mini_portile (0.5.1)
+    multi_json (1.7.9)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    pdf-reader (1.3.3)
+      Ascii85 (~> 1.0.0)
+      afm (~> 0.2.0)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
+    phantomjs (1.8.1.1)
+      poltergeist
+    poltergeist (1.0.3)
+      capybara (~> 1.1)
+      childprocess (~> 0.3)
+      faye-websocket (~> 0.4.4)
+      http_parser.rb (~> 0.5.3)
+      multi_json (~> 1.0)
+    rack (1.4.5)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.1.0)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    ruby-rc4 (0.1.5)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.35.0)
+      childprocess (>= 0.2.5)
+      multi_json (~> 1.0)
+      rubyzip
+      websocket (~> 1.0.4)
+    ttfunk (1.0.3)
+    websocket (1.0.7)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  pdf-reader
+  phantompdf!
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Mc.Spring
+
+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/README.md

@@ -0,0 +1,146 @@
+## PhantomPDF
+
+Generate PDF from HTML using PhantomJS!
+
+Supporting *URL*, *FILE* and *STRING* formats for HTML resource.
+
+## Why PhantomPDF?
+
+Within the Ruby community, there is no simply way to generate *PDF* from *HTML*. You must setup dependences separate and then call some wrapped methods around. When you manage several servers or need to do migrations around, things become much more terrible!
+
+PhantomPDF was born to simplify those. It brings simple API and easy maintenance.
+
+**Yes, PhantomPDF is simply!** You only need to take care of your HTML layout. And then put remaining work to PhantomPDF.
+
+## How to start?
+
+### Installation
+
+##### For Gemfile project
+Adding following to your `Gemfile`
+
+```ruby
+gem 'phantompdf'
+```
+
+and then execute
+
+```ruby
+$ bundle
+```
+
+##### For normal project
+```ruby
+$ gem install phantompdf
+```
+
+That's all! Pretty simple?!
+
+### Usage
+
+##### Quick starts
+```ruby
+require 'phantompdf'
+
+options = {
+  :format => 'A4',
+  :margin => '1cm'
+}
+output_file = '/tmp/phantompdf_google.pdf'
+
+# for *URL* resource
+url = 'http://www.google.com'
+url_generator = PhantomPDF::Generator.new(url, output_file, options)
+returned_file = url_generator.generate  # If output_file is valid(writable) returned_file == output_file, otherwise returned_file should be temp file of your OS.
+
+# for *FILE* resource
+file = 'file://path/to/file.html'
+file_generator = PhantomPDF::Generator.new(file, output_file, options)
+returned_file = file_generator.generate
+
+# for *STRING* resource
+html = '<h1>Hello, PhantomPDF!</h1>'
+html_generator = PhantomPDF::Generator.new(html, output_file, options)
+returned_file = html_generator.generate
+
+# want to dynamic output?
+url_generator.generate('/tmp/dynamic_phantompdf_google.pdf')  # This will output pdf file to /tmp/dynamic_phantompdf_google.pdf though you pass *output* arg when creating generator instance.
+```
+
+##### Configuration
+You can configure PhantomPDF globally in your project, such as Rails' initializers principle.
+
+```ruby
+PhantomPDF.configure do |config|
+  # default pdf output format, e.g. "5in*7.5in", "10cm*20cm", "A4", "Letter"
+  :format            => 'A4',
+
+  # default pdf header, formatted in [headerHeight*]headerString(HTML is supported)
+  # default to 1.2cm when you omit headerHeight
+  # you can use *%{pageNum}* and *%{pageTotal}* to refer current values of page
+  # example: 1.2cm*<h5>PhantomPDF header %{pageNum}/%{pageTotal}
+  :header            => nil,
+
+  # default pdf footer, formatted in footerHeight*footerString(HTML is supported)
+  # you can use *%{pageNum}* and *%{pageTotal}* to refer current values of page
+  # example: 0.6cm*<h5>PhantomPDF header %{pageNum}/%{pageTotal}
+  :footer            => nil,
+
+  # default page margin
+  :margin            => '1cm',
+
+  # default page orientation, 'portrait' or 'landscape'
+  :orientation       => 'portrait',
+
+  # default page zoom factor
+  :zoom              => 1,
+
+  # default cookies, only used for *URL* resource
+  :cookies           => {},
+
+  # PhantomJS running timeout
+  :timeout           => 90000,
+
+  # pdf rendering timeout, increase if your HTML page is big
+  :rendering_timeout => 1000
+end
+```
+
+You can also configure PhantomPDF in place when needs.
+
+```ruby
+# for *URL* resource
+url = 'http://www.google.com'
+url_generator = PhantomPDF::Generator.new(url, output_file, options)
+url_generator.options.header = '0.8cm*<h3>Configure PhantomPDF dynamic</h3>'
+returned_file = url_generator.generate
+```
+
+##### APIs
+```ruby
+# create PhantomPDF
+PhantomPDF::Generator.new(input, output=nil, options={})
+
+# generate pdf
+PhantomPDF::Generator#generate(output=>nil)
+
+# raise PhantomPDF::RenderingError when failed to generate pdf
+PhantomPDF::Generator#generate!(output=>nil)
+
+# get generated pdf as string
+PhantomPDF::Generator#to_string
+```
+
+### Contributing
+If you'd like to help improve PhantomPDF or you find some bugs. You can contribute to it by following:
+
+- Submit an issue describing your problem
+- Fork your repo and work your magic
+- Test your code as far as possible
+- Submit a pull request when you finished hack
+
+### License
+PhantomPDF is released under [MIT license](http://www.opensource.org/licenses/MIT).
+
+### Authors
+[Spring MC](https://twitter.com/mcspring)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
+

data/lib/phantompdf/assets.rb

@@ -0,0 +1,20 @@
+module PhantomPDF
+  class Assets
+    attr_accessor :root, :javascripts
+
+    class << self
+      def root
+        @root ||= File.expand_path('../../../', __FILE__)
+      end
+
+      def javascripts(name)
+        @javascripts ||= {}
+
+        @javascripts[name] ||= "#{root}/vendor/assets/javascripts/#{name}.js"
+        @javascripts[name] = nil unless File.exist?(@javascripts[name])
+
+        @javascripts[name]
+      end
+    end
+  end
+end

data/lib/phantompdf/config.rb

@@ -0,0 +1,32 @@
+module PhantomPDF
+  class Config
+    attr_accessor :default_options
+    attr_reader :phantomjs
+
+    def initialize(options={})
+      @default_options = {
+        :format            => 'A4',
+        :header            => nil,
+        :footer            => nil,
+        :margin            => '1cm',
+        :orientation       => 'portrait',
+        :zoom              => 1,
+        :cookies           => {},
+        :timeout           => 90000,
+        :rendering_timeout => 1000
+      }
+
+      @default_options.merge! options || {}
+    end
+
+    def phantomjs
+      @phantomjs ||= ::Phantomjs.path
+    end
+
+    [:format, :header, :footer, :margin, :orientation, :zoom, :cookies, :timeout, :rendering_timeout].each do |key|
+      define_method("#{key}=") do |val|
+        @default_options[key] = val
+      end
+    end
+  end
+end

data/lib/phantompdf/error.rb

@@ -0,0 +1,7 @@
+module PhantomPDF
+  class Error < StandardError; end
+  class SourceTypeError < Error; end
+  class DestinationTypeError < Error; end
+  class DestinationPermitError < Error; end
+  class RenderingError < Error; end
+end

data/lib/phantompdf/generator.rb

@@ -0,0 +1,104 @@
+require 'uri'
+require 'json'
+require 'tempfile'
+
+module PhantomPDF
+  class Generator
+    attr_accessor :input, :output, :config
+    attr_reader :options, :cookies, :exception
+
+    def initialize(input, output=nil, options={})
+      @input = Source.new(input)
+      @output = dump_output(output, !output.nil?)
+      @options = Config.new(options).default_options
+      @exception = nil
+    end
+
+    def generate(path=nil)
+      @output = dump_output(path, true) unless path.nil?
+
+      result = run
+      unless $?.exitstatus == 0
+        @exception = result.split(/\n/)
+
+        return nil
+      end
+
+      result.strip
+    end
+
+    def generate!(path=nil)
+      result = generate(path)
+      raise RenderingError.new(@exception.join("\n")) if result.nil?
+
+      result
+    end
+
+    def to_string
+      result = generate(nil)
+      return '' if result.nil?
+
+      File.open(result, 'rb').read
+    end
+
+  protected
+    def run
+      ::Phantomjs.run(*dump_args)
+    end
+
+    def dump_output(path, strict)
+      if strict
+        raise DestinationTypeError.new('Destination must be a valid file path!') unless path.is_a?(String)
+        path = File.expand_path(path)
+        raise DestinationPermitError.new('Destination does not writable!') unless File.writable?(File.dirname(path))
+      else
+        path = path.is_a?(String) ? File.expand_path(path) : nil
+        path = Tempfile.new('temp_pdf_file').path if path.nil? || !File.writable?(File.dirname(path))
+      end
+
+      path
+    end
+
+    def dump_args
+      format, header, footer = options[:format], options[:header], options[:footer]
+      zoom, margin, orientation = options[:zoom], options[:margin], options[:orientation]
+      rendering_timeout, timeout = options[:rendering_timeout], options[:timeout]
+      cookie_file = dump_cookies(options[:cookies])
+
+      [Assets.javascripts('rasterize'),
+       @input.to_s,
+       @output,
+       format, dump_header(header), dump_footer(footer),
+       margin, orientation, zoom,
+       cookie_file,
+       rendering_timeout, timeout].map(&:to_s)
+    end
+
+    def dump_header(header)
+      return nil if header.nil? || header.empty?
+
+      return "1.2cm*#{header}" unless header.split('*')[0].to_f > 0
+
+      header
+    end
+
+    def dump_footer(footer)
+      return nil if footer.nil? || footer.empty?
+
+      return "0.7cm*#{header}" unless footer.split('*')[0].to_f > 0
+
+      footer
+    end
+
+    def dump_cookies(cookies)
+      cookie_host = @input.url? ? URI::parse(@input.to_s).host : '/'
+
+      cookie_json = cookies.inject([]) {|ck, (k, v)| ck.push({:name => k, :value => v, :domain => cookie_host}); ck}.to_json
+      return nil if cookie_json.empty?
+
+      cookie_file = Tempfile.new('temp_cookie_file')
+      cookie_file.write(cookie_json)
+      cookie_file.path
+    end
+  end
+end

data/lib/phantompdf/middleware.rb

@@ -0,0 +1,46 @@
+module PhantomPDF
+  class Middleware
+    REGEXP_PDF = /\.pdf\z/i
+
+    def initialize(app, output=nil)
+      @app = app
+      @output = output
+    end
+
+    def call(env)
+      @request = Rack::Request.new(env)
+
+      return @app.call(env) unless request_pdf?
+
+      status, headers, response = @app.call(env)
+      return [status, headers, response] if status != 200 || headers['Content-Type'] != 'text/html'
+
+      response_body = render_pdf(response.first)
+
+      headers.merge!({
+        'Content-Type' => 'application/pdf',
+        'Content-Length' => response_body.size.to_s
+      })
+
+      [200, headers, [response_body]]
+    end
+
+  private
+    def render_pdf(html)
+      Generator.new(html, render_path).to_string
+    end
+
+    def render_path
+      file_name = "#{Digest::MD5.hexdigest(@request.path)}.pdf"
+
+      return Tempfile.new(file_name).path if @output.nil? || !File.directory?(@output) || !File.writable?(@output)
+
+      "#{@output}/#{file_name}"
+    end
+
+    def request_pdf?
+      return true if @request.path.match(Middleware::REGEXP_PDF)
+      false
+    end
+  end
+end

data/lib/phantompdf/source.rb

@@ -0,0 +1,35 @@
+require 'uri'
+
+module PhantomPDF
+  class Source
+    def initialize(src)
+      @source = src
+
+      raise SourceTypeError.new('Unsupported source type.') unless valid?
+    end
+
+    def url?
+      !URI.parse(@source).scheme.nil?
+    rescue
+      false
+    end
+
+    def file?
+      !url? && (@source.kind_of?(File) || File.exists?(@source))
+    end
+
+    def html?
+      !(url? || file?)
+    end
+
+    def valid?
+      url? || file? || html?
+    end
+
+    def to_s
+      return @source if url? || html?
+
+      @source.kind_of?(File) ? @source.path : @source
+    end
+  end
+end

data/lib/phantompdf/version.rb

@@ -0,0 +1,3 @@
+module PhantomPDF
+  VERSION = "1.0.0"
+end

data/lib/phantompdf.rb

@@ -0,0 +1,36 @@
+require 'phantompdf/version'
+require 'phantompdf/error'
+require 'phantompdf/assets'
+require 'phantompdf/source'
+require 'phantompdf/config'
+require 'phantompdf/generator'
+require 'phantompdf/middleware'
+
+module PhantomPDF
+  # Configure PhantomPDF someplace sensible,
+  # like config/initializers/phantompdf.rb
+  #
+  # @example
+  #   PhantomPDF.configure do |config|
+  #     config.format            = 'A4',
+  #     config.header            = nil,
+  #     config.footer            = nil,
+  #     config.margin            = '1cm',
+  #     config.orientation       = 'portrait',
+  #     config.zoom              = 1,
+  #     config.cookies           = {},
+  #     config.timeout           = 90000,
+  #     config.rendering_timeout = 1000
+  #   end
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Config.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/phantompdf.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+phantompdf_lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(phantompdf_lib) unless $LOAD_PATH.include?(phantompdf_lib)
+
+require 'phantompdf/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'phantompdf'
+  spec.version = PhantomPDF::VERSION
+  spec.authors = ['Spring MC']
+  spec.email = %w(Heresy.Mc@gmail.com)
+  spec.description = %q{Generate PDF from HTML using PhantomJS}
+  spec.summary = %q{A PhantomJS based PDF generator}
+  spec.homepage = 'https://github.com/mcspring/phantompdf'
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w(lib)
+  spec.add_runtime_dependency 'phantomjs'
+  spec.add_runtime_dependency 'json'
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pdf-reader'
+  spec.add_development_dependency 'byebug'
+end

data/spec/fixtures/phantompdf.html

@@ -0,0 +1,23 @@
+<html>
+<head></head>
+<body>
+    <header>
+      <h1>Hello PhantomPDF!</h1>
+    </header>
+    <section>
+      <div>
+        <p>
+          This is a HTML file used for PhantomPDF testing.
+        </p>
+      </div>
+    </section>
+    <footer>
+      <div>
+        <p>
+          For more, please visit <a href="https://github.com/mcspring/phantompdf" title="Generate PDF from HTML using Phantomjs" target="_blank">https://github.com/mcspring/phantompdf</a>
+        </p>
+      </div>
+    </footer>
+</body>
+</html>
+

data/spec/phantompdf/assets_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+module PhantomPDF
+  describe Assets do
+    context ".root" do
+      it "should return vendor folder" do
+        File.directory?(Assets.root).should be_true
+      end
+    end
+
+    context ".javascripts" do
+      it "should return rasterize.js abs path" do
+        File.exist?(Assets.javascripts('rasterize')).should be_true
+      end
+
+      it "should return nil for un-existed file" do
+        Assets.javascripts('un-exist-javascript').should be_nil
+      end
+    end
+  end
+end

data/spec/phantompdf/config_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module PhantomPDF
+  describe Config do
+    before do
+      @config = Config.new
+    end
+
+    context "#phantomjs" do
+      it "should respond to :phantomjs" do
+        @config.should respond_to(:phantomjs)
+      end
+
+      it "should return phantomjs bin path" do
+        @config.phantomjs.should == Phantomjs.path
+      end
+    end
+
+    [:format, :header, :footer, :margin, :zoom, :orientation, :cookies, :timeout, :rendering_timeout].each do |method|
+      method = :"#{method}="
+
+      it "should respond to #{method}" do
+        @config.should respond_to(method)
+      end
+    end
+  end
+end

data/spec/phantompdf/generator_spec.rb

@@ -0,0 +1,128 @@
+require 'spec_helper'
+
+module PhantomPDF
+  describe Generator do
+    let(:fixtures_root) {
+      File.expand_path('../../fixtures', __FILE__)
+    }
+
+    subject { Generator.new("#{fixtures_root}/phantompdf.html") }
+
+    context "attributes" do
+      [:input, :output, :config].each do |rwattr|
+        it { should respond_to(rwattr) }
+        it { should respond_to("#{rwattr}=".to_sym) }
+      end
+
+      [:options, :cookies, :exception].each do |rattr|
+        it { should respond_to(rattr) }
+        it { should_not respond_to("#{rattr}=") }
+      end
+    end
+
+    context "#generate" do
+      fixtures_root = File.expand_path('../../fixtures', __FILE__)
+
+      {
+        url: 'http://www.google.com',
+        file: "#{fixtures_root}/phantompdf.html",
+        html: File.read("#{fixtures_root}/phantompdf.html")
+      }.each do |key, value|
+        context "with #{key}" do
+          it "should works" do
+            Generator.new(value).generate.should be_pdf_file
+          end
+        end
+      end
+
+      context "with output" do
+        before :all do
+          @url = 'http://www.google.com'
+          @file = '/tmp/google.pdf'
+        end
+
+        after :each do
+          File.exist?(@file) && File.unlink(@file)
+        end
+
+        it "should generate pdf file following :output" do
+          File.exist?(@file).should be_false
+          Generator.new(@url, @file).generate
+          File.exist?(@file).should be_true
+
+          @file.should be_pdf_file
+        end
+
+        it "should raise PhantomPDF::DestinationTypeError when :output is not a string" do
+          expect{
+            Generator.new(@url, Object.new)
+          }.to raise_error(PhantomPDF::DestinationTypeError)
+        end
+
+        it "should raise PhantomPDF::DestinationPermitError when :output is not writable" do
+          File.stub(:writable?, '/tmp') { false }
+
+          expect{
+            Generator.new(@url, @file)
+          }.to raise_error(PhantomPDF::DestinationPermitError)
+        end
+      end
+
+      context "with options for pdf format" do
+        before :all do
+          @url = 'http://www.google.com'
+          @file = '/tmp/google.pdf'
+        end
+
+        after :each do
+          File.exist?(@file) && File.unlink(@file)
+        end
+
+        pending "should support custom :header" do
+          header = 'Hello, PhantomPDF header!'
+
+          Generator.new(@url, @file, {:header => header}).generate
+
+          pdf_content = PDF::Reader.new(@file).page(1).text
+          pdf_content.should include(header)
+        end
+
+        pending "should support custom :footer" do
+          header = 'Hello, PhantomPDF footer!'
+
+          Generator.new(@url, @file, {:footer => header}).generate
+
+          pdf_content = PDF::Reader.new(@file).page(1).text
+          pdf_content.should include(header)
+        end
+      end
+    end
+
+    context "#generate!" do
+      before :all do
+        @url = 'http://www.google.com'
+      end
+
+      it "should raise PhantomPDF::RenderingError when failed to generate" do
+        $?.stub(:exitstatus) { 1 }
+
+        generator = Generator.new(@url)
+        generator.stub(:run) { 'rendering error' }
+
+        expect{
+          generator.generate!
+        }.to raise_error(PhantomPDF::RenderingError)
+      end
+    end
+
+    context "#to_string" do
+      before :all do
+        @url = 'http://www.google.com'
+      end
+
+      it "should return string" do
+        Generator.new(@url).to_string.should be_pdf_string
+      end
+    end
+  end
+end

data/spec/phantompdf/middleware_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module PhantomPDF
+  describe Middleware do
+    include Rack::Test::Methods
+
+    let(:page) { File.read File.expand_path('../../fixtures/phantompdf.html', __FILE__) }
+    let(:phantompdf) do
+      lambda {|env| [200, {'Content-Type' => 'text/html', 'Content-Length' => page.size.to_s}, [page]]}
+    end
+    let(:app) { Middleware.new(phantompdf, '/tmp') }
+
+    it "should works" do
+      get '/index.pdf'
+
+      last_response.status.should == 200
+      last_response.body.should be_pdf_string
+    end
+
+    it "should respond with original data without PDF request" do
+      get '/'
+
+      last_response.status.should == 200
+      last_response.body.should_not be_pdf_string
+    end
+  end
+end

data/spec/phantompdf/source_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+module PhantomPDF
+  describe Source do
+    before do
+      @url = ['http://www.test.com', 'file://tmp/phantompdf.html', 'ftp://phantompdf:passwd@test.com/phantompdf.html'].sample
+      @file = File.expand_path('../../fixtures/phantompdf.html', __FILE__)
+      @html = File.read(@file)
+
+      @url_source = Source.new(@url)
+      @file_source = Source.new(@file)
+      @html_source = Source.new(@html)
+    end
+
+    context "#url?" do
+      it "should return true for url" do
+        @url_source.url?.should be_true
+      end
+
+      it "should return false for file" do
+        @file_source.url?.should be_false
+      end
+
+      it "should return false for html" do
+        @html_source.url?.should be_false
+      end
+    end
+
+    context "#file?" do
+      it "should return false for url" do
+        @url_source.file?.should be_false
+      end
+
+      it "should return true for file" do
+        @file_source.file?.should be_true
+      end
+
+      it "should return false for html" do
+        @html_source.file?.should be_false
+      end
+
+      it "should return false if file does not exist" do
+        Source.new('path/to/unexisted/file').file?.should be_false
+      end
+    end
+
+    context "#html?" do
+      it "should return false for url" do
+        @url_source.html?.should be_false
+      end
+
+      it "should return false for file" do
+        @file_source.html?.should be_false
+      end
+
+      it "should return true for html" do
+        @html_source.html?.should be_true
+      end
+    end
+
+    context "#valid?" do
+      it "should return true for url" do
+        @url_source.valid?.should be_true
+      end
+
+      it "should return true for file" do
+        @file_source.valid?.should be_true
+      end
+
+      it "should return true for html" do
+        @html_source.valid?.should be_true
+      end
+    end
+
+    context "#to_s" do
+      it "should return url for url source" do
+        @url_source.to_s.should == @url
+      end
+
+      it "should return file path for file source" do
+        @file_source.to_s.should == @file
+      end
+
+      it "should return html string for html source" do
+        @html_source.to_s.should == @html
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'phantomjs'
+require 'phantompdf'
+require 'pdf-reader'
+require 'byebug'
+
+require 'rack/test'
+
+RSpec.configure do |config|
+  # some staff goes here
+end
+
+RSpec::Matchers.define :be_pdf_file do
+  match do |actual|
+    case actual
+    when File
+      actual.read[0...4] == '%PDF'
+    when String
+      File.exist?(actual) && File.open(actual).read[0...4] == '%PDF'
+    end
+  end
+end
+
+RSpec::Matchers.define :be_pdf_string do
+  match do |actual|
+    actual[0...4] == '%PDF'
+  end
+end

data/vendor/assets/javascripts/rasterize.js

@@ -0,0 +1,148 @@
+var page = require('webpage').create(),
+    fs = require('fs'),
+    system = require('system'),
+    system_args_length = system.args.length;
+if (system_args_length < 3 || system_args_length > 12) {
+  console.log('Usage: phantomjs rasterize.js SOURCE DESTINATION [paperWidth*paperHeight|paperFormat] [header] [footer] [margin] [orientation] [zoom] [cookie_file] [render_timeout] [timeout]');
+  console.log('     : paper (pdf output) examples: "5in*7.5in", "10cm*20cm", "A4", "Letter"');
+  phantom.exit(1);
+}
+
+var input = system.args[1],
+    output = system.args[2],
+
+    margin = system.args[6] || '0cm',
+    orientation = system.args[7] || 'portrait',
+    zoom = system.args[8] || '1.0',
+
+    cookie_file = system.args[9],
+    cookies = {},
+
+    render_timeout = system.args[10] || 10000,
+    timeout = system.args[11] || 90000;
+
+window.setTimeout(function () {
+  console.log("Shit's being weird no result within " + timeout + "ms");
+  phantom.exit(1);
+}, timeout);
+
+page.viewportSize = { width:600, height:600 };
+if (output.substr(-4) === '.pdf') {
+  var size, header, footer,
+      paper_size_options = {};
+  if (system_args_length > 3) {
+    size = system.args[3].split('*');
+    paper_size_options = size.length === 2 ? {width:size[0], height:size[1], margin:'0px'} : {format:system.args[3], orientation:orientation, margin:margin};
+  }
+
+  if (system_args_length > 4) {
+    header = system.args[4].split('*');
+    if (header.length >= 2) {
+      paper_size_options['header'] = {
+        height: header.shift(),
+        contents: phantom.callback(function(pageNum, pageTotal){
+          return header.join('*').replace(new RegExp('%{pageNum}', 'g'), pageNum).replace(new RegExp('%{pageTotal}', 'g'), pageTotal);
+        })
+      };
+    }
+  }
+
+  if (system_args_length > 5) {
+    footer = system.args[5].split('*');
+    if (footer.length >= 2) {
+      paper_size_options['footer'] = {
+        height: footer.shift(),
+        contents: phantom.callback(function(pageNum, pageTotal){
+          return footer.join('*').replace(new RegExp('%{pageNum}', 'g'), pageNum).replace(new RegExp('%{pageTotal}', 'g'), pageTotal);
+        })
+      };
+    }
+  }
+
+  page.paperSize = paper_size_options;
+}
+page.zoomFactor = zoom;
+
+if (/<([a-z]+?\d*?).*?>[^\0]*?<\/\1>/i.test(input) === true) {
+  page.content = input;
+
+  window.setTimeout(function () {
+    page.render(output + '_tmp.pdf');
+
+    if (fs.exists(output)) {
+      fs.remove(output);
+    }
+
+    try {
+      fs.move(output + '_tmp.pdf', output);
+
+      console.log(output);
+    } catch (e) {
+      phantom.exit(1);
+      throw e;
+    }
+
+    phantom.exit();
+  }, render_timeout);
+} else {
+  var statusCode = null;
+
+  if (cookie_file) {
+    try {
+      fd = fs.open(cookie_file, 'r');
+      cookies = JSON.parse(fd.read());
+      fs.remove(cookie_file);
+
+
+      phantom.cookiesEnabled = true;
+      phantom.cookies = cookies;
+    } catch (e) {
+      // console.log(e);
+    }
+  }
+
+  // determine the statusCode
+  page.onResourceReceived = function (resource) {
+    if (new RegExp('^'+input).test(resource.url)) {
+      statusCode = resource.status;
+    }
+  };
+
+  page.open(input, function (status) {
+    if (status !== 'success' || (statusCode !== null && statusCode != 200)) {
+      console.log(statusCode, 'Failed to load the input!');
+
+      if (fs.exists(output)) {
+        fs.remove(output);
+      }
+
+      try {
+        fs.touch(output);
+      } catch (e) {
+        phantom.exit(1);
+        throw e;
+      }
+
+      phantom.exit(1);
+    } else {
+      window.setTimeout(function () {
+        page.render(output + '_tmp.pdf');
+
+        if (fs.exists(output)) {
+          fs.remove(output);
+        }
+
+        try {
+          fs.move(output + '_tmp.pdf', output);
+
+          console.log(output);
+        } catch (e) {
+          phantom.exit(1);
+          throw e;
+        }
+
+        phantom.exit();
+      }, render_timeout);
+    }
+  });
+}

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: phantompdf
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Spring MC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: phantomjs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pdf-reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate PDF from HTML using PhantomJS
+email:
+- Heresy.Mc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- NEWS.md
+- README.md
+- Rakefile
+- lib/phantompdf.rb
+- lib/phantompdf/assets.rb
+- lib/phantompdf/config.rb
+- lib/phantompdf/error.rb
+- lib/phantompdf/generator.rb
+- lib/phantompdf/middleware.rb
+- lib/phantompdf/source.rb
+- lib/phantompdf/version.rb
+- phantompdf.gemspec
+- spec/fixtures/phantompdf.html
+- spec/phantompdf/assets_spec.rb
+- spec/phantompdf/config_spec.rb
+- spec/phantompdf/generator_spec.rb
+- spec/phantompdf/middleware_spec.rb
+- spec/phantompdf/source_spec.rb
+- spec/spec_helper.rb
+- vendor/assets/javascripts/rasterize.js
+homepage: https://github.com/mcspring/phantompdf
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A PhantomJS based PDF generator
+test_files:
+- spec/fixtures/phantompdf.html
+- spec/phantompdf/assets_spec.rb
+- spec/phantompdf/config_spec.rb
+- spec/phantompdf/generator_spec.rb
+- spec/phantompdf/middleware_spec.rb
+- spec/phantompdf/source_spec.rb
+- spec/spec_helper.rb