shrimp 0.0.3 → 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f3a74b72ab74c2073b97e509e0d71dc3ac6dc90
+  data.tar.gz: 20c0b3d8b39e38c712cb2e4453bb17f85762de5f
+SHA512:
+  metadata.gz: 045699658ee607453c27708941711b857c21a98cc0606021a12c12ebbb2cab7652c56b7104894be4162ff45f8b5e2a5acfec82b1c1d420da40c2ee90b657f683
+  data.tar.gz: 95443979c5f10a47a2026181f168ead99a6d3fc50a0406f713a23035a6334149036eef8ecc6f4deb631db41ce2cec3df9a07d7d71896040a313813a1ba164ec9

data/.travis.yml

@@ -2,12 +2,9 @@ language: ruby
 rvm:
   - 1.9.3
   - 1.9.2
-  - jruby-19mode
   - rbx-19mode
   - ruby-head  
   - 2.0.0
 matrix:
   allow_failures:
-    - rvm: 
-      - ruby-head  
-      - 2.0.0
+    - rvm: ruby-head  

data/README.md

@@ -19,9 +19,9 @@ Or install it yourself as:
     $ gem install shrimp
 
 
-### pantomjs
+### Phantomjs
 
-    See http://phantomjs.org/download.html on how to install phatomjs
+    See http://phantomjs.org/download.html on how to install phantomjs
 
 ## Usage
 
@@ -60,6 +60,12 @@ 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 
+  # 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
+
   # the timeout for the phantomjs rendering process in ms
   # this needs always to be higher than rendering_time
   # config.rendering_timeout       = 90000

data/lib/shrimp/configuration.rb

@@ -4,7 +4,7 @@ module Shrimp
     attr_accessor :default_options
     attr_writer :phantomjs
 
-    [:format, :margin, :zoom, :orientation, :tmpdir, :rendering_timeout, :rendering_time, :command_config_file].each do |m|
+    [:format, :margin, :zoom, :orientation, :tmpdir, :rendering_timeout, :rendering_time, :command_config_file, :viewport_width, :viewport_height].each do |m|
       define_method("#{m}=") do |val|
         @default_options[m]=val
       end
@@ -19,7 +19,9 @@ module Shrimp
           :tmpdir               => Dir.tmpdir,
           :rendering_timeout    => 90000,
           :rendering_time       => 1000,
-          :command_config_file  => File.expand_path('../config.json', __FILE__)
+          :command_config_file  => File.expand_path('../config.json', __FILE__),
+          :viewport_width       => 600,
+          :viewport_height      => 600
       }
     end
 

data/lib/shrimp/phantom.rb

@@ -1,5 +1,7 @@
 require 'uri'
 require 'json'
+require 'shellwords'
+
 module Shrimp
   class NoExecutableError < StandardError
     def initialize
@@ -26,6 +28,13 @@ 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
@@ -55,9 +64,25 @@ module Shrimp
       cookie_file                       = dump_cookies
       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]
       @outfile                          ||= "#{options[:tmpdir]}/#{Digest::MD5.hexdigest((Time.now.to_i + rand(9001)).to_s)}.pdf"
       command_config_file               = "--config=#{options[:command_config_file]}"
-      [Shrimp.configuration.phantomjs, command_config_file, SCRIPT_FILE, @source.to_s, @outfile, format, zoom, margin, orientation, cookie_file, rendering_time, timeout].join(" ")
+      [
+        Shrimp.configuration.phantomjs,
+        command_config_file,
+        SCRIPT_FILE,
+        @source.to_s.shellescape,
+        @outfile,
+        format,
+        zoom,
+        margin,
+        orientation,
+        cookie_file,
+        rendering_time,
+        timeout,
+        viewport_width,
+        viewport_height
+      ].join(" ")
     end
 
     # Public: initializes a new Phantom Object
@@ -123,6 +148,7 @@ module Shrimp
     end
 
     private
+
     def dump_cookies
       host = @source.url? ? URI::parse(@source.to_s).host : "/"
       json = @cookies.inject([]) { |a, (k, v)| a.push({ :name => k, :value => v, :domain => host }); a }.to_json

data/lib/shrimp/rasterize.js

@@ -6,6 +6,8 @@ var page = require('webpage').create(),
   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,
   cookies = {},
   address, output, size, statusCode;
 
