shrimp 0.0.1 → 0.0.2

data/ChangeLog.md

@@ -0,0 +1,9 @@
+## ChangeLog
+
+2012-12-18: Version 0.0.2
+    Improved Error handling
+    Improved Readme
+    Minor Bug fixes
+
+2012-12-17: Version 0.0.1
+    Initial launch.

data/README.md

@@ -1,5 +1,5 @@
 # Shrimp
-
+[![Build Status](https://travis-ci.org/adeven/shrimp.png?branch=master)](https://travis-ci.org/adeven/shrimp)
 Creates PDFs from URLs using phantomjs
 
 ## Installation
@@ -24,14 +24,16 @@ Or install it yourself as:
 ## Usage
 
 ```
+require 'shrimp'
 url     = 'http://www.google.com'
 options = { :margin => "1cm"}
-Phantomjs::Phantomjs.new(url, options).to_pdf("/output.pdf")
+Shrimp::Phantom.new(url, options).to_pdf("~/output.pdf")
 ```
 ## Configuration
 
 ```
 Shrimp.configure do |config|
+
   # The path to the phantomjs executable
   # defaults to `where phantomjs`
   # config.phantomjs = '/usr/local/bin/phantomjs'
@@ -42,8 +44,8 @@ Shrimp.configure do |config|
 
   # the default margin
   # config.margin           = '1cm'
-  # the zoom factor
 
+  # the zoom factor
   # config.zoom             = 1
 
   # the page orientation 'portrait' or 'landscape'
@@ -52,11 +54,13 @@ Shrimp.configure do |config|
   # a temporary dir used to store tempfiles
   # config.tmpdir           = Dir.tmpdir
 
-  # the timeout for phantomjs rendering process
-  # rendering_timeout       = 90000
-
-  # the default rendering time
+  # the default rendering time in ms
+  # increase if you need to render very complex pages
   # config.rendering_time   = 1000
+
+  # the timeout for the phantomjs rendering process in ms
+  # this needs always to be higher than rendering_time
+  # config.rendering_timeout       = 90000
 end
 ```
 
@@ -76,7 +80,7 @@ Shrimp comes with a middleware that allows users to get a PDF view of any page o
 
     # in application.rb(Rails3) or environment.rb(Rails2)
     require 'shrimp'
-    config.middleware.use PDFKit::Middleware
+    config.middleware.use Shrimp::Middleware
 
 **With Shrimp options**
 
@@ -109,9 +113,9 @@ you can setup the polling interval and the polling offset in seconds.
 
 ### Caching
 
-To avoid rendering the page on each request you can setup some the cache ttl on seconds
+To avoid rendering the page on each request you can setup some the cache ttl in seconds
 
-    config.middleware.use Shrimp::Middleware, :cache_ttl => 3600 # one hour
+    config.middleware.use Shrimp::Middleware, :cache_ttl => 3600, :out_path => "my/pdf/store"
 
 
 ### Ajax requests
@@ -126,7 +130,7 @@ To include some fancy Ajax stuff with jquery
         return window.location.assign(url);
       },
       504: function() {
-       console.log("Shit's beeing wired"
+       console.log("Shit's beeing wired")
       },
       503: function(jqXHR, textStatus, errorThrown) {
         var wait;

data/lib/shrimp/configuration.rb

@@ -1,3 +1,4 @@
+require 'tmpdir'
 module Shrimp
   class Configuration
     attr_accessor :default_options

data/lib/shrimp/phantom.rb

@@ -1,3 +1,5 @@
+require 'uri'
+require 'json'
 module Shrimp
   class NoExecutableError < StandardError
     def initialize
@@ -13,17 +15,39 @@ module Shrimp
     end
   end
 
+  class RenderingError < StandardError
+    def initialize(msg = nil)
+      super("Rendering Error: #{msg}")
+    end
+  end
 
   class Phantom
     attr_accessor :source, :configuration, :outfile
-    attr_reader :options, :cookies
+    attr_reader :options, :cookies, :result, :error
     SCRIPT_FILE = File.expand_path('../rasterize.js', __FILE__)
 
     # Public: Runs the phantomjs binary
     #
     # Returns the stdout output of phantomjs
     def run
+      @error  = nil
+      @result = `#{cmd}`
+      unless $?.exitstatus == 0
+        @error  = @result
+        @result = nil
+      end
+      @result
+    end
+
+    def run!
+      @error  = nil
       @result = `#{cmd}`
+      unless $?.exitstatus == 0
+        @error  = @result
+        @result = nil
+        raise RenderingError.new(@error)
+      end
+      @result
     end
 
     # Public: Returns the phantom rasterize command
@@ -51,7 +75,7 @@ module Shrimp
       @source  = Source.new(url_or_file)
       @options = Shrimp.configuration.default_options.merge(options)
       @cookies = cookies
-      @outfile = outfile
+      @outfile = File.expand_path(outfile) if outfile
       raise NoExecutableError.new unless File.exists?(Shrimp.configuration.phantomjs)
     end
 
@@ -60,7 +84,7 @@ module Shrimp
     #
     # Returns the path to the pdf file
     def to_pdf(path=nil)
-      @outfile = path
+      @outfile = File.expand_path(path) if path
       self.run
       @outfile
     end
@@ -79,8 +103,22 @@ module Shrimp
     #
     # Returns the binary string of the pdf
     def to_string(path=nil)
-      self.to_pdf(path)
-      File.open(path).read
+      File.open(self.to_pdf(path)).read
+    end
+
+    def to_pdf!(path=nil)
+      @outfile = File.expand_path(path) if path
+      self.run!
+      @outfile
+    end
+
+    def to_file!(path=nil)
+      self.to_pdf!(path)
+      File.new(@outfile)
+    end
+
+    def to_string!(path=nil)
+      File.open(self.to_pdf!(path)).read
     end
 
     private

data/lib/shrimp/rasterize.js

@@ -54,8 +54,14 @@ if (system.args.length < 3 || system.args.length > 10) {
       if (fs.exists(output)) {
         fs.remove(output);
       }
-      fs.touch(output);
-      phantom.exit();
+      try {
+        fs.touch(output);
+      }
+      catch (e) {
+        phantom.exit(1);
+        throw e
+      }
+      phantom.exit(1);
     } else {
       window.setTimeout(function () {
         page.render(output + '_tmp.pdf');
@@ -64,7 +70,13 @@ if (system.args.length < 3 || system.args.length > 10) {
           fs.remove(output);
         }
 
-        fs.move(output + '_tmp.pdf', output);
+        try {
+          fs.move(output + '_tmp.pdf', output);
+        }
+        catch (e) {
+          phantom.exit(1);
+          throw e
+        }
         console.log('rendered to: ' + output, new Date().getTime());
         phantom.exit();
       }, render_time);

data/lib/shrimp/version.rb

@@ -1,3 +1,3 @@
 module Shrimp
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/shrimp.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{a phantomjs based pdf renderer}
   gem.homepage      = "http://github.com/adeven/shrimp"
   gem.files         = `git ls-files`.split($/)
+  gem.files.reject! { |fn| fn.include? "script" }
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = %w(lib)

data/spec/shrimp/phantom_spec.rb

@@ -99,4 +99,37 @@ describe Shrimp::Phantom do
       valid_pdf(@result)
     end
   end
+
+  context "Error" do
+    it "should return result nil" do
+      phantom = Shrimp::Phantom.new("file://foo/bar")
+      @result = phantom.run
+      @result.should be_nil
+    end
+
+    it "should be unable to load the address" do
+      phantom = Shrimp::Phantom.new("file:///foo/bar")
+      phantom.run
+      phantom.error.should include "Unable to load the address"
+    end
+
+    it "should be unable to copy file" do
+      phantom = Shrimp::Phantom.new("file://#{testfile}")
+      phantom.to_pdf("/foo/bar/")
+      phantom.error.should include "Unable to copy file "
+    end
+  end
+
+  context "Error Bang!" do
+
+    it "should be unable to load the address" do
+      phantom = Shrimp::Phantom.new("file:///foo/bar")
+      expect { phantom.run! }.to raise_error Shrimp::RenderingError
+    end
+
+    it "should be unable to copy file" do
+      phantom = Shrimp::Phantom.new("file://#{testfile}")
+      expect { phantom.to_pdf!("/foo/bar/") }.to raise_error Shrimp::RenderingError
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,10 +1,6 @@
-require 'URI'
-require 'json'
-require 'rack'
 require 'rack/test'
 require 'shrimp'
 
-
 RSpec.configure do |config|
   include Rack::Test::Methods
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shrimp
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-17 00:00:00.000000000 Z
+date: 2012-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70106322524180 !ruby/object:Gem::Requirement
+  requirement: &70155488162600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70106322524180
+  version_requirements: *70155488162600
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70106322523660 !ruby/object:Gem::Requirement
+  requirement: &70155488162080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70106322523660
+  version_requirements: *70155488162080
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70106322523140 !ruby/object:Gem::Requirement
+  requirement: &70155488161560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.2.0
   type: :development
   prerelease: false
-  version_requirements: *70106322523140
+  version_requirements: *70155488161560
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70106322522660 !ruby/object:Gem::Requirement
+  requirement: &70155488161080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: 0.5.6
   type: :development
   prerelease: false
-  version_requirements: *70106322522660
+  version_requirements: *70155488161080
 description: html to pdf with phantomjs
 email:
 - manuel@adeven.com
@@ -64,6 +64,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- ChangeLog.md
 - Gemfile
 - LICENSE.txt
 - README.md