auto_screenshot 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1151c54fb0fbb5d3ea5e8b387bb3d64cd8eabb54
+  data.tar.gz: 93dcf708c899d050d031473d139d4cc5636351aa
+SHA512:
+  metadata.gz: f091e87e7bae90e61dad47ba510a9a653928f5e8e090d7e728c2bb1463852900bbea2334e8478bc37a4a26410c5aed51a5684b57d1199bffe64c2c219ddb6687
+  data.tar.gz: c3a77ce912c5bf587e48f5370d72fe59cdba4e991d122db73bfe7187f583627340904d0b329f9e909d421567ce327dbcda95a6547d2d6c95d01c807787858863

data/.gitignore

@@ -12,6 +12,8 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
-test/tmp
-test/version_tmp
+test/
 tmp
+screenshots
+.DS_Store
+.rvmrc

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format progress
+-fd
+--drb

data/Gemfile

@@ -2,10 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in auto_screenshot.gemspec
 gemspec
-
-gem 'capybara'
-gem 'json'
-
-group :development do 
-  gem 'pry'
-end

data/README.md

@@ -1,49 +1,84 @@
-Auto Screenshot
-===============
+# AutoScreenshot
 
-A small library designed to help the document web products.
+Built to capture screenshots of a list of webpages in an automated fashion.
 
-## Usage
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'auto_screenshot'
+
+And then run:
+
+    bundle
+
+Or install it yourself as:
 
     gem install auto_screenshot
 
-### Basics
+## Options
+
+### URLs
+
+An array of valid URLs. Pretty simple.
 
-Pass in an array of URL's,
+### Folder
 
-    urls = ["http://domain.lvh.me:3000", "http://domain.lvh.me:3000/link/1"]
-    s = Screenshot.new(:urls => urls)
+`folder` is where the screenshots will be saved.  The default location is the `screenshots` folder based on where the program is run. But, the example below passes a specific folder path to save screenshots at.
+
+    client = AutoScreenshot::Screenshot.new(:folder => '/path/to/folder/')
+
+### Action Map
+
+`action_map` is a ruby hash. each key of the hash is a full URL string
+and each key is a symbol. The symbol corresponds to a name of a method like `wait`. Here is an example:
+
+    action_map = {
+      "http://example.com/page" => :wait
+    }
+
+And a custom method could look like:
+
+    def wait
+      sleep 10 # To allow you to login or something
+    end
+
+## Usage
 
-read from a [.json](/links.json) file,
+AutoScreenshot saves screenshots of webpages as .png files in a folder.  Create a Screenshot client and specify an array of URLs to capture.
 
-    s = Screenshot.new(:file => "test.json")  # an array of URL's as string    
+#### Create a Client. Then set options.
 
-or, read a [.rb](/links.rb) file.
+    client = AutoScreenshot::Screenshot.new #=> get a Screenshot object
+    client.urls = ["http://google.com, http://github.com"]
+    client.folder = "/custom/folder/path"
+    client.action_map = {
+      "http://example.com/do-something-custom-at-this-url" => :custom_method
+    }
 
-    s = Screenshot.new(:file => "/users/name/path/to/links.rb") 
 
-Run Capybara (Selenium) and Firefox. 
+or
 
-    s.go # screenshots are saved to the /screenshots directory as .png files.
+#### Create a Client with options.
 
-### Logging in and custom stuff
+    client = AutoScreenshot::Screenshot.new(:urls => [], :folder => "/custom/folder/path", :action_map => {@url_string => :custom_method})
 
-[Action Map](/action_map.rb) - an action map allows you to specify certain URL's that call some ruby code that you write.  I built this to accomodate logins. It can be used for whatever.
+## Contributing
 
