jeffrafter-crocodile 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeff Rafter
+
+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.rdoc

@@ -0,0 +1,28 @@
+= Crocodile
+
+Crocodile is a simple lib and executable for taking screenshots. Make it better.
+It relies on the selenium-client gem. Currently however, it is only compatabile
+with the selenium-client -v=1.2.14. Newer versions of the selenium gem are
+not yet supported. 
+
+  $ sudo gem install selenium-client -v=1.2.14
+  $ sudo gem install crocodile
+  
+Once you have installed crocodile and the selenium-client gem you can quickly
+snap shots of mockups from the commandline:
+
+  $ crocodile --start --stop --width=1024 --height=768 mockup.html mockup.png
+  
+This tells crocodile to start the Selenium Remote Control Server in the
+background (and stop it when the task is completed). It tells it to load the 
+file mockup.html (because no protocol is included, the script assumes this is 
+on the local filesystem). Once loaded, the browser window will be resized to 
+1024 pixels by 768 pixels. The screenshot will be saved as mockup.png.
+
+You can get basic help as well
+
+  $ crocodile --help
+
+== Copyright
+
+Copyright (c) 2009 Jeff Rafter. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "crocodile"
+    gem.summary = %Q{ Crocodile is a quick tool for taking screenshots using selenium-client }
+    gem.email = "jeff@baobabhealth.org"
+    gem.homepage = "http://github.com/jeffrafter/crocodile"
+    gem.authors = ["Jeff Rafter"]
+    gem.add_dependency('selenium-client', '= 1.2.14')
+    gem.files.include('vendor/*')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "crocodile #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/bin/crocodile

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+if ARGV.size == 0 || ARGV.include?('--help')
+  puts "Usage: crocodile [options] source dest" 
+  puts ""
+  puts "  --start          Start the selenium server"
+  puts "  --stop           Stop the selenium server"
+  puts "  --width=WIDTH    Set the width of the window"
+  puts "  --height=HEIGHT  Set the height of the window"
+  puts "  --script=SCRIPT  Execute arbitrary javascript in the window"
+  puts "  --help"
+  exit
+end
+
+# Grab the params
+params = ARGV.reject{|arg| arg =~ /^--/}
+source = params[0] rescue nil
+dest = params[1] rescue nil
+
+raise "You're not doing it right" if source.empty? || dest.empty?
+
+require 'rubygems'
+require 'crocodile'
+require 'net/http'
+
+def opt(name)
+  p = ARGV.select{|arg| arg =~ /^--#{name}=/}.first
+  p.gsub(/^--#{name}=/, '') if p
+end
+
+width = opt "width"
+height = opt "height"
+script = opt "script"
+
+puts "Starting Selenium"
+options = {}
+options[:start] = true if ARGV.include? '--start'
+options[:stop] = true if ARGV.include? '--start'
+options[:width] = width if width
+options[:height] = height if height
+
+source_uri = URI.parse(source)
+if (source_uri.relative?)
+  source_path = File.expand_path(source)
+  source_base = "file://"
+else
+  source_path = source_uri.path
+  source_base = source.gsub(Regexp.new(source_path + "$"), '')
+end  
+Crocodile.snap(source_base, source_path, dest, options) do |browser|
+  browser.get_eval script if script
+end
+puts "Done"

data/crocodile.gemspec

@@ -0,0 +1,54 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{crocodile}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeff Rafter"]
+  s.date = %q{2009-07-08}
+  s.default_executable = %q{crocodile}
+  s.email = %q{jeff@baobabhealth.org}
+  s.executables = ["crocodile"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/crocodile",
+     "crocodile.gemspec",
+     "lib/crocodile.rb",
+     "test/crocodile_test.rb",
+     "test/test_helper.rb",
+     "vendor/selenium-server.jar",
+     "vendor/selenium-server.jar"
+  ]
+  s.homepage = %q{http://github.com/jeffrafter/crocodile}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Crocodile is a quick tool for taking screenshots using selenium-client}
+  s.test_files = [
+    "test/crocodile_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<selenium-client>, ["= 1.2.14"])
+    else
+      s.add_dependency(%q<selenium-client>, ["= 1.2.14"])
+    end
+  else
+    s.add_dependency(%q<selenium-client>, ["= 1.2.14"])
+  end
+end

data/lib/crocodile.rb

@@ -0,0 +1,39 @@
+require 'selenium/client'
+
+class Crocodile  
+
+  HOST = "0.0.0.0"
+  PORT = 4444
+  TIMEOUT = 60
+
+  def self.start
+    selenium = Selenium::RemoteControl::RemoteControl.new(HOST, PORT, TIMEOUT)
+    selenium.jar_file = File.join(File.dirname(__FILE__), '..', 'vendor', "selenium-server.jar")
+    selenium.start :background => true
+    TCPSocket.wait_for_service :host => HOST, :port => PORT
+  end
+
+  def self.stop
+    selenium = Selenium::RemoteControl::RemoteControl.new(HOST, PORT, TIMEOUT)
+    selenium.stop
+    TCPSocket.wait_for_service_termination :host => HOST, :port => PORT
+  end
+
+  def self.snap(host, url, dest, options, &block)
+    start if options[:start]
+    browser = Selenium::Client::Driver.new( 
+      :host => HOST || options[:host],
+      :port => PORT || options[:port],
+      :timeout_in_second => TIMEOUT || options[:timeout],
+      :browser => "*firefox",
+      :url => host)
+    browser.start_new_browser_session
+    browser.open url
+    browser.get_eval "window.resizeTo(#{options[:width]},#{options[:height]});" if (options[:width] && options[:height])
+    yield browser if block
+    browser.capture_entire_page_screenshot File.join(File.expand_path('.'), dest), ''
+    browser.close_current_browser_session    
+  ensure
+    stop if options[:stop]
+  end
+end

data/test/crocodile_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class CrocodileTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'crocodile'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: jeffrafter-crocodile
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Jeff Rafter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-08 00:00:00 -07:00
+default_executable: crocodile
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: selenium-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.2.14
+    version: 
+description: 
+email: jeff@baobabhealth.org
+executables: 
+- crocodile
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/crocodile
+- crocodile.gemspec
+- lib/crocodile.rb
+- test/crocodile_test.rb
+- test/test_helper.rb
+- vendor/selenium-server.jar
+has_rdoc: false
+homepage: http://github.com/jeffrafter/crocodile
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Crocodile is a quick tool for taking screenshots using selenium-client
+test_files: 
+- test/crocodile_test.rb
+- test/test_helper.rb