auto_screenshot 0.0.1 → 0.0.2

data/Gemfile

@@ -5,3 +5,7 @@ gemspec
 
 gem 'capybara'
 gem 'json'
+
+group :development do 
+  gem 'pry'
+end

data/README.md

@@ -1,42 +1,47 @@
 Auto Screenshot
 ===============
 
-A small library designed to help document web products.
+A small library designed to help the document web products.
 
 ## Usage
 
-From console, within the /auto_screenshot directory:
-    
-    irb
-    load auto_screenshot.rb
+    gem install auto_screenshot
 
-This works in 2 ways:
+### Basics
 
-Method 1: Pass in an array of URL's
+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
+    urls = ["http://domain.lvh.me:3000", "http://domain.lvh.me:3000/link/1"]
+    s = Screenshot.new(:urls => urls)
 
-Or
+read from a [.json](/links.json) file,
 
-Method 2: Read from a .json file
+    s = Screenshot.new(:file => "test.json")  # an array of URL's as string    
 
-    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
+or, read a [.rb](/links.rb) file.
 
-    gem install auto_screenshot
-    rake screenshots --all
-    
-screenshot based on a .rb file or pass arguments
+    s = Screenshot.new(:file => "/users/name/path/to/links.rb") 
+
+Run Capybara (Selenium) and Firefox. 
+
+    s.go # screenshots are saved to the /screenshots directory as .png files.
+
+### Logging in and custom stuff
+
+[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.
+
+    s = Screenshot.new({ :file       => "/some/links/in/ruby.rb",
+                         :action_map => "/users/name/path/to/action_map.rb" })
 
-    load 'auto_screenshot.rb'
-    s = Screenshot.new(:file => "test.json")
-    s.go
+load 'lib/auto_screenshot.rb'
 
-Alternatively, use a ruby file to generate a @links array of URL strings for each page (see dmap.rb as an example)
+    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"
+    })
 
-    load 'dmap.rb'
-    s = Screenshot.new(:urls => $links)
 
 #### Remember
 

data/lib/auto_screenshot.rb

@@ -7,39 +7,45 @@ 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)
+    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
+    #
+    # 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_map_path = opts[:action_map_path]
+      @action_mappings = set_action_mappings(opts[:action_mappings])
+      load opts[:action_map].to_s
       @folder = opts[:folder] ||= "screenshots"
-      @action_map = action_map
     end
 
     def go
       errors = []
-      @urls.each do |url|
+      @links.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
@@ -52,38 +58,28 @@ module AutoScreenshot
       puts errors
     end
 
-    def action_map
-      json = File.open(@action_map_path).read
+    # 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
 
-
-    # custom actions for Granicus
-    # something custom based on a page.  pages must be ordered in the URL array though
+    # do a specific action for a url, like login
     def actions(url)
-      # do a specific action for a url, like login
-
-      if action_map.has_key?(url)
-        self.send(action_map[url])
+      if action_mappings.has_key?(url)
+        sleep 10.0
+        # self.send(action_mappings[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 = []
 
@@ -99,7 +95,7 @@ module AutoScreenshot
       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")
+      Capybara.current_session.driver.browser.save_screenshot("#{@folder}/#{name}.png")
     end
 
   end

data/lib/auto_screenshot/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auto_screenshot
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-19 00:00:00.000000000Z
+date: 2013-03-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70132291619560 !ruby/object:Gem::Requirement
+  requirement: &70237450785980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70132291619560
+  version_requirements: *70237450785980
 description: ! '''Automatically screenshot webpages'''
 email:
 - wold@afomi.com