selenium-server 0.2.1 → 1.0.0

data/.gitignore

@@ -1,3 +1,5 @@
+*.swp
+profiles/
 *.jar
 *.gem
 *.rbc

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    selenium-server (0.3.0)
+      rake
+      selenium-webdriver
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    ffi (1.6.0)
+    multi_json (1.7.2)
+    rake (10.0.4)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.31.0)
+      childprocess (>= 0.2.5)
+      multi_json (~> 1.0)
+      rubyzip
+      websocket (~> 1.0.4)
+    websocket (1.0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  selenium-server!

data/README.md

@@ -1,15 +1,40 @@
 #selenium-server
 ===============
 
-A wrapper for the [Selenium Rake Server Task](http://selenium.googlecode.com/svn/trunk/docs/api/rb/Selenium/Rake/ServerTask.html) -- used to download, start, stop, and restart selenium-standalone-server.jar.
+This library aims to make configuring and running your Selenium tests against a Selenium Server simple for both local and remote execution.
+
 
 ## Getting Started
 ```ruby
 require 'selenium-server'
-SeleniumServer.start
-SeleniumServer.restart
-SeleniumServer.stop
+
+SeleniumServer.configure do |c|
+  c.host         = "localhost"
+  c.port         = "4444"
+  c.browser      = "firefox"
+  c.profile_path = "#{Dir.pwd}/profiles/your_custom_firefox_profile"
+end
+
+@driver = SeleniumServer.start
+
+@driver.get "http://www.google.com"
+
+SeleniumServer.finish
 ```  
 
 ## Helpful bits
-The start action will download the latest selenium-standalone-server.jar (unless it already has) and run it, backgrounded, with logging disabled.
+
+### Selenium Actions Reference  
+This library uses the Selenium WebDriver Remote Bridge actions. You can find them [here](http://www.ruby-doc.org/gems/docs/b/bbc-selenium-webdriver-1.17.0/Selenium/WebDriver/Remote/Bridge.html).  
+
+### Start  
+If host is set to "localhost", it will download the latest selenium-standalone-server.jar (unless it already has) and run it. If no additional parameters are set, it will be exected in the background, with logging disabled. This functionality is driven using the [Selenium Rake Server Task](http://selenium.googlecode.com/svn/trunk/docs/api/rb/Selenium/Rake/ServerTask.html).
+
+### Finish  
+Issues a quit command to the driver (and stops the local server if your host is set to "localhost").  
+
+### Support  
+Currently, Firefox is is all that is supported. More coming soon!  
+
+### Versioning  
+This project loosely follows [Semantic Versioning](http://semver.org/).

data/example.rb

@@ -0,0 +1,13 @@
+require 'selenium-server'
+
+SeleniumServer.configure do |c|
+  c.host          = "localhost"
+  c.port          = "4444"
+  c.profile_path  = "#{Dir.pwd}/profiles/alfresco"
+end
+
+@driver = SeleniumServer.start
+
+@driver.get "http://www.google.com"
+
+SeleniumServer.finish

data/lib/selenium-server.rb

@@ -1 +1,5 @@
-require 'selenium-server/wrapper'
+require 'selenium-webdriver'
+require 'selenium-server/selenium-server'
+require 'selenium-server/configuration'
+require 'selenium-server/runner'
+require 'selenium-server/server'

data/lib/selenium-server/configuration.rb

@@ -0,0 +1,5 @@
+module SeleniumServer
+  class Configuration
+    attr_accessor :host, :port, :browser, :profile_path, :version, :background, :log
+  end
+end

data/lib/selenium-server/runner.rb

@@ -0,0 +1,31 @@
+#browser type determines server type
+#browser type determines config params
+#initializer *should* be the same
+
+module SeleniumServer
+  class Runner
+    attr_reader :driver
+
+    def initialize(configuration)
+      @driver = initialize_server(configuration)
+    end
+
+    private
+
+    def set_profile(profile_path)
+      profile = Selenium::WebDriver::Firefox::Profile.new(profile_path)
+      profile.assume_untrusted_certificate_issuer = false
+      Selenium::WebDriver::Remote::Capabilities.firefox(:firefox_profile => profile)
+    end
+
+    def set_server_url(host, port)
+      "http://#{host}:#{port}/wd/hub"
+    end
+
+    def initialize_server(configuration)
+      Selenium::WebDriver::Remote::Bridge.new(
+        :url => set_server_url(configuration.host, configuration.port),
+        :desired_capabilities => set_profile(configuration.profile_path))
+    end
+  end
+end

data/lib/selenium-server/selenium-server.rb

@@ -0,0 +1,34 @@
+module SeleniumServer
+  extend self
+
+  def configure
+    yield configuration
+  end
+
+  def configuration
+    @configuration = Configuration.new
+  end
+
+  attr_reader :driver
+
+  def localhost?
+    case @configuration.host
+      when "localhost" then true
+      else false
+    end
+  end
+
+  def run
+    if localhost? then Server.start end
+    @driver = Runner.new(@configuration).driver
+    return driver
+  end
+
+  def finish
+    driver.quit
+    if localhost? then Server.stop end
+  end
+
+  alias :start :run
+  alias :stop :finish
+end

data/lib/selenium-server/server.rb

@@ -0,0 +1,27 @@
+module SeleniumServer
+  module Server
+    extend self
+
+    def start
+      rake "start"
+    end
+
+    def stop
+      rake "stop"
+    end
+
+    def restart
+      rake "restart"
+    end
+
+    private
+
+    def rake_file
+      "#{File.join(File.dirname(File.expand_path(__FILE__)), 'rake.task')}"
+    end
+
+    def rake(task)
+      system "rake -f #{rake_file} server:#{task}"
+    end
+  end
+end

data/selenium-server.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |s|
   s.name          = 'selenium-server'
-  s.version       = '0.2.1'
+  s.version       = '1.0.0'
   s.platform      = Gem::Platform::RUBY
   s.authors       = ['Dave Haeffner']
   s.email         = ['dave@arrgyle.com']
   s.homepage      = 'https://github.com/arrgyle/selenium-server'
-  s.summary       = 'A wrapper and runner for the selenium-standalone-server jar file.'
+  s.summary       = 'A configurator and runner for you Selenium tests against a Selenium Server.'
   s.license       = 'MIT'
 
   s.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium-server
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-16 00:00:00.000000000 Z
+date: 2013-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -53,10 +53,15 @@ files:
 - .gitignore
 - .rvmrc
 - Gemfile
+- Gemfile.lock
 - README.md
+- example.rb
 - lib/selenium-server.rb
+- lib/selenium-server/configuration.rb
 - lib/selenium-server/rake.task
-- lib/selenium-server/wrapper.rb
+- lib/selenium-server/runner.rb
+- lib/selenium-server/selenium-server.rb
+- lib/selenium-server/server.rb
 - selenium-server.gemspec
 homepage: https://github.com/arrgyle/selenium-server
 licenses:
@@ -82,5 +87,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: A wrapper and runner for the selenium-standalone-server jar file.
+summary: A configurator and runner for you Selenium tests against a Selenium Server.
 test_files: []

data/lib/selenium-server/wrapper.rb

@@ -1,23 +0,0 @@
-module SeleniumServer
-  def self.start
-    rake "start"
-  end
-
-  def self.stop
-    rake "stop"
-  end
-
-  def self.restart
-    rake "restart"
-  end
-
-  private
-
-  def self.rake_file
-    "#{File.join(File.dirname(File.expand_path(__FILE__)), 'rake.task')}"
-  end
-
-  def self.rake(task)
-    system "rake -f #{rake_file} server:#{task}"
-  end
-end