screencork 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7d5d5dcc9ea3cdf64b4fa76e615d7c5b4c9a6b8
+  data.tar.gz: 7202348e60bf1893d4f0e12d8c0da8082c4429dc
+SHA512:
+  metadata.gz: e2078779807978237e455759635c42a61df789c613bb8524365064b6d518ea7a6fdb8e555b1f790f38f5b6b3be1412915873f53c820aa382345e1431049ef671
+  data.tar.gz: f80308da4c8c41f1ce38afa77142091f3d12195dca0acb86f9460414768543dcbf137aff0732d87b95b45b19883d35044706fe16be81b2a51aa78bbde48d21ed

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+*.rbc
+.bundle
+.config
+Gemfile.lock
+pkg
+rdoc
+tmp
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in screencork.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Maxwell Sechzer
+
+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,51 @@
+# Screencork
+
+A gem for grabbing screenshots OR pdfs of webpages. It uses PhantomJS to load and render pages to strings.
+
+## Basic Usage
+
+Either pass in the page's url to a new instance of Screencork::Screen, or to the ::screen method.
+Then just call #to_your-format-here to return the string content of the file in that format.
+Supported file formats are bmp, jpg, jpeg, png, ppm, xbm, xpm, and pdf.
+
+```ruby
+  require 'screencork'
+
+  screen = Screencork.screen('http://google.com')
+  screenshot = screen.to_png
+```
+
+You can pass in any of the allowed options like so:
+
+```ruby
+  screen = Screencork.screen('http://google.com', height: 300, cutoff: 5000)
+
+  screen.to_pdf
+```
+
+## Advanced Usage
+
+Options with defaults will have their defaults displayed below. All nested arrays/hashes will not have a default,
+but do have default options for when only some of the nested options are supplied. These will be shown with the
+shape of the required array/hash. If there are multiple ways to submit an option they are demonstrated together.
+
+```ruby
+  screen = Screencork.screen('google.com',
+    height: 300, # the height of the viewport itself
+    width: 400, # the width of the viewport itself
+    cutoff: 5000, # the amount of time (in ms) allowed before considering the request failed
+    cookies: [{ name: 'my-cookie', value: 'my-cookie-val', domain: 'google.com' }], # an array of the cookies to be sent with the request. Must at least have a name, value and valid domain
+    paper_size: { width: 400, height: 300, margin: 0 }, # the size of the page when rendering a pdf file. Either width or height must be supplied for this option
+    paper_size: { format: 'A4', orientation: 'portrait', margin: 0 }, # either format or orientation must be supplied for this option.
+  )
+
+  screen.to_pdf
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/screencork/image_formats.rb

@@ -0,0 +1,3 @@
+module Screencork
+  IMAGE_FORMATS = %i(bmp jpg jpeg png ppm xbm xpm pdf)
+end

data/lib/screencork/render.js

@@ -0,0 +1,114 @@
+var system = require('system'),
+    stdout = system.stdout,
+    page = require('webpage').create(),
+    url = system.args[1],
+    format = system.args[2],
+    opts = system.args[3],
+    args = { cutoff: 5000 };
+    defaultPaperSize = { format: 'A4', orientation: 'portrait' };
+
+if( !url || !format ) {
+  stdout.write('Error: A URL and a file type must be given');
+  phantom.exit(1);
+}
+
+function extend() {
+  var obj, key, i = 1,
+      len = arguments.length,
+      baseObj = arguments[0];
+
+  for (; i < len; i++) {
+    obj = arguments[i];
+
+    for (key in obj) {
+      if (obj.hasOwnProperty(key)) {
+        baseObj[key] = obj[key];
+      }
+    }
+  }
+
+  return baseObj;
+}
+
+function timeout() {
+  stdout.write('Error: Request to ' + url + ' exceeded ' + args.cutoff + 'ms');
+  phantom.exit(1);
+}
+
+function setCutoff() {
+  setTimeout( timeout, args.cutoff );
+}
+
+function parseArguments() {
+  function camelize( string ) {
+    return  string.replace(/_([a-z])/g, function (g) { return g[1].toUpperCase(); });
+  }
+
+  var systemArgs = opts ? JSON.parse( opts ) : {};
+
+  for ( var arg in systemArgs ) {
+    if ( systemArgs.hasOwnProperty(arg) ) {
+      args[camelize( arg )] = systemArgs[arg];
+    }
+  }
+}
+
+function addCookies() {
+  if ( !args.cookies ) { return; }
+  args.cookies.forEach(phantom.addCookie);
+}
+
+function setViewport() {
+  if ( args.height ) {
+    page.viewportSize = { height: args.height, width: args.width };
+  }
+}
+
+function setPaperSize() {
+  if ( args.paperSize && format === 'pdf' ) {
+    if ( args.paperSize.width || args.paperSize.height ) {
+      page.paperSize = { width: args.paperSize.width, height: args.paperSize.height, margin: args.paperSize.margin };
+    } else {
+      page.paperSize = extend( {}, defaultPaperSize, args.paperSize );
+    }
+  }
+}
+
+function getClipRect() {
+  if ( args.el ) {
+    page.clipRect = page.evaluate(function( sel ) {
+      return document.querySelector( sel ).getBoundingClientRect();
+    }, args.el);
+  }
+}
+
+// either get the base64 encoded file directly if the type is supported, or write the file to stdout
+function render() {
+  if ( format === 'pdf' ) {
+    page.render( '/dev/stdout', {format: format} );
+  } else {
+    stdout.write(page.renderBase64( format ));
+  }
+
+  phantom.exit();
+}
+
+function openPage() {
+  page.open(url, function( status ) {
+    if( status !== 'success' ) {
+      stdout.write('Error: Unable to load: ' + url);
+      phantom.exit(1);
+    } else {
+      getClipRect();
+      render();
+    }
+  });
+
+  setCutoff();
+}
+
+parseArguments();
+addCookies();
+setViewport();
+setPaperSize();
+openPage();

data/lib/screencork/screen.rb

@@ -0,0 +1,29 @@
+module Screencork
+  class Screen
+    def initialize(url, opts = {})
+      @url = url
+      @opts = opts
+    end
+
+    IMAGE_FORMATS.each do |format|
+      define_method "to_#{format}" do
+        render format
+      end
+    end
+
+    private
+
+    def render(format)
+      Screencork.render(@url, format, proccessed_opts)
+    end
+
+    def proccessed_opts
+      if (cookies = @opts[:cookies]) && cookies.is_a?(Hash)
+        array_cookies = cookies.map { |name, value| {domain: URI(@url).host, name: name, value: value} }
+        @opts.merge(cookies: array_cookies)
+      else
+        @opts
+      end
+    end
+  end
+end

data/lib/screencork/version.rb

@@ -0,0 +1,3 @@
+module Screencork
+  VERSION = '0.0.6'
+end

data/lib/screencork.rb

@@ -0,0 +1,44 @@
+require 'screencork/version'
+require 'screencork/image_formats'
+require 'screencork/screen'
+require 'phantomjs'
+require 'json'
+
+module Screencork
+  class ScreencorkError < StandardError; end;
+
+  class << self
+    def screen(*args)
+      Screen.new(*args)
+    end
+
+    def render(url, format, opts = {})
+      result = run_phantom(url, format, opts)
+      raise_if_error! result
+      format == :pdf ? result : Base64.decode64(result)
+    end
+
+    def run_phantom(url, format, opts = {})
+      format, opts = format.to_s, opts.to_json
+      log_command(url, format, opts)
+      Phantomjs.run(render_script_path, url, format, opts)
+    end
+
+    private
+
+    def log_command(url, format, opts = {})
+      puts [Phantomjs.path, render_script_path, url, format, opts.inspect.inspect].join(' ')
+    end
+
+    def raise_if_error!(result)
+      return if !result.valid_encoding?
+      error_match = /Error: /.match(result)
+      return if error_match.nil?
+      raise ScreencorkError.new(error_match.post_match)
+    end
+
+    def render_script_path
+      @render_script_path ||= File.expand_path('../screencork/render.js', __FILE__)
+    end
+  end
+end

data/screencork.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+require File.expand_path('../lib/screencork/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "screencork"
+  gem.version       = Screencork::VERSION
+  gem.authors       = ['Maxwell Sechzer']
+  gem.email         = ['maxwell at sechzer.com']
+  gem.description   = 'A gem for grabbing screenshots of webpages.'
+  gem.summary       = 'Uses PhantomJS to load and render pages to strings.'
+  gem.homepage      = ''
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($\)
+  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 = ["lib"]
+
+  gem.add_dependency 'phantomjs'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: screencork
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Maxwell Sechzer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-12 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: 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: 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'
+description: A gem for grabbing screenshots of webpages.
+email:
+- maxwell at sechzer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/screencork.rb
+- lib/screencork/image_formats.rb
+- lib/screencork/render.js
+- lib/screencork/screen.rb
+- lib/screencork/version.rb
+- screencork.gemspec
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Uses PhantomJS to load and render pages to strings.
+test_files: []