sauce 1.0.2 → 2.0.0

data/.document

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

data/.gitignore

@@ -0,0 +1,30 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+sauce_connect.log*
+account.yml
+*.gem
+Gemfile.lock
+.idea
+.rvmrc
+ondemand.yml
+*.sqlite3
+schema.rb

data/Gemfile

@@ -0,0 +1,16 @@
+source :gemcutter
+
+gem 'rake'
+
+gemspec
+
+group :test do
+  gem 'cucumber'
+  gem 'rspec', '~> 2.9'
+  gem 'capybara'
+  gem 'jasmine'
+end
+
+group :development do
+  gem 'ruby-debug'
+end

data/README.markdown

@@ -1,20 +1,30 @@
-Sauce OnDemand is a Selenium testing cloud service, developed by Sauce Labs Inc
-(saucelabs.com). This is the Ruby client adapter for Sauce OnDemand.
+# Sauce OnDemand for Ruby
 
-Features
---------
+Sauce OnDemand is a Selenium-based browser testing service offered by [Sauce
+Labs](https://www.saucelabs.com).
 
-*   Drop-in replacement for Selenium::Client::Driver that takes care of connecting to Sauce OnDemand
-*   RSpec, Test::Unit, and Rails integration for tests, including automatic setup of Sauce Connect
-*   ActiveRecord-like interface for job metadata: Find/create/destroy
 
-Install
--------
+## Installation
 
-`gem install sauce`
+```bash
+    % gem install sauce
+```
 
-Rails Integration
--------
+
+## Suggested Toolchain
+
+
+The Sauce gem has been optimized to work most effectively with
+[Cucumber](https://www.cukes.info) and
+[Capybara](http://jnicklas.github.com/capybara/).
+
+You can read more about how to get started with [Cucumber and Capybara on this
+wiki
+page](https://github.com/saucelabs/sauce\_ruby/wiki/Cucumber-and-Capybara).
+
+
+
+## Legacy Rails Integration
 
 You can use either RSpec or Test::Unit with Rails and Sauce OnDemand.  To get started, run the generator:
 
@@ -28,11 +38,11 @@ configuration, which you can tweak inside the `Sauce.config` block if necessary.
 Here's an example test for RSpec.  Drop something like this in spec/selenium/example.rb.  (Because of the way RSpec categorizes tests, the "spec/selenium" directory tree is required for the integration to work properly):
 
     require "spec_helper"
-    
+
     describe "my app" do
       it "should have a home page" do
-        page.open "/"
-        page.is_text_present("Welcome Aboard").should be_true
+        s.get 'http://localhost:3001/'
+        assert s.page_source.include? 'Welcome aboard'
       end
     end
 
@@ -42,14 +52,14 @@ Here's how you run RSpec tests with Sauce OnDemand using rake:
 
 ### Example Test::Unit test for Rails
 
-Here's an example test for Test::Unit.  Drop something like this in test/selenium/example.rb:
+Here's an example test for Test::Unit.  Drop something like this in test/selenium/example\_test.rb:
 
     require "test_helper"
-    
+
     class DemoTest < Sauce::RailsTestCase
       test "my app", do
-        page.open "/"
-        page.is_text_present("Welcome Aboard").should be_true
+        s.get 'http://localhost:3001/'
+        assert s.page_source.include? 'Welcome aboard'
       end
     end
 
@@ -57,138 +67,22 @@ Here's how you run Test::Unit tests with Sauce OnDemand using rake:
 
 `rake test:selenium:sauce`
 
-RSpec integration without Rails
--------------------------------
-
-First, configure with your account info:
-
-`sauce config USERNAME ACCESS_KEY`
-
-And here's an example test.  Drop something like this in spec/selenium/example.rb.  (Because of the way RSpec categorizes tests, the "spec/selenium" directory tree is required for the integration to work properly):
-
-    #!/usr/bin/env ruby
-    #
-    # Sample RSpec test case using the Sauce gem
-    #
-    require "rubygems"
-    require "sauce"
-    
-    # This should go in your spec_helper.rb file if you have one
-    Sauce.config do |config|
-      config.browser_url = "http://saucelabs.com/"
-      config.browsers = [
-        ["Linux", "firefox", "3.6."]
-      ]
-    
-      # uncomment this if your server is not publicly accessible
-      #config.application_host = "localhost"
-      #config.application_port = "80"
-    end
-    
-    # If this goes in spec/selenium/foo_spec.rb, you can omit the :type parameter
-    describe "The Sauce Labs website", :type => :selenium do
-      it "should have a home page" do
-        page.open "/"
-        page.is_text_present("Sauce Labs").should be_true
-      end
-    
-      it "should have a pricing page" do
-        page.open "/"
-        page.click "link=Pricing"
-        page.wait_for_page_to_load 30000
-        page.is_text_present("Free Trial").should be_true
-      end
-    end
 
-Test::Unit integration without Rails
-------------------------------------
-
-First, configure with your account info:
-
-`sauce config USERNAME ACCESS_KEY`
-
-And here's an example test:
-
-    #!/usr/bin/env ruby
-    #
-    # Sample Test:Unit test case using the Sauce gem
-    #
-    require "test/unit"
-    require "rubygems"
-    require "sauce"
-    
-    # This should go in your test_helper.rb file if you have one
-    Sauce.config do |config|
-      config.browser_url = "http://saucelabs.com/"
-      config.browsers = [
-        ["Linux", "firefox", "3.6."]
-      ]
-    
-      # uncomment this if your server is not publicly accessible
-      #config.application_host = "localhost"
-      #config.application_port = "80"
-    end
-    
-    class ExampleTest < Sauce::TestCase
-        def test_sauce
-            page.open "/"
-            assert page.title.include?("Sauce Labs")
-        end
-    end
-
-Direct use of the Selenium Client driver
-----------------------------------------
-
-First, configure with your account info:
-
-`sauce config USERNAME ACCESS_KEY`
-
-And here's an example test:
-
-    require 'rubygems'
-    require 'sauce'
-    selenium = Sauce::Selenium.new(:browser_url => "http://saucelabs.com",
-        :browser => "firefox", :browser_version => "3.", :os => "Windows 2003",
-        :job_name => "My first test!")
-    selenium.start
-    selenium.open "/"
-    selenium.stop
+### Contributing to the Gem
 
-Note on Patches/Pull Requests
------------------------------ 
+*  Fork the project.
+*  Make your feature addition or bug fix.
+*  Please add RSpec tests for your changes, as we don't create a new release of the gem unless all tests are passing.
+*  Commit
+*  Send a pull request. Bonus points for topic branches.
 
-*   Fork the project.
-*   Make your feature addition or bug fix.
-*   Add tests for it. This is important so we 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.
 
-Testing the Gem
----------------
+### Testing the Gem
 
-The tests in test/ need a bit of setup to get running:
+Running the full test suite will require [RVM](http://rvm.beginrescueend.com)
 
-if you're on Ubuntu:
-
-* sudo aptitude install expect libsqlite3-dev
-
-For all platforms:
-
-* Install RVM: bash < <( curl http://rvm.beginrescueend.com/releases/rvm-install-head )
-* If you're in a headless environment, set SAUCE_TEST_NO_LOCAL=y in your environment
 * Set SAUCE_USERNAME and SAUCE_ACCESS_KEY in your environment to valid Sauce OnDemand credentials
 * bundle install
-* rake test
-
-If you want tests to go a bit faster, globally install the gems with native extensions:
-
-* rvm use 1.8.7@global
-* gem install ffi sqlite3 json
-* rvm use 1.9.2@global
-* gem install ffi sqlite3 json
-* rvm use default
-
-Copyright
----------
+* rake spec:unit # Will just run the unit tests
+* rake test      # Will run *all* the tests and can be slow
 
-Copyright (c) 2009-2011 Sauce Labs Inc. See LICENSE for details.

data/Rakefile

@@ -1,26 +1,53 @@
 require 'rubygems'
-require 'rake'
-
+require 'bundler'
 require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+namespace :spec do
+  rspec_options = '--color --format d --fail-fast --order random'
+  RSpec::Core::RakeTask.new(:unit) do |s|
+    s.pattern = 'spec/sauce/**_spec.rb'
+    s.rspec_opts = rspec_options
+  end
+
+  RSpec::Core::RakeTask.new(:integration) do |s|
+    s.pattern = 'spec/integration/**_spec.rb'
+    s.rspec_opts = rspec_options
+  end
+end
+
+task :default => :'spec:unit'
+
+def ensure_rvm!
+  unless File.exists? File.expand_path("~/.rvm/scripts/rvm")
+    abort("I don't think you have RVM installed, which means this test will fail")
+  end
 end
 
 namespace :test do
-  Rake::TestTask.new(:api) do |test|
-    test.libs << 'lib' << 'test'
-    test.pattern = 'test/api/test_*.rb'
-    test.verbose = true
+  namespace :cucumber do
+    desc "Run an integration test with the cucumber-capybara code (slow)"
+    task :capybara do |t|
+      ensure_rvm!
+      sh "(cd examples/cucumber-capybara/ && ./run-test.sh)"
+    end
   end
-  Rake::TestTask.new(:integrations) do |test|
-    test.libs << 'lib' << 'test'
-    test.pattern = 'test/test_integrations.rb'
-    test.verbose = true
+  namespace :rails3 do
+    desc "Run an integration test with the rails3-demo code (slow)"
+    task :testunit do |t|
+      ensure_rvm!
+      sh "(cd examples/rails3-demo && ./run-test.sh)"
+    end
   end
 end
 
+desc "Run *all* tests, this will be slow!"
+task :test => [:'spec:unit', :'spec:integration',
+               :'test:cucumber:capybara', :'test:rails3:testunit']
+
+
 Rake::TestTask.new(:examples) do |test|
   test.libs << 'lib' << 'examples'
   test.pattern = 'examples/test_*.rb'
@@ -50,13 +77,12 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-task :build do
-  system "gem build sauce.gemspec"
-end
-
 desc 'Release gem to rubygems.org'
 task :release => :build do
-  system "gem push `ls *.gem | sort | tail -n 1`"
+  gems = Dir["pkg/*.gem"]
+  if gems
+    system("gem push #{gems[-1]}")
+  end
 end
 
 desc 'tag current version'
@@ -80,4 +106,4 @@ task :push do
   system "git push origin master --tags"
 end
 
-task :default => [:tag, :release, :push]
+#task :default => [:tag, :release, :push]

data/bin/sauce

@@ -10,79 +10,90 @@ require 'highline/import'
 sauce_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(sauce_dir) unless $LOAD_PATH.include?(sauce_dir)
 
-# special case for sauce connect
-if ARGV.length > 0 && ARGV[0] == 'connect'
-  require 'sauce/connect'
-  system ([Sauce::Connect.find_sauce_connect] + ARGV[1..100]).join(" ")
-else
   require 'sauce'
 
-  cmd = CmdParse::CommandParser.new(true, true)
-  cmd.program_name = "sauce "
-  cmd.program_version = [0, 1, 0]
+cmd = CmdParse::CommandParser.new(true, true)
+cmd.program_name = "sauce "
+cmd.program_version = [0, 1, 0]
 
-  cmd.add_command(CmdParse::HelpCommand.new)
+cmd.add_command(CmdParse::HelpCommand.new)
 
-  # configure
-  class ConfigureCommand < CmdParse::Command
-    def usage
-      "Usage: #{commandparser.program_name}configure USERNAME ACCESS_KEY"
-    end
+class ConnectCommand < CmdParse::Command
+  def usage
+    "Usage: #{commandparser.program_name}connect"
   end
-  configure = ConfigureCommand.new('configure', false)
-  configure.short_desc = "Configure Sauce OnDemand credentials"
-  configure.set_execution_block do |args|
-    if args.length < 2
-      puts configure.usage
-      exit 1
-    end
-    username = args[0]
-    access_key = args[1]
-    dir = File.join(File.expand_path("~"), ".sauce")
-    FileUtils.mkdir(dir) unless File.directory?(dir)
+end
+connect = ConnectCommand.new('connect', false)
+connect.short_desc = 'Connect a Sauce Connect tunnel'
+connect.set_execution_block do |args|
+  require 'sauce/connect'
+  require 'sauce/config'
+  config = Sauce::Config.new
+  command = "#{Sauce::Connect.connect_command} #{config.username} #{config.access_key} #{ARGV[1 .. -1]}"
+  exec(command)
+end
+cmd.add_command(connect)
 
-    out = File.new(File.join(dir, "ondemand.yml"), 'w')
-    out.write(YAML.dump({"username" => username, "access_key" => access_key}))
-    out.close()
+
+# configure
+class ConfigureCommand < CmdParse::Command
+  def usage
+    "Usage: #{commandparser.program_name}configure USERNAME ACCESS_KEY"
   end
-  cmd.add_command(configure)
+end
+configure = ConfigureCommand.new('configure', false)
+configure.short_desc = "Configure Sauce OnDemand credentials"
+configure.set_execution_block do |args|
+  if args.length < 2
+    puts configure.usage
+    exit 1
+  end
+  username = args[0]
+  access_key = args[1]
+  dir = File.join(File.expand_path("~"), ".sauce")
+  FileUtils.mkdir(dir) unless File.directory?(dir)
+
+  out = File.new(File.join(dir, "ondemand.yml"), 'w')
+  out.write(YAML.dump({"username" => username, "access_key" => access_key}))
+  out.close()
+end
+cmd.add_command(configure)
 
-  #create
-  create = CmdParse::Command.new('create', false)
-  create.short_desc = "Create a new Sauce OnDemand account"
-  create.set_execution_block do |args|
-    puts "Let's create a new account!"
-    username = ask("Username: ")
-    password = ask("Password: ") { |q| q.echo = "*" }
-    email = ask("Email: ")
-    name = ask("Full name: ")
+#create
+create = CmdParse::Command.new('create', false)
+create.short_desc = "Create a new Sauce OnDemand account"
+create.set_execution_block do |args|
+  puts "Let's create a new account!"
+  username = ask("Username: ")
+  password = ask("Password: ") { |q| q.echo = "*" }
+  email = ask("Email: ")
+  name = ask("Full name: ")
 
-    body = {
-      :username => username,
-      :password => password,
-      :email => email,
-      :name => name,
-      :token => "c8eb3e2645005bcbbce7e2c208c6b7a71555d908"
-    }.to_json
+  body = {
+    :username => username,
+    :password => password,
+    :email => email,
+    :name => name,
+    :token => "c8eb3e2645005bcbbce7e2c208c6b7a71555d908"
+  }.to_json
 
+  begin
+    result = RestClient.post("http://saucelabs.com/rest/v1/users",
+                              body, :content_type => :json, :accept => :json)
+  rescue => e
     begin
-      result = RestClient.post("http://saucelabs.com/rest/v1/users",
-                               body, :content_type => :json, :accept => :json)
-    rescue => e
-      begin
-        puts "ERROR: #{JSON.load(e.response)['errors']}"
-      rescue
-        puts "ERROR: #{e.response}"
-      end
-    else
-      result = JSON.load(result)
-
-      puts "Account #{username} created successfully."
-      puts "Your access key is: #{result['access_key']}"
+      puts "ERROR: #{JSON.load(e.response)['errors']}"
+    rescue
+      puts "ERROR: #{e.response}"
     end
+  else
+    result = JSON.load(result)
+
+    puts "Account #{username} created successfully."
+    puts "Your access key is: #{result['access_key']}"
   end
+end
 
-  cmd.add_command(create)
+cmd.add_command(create)
 
-  cmd.parse
-end
+cmd.parse