phantoshot 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NmFmMzIyNDE2NmIyZTQyMDBmNzhmMDI3MjY4NzBkOTk1MDlhYmVmOQ==
+  data.tar.gz: !binary |-
+    ZDY1MDIzMzY2YWYyNjFkMjBiNThhYmU3ODI5ZGRhOWNiZTJmMDljMw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NGQ2YTQ1Y2EwNjExNWQyNDFmODllNWU4ZWM2ZmIwMzI1NGEzODdiNGI1M2Vl
+    ODEzYjg3ZTMyZGIzOGU3ZmJjODBiNDAxZDY4YjNmOWM5NjI2Y2YxYmM2ZWJl
+    MmIzYWEzYjZlNTJiODJmMWYzZGI5ZGM2MGQ1OWQ1YTYxNzUwZmE=
+  data.tar.gz: !binary |-
+    ZDg3Y2FmNjY4NjQ2ZTgyYWYxMDlkZTMyOTNhYmJjMGU0NjFhNjhlNTY2ZDY2
+    YzI1MGFmMjAyNjc1NzMzMWIzZmE4OTQzOTY4MTRiZWQ2ZTlmN2E3MmM1ZTYx
+    NWY4Y2M2YWE3ZGIwMGE0Yjc3MTE1OGJmNWVkYTgwMWNjNzliYzE=

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
+.DS_Store
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in phantoshot.gemspec
+gemspec
+
+group :development do 
+     gem 'foreman', require: false
+     gem 'rspec', "~>2.8"
+     gem 'fakeweb'
+     gem 'pry'
+     gem 'fastimage'
+#     gem 'debugger'
+#     gem 'better_errors'
+end

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    phantoshot (0.0.1)
+      hashie
+      multi_json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    dotenv (0.7.0)
+    fakeweb (1.3.0)
+    fastimage (1.4.0)
+    foreman (0.63.0)
+      dotenv (>= 0.7)
+      thor (>= 0.13.6)
+    hashie (2.0.5)
+    method_source (0.8.1)
+    multi_json (1.7.6)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.0.4)
+    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)
+    slop (3.4.5)
+    thor (0.18.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  fakeweb
+  fastimage
+  foreman
+  phantoshot!
+  pry
+  rake
+  rspec (~> 2.8)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dan Nguyen
+
+MIT License
+
+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,4 @@
+phantoshot
+==========
+
+A website snapshot utility, using Phantom.js

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :rspec
+
+desc 'Run the specs'
+RSpec::Core::RakeTask.new(:rspec) do |t|
+  t.rspec_opts = ['--color']
+  t.pattern = './spec/**/*_spec.rb'
+end
+
+spec = Gem::Specification.load("#{File.dirname(__FILE__)}/phantoshot.gemspec")
+
+desc "Package gem."
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end

data/lib/phantom-shot-script.js

@@ -0,0 +1,24 @@
+var page = require('webpage').create();
+var system = require('system');
+
+var result = {
+   url: system.args[1],
+   width: parseInt(system.args[2]),
+   height: parseInt(system.args[3])
+};
+
+
+page.viewportSize = {
+  width: result.width,
+  height: result.height
+};
+
+page.open(result.url, function() {
+    
+    result.file_format = 'PNG';
+    result.image_data = page.renderBase64(result.file_format);    
+
+    console.log( JSON.stringify(result) );
+
+    phantom.exit();
+});

data/lib/phantoshot/make_screenshot.rb

@@ -0,0 +1,24 @@
+module Phantoshot
+   def make_screenshot(url, opts={})
+
+      width = opts[:width] || 600
+      height = opts[:height] || 400
+
+      res = MultiJson.load( phantom_command(url, width, height) )
+
+      hsh = Hashie::Mash.new(res)
+
+      # Decode it for writing out to binary
+      hsh[:image_data] = Base64.decode64( hsh[:image_data] )      
+      return hsh
+   end
+
+
+   # returns JSON string with these attributes:
+   # :image_data (in base64), :width, :height, :file_format (default is PNG), and :url
+   #
+   def phantom_command(url, width, height)
+      cmd = "phantomjs #{JS_LIB_NAME} #{url} #{width} #{height}"
+      `#{cmd}`
+   end
+end

data/lib/phantoshot/version.rb

@@ -0,0 +1,3 @@
+module Phantoshot
+  VERSION = "0.0.1"
+end

data/lib/phantoshot.rb

@@ -0,0 +1,12 @@
+require "phantoshot/version"
+require "phantoshot/make_screenshot"
+
+require 'hashie'
+require 'multi_json'
+require 'base64'
+
+module Phantoshot
+   JS_LIB_NAME = File.join(File.dirname(__FILE__), "/phantom-shot-script.js")
+end
+
+include Phantoshot

data/phantoshot.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'phantoshot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "phantoshot"
+  spec.version       = Phantoshot::VERSION
+  spec.authors       = ["Andrew Callahan", "Dan Nguyen"]
+  spec.email         = ["dn@gskift.com"]
+  spec.description   = %q{Take screenshots with phantom.js}
+  spec.summary       = %q{A simple Ruby wrapper around phantom.js}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "hashie"
+  spec.add_dependency "multi_json"
+
+
+end

data/spec/fixtures/example-fixture.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+<head>
+   <meta charset="UTF-8">
+   <title>Document</title>
+</head>
+<body>
+   <h1>Example</h1>
+   <p>This is a webpage</p>
+
+   <h2>Another headline</h2>
+</body>
+</html>

data/spec/lib/phantoshot_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+include Phantoshot
+
+describe Phantoshot do 
+   it "should run this test" do 
+      expect(true).to be true
+   end
+
+
+
+   describe "make_screenshot" do 
+
+      context "basic setup" do 
+         it "should require a single String parameter" do
+            expect{ make_screenshot }.to raise_error
+         end
+
+         it "should return Hashie::Mash object" do 
+            # expect( make_screenshot('http://www.example.com') ).to be_a Hashie::Mash
+         end
+      end
+
+      context "image production" do 
+         it "should return an image_data attribute in the data_hash" do 
+           hsh = make_screenshot(HTML_FIXTURE_FILENAME)
+           expect( hsh.image_data ).to be_a String            
+         end
+      end
+
+
+      context "call with parameters" do 
+         before(:each) do 
+            @imgfile = Tempfile.new('foo.png')
+         end
+
+         it "should accept width and height options" do
+            response = make_screenshot(HTML_FIXTURE_FILENAME, width: 300, height: 200)
+            
+            ## let's have the hash contain height, width attributes
+            expect(response.width).to eq 300
+            expect(response.height).to eq 200
+            expect(response.url).to eq HTML_FIXTURE_FILENAME
+            expect(response.file_format).to eq 'PNG'
+
+            @imgfile.write( response.image_data )
+            @imgfile.close
+
+            expect( FastImage.size(@imgfile.path)[0] ).to eq 300
+            expect( FastImage.size(@imgfile.path)[1] ).to eq 200
+         end
+
+         after(:each) do 
+            @imgfile.unlink
+         end
+      end
+
+
+      context "Error handling: should have an :error attribute when phantom_command fails" do 
+
+         it "should return 'Error': Invalid source address' when nonexistent address is given"
+
+      end
+
+
+   end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'phantoshot'
+require 'fakeweb'
+require 'fastimage'
+require 'tempfile'
+
+HTML_FIXTURE_FILENAME = File.expand_path "./spec/fixtures/example-fixture.html"
+
+RSpec.configure do |config|
+  config.before(:each) do
+#
+  end
+  config.after(:each) do
+#
+  end
+end
+
+
+
+
+
+
+

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: phantoshot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Callahan
+- Dan Nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: hashie
+  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: multi_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'
+description: Take screenshots with phantom.js
+email:
+- dn@gskift.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/phantom-shot-script.js
+- lib/phantoshot.rb
+- lib/phantoshot/make_screenshot.rb
+- lib/phantoshot/version.rb
+- phantoshot.gemspec
+- spec/fixtures/example-fixture.html
+- spec/lib/phantoshot_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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 simple Ruby wrapper around phantom.js
+test_files:
+- spec/fixtures/example-fixture.html
+- spec/lib/phantoshot_spec.rb
+- spec/spec_helper.rb