sauce 0.5.0 → 0.6.0

data/README.markdown

@@ -1,7 +1,7 @@
 sauce
 =====
 
-Ruby access to SauceLab's features
+Ruby access to Sauce OnDemand
 
 Features
 --------
@@ -17,8 +17,6 @@ Planned:
 
 Install
 -------
-Make sure you're pulling in gems from http://rubygems.org/, and then:
-
 `gem install sauce`
 
 Example

data/Rakefile

@@ -11,7 +11,10 @@ begin
     gem.homepage = "http://github.com/sgrove/sauce"
     gem.authors = ["Sean Grove"]
     gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
-    gem.add_development_dependency "rest-client", ">= 0"
+    gem.add_runtime_dependency "rest-client", ">= 0"
+    gem.add_runtime_dependency "net-ssh", ">= 0"
+    gem.add_runtime_dependency "net-ssh-gateway", ">= 0"
+    gem.add_runtime_dependency "selenium-client", ">= 1.2.18"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/lib/sauce.rb

@@ -1,4 +1,6 @@
-require 'tunnel'
-require 'job'
-require 'rest'
-
+require 'sauce/tunnel'
+require 'sauce/job'
+require 'sauce/client'
+require 'sauce/config'
+require 'sauce/selenium'
+require 'sauce/integrations'

data/lib/sauce/config.rb

@@ -0,0 +1,76 @@
+require 'json'
+require 'yaml'
+
+module Sauce
+  class Config
+    attr_reader :opts
+    DEFAULT_OPTIONS = {
+        :host => "saucelabs.com",
+        :port => 4444,
+        :browser_url => "http://saucelabs.com",
+        :os => "Linux",
+        :browser => "firefox",
+        :browser_version => "3.",
+        :job_name => "Unnamed Ruby job"
+    }
+
+    def initialize(opts={})
+      @opts = DEFAULT_OPTIONS.merge(load_options_from_yaml)
+      @opts.merge! load_options_from_environment
+      @opts.merge! opts
+    end
+
+    def method_missing(meth, *args)
+      return @opts[meth]
+    end
+
+    def to_browser_string
+      browser_options = {
+        'username' => @opts[:username],
+        'access-key' => @opts[:access_key],
+        'os' => @opts[:os],
+        'browser' => @opts[:browser],
+        'browser-version' => @opts[:browser_version],
+        'name' => @opts[:job_name]}
+      return browser_options.to_json
+    end
+
+    private
+
+    def load_options_from_environment
+      opts = {}
+      opts[:host] = ENV['SAUCE_HOST']
+      opts[:port] = ENV['SAUCE_PORT']
+      opts[:browser_url] = ENV['SAUCE_BROWSER_URL']
+
+      opts[:username] = ENV['SAUCE_USERNAME']
+      opts[:access_key] = ENV['SAUCE_ACCESS_KEY']
+
+      opts[:os] = ENV['SAUCE_OS']
+      opts[:browser] = ENV['SAUCE_BROWSER']
+      opts[:browser_version] = ENV['SAUCE_BROWSER_VERSION']
+      opts[:job_name] = ENV['SAUCE_JOB_NAME']
+
+      opts[:firefox_profile_url] = ENV['SAUCE_FIREFOX_PROFILE_URL']
+      opts[:user_extensions_url] = ENV['SAUCE_USER_EXTENSIONS_URL']
+
+      return opts.delete_if {|key, value| value.nil?}
+    end
+
+    def load_options_from_yaml
+        paths = [
+            "ondemand.yml",
+            File.join("config", "ondemand.yml"),
+            File.join(ENV['HOME'], ".ondemand.yml")
+        ]
+
+        paths.each do |path|
+            if File.exists? path
+                conf = YAML.load_file(path)
+                return conf.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+            end
+        end
+        return {}
+    end
+  end
+end

data/lib/sauce/heroku.rb

