glebtv-screencap 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c009987882aa5b8c1b83331603aa852e84856b2f
+  data.tar.gz: 9436799c4d60a7af5d2e0c628264f43ffd4e5a89
+SHA512:
+  metadata.gz: 470749f6504d31e4b1126aa1ba720cefbb195824e7b9d5967c22ff3ef3357f12ac610d8b6103b820404c943cead54beb03cfb3667eac89f3ca9988e7d613bbe1
+  data.tar.gz: a5ef19f475ebc823096946ce19f6927a3e745e2e86ed66e84896380b996f45d1ee6a06b763a739b1dc587a54d5bf4ec36c25c690ceac45916d9ea854b1f18436

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+screencap

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.3
+script: "bundle exec rake"

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Maxwell Salzberg
+
+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,57 @@
+# Screencap
+
+This forks contains an adaptation for our needs
+
+100% height, fixed width, configurable delay after page is loaded
+
+Some options were removed.
+
+Please see original gem as it is much more generic than our usecase.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'glebtv-screencap'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install glebtv-screencap
+
+## Usage
+
+```ruby
+require 'screencap'
+
+f = Screencap::Fetcher.new('http://google.com')
+screenshot = f.fetch
+```
+
+it also currently supports a couple of options
+
+```ruby
+f = Screencap::Fetcher.new('http://google.com')
+screenshot = f.fetch(
+  :output => '~/my_directory.png', #dont forget the extension!
+  # optional:
+  :height => 1024,
+  :width => 1024,
+  :delay => 15000,
+)
+
+```
+
+## To-do
+
+## 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,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :default => :spec

data/glebtv-screencap.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/screencap/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["glebtv", "Maxwell Salzberg","David Spurr"]
+  gem.email         = ["glebtv@gmail.com"]
+  gem.description   = %q{a gem to grab screenshots of webpages, or just parts of webpages}
+  gem.summary       = %q{uses Phantom.js to grab pages, or parts of pages. Simple API.}
+  gem.homepage      = "http://github.com/glebtv/screencap"
+
+  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.name          = "glebtv-screencap"
+  gem.require_paths = ["lib"]
+  gem.version       = Screencap::VERSION
+
+  gem.add_development_dependency 'rspec', '~> 2.14'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'fastimage'
+
+  gem.add_runtime_dependency 'phantomjs'
+end

data/lib/glebtv-screencap.rb

@@ -0,0 +1,2 @@
+require 'screencap'
+

data/lib/screencap.rb

@@ -0,0 +1,14 @@
+require "screencap/version"
+
+require 'pathname'
+
+require 'phantomjs'
+
+module Screencap
+  SCREENCAP_ROOT = Pathname.new(File.dirname(__FILE__))
+
+  class Error < StandardError; end
+end
+
+require 'screencap/fetcher'
+require 'screencap/phantom'

data/lib/screencap/fetcher.rb

@@ -0,0 +1,31 @@
+module Screencap
+  class Fetcher
+    def initialize(url)
+      @url = url
+    end
+
+    def fetch(opts = {})
+      @filename = opts.fetch(:output, clean_filename)
+      raster(@url, @filename, opts)
+      fetched_file
+    end
+
+    def filename
+      @filename
+    end
+
+    def fetched_file
+      if File.exists?(filename)
+        File.open(filename)
+      end
+    end
+
+    def raster(*args)
+      Screencap::Phantom.rasterize(*args)
+    end
+
+    def clean_filename
+      "#{@url.delete('/.:?!')}.png"
+    end
+  end
+end

data/lib/screencap/phantom.rb

@@ -0,0 +1,27 @@
+module Screencap
+  class Phantom
+    RASTERIZE = SCREENCAP_ROOT.join('screencap', 'raster.js')
+
+    def self.rasterize(url, path, args = {})
+      params = {
+        url: CGI::escape(url),
+        output: path
+      }.merge(args).collect {|k,v| "#{k}=#{v}"}
+      #puts RASTERIZE.to_s, params
+      result = Phantomjs.run(RASTERIZE.to_s, *params)
+      p result
+      raise Screencap::Error, "Could not load URL #{url}" if result.match /Unable to load/
+    end
+
+    def quoted_args(args)
+      args.map{|x| quoted_arg(x)}
+    end
+
+    def quoted_arg(arg)
+      return arg if arg.starts_with?("'") && arg.ends_with?("'")
+      arg = "'" + arg unless arg.starts_with?("'")
+      arg = arg + "'" unless arg.ends_with?("'")
+      arg
+    end
+  end
+end

data/lib/screencap/raster.js

