selenium_shots 0.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Kyle J. Ginavan
+
+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/LICENSE.orig

@@ -0,0 +1,24 @@
+<<<<<<< HEAD
+Copyright (c) 2010 Kyle Ginavan
+=======
+Copyright (c) 2010 Kyle J. Ginavan
+>>>>>>> 469e6dd32e742be5b03b6d01b441316b7e4c6bbc
+
+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,18 @@
+= selenium_shots
+
+http://www.seleniumshots.com
+Selenium Shots is an Integration Testing Service that transparently distributes your integration tests across multiple operating systems with different versions of all major browsers AND captures a screen shot. This eliminates the need to have multiple vm's on your computer or the need for multiple machines on your test to test your web application.  Running your tests remotely will dramatically speed up in-browser web testing and leave more time to  and create a slide show available to confirm visuals making it easy for you to improve your web application.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Kyle Ginavan. See LICENSE for details.

data/bin/selenium_shots

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib/selenium_shots/cli/')
+
+require 'init'
+
+args = ARGV.dup
+ARGV.clear
+command = args.shift.strip rescue 'help'
+
+if File.exists?('config/environment.rb')
+  SeleniumShots::Command.run(command, args)
+else
+  puts "No rails app found!, you need stay inside on the root of one rails app"
+end
+

data/lib/selenium_shots.rb

@@ -0,0 +1,2 @@
+require "selenium_shots/test_selenium_shots"
+

