shrimp 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f3a74b72ab74c2073b97e509e0d71dc3ac6dc90
-  data.tar.gz: 20c0b3d8b39e38c712cb2e4453bb17f85762de5f
+  metadata.gz: 05e0367a03f9aa8546b0b317bdb720d3370bdd36
+  data.tar.gz: ccc3e94cd1cd019a2defb5c8f63aa8c768f340c1
 SHA512:
-  metadata.gz: 045699658ee607453c27708941711b857c21a98cc0606021a12c12ebbb2cab7652c56b7104894be4162ff45f8b5e2a5acfec82b1c1d420da40c2ee90b657f683
-  data.tar.gz: 95443979c5f10a47a2026181f168ead99a6d3fc50a0406f713a23035a6334149036eef8ecc6f4deb631db41ce2cec3df9a07d7d71896040a313813a1ba164ec9
+  metadata.gz: 197abf62e9ad22f6a7ad54c14b92a401bd86a294a99d961fdcf10fcbed375c7566d10d475fb21b83c0801ba764b36dcdc69c8b6bff75817170ed77c500334783
+  data.tar.gz: 684cb4b7d4618630bd0551a6521bf3b369eef9ad28b7022f3b873e199b49b797285ec87d12dfed0c0b014239642b1a34630e866574be7d0e88d4c9e309e283c1

data/.travis.yml

@@ -1,10 +1,9 @@
 language: ruby
 rvm:
   - 1.9.3
-  - 1.9.2
-  - rbx-19mode
-  - ruby-head  
+  - rbx-2
   - 2.0.0
+  - 2.1.1
 matrix:
   allow_failures:
-    - rvm: ruby-head  
+    - rvm: rbx-2

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)
+[![Build Status](https://travis-ci.org/adjust/shrimp.png?branch=master)](https://travis-ci.org/adjust/shrimp)
 Creates PDFs from URLs using phantomjs
 
 Read our [blogpost](http://big-elephants.com/2012-12/pdf-rendering-with-phantomjs/) about how it works.
@@ -60,15 +60,20 @@ Shrimp.configure do |config|
   # increase if you need to render very complex pages
   # config.rendering_time   = 1000
 
-  # change the viewport size.  If you rendering pages that have 
+  # change the viewport size.  If you rendering pages that have
   # flexible page width and height then you may need to set this
   # to enforce a specific size
-  # config.viewport_width = 600 
-  # config.viewport_height = 600
+  # config.viewport_width     = 600
+  # config.viewport_height    = 600
 
   # the timeout for the phantomjs rendering process in ms
   # this needs always to be higher than rendering_time
-  # config.rendering_timeout       = 90000
+  # config.rendering_timeout  = 90000
+
+  # maximum number of redirects to follow
+  # by default Shrimp does not follow any redirects which means that
+  # if the server responds with non HTTP 200 an error will be returned
+  # config.max_redirect_count = 0
 
   # the path to a json configuration file for command-line options
   # config.command_config_file = "#{Rails.root.join('config', 'shrimp', 'config.json')}"
@@ -153,7 +158,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 being wired")
       },
       503: function(jqXHR, textStatus, errorThrown) {
         var wait;

data/lib/shrimp/configuration.rb

@@ -1,10 +1,11 @@
 require 'tmpdir'
+
 module Shrimp
   class Configuration
     attr_accessor :default_options
     attr_writer :phantomjs
 
-    [:format, :margin, :zoom, :orientation, :tmpdir, :rendering_timeout, :rendering_time, :command_config_file, :viewport_width, :viewport_height].each do |m|
+    [:format, :margin, :zoom, :orientation, :tmpdir, :rendering_timeout, :rendering_time, :command_config_file, :viewport_width, :viewport_height, :max_redirect_count].each do |m|
       define_method("#{m}=") do |val|
         @default_options[m]=val
       end
@@ -21,7 +22,8 @@ module Shrimp
           :rendering_time       => 1000,
           :command_config_file  => File.expand_path('../config.json', __FILE__),
           :viewport_width       => 600,
-          :viewport_height      => 600
+          :viewport_height      => 600,
+          :max_redirect_count   => 0
       }
     end
 

data/lib/shrimp/phantom.rb

@@ -28,13 +28,6 @@ module Shrimp
     attr_reader :options, :cookies, :result, :error
     SCRIPT_FILE = File.expand_path('../rasterize.js', __FILE__)
 
-    class << self
-      def quote_arg(arg)
-        # "'#{arg.gsub("'", %q(\\\'))}'"
-        "'#{arg.gsub("'", %q('"'"'))}'"
-      end
-    end
-
     # Public: Runs the phantomjs binary
     #
     # Returns the stdout output of phantomjs
@@ -65,6 +58,7 @@ module Shrimp
       format, zoom, margin, orientation = options[:format], options[:zoom], options[:margin], options[:orientation]
       rendering_time, timeout           = options[:rendering_time], options[:rendering_timeout]
       viewport_width, viewport_height   = options[:viewport_width], options[:viewport_height]
+      max_redirect_count                = options[:max_redirect_count]
       @outfile                          ||= "#{options[:tmpdir]}/#{Digest::MD5.hexdigest((Time.now.to_i + rand(9001)).to_s)}.pdf"
       command_config_file               = "--config=#{options[:command_config_file]}"
       [
@@ -81,7 +75,8 @@ module Shrimp
         rendering_time,
         timeout,
         viewport_width,
-        viewport_height
+        viewport_height,
+        max_redirect_count
       ].join(" ")
     end
 

data/lib/shrimp/rasterize.js

@@ -1,69 +1,83 @@
-var page = require('webpage').create(),
-  fs = require('fs'),
-  system = require('system'),
-  margin = system.args[5] || '0cm',
-  orientation = system.args[6] || 'portrait',
-  cookie_file = system.args[7] ,
-  render_time = system.args[8] || 10000 ,
-  time_out = system.args[9] || 90000 ,
-  viewport_width = system.args[10] || 600,
-  viewport_height= system.args[11] || 600,
+var
+  webpage = require('webpage'),
+  fs      = require('fs'),
+  system  = require('system'),
+  margin          = system.args[5] || '0cm',
+  orientation     = system.args[6] || 'portrait',
+  cookie_file     = system.args[7],
+  render_time     = system.args[8] || 10000 ,
+  time_out        = system.args[9] || 90000 ,
+  viewport_width  = system.args[10] || 600,
+  viewport_height = system.args[11] || 600,
+  redirects_num   = system.args[12] || 0,
   cookies = {},
-  address, output, size, statusCode;
+  address, output, size;
 
-window.setTimeout(function () {
-  console.log("Shit's being weird no result within: " + time_out + "ms");
+function error(msg) {
+  msg = msg || 'Unknown error';
+  console.log(msg);
   phantom.exit(1);
-}, time_out);
-
-try {
-  f = fs.open(cookie_file, "r");
-  cookies = JSON.parse(f.read());
-  fs.remove(cookie_file)
-} catch (e) {
-  console.log(e);
+  throw msg;
 }
-phantom.cookiesEnabled = true;
-phantom.cookies = cookies;
 
-if (system.args.length < 3 || system.args.length > 12) {
-  console.log('Usage: rasterize.js URL filename [paperwidth*paperheight|paperformat] [zoom] [margin] [orientation] [cookie_file] [render_time] [time_out] [viewport_width] [viewport_height]');
+function print_usage() {
+  console.log('Usage: rasterize.js URL filename [paperwidth*paperheight|paperformat] [zoom] [margin] [orientation] [cookie_file] [render_time] [time_out] [viewport_width] [viewport_height] [max_redirects_count]');
   console.log('  paper (pdf output) examples: "5in*7.5in", "10cm*20cm", "A4", "Letter"');
-  phantom.exit(1);
-} else {
-  address = system.args[1];
-  output = system.args[2];
-  page.viewportSize = { width: viewport_width, height: viewport_height };
-  if (system.args.length > 3 && system.args[2].substr(-4) === ".pdf") {
-    size = system.args[3].split('*');
-    page.paperSize = size.length === 2 ? { width:size[0], height:size[1], margin:'0px' }
-      : { format:system.args[3], orientation:orientation, margin:margin };
-  }
-  if (system.args.length > 4) {
-    page.zoomFactor = system.args[4];
+}
+
+window.setTimeout(function () {
+  error("Shit's being weird no result within: " + time_out + "ms");
+}, time_out);
+
+function renderUrl(url, output, options) {
+  options = options || {};
+
+  var statusCode,
+      page = webpage.create();
+
+  for (var k in options) {
+    if (options.hasOwnProperty(k)) {
+      page[k] = options[k];
+    }
   }
 
   // determine the statusCode
   page.onResourceReceived = function (resource) {
-    if (resource.url == address) {
+    if (resource.url == url) {
       statusCode = resource.status;
     }
   };
 
-  page.open(address, function (status) {
+  page.onResourceError = function (resourceError) {
+    error(resourceError.errorString + ' (URL: ' + resourceError.url + ')');
+  };
+
+  page.onNavigationRequested = function (redirect_url, type, willNavigate, main) {
+    if (main) {
+      if (redirect_url !== url) {
+        page.close();
+
+        if (redirects_num-- >= 0) {
+          renderUrl(redirect_url, output, options);
+        } else {
+          error(url + ' redirects to ' + redirect_url + ' after maximum number of redirects reached');
+        }
+      }
+    }
+  };
+
+  page.open(url, function (status) {
     if (status !== 'success' || (statusCode != 200 && statusCode != null)) {
-      console.log(statusCode, 'Unable to load the address!');
       if (fs.exists(output)) {
         fs.remove(output);
       }
       try {
         fs.touch(output);
+      } catch (e) {
+        console.log(e);
       }
-      catch (e) {
-        phantom.exit(1);
-        throw e
-      }
-      phantom.exit(1);
+
+      error('Unable to load the URL: ' + url + ' (HTTP ' + statusCode + ')');
     } else {
       window.setTimeout(function () {
         page.render(output + '_tmp.pdf');
@@ -74,15 +88,49 @@ if (system.args.length < 3 || system.args.length > 12) {
 
         try {
           fs.move(output + '_tmp.pdf', output);
+        } catch (e) {
+          error(e);
         }
-        catch (e) {
-            console.log(e);
-            phantom.exit(1);
-            throw e
-        }
-        console.log('rendered to: ' + output, new Date().getTime());
-        phantom.exit();
+        console.log('Rendered to: ' + output, new Date().getTime());
+        phantom.exit(0);
       }, render_time);
     }
   });
 }
+
+if (cookie_file) {
+  try {
+    f = fs.open(cookie_file, "r");
+    cookies = JSON.parse(f.read());
+    fs.remove(cookie_file);
+  } catch (e) {
+    console.log(e);
+  }
+  phantom.cookiesEnabled = true;
+  phantom.cookies = cookies;
+}
+
+if (system.args.length < 3 || system.args.length > 13) {
+  print_usage() && phantom.exit(2);
+} else {
+  address = system.args[1];
+  output  = system.args[2];
+
+  page_options = {
+    viewportSize: {
+      width:  viewport_width,
+      height: viewport_height
+    }
+  };
+
+  if (system.args.length > 3 && system.args[2].substr(-4) === ".pdf") {
+    size = system.args[3].split('*');
+    page_options.paperSize = size.length === 2 ? { width:size[0], height:size[1], margin:'0px' }
+      : { format:system.args[3], orientation:orientation, margin:margin };
+  }
+  if (system.args.length > 4) {
+    page_options.zoomFactor = system.args[4];
+  }
+
+  renderUrl(address, output, page_options);
+}

data/lib/shrimp/version.rb

@@ -1,3 +1,3 @@
 module Shrimp
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/shrimp/phantom_spec.rb

@@ -58,10 +58,11 @@ describe Shrimp::Phantom do
   end
 
   it "should parse options into a cmd line" do
-    phantom = Shrimp::Phantom.new("file://#{testfile}", { :margin => "2cm" }, { }, "#{Dir.tmpdir}/test.pdf")
+    phantom = Shrimp::Phantom.new("file://#{testfile}", { :margin => "2cm", :max_redirect_count => 10 }, { }, "#{Dir.tmpdir}/test.pdf")
     phantom.cmd.should include "test.pdf A4 1 2cm portrait"
     phantom.cmd.should include "file://#{testfile}"
     phantom.cmd.should include "lib/shrimp/rasterize.js"
+    phantom.cmd.should end_with " 10"
   end
 
   it "should properly escape arguments" do
@@ -130,7 +131,7 @@ describe Shrimp::Phantom do
     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"
+      phantom.error.should include "Error opening /foo/bar: No such file or directory (URL: file:///foo/bar)"
     end
 
     it "should be unable to copy file" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrimp
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Manuel Kniep
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-21 00:00:00.000000000 Z
+date: 2014-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json