@@ -0,0 +1,56 @@
+//
+// Takes a screenshot of the given URL, uses named arguments passed in like so: phantomjs raster.js arg=value arg2=value2
+//
+// Arguments:
+// - url                      - URL to screenshot
+// - output                   - page to output (e.g. /tmp/output.png)
+// - width         [optional] - default 1400 - viewport width
+// - height        [optional] - viewport height (defaults to page height)
+// - delay         [optional] - default 2000 - delay in msec before saving screenshot
+
+var page = new WebPage(), address, output, div, i, pair;
+
+// use named arguments
+var args = {};
+for(i = 0; i < phantom.args.length; i++) {
+  pair = phantom.args[i].split(/=(.*)/);
+  args[pair[0]] = pair[1];
+}
+
+if( args.url ) {
+  args.url = decodeURIComponent(args.url);
+}
+
+// console.log(JSON.stringify(args));
+
+if( !args.url || !args.output ) {
+  console.log('Usage: rasterize.js url=URL output=filename delay=delay');
+  phantom.exit();
+}
+
+page.onConsoleMessage = function (msg) {
+  console.log("from page: " + msg);
+};
+
+page.open(args.url, function (status) {
+  console.log(status, args);
+  if(status !== 'success') {
+    console.log('Unable to load:' + args.url);
+    phantom.exit();
+  }
+  var width = args.width || 1400;
+  var height = args.height || page.evaluate(function () {
+   return document.body.clientHeight;
+  });
+  var delay = args.delay || 2000;
+
+  page.viewportSize = {width: args.width, height: height};
+
+  // console.log("Waiting " + delay + "ms");
+
+  setTimeout(function() {
+    page.render(args.output);
+    phantom.exit();
+  }, delay)
+});
+

data/lib/screencap/version.rb

@@ -0,0 +1,3 @@
+module Screencap
+  VERSION = "0.0.8"
+end

data/spec/fetcher_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Screencap::Fetcher do
+  it 'takes a url' do
+    Screencap::Fetcher.new('http://google.com').should_not be_nil
+  end
+
+  it 'supports a custom filename' do
+    screenshot = Screencap::Fetcher.new('http://yahoo.com').fetch(:output => TMP_DIRECTORY + 'kats.png')
+    File.exists?(screenshot).should == true
+  end
+
+  it 'supports a custom width' do
+  	screenshot = Screencap::Fetcher.new('http://google.com').fetch(:output => TMP_DIRECTORY + 'foo.jpg', :width => 800)
+  	FastImage.size(screenshot)[0].should == 800
+  end
+
+  #it 'captures a given element' do
+    #screenshot = Screencap::Fetcher.new('http://placehold.it').fetch(:output => TMP_DIRECTORY + 'bar.jpg', :div => 'img.image')
+    #FastImage.size(screenshot)[0].should == 140
+  #end
+
+  it 'should work when given a query string with ampersand in it' do
+    screenshot = Screencap::Fetcher.new('http://google.com?1=2&3=4').fetch(:output => TMP_DIRECTORY + 'foo.jpg', :width => 800)
+    FastImage.size(screenshot)[0].should == 800
+  end
+end

data/spec/screencap_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Screencap do
+  it 'works' do
+    screenshot = Screencap::Fetcher.new('http://google.com').fetch(output: TMP_DIRECTORY + 'google.png')
+    FastImage.size(screenshot)[0].should == 602
+  end
+
+  it 'throws error when phantom could not load page' do
+  	expect {
+  		Screencap::Fetcher.new('http://doesnotexistatallipromise.com/').fetch(output: TMP_DIRECTORY + 'foo.png')
+  	}.to raise_error Screencap::Error, "Could not load URL http://doesnotexistatallipromise.com/"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'screencap'
+require 'fastimage'
+
+TMP_DIRECTORY = Screencap::SCREENCAP_ROOT.join('..', 'tmp')
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.before(:all) do
+    # system("rm #{TMP_DIRECTORY}/*.png") leave them for now
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: glebtv-screencap
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+platform: ruby
+authors:
+- glebtv
+- Maxwell Salzberg
+- David Spurr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !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: fastimage
+  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: 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'
+description: a gem to grab screenshots of webpages, or just parts of webpages
+email:
+- glebtv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- glebtv-screencap.gemspec
+- lib/glebtv-screencap.rb
+- lib/screencap.rb
+- lib/screencap/fetcher.rb
+- lib/screencap/phantom.rb
+- lib/screencap/raster.js
+- lib/screencap/version.rb
+- spec/fetcher_spec.rb
+- spec/screencap_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/glebtv/screencap
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: uses Phantom.js to grab pages, or parts of pages. Simple API.
+test_files:
+- spec/fetcher_spec.rb
+- spec/screencap_spec.rb
+- spec/spec_helper.rb