smartshot 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a05d7100ca627ef66d421eccc73d2f141e3258d6
+  data.tar.gz: 75e0b0dad27d08463325808b873134f83754eb2b
+SHA512:
+  metadata.gz: 80a8ac8dbc6d6a1f09a94de3b1bfd2a7227abd4e51762e97afa5ea2e4ae6f7bb765ba3e2d80ca1e07ad43ce3dffb86f88faa2f3c5208db9c815661a59da779a9
+  data.tar.gz: 734000531cd2aa9822541eac895fd9f5660a13f0b768191fd4452cbe7f4cf139a82c4a31067f941007d2ca5350ca417ee12fbff0ad7604a26956260a2791abe2

data/.gitignore

@@ -0,0 +1,2 @@
+*.sw*
+test/data

data/CONTRIBUTORS

@@ -0,0 +1 @@
+Caio Almeida

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Caio Almeida
+
+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,59 @@
+# Smartshot
+
+Captures a web page as a screenshot using Poltergeist, Capybara and PhantomJS.
+It can wait for elements and also dive into iframes, while the existing gems
+just wait for time or expect elements on the main window.
+
+## Installation
+
+Download and install [PhantomJS](http://phantomjs.org/),
+add the directory containing the binary to your PATH.
+
+Add the `smartshot` gem to your Gemfile:
+
+    gem "smartshot"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smartshot
+
+## Usage
+
+```rb
+# Instantiate - additional "options" can be passed to Capybara
+fetcher = Smartshot::Screenshot.new(window_size: [800, 600])
+
+# Simpler usage - you can now grab a screenshot of a page
+fetcher.take_screenshot! url: 'http://www.google.com', output: '/tmp/google.png'
+
+# More complex example
+# Let's take the screenshot only when some element (here a "div"
+# with class "embed") is present on an iframe which is inside two
+# other iframes - the iframes path to be followed by the bot
+# is defined by an array, where iframes can be defined by
+# index (0-based), name or id
+fetcher.take_screenshot! url: 'http://some.page.with/deep/iframes',
+                         output: '/tmp/screenshot.png',
+                         wait_for_element: 'div.embed',
+                         frames_path: [0, 'name-of-an-iframe-inside-the-first-iframe', 'id-of-an-iframe-inside-the-previous-one']
+```
+
+Besides the four options presented so far, it's possible to pass the same options accepted by
+[Poltergeist's save screenshot method](https://github.com/teampoltergeist/poltergeist#taking-screenshots-with-some-extensions),
+for example:
+
+```rb
+fetcher.take_screenshot! url: 'http://google.com', output: '/tmp/google.png', full: false, selector: '#myDiv .my-class p'
+```
+
+## 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 smartshot 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/smartshot.rb

@@ -0,0 +1,11 @@
+require 'capybara/dsl'
+require 'capybara/poltergeist'
+require 'active_support'
+require 'active_support/core_ext'
+require 'smartshot/version'
+require 'smartshot/errors'
+require 'smartshot/screenshot'
+
+module Smartshot
+
+end

data/lib/smartshot/errors.rb

@@ -0,0 +1,3 @@
+module Smartshot
+  class SmartshotError < RuntimeError; end
+end

data/lib/smartshot/screenshot.rb

@@ -0,0 +1,42 @@
+module Smartshot
+  class Screenshot
+    include Capybara::DSL
+
+    def self.setup_capybara(options = {})
+      defaults = { js_errors: false, phantomjs_options: ['--ignore-ssl-errors=yes', '--ssl-protocol=any'] }
+      Capybara.register_driver :poltergeist do |app|
+        Capybara::Poltergeist::Driver.new(app, defaults.merge(options))
+      end
+      Capybara.run_server = false
+      Capybara.current_driver = :poltergeist
+      Capybara.default_wait_time = 30
+    end
+
+    def initialize(options = {})
+      Smartshot::Screenshot.setup_capybara(options)
+    end
+
+    def take_screenshot!(params = {})
+      options = { full: true, output: 'screenshot.png', url: 'http://ca.ios.ba', wait_for_element: 'body', frames_path: [] }.merge(params)
+      begin
+        visit options.delete(:url)
+        inside_frames options.delete(:frames_path) do
+          page.find options.delete(:wait_for_element)
+        end
+        page.driver.save_screenshot(options.delete(:output), options)
+      rescue => e
+        raise SmartshotError.new("Error: #{e.message.inspect}")
+      end
+    end
+
+    protected
+
+    def inside_frames(frames = [], &block)
+      block.call and return if frames.empty?
+      frame = frames.shift
+      within_frame frame do
+        inside_frames(frames, &block)
+      end
+    end
+  end
+end

data/lib/smartshot/version.rb

@@ -0,0 +1,3 @@
+module Smartshot
+  VERSION = '0.0.1'
+end

data/smartshot.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smartshot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'smartshot'
+  spec.version       = Smartshot::VERSION
+  spec.authors       = ['Caio Almeida']
+  spec.email         = ['caiosba@gmail.com']
+  spec.description   = %q{Captures a web page as a screenshot using Poltergeist, Capybara and PhantomJS,
+                          optionally waiting for elements (defined by CSS selectors) that can be inside iframes}
+  spec.summary       = %q{Captures a web page as a screenshot using Poltergeist, Capybara and PhantomJS,
+                          optionally waiting for elements (defined by CSS selectors) that can be inside iframes}
+  spec.homepage      = 'https://github.com/caiosba/smartshot'
+  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'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'gem-release'
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'poltergeist', '~> 1.5.0'
+  spec.add_dependency 'faye-websocket', '~> 0.7.3'
+end

data/test/smartshot_test.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+
+class SmartshotTest < MiniTest::Unit::TestCase
+
+  DATA_DIR = File.expand_path(File.dirname(__FILE__) + '/data')
+
+  def setup
+    FileUtils.mkdir_p(DATA_DIR) unless File.directory?(DATA_DIR)
+    @smartshot = Smartshot::Screenshot.new
+  end
+
+  def test_http
+    %w(www.yahoo.com).each do |name|
+      output = thumb(name)
+      File.delete output if File.exists? output
+      @smartshot.take_screenshot! url: "http://#{name}/", output: output
+      assert File.exists? output
+    end
+  end
+
+  def test_https
+    %w(github.com).each do |name|
+      output = thumb(name)
+      File.delete output if File.exists? output
+      @smartshot.take_screenshot! url: "https://#{name}/", output: output
+      assert File.exists? output
+    end
+  end
+
+  def test_invalid_url
+    %w(nxdomain).each do |name|
+      assert_raises Smartshot::SmartshotError do
+        @smartshot.take_screenshot! url: "http://#{name}/", output: thumb(name)
+      end
+    end
+  end
+
+  def test_iframe
+    waited = notwaited = nil
+   
+    %w(waited).each do |name|
+      waited = thumb(name)
+      File.delete waited if File.exists? waited
+      @smartshot.take_screenshot! url: 'http://ca.ios.ba/files/others/smartshot.html', output: waited, wait_for_element: 'p.Tweet-text',
+                                  frames_path: [0, 'child', 'twitter-widget-0']
+      assert File.exists? waited
+    end
+
+    %w(notwaited).each do |name|
+      notwaited = thumb(name)
+      File.delete notwaited if File.exists? notwaited
+      @smartshot.take_screenshot! url: 'http://ca.ios.ba/files/others/smartshot.html', output: notwaited
+      assert File.exists? notwaited
+    end
+
+    assert File.size(waited) > File.size(notwaited)
+  end
+
+  def thumb(name)
+    File.join(DATA_DIR, "#{name}.png")
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'smartshot'
+require 'minitest/autorun'
+require 'minitest/unit'

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: smartshot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Caio Almeida
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: gem-release
+  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: activesupport
+  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: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+description: |-
+  Captures a web page as a screenshot using Poltergeist, Capybara and PhantomJS,
+                            optionally waiting for elements (defined by CSS selectors) that can be inside iframes
+email:
+- caiosba@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CONTRIBUTORS
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/smartshot.rb
+- lib/smartshot/errors.rb
+- lib/smartshot/screenshot.rb
+- lib/smartshot/version.rb
+- smartshot.gemspec
+- test/smartshot_test.rb
+- test/test_helper.rb
+homepage: https://github.com/caiosba/smartshot
+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.14
+signing_key: 
+specification_version: 4
+summary: Captures a web page as a screenshot using Poltergeist, Capybara and PhantomJS,
+  optionally waiting for elements (defined by CSS selectors) that can be inside iframes
+test_files:
+- test/smartshot_test.rb
+- test/test_helper.rb