-    s = Screenshot.new({ :file       => "/some/links/in/ruby.rb",
-                         :action_map => "/users/name/path/to/action_map.rb" })
+1. Say [hi](https://twitter.com/randw) and let me know you're using aut
+1. Fork it
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create new Pull Request
 
-load 'lib/auto_screenshot.rb'
+### During Development
 
-    s = AutoScreenshot::Screenshot.new({
-      :links => "/users/ryanw/Desktop/ci.rb",
-      :action_mappings => "/path/to/action_mappings.json",
-      :action_map => "/path/to/action_map.rb",
-      :folder => "/path/to/screenshot_images"
-    })
+Run this from the `auto_screenshot/` directory.
 
+    irb
+    load 'lib/auto_screenshot.rb'
 
-#### Remember
+And, to build the .gem:
 
-* Ensure your website is running when testing locally.
-* Don't abuse anybody's website.
+    gem build auto_screenshot.gemspec

data/auto_screenshot.gemspec

@@ -1,18 +1,29 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/auto_screenshot/version', __FILE__)
+#encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'auto_screenshot/version'
 
 Gem::Specification.new do |gem|
+  gem.name          = "auto_screenshot"
+  gem.version       = AutoScreenshot::VERSION
   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.license       = "MIT"
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files -z`.split("\x0")
+  gem.executables   = gem.files.grep(%r{^bin/}) { |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'
+
+  gem.add_dependency "capybara"
+  gem.add_dependency "json"
+  gem.add_dependency "nokogiri"
+  gem.add_dependency "selenium-webdriver"
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
 end

data/examples/links.json

@@ -0,0 +1,9 @@
+[
+  "http://lvh.me/1",
+  "http://lvh.me/2",
+  "http://lvh.me/3",
+  "http://lvh.me/4",
+  "http://lvh.me/5",
+  "http://lvh.me/6",
+  "http://lvh.me/7"
+]

data/examples/links.rb

@@ -0,0 +1,17 @@
+# Sample links.rb file for AutoScreenshot
+#
+# Important: Be sure to return an Array of URL's
+
+links = []
+
+links << "http://lvh.me/1"
+links << "http://lvh.me/2"
+# links << "http://lvh.me/3"
+
+(4..10).each do |i|
+  links << "http://lvh.me/#{i}"
+end
+
+links << "http://dev.lvh.me:3000/login"
+
+$links = links

data/lib/auto_screenshot.rb

@@ -1,51 +1,48 @@
 require "auto_screenshot/version"
-
-require 'uri'
-require 'json'
 require 'capybara/dsl'
+require 'json'
+require 'uri'
 
 module AutoScreenshot
 
   class Screenshot
+    attr_accessor :urls, :folder, :action_map
+
     include Capybara::DSL
     Capybara.default_driver = :selenium
 
-    attr_accessor :links, :folder, :action_mappings, :action_map
-
-    # Pass in an array of URL's, with http(s)
-    #   or
-    # Pass in a .json or .rb file of links
+    # urls: an array of full URL strings
+    # folder: where to store the files
+    # action_map: a hash where
+    #               keys are URL's that are visited
+    #               values are symbols for custom actions
     #
-    # pass in an action_map
-    # pass in a folder path to where to store the screenshots
-    def initialize(opts = { :links => "", :action_mappings => [], :action_map => "", :folder => "" })
-      raise Exception, "please pass in an array of urls like {:urls => []}, or a file, like {:file => \"test.json\"}" unless opts[:links]
-
-      @links = opts[:links]
-      if @links.class == Array
-        @links = links
-      elsif links.class == String
-        ext = File.extname(@links)
-        if ext == ".rb"
-          load @links
-          @links = $links
-        elsif ext == ".json"
-          @links = JSON.parse(File.open(@links, "r").read)
-        end
-      end
-
-      @action_mappings = set_action_mappings(opts[:action_mappings])
-      load opts[:action_map].to_s
-      @folder = opts[:folder] ||= "screenshots"
+    # see the `wait` method for an example of mapping an action
+    def initialize(options = {
+                    urls: [],
+                    folder: nil,
+                    action_map: {}
+                  })
+      @urls = options[:urls]
+      @folder = options[:folder] ||= "screenshots"
+      @action_map = options[:action_map]
     end
 
-    def go
+    # Passing `dry_run=true`
+    # only lists the URL's that would be processed
+    # but does not take screenshots
+    def go(dry_run = false)
+      raise 'no URLs specified' if @urls.empty?
+
       errors = []
-      @links.each do |url|
+
+      @urls.each do |url|
+        p url; next if dry_run
+
         begin
           puts "Getting #{url}"
           visit "#{url}"
-
+          sleep 3.0 # arbitrary sleep to allow heavily ajax-y pages to load
           snap
           actions(url)
         rescue => err
@@ -55,31 +52,32 @@ module AutoScreenshot
         end
       end
 
-      puts errors
+      errors
     end
 
-    # Load an action map .json file
-    # see /action_mappings.json as an example
-    # {
-    #   "url":<method in action_map.rb>
-    # }
-    def set_action_mappings(path)
-      return {} if path && path.empty?
-
-      json = File.open(path).read
-      hash = JSON.parse(json)
-    end
-
-    # do a specific action for a url, like login
+    # Custom actions, based on a page url
+    # do a specific action for a url, like #wait
     def actions(url)
-      if action_mappings.has_key?(url)
-        sleep 10.0
-        # self.send(action_mappings[url])
+      if action_map && action_map.has_key?(url)
+        self.send(action_map[url])
       else
         nil
       end
     end
 
+    # Define custom actions by monkey-patching.
+    # Use the custom actions
+    # by passing action_map: { :url => :method }
+    #
+    # class AutoScreenshot::Screenshot
+    #   def your_custom_action
+    #   end
+    # end
+    def wait
+      sleep 10.0
+    end
+
+    # TODO: Helper Method
     def grab_links(url)
       links = []
 
@@ -91,13 +89,39 @@ module AutoScreenshot
       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("#{@folder}/#{name}.png")
+    # passing a `descriptor`
+    # adds a string to the filename, so you can name a sub-state for a page
+    def snap(descriptor = "")
+      name = clean_url(page.current_url)
+
+      # Descriptor
+      name = name + (descriptor.empty? ? "" : "-state-#{descriptor}")
+      p "#snap", "name", name unless name.empty?
+
+      set_window_size
+
+      # Ensure @folder exists
+      FileUtils.mkdir_p(@folder) unless File.exists?(@folder)
+  Capybara.current_session.driver.browser.save_screenshot("#{@folder}/#{name}.png")
     end
 
-  end
 
+    private
+
+    def clean_url(full_url)
+      p "#clean_url", full_url
+
+      full_url.gsub("https:\/\/", "")
+              .gsub("http:\/\/", "")
+              .gsub(":", "")
+              .gsub("\/", "-")
+              .gsub("&", "-")
+              .gsub("?", "_")
+    end
+
+    def set_window_size
+      Capybara.current_session.driver.browser.manage.window.resize_to(1200, 800)
+    end
+
+  end
 end

data/lib/auto_screenshot/version.rb

@@ -1,3 +1,3 @@
 module AutoScreenshot
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/lib/auto_screenshot_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe AutoScreenshot::Screenshot do
+
+  describe "#initialize" do
+    context "no args" do
+      before do
+        @client = AutoScreenshot::Screenshot.new
+      end
+
+      it "instantiates" do
+        expect(@client.instance_variables).to match_array [:@urls, :@folder, :@action_map]
+        expect(@client.urls.size).to eq 0
+        expect(@client.action_map).to eq {}
+        expect(@client.folder).to eq 'screenshots'
+      end
+    end
+
+    context "with :urls" do
+      before do
+        @client = AutoScreenshot::Screenshot.new({
+          urls: [
+            "http://google.com",
+            "http://communicatingdesign.com"
+          ]
+        })
+      end
+
+      describe ".new" do
+        it "instantiates" do
+          expect(@client.urls.size).to eq 2
+          expect(@client.folder).to eq 'screenshots'
+          expect(@client.action_map).to eq {}
+        end
+      end
+    end
+
+    context "with :folder" do
+      before do
+        @client = AutoScreenshot::Screenshot.new({
+          folder: 'custom_folder',
+          urls: '[http://google.com]'
+        })
+      end
+
+      it "instantiates" do
+        expect(@client.folder).to eq 'custom_folder'
+      end
+    end
+
+    context "with :action_map" do
+      before do
+        @client = AutoScreenshot::Screenshot.new({
+          action_map: {
+            :url => :custom_method
+          }
+        })
+      end
+
+      it "instantiates" do
+        expect(@client.action_map).to eq ({
+          :url => :custom_method
+        })
+      end
+    end
+  end
+
+  describe "#go" do
+    before do
+      @client = AutoScreenshot::Screenshot.new({
+        urls: [
+          "http://google.com",
+          "http://communicatingdesign.com"
+        ]
+      })
+    end
+
+    describe "#go" do
+      before do
+        @client.go
+      end
+
+      it "save screenshots as .png on Filesystem" do
+        expect(Dir.glob("screenshots/communicatingdesign*.png").size).to eq 1
+        expect(Dir.glob("screenshots/www.google*.png").size).to eq 1
+      end
+    end
+  end
+
+  describe "#actions" do
+  end
+
+  describe "#grab_links" do
+  end
+
+  describe "#wait" do
+    # `wait` is an example of an action used by the `action_map`
+  end
+
+  describe "#snap" do
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,85 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+
+  require 'auto_screenshot'
+  require 'pry'
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  config.before(:all, :type => :request) do
+    Capybara.current_session.driver.browser.manage.window.resize_to(1100, 800)
+  end
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -1,65 +1,171 @@
 --- !ruby/object:Gem::Specification
 name: auto_screenshot
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Ryan Wold
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-20 00:00:00.000000000Z
+date: 2014-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70237450785980 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70237450785980
-description: ! '''Automatically screenshot webpages'''
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  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: nokogiri
+  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: selenium-webdriver
+  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: 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: pry
+  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: 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'
+description: "'Automatically screenshot webpages'"
 email:
 - wold@afomi.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - auto_screenshot.gemspec
+- examples/links.json
+- examples/links.rb
 - lib/auto_screenshot.rb
 - lib/auto_screenshot/version.rb
+- spec/lib/auto_screenshot_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/afomi/auto_screenshot
-licenses: []
+licenses:
+- MIT
+metadata: {}
 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
+rubygems_version: 2.4.3
 signing_key: 
-specification_version: 3
-summary: ! '''Automating webpage screenshots'''
-test_files: []
-has_rdoc: 
+specification_version: 4
+summary: "'Automating webpage screenshots'"
+test_files:
+- spec/lib/auto_screenshot_spec.rb
+- spec/spec_helper.rb