Welcome to the official Ruby driver for [Selenium Remote Control](http://selenium-rc.openqa.org)

Mission
=======

 Provide a simple yet idiomatic Ruby API to write Selenium tests in Ruby. Gives you a straightforward way to
 write your Selenium tests in Ruby.
 
Install It
==========

 The easiest way to install the install selenium-client using RubyGems:

    sudo gem install selenium-client

Features
========

 * Backward compatible with the old-fashioned, XSL generated Selenium Ruby API.
   See [the generated driver](http://selenium-client.rubyforge.org/classes/Selenium/Client/GeneratedDriver.html) to get an extensive reference.
   
 * Idiomatic interface to the Selenium API.
  See [the Idiomatic module](http://selenium-client.rubyforge.org/classes/Selenium/Client/Idiomatic.html)
  for more details.
 
 * Convenience methods for AJAX.
   See the [Extensions](http://selenium-client.rubyforge.org/classes/Selenium/Client/Extensions.html)
   for more details.
   
 * Leveraging latest innovations in Selenium Remote Control (screenshots, log captures, ...)
 
 * Robust Rake task to start/stop the Selenium Remote Control server. More details in the next section.

 * State-of-the-art reporting for RSpec.

Plain API
=========
 
 Selenium client is just a plain Ruby API, so you can use it wherever you can use Ruby. For instance
 to write a little Ruby script using selenium-client you could write something like:

    #!/usr/bin/env ruby
    #
    # Sample Ruby script using the Selenium client API
    #
    require "test/unit"
    require "rubygems"
    gem "selenium-client"
    require "selenium"

    begin
      @browser = Selenium::Client::Driver.new("localhost", 4444, "*firefox", "http://www.google.com", 10000);
      @browser.start_new_browser_session
    	@browser.open "/"
    	@browser.type "q", "Selenium"
    	@browser.click "btnG", :wait_for => :page
    	puts @browser.text?("selenium.openqa.org")
    ensure
      @browser.close_current_browser_session    
    end
 
Writing Tests
=============
 
 Most likely you will be writing functional and acceptance tests using selenium-client. If you are a 
 `Test::Unit` fan your tests will look like:
 
    #!/usr/bin/env ruby
    #
    # Sample Test:Unit based test case using the selenium-client API
    #
    require "test/unit"
    require "rubygems"
    gem "selenium-client"
    require "selenium"

    class ExampleTest < Test::Unit::TestCase
    	attr_reader :browser

      def setup
        @browser = Selenium::Client::Driver.new "localhost", 4444, "*firefox", "http://www.google.com", 10000
        browser.start_new_browser_session
      end

      def teardown
        browser.close_current_browser_session
      end

      def test_page_search
    		browser.open "/"
    		assert_equal "Google", browser.title
    		browser.type "q", "Selenium"
    		browser.click "btnG", :wait_for => :page
    		assert_equal "Selenium - Google Search", browser.title
    		assert_equal "Selenium", browser.field("q")
    		assert browser.text?("selenium.openqa.org")
    		assert browser.element?("link=Cached")
      end

    end
    
 If BDD is more your style, here is how you can achieve the same thing  using RSpec:

    require 'rubygems'
    require 'spec'
    gem "selenium-client"
    require "selenium"
    require "selenium/rspec/spec_helper"

    describe "Google Search" do
    	attr_reader :selenium_driver
    	alias :page :selenium_driver

     before(:all) do
       @selenium_driver = Selenium::Client::Driver.new "localhost", 4444, "*firefox", "http://www.google.com", 10000    
     end

     before(:each) do
       selenium_driver.start_new_browser_session
     end

     after(:each) do
       selenium_driver.close_current_browser_session
     end

     it "can find Selenium" do    
       page.open "/"
       page.title.should eql("Google")
       page.type "q", "Selenium"
       page.click "btnG", :wait_for => :page
       page.value("q").should eql("Selenium")
       page.text?("selenium.openqa.org").should be_true
       page.title.should eql("Selenium - Google Search")
     end

    end 

Start/Stop a Selenium Remote Control Server
===========================================
 
  Selenium client comes with some convenient Rake tasks to start/stop a Remote Control server.
  To leverage all selenium-client capabilities I recommend downloading a recent nightly build of
  a standalone packaging of Selenium Remote Control (great for kick-ass Safari and Firefox 3 support anyway).
  You will find the mightly build at [OpenQA.org](http://archiva.openqa.org/repository/snapshots/org/openqa/selenium/selenium-remote-control/1.0-SNAPSHOT/)
  
    require 'selenium/rake/tasks' 
    
    Selenium::Rake::RemoteControlStartTask.new do |rc|
      rc.port = 4444
      rc.timeout_in_seconds = 3 * 60
      rc.background = true
      rc.wait_until_up_and_running = true
      rc.jar_file = "/path/to/where/selenium-rc-standalone-jar-is-installed"
      rc.additional_args << "-singleWindow"
    end

    Selenium::Rake::RemoteControlStopTask.new do |rc|
      rc.host = "localhost"
      rc.port = 4444
      rc.timeout_in_seconds = 3 * 60
    end
    
 Check out [RemoteControlStartTask](http://selenium-client.rubyforge.org/classes/Selenium/Rake/RemoteControlStartTask.html) and [RemoteControlStopTask](http://selenium-client.rubyforge.org/classes/Selenium/Rake/RemoteControlStopTask.html) for more 
details. 

State-of-the-Art RSpec Reporting
================================

 Selenium Client comes with out-of-the-box RSpec reporting that include HTML snapshots, O.S. screenshots, in-browser page
screenshots (not limited to current viewport), and a capture of the latest remote controls for all failing tests. And all
course all this works even if your infrastructure is distributed (In particular in makes wonders with [Selenium
Grid](http://selenium-grid.openqa.org))

 Using selenium-client RSpec reporting is as simple as using `SeleniumTestReportFormatter` as one of you RSpec formatters. For instance:

    require 'spec/rake/spectask'
    desc 'Run acceptance tests for web application'
    Spec::Rake::SpecTask.new(:'test:acceptance:web') do |t|
     t.libs << "test"
     t.pattern = "test/*_spec.rb"
     t.spec_opts << '--color'
     t.spec_opts << "--require 'rubygems,selenium/rspec/reporting/selenium_test_report_formatter'"
     t.spec_opts << "--format=Selenium::RSpec::SeleniumTestReportFormatter:./tmp/acceptance_tests_report.html"
     t.spec_opts << "--format=progress"                
     t.verbose = true
    end

 You can then get cool reports like [this one](http://ph7spot.com/examples/selenium_rspec_report.html)