@@ -24,14 +26,14 @@ try {
 phantom.cookiesEnabled = true;
 phantom.cookies = cookies;
 
-if (system.args.length < 3 || system.args.length > 10) {
-  console.log('Usage: rasterize.js URL filename [paperwidth*paperheight|paperformat] [zoom] [margin] [orientation] [cookie_file] [render_time] [time_out]');
+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]');
   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:600, height:600 };
+  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' }

data/lib/shrimp/version.rb

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

data/spec/shrimp/phantom_spec.rb

@@ -10,21 +10,31 @@ def valid_pdf(io)
   end
 end
 
-def testfile
-  File.expand_path('../test_file.html', __FILE__)
-end
-
-Shrimp.configure do |config|
-  config.rendering_time = 1000
-end
-
 describe Shrimp::Phantom do
+  let(:testfile) { File.expand_path('../test_file.html', __FILE__) }
+
   before do
-    Shrimp.configure do |config|
-      config.rendering_time = 1000
-    end
+    Shrimp.configure { |config| config.rendering_time = 1000 }
   end
 
+  # describe ".quote_arg" do
+  #   subject { described_class }
+
+  #   let(:arg) { "test" }
+
+  #   it "wraps the argument with single quotes" do
+  #     subject.quote_arg(arg).should eq "'test'"
+  #   end
+
+  #   context "when the argument contains single quotes" do
+  #     let(:arg) { "'te''st'" }
+
+  #     it "escapes them" do
+  #       %x(echo #{subject.quote_arg(arg)}).strip.should eq arg
+  #     end
+  #   end
+  # end
+
   it "should initialize attributes" do
     phantom = Shrimp::Phantom.new("file://#{testfile}", { :margin => "2cm" }, { }, "#{Dir.tmpdir}/test.pdf")
     phantom.source.to_s.should eq "file://#{testfile}"
@@ -54,8 +64,18 @@ describe Shrimp::Phantom do
     phantom.cmd.should include "lib/shrimp/rasterize.js"
   end
 
+  it "should properly escape arguments" do
+    malicious_uri = "file:///hello';shutdown"
+    bogus_phantom = Shrimp::Phantom.new(malicious_uri)
+
+    bogus_phantom.cmd.should_not include malicious_uri
+
+    Shrimp.configuration.stub(:phantomjs).and_return "echo"
+    %x(#{bogus_phantom.cmd}).strip.should include malicious_uri
+  end
+
   context "rendering to a file" do
-    before(:all) do
+    before do
       phantom = Shrimp::Phantom.new("file://#{testfile}", { :margin => "2cm" }, { }, "#{Dir.tmpdir}/test.pdf")
       @result = phantom.to_file
     end
@@ -70,7 +90,7 @@ describe Shrimp::Phantom do
   end
 
   context "rendering to a pdf" do
-    before(:all) do
+    before do
       @phantom = Shrimp::Phantom.new("file://#{testfile}", { :margin => "2cm" }, { })
       @result  = @phantom.to_pdf("#{Dir.tmpdir}/test.pdf")
     end
@@ -86,7 +106,7 @@ describe Shrimp::Phantom do
   end
 
   context "rendering to a String" do
-    before(:all) do
+    before do
       phantom = Shrimp::Phantom.new("file://#{testfile}", { :margin => "2cm" }, { })
       @result = phantom.to_string("#{Dir.tmpdir}/test.pdf")
     end
@@ -121,7 +141,6 @@ describe Shrimp::Phantom do
   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

data/spec/shrimp/source_spec.rb

@@ -7,8 +7,9 @@ describe Shrimp::Source do
       source = Shrimp::Source.new("file:///test/test.html")
       source.should be_url
     end
+
     it "should match http urls" do
-      source = Shrimp::Source.new("http:///test/test.html")
+      source = Shrimp::Source.new("http://test/test.html")
       source.should be_url
     end
   end

metadata

@@ -1,84 +1,74 @@
 --- !ruby/object:Gem::Specification
 name: shrimp
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - Manuel Kniep
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-20 00:00:00.000000000 Z
+date: 2014-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.6
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -98,8 +87,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - ChangeLog.md
 - Gemfile
 - LICENSE.txt
@@ -121,34 +110,27 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/adeven/shrimp
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2078211269578037741
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2078211269578037741
 requirements:
 - phantomjs, v1.6 or greater
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: a phantomjs based pdf renderer
 test_files:
 - spec/shrimp/middleware_spec.rb