data/lib/selenium_shots/cli/client.rb

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rexml/document'
+require 'rest_client'
+require 'uri'
+require 'time'
+
+class SeleniumShots::Client
+
+	attr_reader :host, :api_key
+
+	def initialize(api_key, host='seleniumshots.heroku.com')
+		@api_key  = api_key
+		@host     = host
+	end
+
+  def list
+    #get list app from selenium_shots
+    []
+  end
+
+############
+	def resource(uri)
+		RestClient::Resource.new("http://#{host}", api_key)[uri]
+	end
+
+	def get(uri)
+		resource(uri).get
+	end
+
+	def post(uri)
+		resource(uri).post
+	end
+
+	def put(uri)
+		resource(uri).put
+	end
+
+	def delete(uri)
+		resource(uri).delete
+	end
+
+	def xml(raw)   # :nodoc:
+		REXML::Document.new(raw)
+	end
+
+	def escape(value)  # :nodoc:
+		escaped = URI.escape(value.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+		escaped.gsub('.', '%2E') # not covered by the previous URI.escape
+	end
+
+
+end
+

data/lib/selenium_shots/cli/command.rb

@@ -0,0 +1,50 @@
+module SeleniumShots
+	module Command
+		class InvalidCommand < RuntimeError; end
+		class CommandFailed  < RuntimeError; end
+
+		class << self
+			def run(command, args)
+				run_internal(command, args)
+			rescue InvalidCommand
+				display "Unknown command. Run 'selenium_shots help' for usage information."
+			end
+
+			def run_internal(command, args)
+				namespace, command = parse(command)
+				require "#{namespace}"
+				klass = SeleniumShots::Command.const_get(namespace.capitalize).new(args)
+				raise InvalidCommand unless klass.respond_to?(command)
+				klass.send(command)
+			end
+
+			def display(msg)
+				puts(msg)
+			end
+
+			def parse(command)
+				parts = command.split(':')
+				case parts.size
+					when 1
+						if namespaces.include? command
+							return command, 'index'
+						else
+							return 'app', command
+						end
+					when 2
+						raise InvalidCommand unless namespaces.include? parts[0]
+						return parts
+					else
+						raise InvalidCommand
+				end
+			end
+
+			def namespaces
+				@@namespaces ||= Dir["#{File.dirname(__FILE__)}/commands/*"].map do |namespace|
+					namespace.gsub(/.*\//, '').gsub(/\.rb/, '')
+				end
+			end
+		end
+	end
+end
+

data/lib/selenium_shots/cli/commands/app.rb

@@ -0,0 +1,20 @@
+module SeleniumShots::Command
+	class App < Base
+    def create
+		  name    = args.shift.downcase.strip rescue nil
+      api_key ||= SeleniumShots::Command.run_internal('auth:api_key', args)
+      make_config_file(name, api_key)
+		  display "Created #{name}"
+    end
+
+    def list
+			list = selenium_shots.list
+			if list.size > 0
+				display list.join("\n")
+			else
+				display "You have no apps."
+			end
+		end
+	end
+end
+

data/lib/selenium_shots/cli/commands/auth.rb

@@ -0,0 +1,127 @@
+module SeleniumShots::Command
+	class Auth < Base
+		attr_accessor :api_key_hash
+
+		def client
+			@client ||= init_selenium_shots
+		end
+
+		def init_selenium_shots
+			SeleniumShots::Client.new(api_key)
+		end
+
+		def api_key
+      get_api_key
+		end
+
+    def get_api_key_from_host
+      RestClient.post 'http://seleniumshots.heroku.com/selenium_tests/get_api_key', :user_session => { :login => @api_key_hash[0],
+                                                                                    :password => @api_key_hash[1]}
+    end
+
+		def api_key_file
+			"#{home_directory}/.selenium_shots/api_key"
+		end
+
+		def get_api_key
+			return if @api_key_hash
+			unless @api_key_hash = read_api_key
+				@api_key_hash = ask_for_api_key
+				save_api_key
+			end
+			@api_key_hash
+		end
+
+		def read_api_key
+			if File.exists? api_key_file
+				return File.read(api_key_file).split("\n")
+			end
+		end
+
+		def echo_off
+			system "stty -echo"
+		end
+
+		def echo_on
+			system "stty echo"
+		end
+
+		def ask_for_api_key
+			puts "Enter your SeleniumShots Account"
+
+			print "Login: "
+			user = ask
+
+			print "Password: "
+			password = running_on_windows? ? ask_for_password_on_windows : ask_for_password
+
+			[ user, password ]
+		end
+
+		def ask_for_password_on_windows
+			require "Win32API"
+			char = nil
+			password = ''
+
+			while char = Win32API.new("crtdll", "_getch", [ ], "L").Call do
+				break if char == 10 || char == 13 # received carriage return or newline
+				if char == 127 || char == 8 # backspace and delete
+					password.slice!(-1, 1)
+				else
+					password << char.chr
+				end
+			end
+			puts
+			return password
+		end
+
+		def ask_for_password
+			echo_off
+			password = ask
+			puts
+			echo_on
+			return password
+		end
+
+		def save_api_key
+			begin
+        @api_key_hash = get_api_key_from_host
+				write_api_key
+			rescue RestClient::Unauthorized => e
+				delete_api_key
+				raise e unless retry_login?
+				display "\nAuthentication failed"
+				@api_key_hash = ask_for_api_key
+				@client = init_selenium_shots
+				retry
+			rescue Exception => e
+				delete_api_key
+				raise e
+			end
+		end
+
+		def retry_login?
+			@login_attempts ||= 0
+			@login_attempts += 1
+			@login_attempts < 3
+		end
+
+		def write_api_key
+			FileUtils.mkdir_p(File.dirname(api_key_file))
+			File.open(api_key_file, 'w') do |f|
+				f.puts self.api_key_hash
+			end
+			set_api_key_permissions
+		end
+
+		def set_api_key_permissions
+			FileUtils.chmod 0700, File.dirname(api_key_file)
+			FileUtils.chmod 0600, api_key_file
+		end
+
+		def delete_api_key
+			FileUtils.rm_f(api_key_file)
+		end
+	end
+end
+

data/lib/selenium_shots/cli/commands/base.rb

@@ -0,0 +1,61 @@
+require 'fileutils'
+
+module SeleniumShots::Command
+	class Base
+		attr_accessor :args
+		def initialize(args)
+			@args = args
+		end
+
+		def selenium_shots
+			@selenium_shots ||= SeleniumShots::Command.run_internal('auth:client', args)
+		end
+
+		def display(msg, newline=true)
+			newline ? puts(msg) : print(msg)
+		end
+
+		def ask
+			gets.strip
+		end
+
+		def shell(cmd)
+			`#{cmd}`
+		end
+
+		def home_directory
+			running_on_windows? ? ENV['USERPROFILE'] : ENV['HOME']
+		end
+
+		def running_on_windows?
+			RUBY_PLATFORM =~ /mswin32/
+		end
+
+    def config_file
+      'config/selenium_shots.yml'
+    end
+
+    def make_config_file(name, api_key)
+ 			FileUtils.rm_f(config_file) if File.exists?(config_file)
+      config_file_hash = <<EOFILE
+api_key: "#{api_key}"
+hub_url: 'url'
+hub_port: 'port'
+default_browser_url: 'default url'
+application_name: "#{name}"
+browsers:
+    - IE8 on XP
+EOFILE
+			File.open(config_file, 'w') do |f|
+				f.puts config_file_hash
+			end
+    end
+
+    def inside_rails_app?
+      File.exists?('config/environment.rb')
+    end
+
+	end
+
+end
+

data/lib/selenium_shots/cli/commands/help.rb

@@ -0,0 +1,23 @@
+module SeleniumShots::Command
+	class Help < Base
+		def index
+			display usage
+		end
+
+		def usage
+			usage = <<EOTXT
+=== General Commands
+
+ help                         # show this usage
+ create [name]                # create file config for your app
+=== Example story:
+
+ rails myapp
+ cd myapp
+ (...make edits...)
+ selenium_shots create example_one
+EOTXT
+		end
+	end
+end
+

data/lib/selenium_shots/cli/init.rb

@@ -0,0 +1,9 @@
+module SeleniumShots; end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/commands')
+
+require "rubygems" #take this later
+require "base"
+require "client"
+require "command"
+

data/lib/selenium_shots/test_selenium_shots.rb

@@ -0,0 +1,104 @@
+require "test/unit"
+require "rubygems"
+require "selenium/client"
+require 'active_support'
+require 'active_support/test_case'
+require 'ostruct'
+
+
+#load config
+SeleniumConfig = OpenStruct.new(YAML.load_file("#{RAILS_ROOT}/config/selenium_shots.yml"))
+#
+PICS_WINDOWS_PATH = "Z:"
+PICS_LINUX_PATH   = ''
+PICS_MACOS_PATH   = ''
+#
+#activeresource models
+class SeleniumTest < ActiveResource::Base
+  self.site = "http://seleniumshots.heroku.com"
+  self.user = SeleniumConfig.api_key
+end
+
+
+class ActiveSupport::TestCase
+
+  attr_reader :browser, :agent
+
+  def self.selenium_shot(description, &block)
+    #set vars
+    @description = description
+
+    test_name = "test_#{description.gsub(/\s+/,'_')}".to_sym
+    defined = instance_method(test_name) rescue false
+    raise "#{test_name} is already defined in #{self}" if defined
+    if block_given?
+      define_method(test_name, &block)
+    else
+      define_method(test_name) do
+        flunk "No implementation provided for #{name}"
+      end
+    end
+  end
+
+  def select_browser(browser, url = nil)
+    @browser = Selenium::Client::Driver.new \
+        :host => SeleniumConfig.hub_url,
+        :port => SeleniumConfig.hub_port,
+        :browser => browser,
+        :url => url || SeleniumConfig.default_browser_url,
+        :timeout_in_second => 60,
+        :highlight_located_element => true
+    @browser.start_new_browser_session
+  end
+
+  def hover_click(locator)
+    browser.mouse_over locator
+    browser.click locator
+    browser.focus locator
+  end
+
+  def open_and_wait(url)
+    browser.open url
+    browser.wait_for_page_to_load "30000"
+  end
+
+  def run_test(&proc)
+    begin
+      proc.call
+      @error = nil
+    rescue => e
+      @error = e.message
+    end
+  end
+
+  def teardown
+    save_test ({:selenium_test_group_name => @group, :selenium_test_name => @name,
+                :description => @description})
+    browser.close_current_browser_session
+  end
+
+  def capture_screenshot_on(src)
+    browser.window_focus
+    browser.window_maximize
+    sleep(2)
+    if browser.browser_string.match(/XP/)
+      browser.capture_entire_page_screenshot("#{PICS_WINDOWS_PATH}\\#{src}", "background=#FFFFFF")
+    elsif browser.browser_string.match(/SnowLeopard/)
+      browser.capture_entire_page_screenshot("#{PICS_MACOS_PATH}/#{src}", "background=#FFFFFF")
+    elsif browser.browser_string.match(/Linux/)
+      browser.capture_entire_page_screenshot("#{PICS_LINUX_PATH}/#{src}", "background=#FFFFFF")
+    end
+  end
+
+  def save_test(params)
+    src = "#{SeleniumConfig.application_name}_#{params[:selenium_test_group_name]}_#{params[:selenium_test_name]}_" +
+          "#{browser.browser_string.gsub(/\s+/,"_").downcase}.png"
+
+    capture_screenshot_on(src)
+
+    SeleniumTest.create(:selenium_test_name => params[:selenium_test_name], :description => params[:description],
+      :url => browser.location, :error_message => @error, :is_error => !@error.nil?, :environment => browser.browser_string,
+      :selenium_test_group_name => params[:selenium_test_group_name], :application_name => SeleniumConfig.application_name)
+  end
+end
+

data/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 'selenium_shots'
+
+class Test::Unit::TestCase
+end

data/test/test_selenium_shots.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSeleniumShots < 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

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: selenium_shots
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Kyle J. Ginavan
+- Mauro Torres
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-08 00:00:00 -05:00
+default_executable: selenium_shots
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 2
+        version: 0.8.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: launchy
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 2
+        version: 0.3.2
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: selenium-client
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 18
+        version: 1.2.18
+  type: :runtime
+  version_requirements: *id004
+description: Selenium Shots is an Integration Testing Service that transparently distributes your integration tests across multiple operating systems with different versions of all major browsers AND captures a screen shot
+email: kyle@4rockets.com
+executables: 
+- selenium_shots
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- LICENSE.orig
+- README.rdoc
+files: 
+- lib/selenium_shots.rb
+- lib/selenium_shots/cli/client.rb
+- lib/selenium_shots/cli/command.rb
+- lib/selenium_shots/cli/commands/app.rb
+- lib/selenium_shots/cli/commands/auth.rb
+- lib/selenium_shots/cli/commands/base.rb
+- lib/selenium_shots/cli/commands/help.rb
+- lib/selenium_shots/cli/init.rb
+- lib/selenium_shots/test_selenium_shots.rb
+- LICENSE
+- LICENSE.orig
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/kylejginavan/selenium_shots
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Integration Tests made easy
+test_files: 
+- test/helper.rb
+- test/test_selenium_shots.rb