webshot 0.0.1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+test/data/*
+
+# Vim
+*.swp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Vitalie Cherpec
+
+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,37 @@
+# Webshot
+
+Captures a web page as a screenshot using Poltergeist, Capybara and PhantomJS.
+
+## Installation
+
+Download and install [PhantomJS](http://phantomjs.org/) and then add PhantomJS to
+your PATH. Add this line to your application's Gemfile:
+
+    gem "webshot"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install webshot
+
+## Usage
+
+    # Setup Capybara
+    Webshot.capybara_setup!
+
+    webshot = Webshot::Screenshot.new
+    webshot.capture "http://www.google.com/", "google.png"
+
+    # Customize output (MiniMagick settings)
+    webshot.capture "http://www.google.com/", "google.png", width: 100, height: 90, quality: 85
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rdoc/task"
+
+desc "Default: run tests."
+task :default => :test
+
+
+desc "Run webshot unit tests."
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = Dir[ "test/*_test.rb" ]
+  t.verbose = true
+end

data/lib/webshot.rb

@@ -0,0 +1,43 @@
+require "mini_magick"
+require "capybara/dsl"
+require "capybara/poltergeist"
+require "active_support/core_ext"
+require "webshot/version"
+require "webshot/errors"
+require "webshot/screenshot"
+
+module Webshot
+
+  ## Browser settings
+  # Width
+  mattr_accessor :width
+  @@width = 1024
+
+  # Height
+  mattr_accessor :height
+  @@height = 768
+
+  # User agent
+  mattr_accessor :user_agent
+  @@user_agent = "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.31 (KHTML, like Gecko) Chrome/26.0.1410.43 Safari/537.31"
+
+  def self.setup
+    yield self
+  end
+
+  def self.capybara_setup!
+    # By default Capybara will try to boot a rack application
+    # automatically. You might want to switch off Capybara's
+    # rack server if you are running against a remote application
+    Capybara.run_server = false
+    Capybara.register_driver :poltergeist do |app|
+      Capybara::Poltergeist::Driver.new(app, {
+        # Raise JavaScript errors to Ruby
+        js_errors: false,
+        # Additional command line options for PhantomJS
+        phantomjs_options: ['--ignore-ssl-errors=yes'],
+      })
+    end
+    Capybara.current_driver = :poltergeist
+  end
+end

data/lib/webshot/errors.rb

@@ -0,0 +1,3 @@
+module Webshot
+  class WebshotError < RuntimeError; end
+end

data/lib/webshot/screenshot.rb

@@ -0,0 +1,39 @@
+module Webshot
+  class Screenshot
+    include Capybara::DSL
+
+    def initialize(opts = {})
+      width  = opts.fetch(:width, Webshot.width)
+      height = opts.fetch(:height, Webshot.height)
+      user_agent = opts.fetch(:user_agent, Webshot.user_agent)
+      page.driver.resize(width, height)
+      page.driver.headers = {
+        "User-Agent" => user_agent,
+      }
+    end
+
+    def capture(url, path, opts = {})
+      # Default settings
+      width   = opts.fetch(:width, 120)
+      height  = opts.fetch(:height, 90)
+      gravity = opts.fetch(:gravity, "north")
+      quality = opts.fetch(:quality, 85)
+
+      visit url
+      if page.driver.status_code == 200
+        page.driver.save_screenshot(path, :full => true)
+        thumb = MiniMagick::Image.open(path)
+        thumb.combine_options do |c|
+          c.thumbnail "#{width}x"
+          c.background "white"
+          c.extent "#{width}x#{height}"
+          c.gravity "north"
+          c.quality 85
+        end
+        thumb.write path
+      else
+        raise WebshotError.new("Could not fetch page: #{url.inspect}")
+      end
+    end
+  end
+end

data/lib/webshot/version.rb

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

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require "webshot"
+require "test/unit"

data/test/webshot_test.rb

@@ -0,0 +1,47 @@
+require "test_helper"
+
+class WebshotTest < Test::Unit::TestCase
+
+  DATA_DIR = File.expand_path(File.dirname(__FILE__) + "/data")
+
+  def setup
+    Webshot.capybara_setup!
+    @webshot = Webshot::Screenshot.new
+  end
+
+  def test_http
+    assert_nothing_raised do
+      %w(www.google.com www.yahoo.com).each do |name|
+        output = thumb(name)
+        File.delete output if File.exists? output
+        @webshot.capture "http://#{name}/", output
+        assert File.exists? output
+      end
+    end
+  end
+
+  def test_https
+    assert_nothing_raised do
+      %w(github.com).each do |name|
+        output = thumb(name)
+        File.delete output if File.exists? output
+        @webshot.capture "https://#{name}/", output
+        assert File.exists? output
+      end
+    end
+  end
+
+  def test_
+    %w(888.888.888.888).each do |name|
+      assert_raise Webshot::WebshotError do
+        @webshot.capture "http://#{name}/", thumb(name)
+      end
+    end
+  end
+
+  protected
+
+  def thumb(name)
+    File.join(DATA_DIR, "#{name}.png")
+  end
+end

data/webshot.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'webshot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "webshot"
+  spec.version       = Webshot::VERSION
+  spec.authors       = ["Vitalie Cherpec"]
+  spec.email         = ["vitalie@penguin.ro"]
+  spec.description   = %q{Captures a web page as a screenshot using Poltergeist, Capybara and PhantomJS}
+  spec.summary       = %q{Captures a web page as a screenshot}
+  spec.homepage      = "https://github.com/vitalie/webshot"
+  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 "activesupport"
+  spec.add_dependency "poltergeist", "~> 1.2.0"
+  spec.add_dependency "mini_magick", "~> 3.5.0"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: webshot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Vitalie Cherpec
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+description: Captures a web page as a screenshot using Poltergeist, Capybara and PhantomJS
+email:
+- vitalie@penguin.ro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/webshot.rb
+- lib/webshot/errors.rb
+- lib/webshot/screenshot.rb
+- lib/webshot/version.rb
+- test/test_helper.rb
+- test/webshot_test.rb
+- webshot.gemspec
+homepage: https://github.com/vitalie/webshot
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Captures a web page as a screenshot
+test_files:
+- test/test_helper.rb
+- test/webshot_test.rb