@@ -0,0 +1,18 @@
+module Sauce
+  if ENV['SAUCE_ONDEMAND_HEROKU_URL'] and ENV['URL']
+
+    # Heroku Configuation
+    config                   = JSON.parse RestClient.get(ENV['SAUCE_ONDEMAND_HEROKU_URL']).body
+    Sauce::Selenium_browsers = JSON.parse config["SAUCE_ONDEMAND_BROWSERS"]
+    Sauce::Selenium_url      =            "#{config['SAUCE_ONDEMAND_PROTOCOL']}#{ENV['URL']}"
+    Sauce::Selenium_host     =            config["SAUCE_ONDEMAND_SERVER"  ]
+    Sauce::Selenium_port     =            config["SAUCE_ONDEMAND_PORT"    ]
+  else
+    
+    # Local Configuration
+    Sauce::Selenium_url      = ENV['SELENIUM_URL']     || "http://localhost:3000"
+    Sauce::Selenium_host     = ENV['SELENIUM_HOST']    || "localhost"
+    Sauce::Selenium_port     = ENV['SELENIUM_PORT']    || "4444"
+    Sauce::Selenium_browsers = ENV['SELENIUM_BROWSER'] || ["*firefox"]
+  end
+end

data/lib/sauce/integrations.rb

@@ -0,0 +1,29 @@
+begin
+  require 'spec'
+  module Sauce
+    module RSpec
+      class SeleniumExampleGroup < Spec::Example::ExampleGroup
+        attr_reader :selenium
+
+        before(:all) do
+          @selenium = Sauce::Selenium.new
+        end
+
+        before(:each) do
+          @selenium.start
+        end
+
+        after(:each) do
+          @selenium.stop
+        end
+
+        alias_method :page, :selenium
+        alias_method :s, :selenium
+
+        Spec::Example::ExampleGroupFactory.register(:selenium, self)
+      end
+    end
+  end
+rescue LoadError
+  # User doesn't have RSpec installed
+end

data/lib/sauce/selenium.rb

@@ -0,0 +1,12 @@
+require "selenium/client"
+
+module Sauce
+  class Selenium < Selenium::Client::Driver
+    def initialize(opts={})
+      @config = Sauce::Config.new(opts)
+      opts.merge!({:host => @config.host, :port => @config.port,
+           :browser => @config.to_browser_string, :url => @config.browser_url})
+      super(opts)
+    end
+  end
+end

data/test/saucelabs_spec.rb

@@ -0,0 +1,8 @@
+require 'helper'
+
+describe "saucelabs.com", :type => :selenium do
+  it "works" do
+    page.open "/"
+    page.is_text_present("Sauce Labs").should be_true
+  end
+end

data/test/test_config.rb

@@ -0,0 +1,27 @@
+require 'helper'
+
+class TestConfig < Test::Unit::TestCase
+  context "A new Config" do
+    should "Generate a reasonable browser string from the environment" do
+      ENV['SAUCE_USERNAME'] = "test_user"
+      ENV['SAUCE_ACCESS_KEY'] = "test_access"
+      ENV['SAUCE_OS'] = "Linux"
+      ENV['SAUCE_BROWSER'] = "firefox"
+      ENV['SAUCE_BROWSER_VERSION'] = "3."
+
+      config = Sauce::Config.new
+      assert_equal "{\"name\":\"Unnamed Ruby job\",\"access-key\":\"test_access\",\"os\":\"Linux\",\"username\":\"test_user\",\"browser-version\":\"3.\",\"browser\":\"firefox\"}", config.to_browser_string
+    end
+
+    should "Generate a browser string from parameters" do
+      config = Sauce::Config.new(:username => "test_user", :access_key => "test_access",
+                                 :os => "Linux", :browser => "firefox", :browser_version => "3.")
+      assert_equal "{\"name\":\"Unnamed Ruby job\",\"access-key\":\"test_access\",\"os\":\"Linux\",\"username\":\"test_user\",\"browser-version\":\"3.\",\"browser\":\"firefox\"}", config.to_browser_string
+    end
+
+    should "Respond to convenience accessors" do
+      config = Sauce::Config.new
+      assert_equal "saucelabs.com", config.host
+    end
+  end
+end

data/test/test_jobs.rb

@@ -6,7 +6,7 @@ class TestSauce < Test::Unit::TestCase
   context "A V1 jobs instance" do
     setup do
       # Create this file and put in your details to run the tests
-      account = YAML.load_file "account2.yml"
+      account = YAML.load_file "account.yml"
       @username = account["username"]
       @access_key = account["access_key"]
       @ip = account["ip"]
@@ -58,7 +58,7 @@ class TestSauce < Test::Unit::TestCase
       assert_equal "complete", job.status
       assert_equal "job-example-fixture", job.name
 
-      assert_equal "Firefox", job.browser
+      assert_equal "firefox", job.browser
       assert_equal "3.5.", job.browser_version
       assert_equal "Windows 2003", job.os
 
@@ -70,7 +70,7 @@ class TestSauce < Test::Unit::TestCase
       assert_equal "http://saucelabs.com/jobs/gem-test-job/selenium-server.log", job.log_url
 
       assert_equal false, job.public
-      assert_equal ['test', 'equal', 'multilingualism is fun'], job.tags
+      assert_equal ['test', 'equal', 'multilingualism_is_fun'], job.tags
     end
 
     should "update writable properties" do
@@ -78,12 +78,12 @@ class TestSauce < Test::Unit::TestCase
 
       # Make sure it's in the expected condition before changing
       assert_equal false, job.public
-      assert_equal ["test", "equal", "multilingualism is fun"], job.tags
+      assert_equal ["test", "example", "multilingualism_is_fun"], job.tags
       assert_equal "job-example-fixture", job.name
 
       job.public = true
       job.tags = ["changed", "updated", "ruby_is_also_fun"]
-      job.name = "changed-job-name"
+      job.name = "changed-job-name", job.name
       job.save
 
       # Fresh copy of the same job
@@ -95,8 +95,8 @@ class TestSauce < Test::Unit::TestCase
 
       # Return the job to its original state and check it out
       job.public = false
-      job.tags = ["test", "example", "multilingualism is fun"]
-      job.name = "job-example-fixture"
+      job.tags = ["test", "example", "multilingualism_is_fun"]
+      job.name = "job-example-fixture", job.name
       job.save
 
       # Check to see if the change took
@@ -135,7 +135,7 @@ class TestSauce < Test::Unit::TestCase
       assert_equal 2, jobs.count
     end
 
-    should "show job listings with full job information if requested" do
+    should "show the full job information on index if requested" do
       flunk "TODO: implement this"
     end
 

data/test/test_selenium.rb

@@ -0,0 +1,14 @@
+require 'helper'
+
+class TestSelenium < Test::Unit::TestCase
+  context "The Sauce Selenium driver" do
+    should "Connect successfully using credentials from the environment" do
+      assert ENV['SAUCE_USERNAME'], "You haven't configured a Sauce OnDemand username. Please set $SAUCE_USERNAME"
+      assert ENV['SAUCE_USERNAME'], "You haven't configured a Sauce OnDemand access key. Please set $SAUCE_ACCESS_KEY"
+      selenium = Sauce::Selenium.new()
+      selenium.start
+      selenium.open "/"
+      selenium.stop
+    end
+  end
+end

data/test/test_tunnels.rb

@@ -5,16 +5,14 @@ class TestSauce < Test::Unit::TestCase
   context "A V1 tunnel instance" do
     setup do
       # Create this file and put in your details to run the tests
-      account = YAML.load_file "account2.yml"
+      account = YAML.load_file "account.yml"
       @username = account["username"]
       @access_key = account["access_key"]
       @ip = account["ip"]
       @client = Sauce::Client.new(:username => @username,
                                   :access_key => @access_key,
-                                  :ip => @ip,
-                                  :protocol => account["protocol"],
-                                  :host => account["host"],
-                                  :port => account["port"])
+                                  :ip => @ip
+                                  )
 
       #STDOUT.puts @client.api_url
       @client.tunnels.destroy_all
@@ -33,14 +31,6 @@ class TestSauce < Test::Unit::TestCase
       assert_equal @username, tunnel.owner
     end
 
-    should "error if a tunnel is created without domain names" do
-      flunk "TODO: Implement this"
-      tunnel = @client.tunnels.create('DomainNames' => [])
-      tunnel.refresh!
-      assert_not_nil tunnel
-      assert_equal @username, tunnel.owner
-    end
-
     should "list current tunnels" do
       @client.tunnels.create('DomainNames' => ["192.168.0.111"])
       @client.tunnels.create('DomainNames' => ["192.168.0.112"])
@@ -53,7 +43,7 @@ class TestSauce < Test::Unit::TestCase
     should "destroy a tunnel" do
       tunnel = @client.tunnels.create('DomainNames' => ["192.168.0.114"])
       tunnel.destroy
-      assert ["terminated", "halting"].include?(tunnel.status)
+      assert_equal "halting", tunnel.status
     end
 
     should "destroy all tunnels" do
@@ -66,13 +56,12 @@ class TestSauce < Test::Unit::TestCase
       @client.tunnels.all.each do |tunnel|
         # This could be failing because the tunnels are already dead. Our servers too fast?
         tunnel.refresh!
-        assert ["terminated", "halting"].include? tunnel.status
+        assert_equal "halting", tunnel.status
       end
     end
 
     should "say hello on port 1025 if healthy" do
-      tunnel = @client.tunnels.create('DomainNames' => ["192.168.0.118"])
-
+      tunnel = @client.tunnels.create('DomainNames' => [@ip])
 
       max_retries = 30
       retries = 0
@@ -88,7 +77,7 @@ class TestSauce < Test::Unit::TestCase
     end
 
     should "have a host if finished booting" do
-      tunnel = @client.tunnels.create('DomainNames' => ["192.168.0.119"])
+      tunnel = @client.tunnels.create('DomainNames' => [@ip])
 
       max_retries = 30
       retries = 0
@@ -106,7 +95,7 @@ class TestSauce < Test::Unit::TestCase
     end
 
     should "not attempt to telnet if status is not running" do
-      tunnel = @client.tunnels.create('DomainNames' => ["192.168.0.119"])
+      tunnel = @client.tunnels.create('DomainNames' => [@ip])
 
       tunnel.status = "booting"
       assert_equal false, tunnel.says_hello?

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sauce
 version: !ruby/object:Gem::Version 
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Sean Grove
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-16 00:00:00 -07:00
+date: 2010-10-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -33,14 +36,60 @@ dependencies:
   name: rest-client
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: net-ssh
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: net-ssh-gateway
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: selenium-client
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 1
+        - 2
+        - 18
+        version: 1.2.18
+  type: :runtime
+  version_requirements: *id005
 description: A ruby interface to Sauce Labs' services. Start/stop tunnels, retrieve Selenium logs, access video replays, etc.
 email: sean@saucelabs.com
 executables: []
@@ -57,13 +106,20 @@ files:
 - README.markdown
 - Rakefile
 - VERSION
-- lib/gateway_ext.rb
-- lib/job.rb
-- lib/rest.rb
 - lib/sauce.rb
-- lib/tunnel.rb
+- lib/sauce/client.rb
+- lib/sauce/config.rb
+- lib/sauce/gateway_ext.rb
+- lib/sauce/heroku.rb
+- lib/sauce/integrations.rb
+- lib/sauce/job.rb
+- lib/sauce/selenium.rb
+- lib/sauce/tunnel.rb
 - test/helper.rb
+- test/saucelabs_spec.rb
+- test/test_config.rb
 - test/test_jobs.rb
+- test/test_selenium.rb
 - test/test_tunnels.rb
 has_rdoc: true
 homepage: http://github.com/sgrove/sauce
@@ -75,29 +131,34 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Ruby access to Sauce Labs' features
 test_files: 
-- test/debug.rb
 - test/helper.rb
-- test/monitor_jobs.rb
+- test/saucelabs_spec.rb
+- test/test_config.rb
 - test/test_jobs.rb
+- test/test_selenium.rb
 - test/test_tunnels.rb

data/test/debug.rb

@@ -1,11 +0,0 @@
-require 'helper'
-
-c = Sauce::Client.new(:username => "sgrove",
-                      :access_key => "4c592ce3-8f45-4cd6-8e3e-65b9f0b173d0")
-
-c.destroy_all_tunnels
-t = c.create_tunnel('DomainNames' => ["111.111.111.111"])
-
-puts c.tunnels.inspect
-
-c.destroy_all_tunnels

data/test/monitor_jobs.rb

@@ -1,13 +0,0 @@
-require 'rubygems'
-require 'yaml'
-$: << "../lib/"
-require 'sauce'
-
-account = YAML.load_file("account.yml")
-
-client = Sauce::Client.new(:username => account["username"],
-                           :access_key => account["access_key"])
-
-jobs = client.jobs.all
-
-puts jobs.inspect