auto_screenshot 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in auto_screenshot.gemspec
+gemspec
+
+gem 'capybara'
+gem 'json'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ryan Wold
+
+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,44 @@
+Auto Screenshot
+===============
+
+A small library designed to help document web products.
+
+## Usage
+
+From console, within the /auto_screenshot directory:
+    
+    irb
+    load auto_screenshot.rb
+
+This works in 2 ways:
+
+Method 1: Pass in an array of URL's
+
+    urls = ["http://ryanwold.net", "http://afomi.com", "http://www.granicus.com"]
+    s = Screenshot.new(:urls => urls) # => an array of URL's as strings
+
+Or
+
+Method 2: Read from a .json file
+
+    s = Screenshot.new(:file => "test.json")  # => an array of URL's as strings
+    s.go # => screenshots are saved to the /screenshots directory as .png files
+
+    gem install auto_screenshot
+    rake screenshots --all
+    
+screenshot based on a .rb file or pass arguments
+
+    load 'auto_screenshot.rb'
+    s = Screenshot.new(:file => "test.json")
+    s.go
+
+Alternatively, use a ruby file to generate a @links array of URL strings for each page (see dmap.rb as an example)
+
+    load 'dmap.rb'
+    s = Screenshot.new(:urls => $links)
+
+#### Remember
+
+* Ensure your website is running when testing locally.
+* Don't abuse anybody's website.

data/Rakefile

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

data/auto_screenshot.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/auto_screenshot/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ryan Wold"]
+  gem.email         = ["wold@afomi.com"]
+  gem.description   = %q{'Automatically screenshot webpages'}
+  gem.summary       = %q{'Automating webpage screenshots'}
+  gem.homepage      = "http://github.com/afomi/auto_screenshot"
+
+  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          = "auto_screenshot"
+  gem.require_paths = ["lib"]
+  gem.version       = AutoScreenshot::VERSION
+  gem.add_runtime_dependency 'capybara'
+end

data/lib/auto_screenshot/version.rb

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

data/lib/auto_screenshot.rb

@@ -0,0 +1,107 @@
+require "auto_screenshot/version"
+
+require 'uri'
+require 'json'
+require 'capybara/dsl'
+
+module AutoScreenshot
+
+  class Screenshot
+
+    include Capybara::DSL
+    Capybara.default_driver = :selenium
+
+    attr_accessor :urls, :folder, :action_map_path, :action_map
+
+    def initialize(opts = { :urls => [], :file => "", :rb_file => nil, :action_map_path => "", :folder => "" })
+      raise Exception, "please pass in an array of urls like {:urls => []}, or a file, like {:file => \"test.json\"}" unless opts[:urls] or opts[:file] or opts[:rb_file]
+
+      if opts[:urls]
+        @urls = opts[:urls]
+      elsif opts[:rb_file]
+        require_relative opts[:rb_file]
+        @urls = $links
+      elsif opts[:file]
+        @urls = JSON.parse(File.open(opts[:file], "r").read)
+      end
+
+      @action_map_path = opts[:action_map_path]
+      @folder = opts[:folder] ||= "screenshots"
+      @action_map = action_map
+    end
+
+    def go
+      errors = []
+      @urls.each do |url|
+        begin
+          puts "Getting #{url}"
+          visit "#{url}"
+
+          page.wait_until do
+            page.evaluate_script 'jQuery.active == 0'
+          end
+          snap
+          actions(url)
+        rescue => err
+          puts err.inspect
+          puts "error on #{url}"
+          errors << url
+        end
+      end
+
+      puts errors
+    end
+
+    def action_map
+      json = File.open(@action_map_path).read
+      hash = JSON.parse(json)
+    end
+
+
+    # custom actions for Granicus
+    # something custom based on a page.  pages must be ordered in the URL array though
+    def actions(url)
+      # do a specific action for a url, like login
+
+      if action_map.has_key?(url)
+        self.send(action_map[url])
+      else
+        nil
+      end
+    end
+
+    def login
+      click_on "Sign in / up"
+      sleep 2.0
+      fill_in "user_email", :with => "ryanw@granicus.com"
+      fill_in "user_password", :with => ""
+      click_on "Sign in"
+      sleep 2.0
+      wait_for_ajax
+    end
+
+    def wait
+      sleep 15.0
+    end
+
+    def grab_links(url)
+      links = []
+
+      visit "#{url}"
+      nodes = Nokogiri::HTML(page.html).css("a")
+      nodes.each do |link|
+        links << link["href"]
+      end
+      links.uniq
+    end
+
+    def snap
+      page.execute_script('$(window).width(1200)')
+      name = page.current_url.gsub("https:\/\/", "").gsub("http:\/\/", "").gsub(":", "").gsub("\/", "-").gsub("&", "-").gsub("?", "_").gsub("dev.lvh.me3000-", "").gsub("admin.lvh.me3000-", "").gsub("localhost3001-", "").gsub("dev.dev.lvh.me3000-", "").gsub("test.civicideasstaging.com", "")
+      Capybara.current_session.driver.browser.manage.window.resize_to(1000, 800)
+      Capybara.current_session.driver.browser.save_screenshot("#{File.dirname(__FILE__)}/#{@folder}/#{name}.png")
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: auto_screenshot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Wold
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &70132291619560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70132291619560
+description: ! '''Automatically screenshot webpages'''
+email:
+- wold@afomi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- auto_screenshot.gemspec
+- lib/auto_screenshot.rb
+- lib/auto_screenshot/version.rb
+homepage: http://github.com/afomi/auto_screenshot
+licenses: []
+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.15
+signing_key: 
+specification_version: 3
+summary: ! '''Automating webpage screenshots'''
+test_files: []
+has_rdoc: