sauce 0.3.0 → 0.4.0

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/job.rb

@@ -7,21 +7,19 @@ module Sauce
   # Interact with a Sauce Labs selenium jobs as if it were a ruby object
   class Job
 
-    #{"BrowserVersion": "3.", "Name": "prsel_./spec/integration/people_a_1_spec.rb", "_rev": "5-228269313", "CreationTime": 1266698090, "AssignmentTime": 1266698097, "Server": "10.212.146.145:4443", "AssignedTo": "f663372ba04444ce8cb3e6f61503f304", "ChefStartTime": 1266698101, "EndTime": 1266698139, "Type": "job", "Interactive": "true", "Status": "complete", "SeleniumServerLogUploadRequest": {"bucket": "sauce-userdata", "key": "sgrove/6337fe576deba0ba278dc1b5dfceac5f/selenium-server.log"}, "Tags": [], "ResultId": "6337fe576deba0ba278dc1b5dfceac5f", "AttachmentRequests": {}, "ModificationTime": 1266698139, "Browser": "firefox", "StartTime": 1266698101, "Owner": "sgrove", "_id": "01fc48caba6d15b46fad79e1b0562bbe", "OS": "Linux", "VideoUploadRequest": {"bucket": "sauce-userdata", "key": "sgrove/6337fe576deba0ba278dc1b5dfceac5f/video.flv"}}
+    class CannotDeleteJobError < StandardError; end #:nodoc
 
-    attr_accessor :owner, :id, :name, :_rev, :server, :assigned_to, :sauce_type, :interactive, :status,:tags, :result_id
-    attr_accessor :selenium_server_log_upload_request, :attachment_requests, :videoupload_request
-    attr_accessor :creation_time, :assignment_time, :chef_start_time, :end_time, :modification_time, :start_time
-    attr_accessor :os, :browser, :browser_version
+    attr_accessor :id, :owner, :status, :error
+    attr_accessor :name, :browser, :browser_version, :os
+    attr_accessor :creation_time, :start_time, :end_time
+    attr_accessor :public, :video_url, :log_url, :tags
 
-    # TODO: Buckets for logs and videos
-    
     # Get the class @@client.
     # TODO: Consider metaprogramming this away
     def self.client
       @@client
     end
-
+    
     # Set the class @@client.
     # TODO: Consider metaprogramming this away
     def self.client=(client)
@@ -48,42 +46,28 @@ module Sauce
       self.all.last
     end
 
-    def self.all
-=begin
-      responses = JSON.parse @@client["jobs/recent"].get
+    # Misnomer: Gets the most recent 100 jobs
+    # TODO: Allow/automate paging
+    def self.all(options={})
+      responses = JSON.parse @@client["jobs/full"].get
       return responses.collect{|response| Sauce::Job.new(response)}
-=end
-      return self.complete_jobs + self.in_progress_jobs
     end
 
     def self.destroy
       self.all.each { |tunnel| tunnel.destroy }
     end
 
-    def self.find id
+    def self.find(options={})
+      if options.class == String
+        id = options
+      elsif options.class == Hash
+        id = options[:id]
+      end
+      
       #puts "GET-URL: #{@@client.url}jobs/#{id}"
       Sauce::Job.new JSON.parse(@@client["jobs/#{id}"].get)
     end
 
-    def self.complete_jobs
-      responses = JSON.parse @@client["complete-jobs"].get
-      start = Time.now
-      jobs = responses["jobs"].collect{|response| Sauce::Job.find(response["id"])}
-      lapsed = Time.now - start
-      puts "Took #{lapsed} seconds"
-      return jobs
-    end
-
-    def self.in_progress_jobs
-      responses = JSON.parse @@client["in-progress-jobs"].get
-      return [] if responses == []
-      start = Time.now
-      jobs = responses["jobs"].collect{|response| Sauce::Job.find(response["id"])}
-      lapsed = Time.now - start
-      puts "Took #{lapsed} seconds"
-      return jobs
-    end
-
     # Creates an instance representing a job.
     def initialize(options)
       build!(options)
@@ -92,42 +76,64 @@ module Sauce
     # Retrieves the latest information on this job from the Sauce Labs' server
     def refresh!
       response = JSON.parse @@client["jobs/#{@id}"].get
-      puts "\tjob refresh with: #{response.inspect}"
+      #puts "\tjob refresh with: #{response}"
       build! response
       self
     end
 
-    protected 
+    # Save/update the current information for the job
+    def save
+      response = JSON.parse(@@client["jobs/#{@id}"]. self.to_json, :content_type => :json, :accept => :json)
+    end
+
+    def self.to_json(options={})
+      json = {
+        :id =>              @id,
+        :owner =>           @owner,
+        :status =>          @status,
+        :error =>           @error,
+        :name =>            @name,
+        :browser =>         @browser,
+        :browser_version => @browser_version,
+        :os =>              @os,
+        :creation_time =>   @creation_time,
+        :start_time =>      @start_time,
+        :end_time =>        @end_time,
+        :video_url =>       @video_url,
+        :log_url =>         @log_url,
+        :public =>          @public,
+        :tags =>            @tags
+      }
+
+      options[:except].each { |key| json.delete(key) } if options[:except]
+      json = json.select { |key,value| options[:only].include? key } if options[:only]
+      
+      return json
+    end
+
+    def delete
+      raise CannonDeleteJobError("Cannot delete jobs via Sauce Labs'  REST API currently")
+    end
+
+    protected
 
     # Sets all internal variables from a hash
     def build!(options)
-      #puts "\tBuild  with #{options.inspect}"
-      
-      @owner       = options["Owner"]
-      @id          = options["_id"]
-      @id          = options["id"] if @id.nil? or @id.empty?
-      @name        = options["Name"]
-      @_rev        = options["_rev"]
-      @server      = options["Server"]
-      @assigned_to = options["AssignedTo"]
-
-      @sauce_type  = options["Type"]
-      @interactive = options["Interactive"]
-      @status      = options["Status"]
-      @tags        = options["Tags"]
-      @result_id   = options["ResultId"]
-
-      @os              = options["OS"]
-      @browser         = options["Browser"]
-      @browser_version = options["BrowserVersion"]
-
-      # TODO: Should this be created_at and updated_at? Probably.
-      @creation_time     = options["CreationTime"]
-      @assignment_time   = options["AssignmentTime"]
-      @chef_start_time   = options["ChefStartTime"]
-      @end_time          = options["EndTime"]
-      @modification_time = options["ModificationTime"]
-      @start_time        = options["StartTime"]
+      @id              = options["id"]
+      @owner           = options["owner"]
+      @status          = options["status"]
+      @error           = options["error"]
+      @name            = options["name"]
+      @browser         = options["browser"]
+      @browser_version = options["browser_version"]
+      @os              = options["os"]
+      @creation_time   = options["creation_time"].to_i
+      @start_time      = options["start_time"].to_i
+      @end_time        = options["end_time"].to_i
+      @video_url       = options["video_url"]
+      @log_url         = options["log_url"]
+      @public          = options["public"]
+      @tags            = options["tags"]
 
       raise NoIDError if @id.nil? or @id.empty?
     end

data/lib/rest.rb

@@ -4,8 +4,8 @@ require 'json'
 module Sauce
   # The module that brokers most communication with Sauce Labs' REST API
   class Client
-    class BadAccessError < StandardError; end #nodoc
-    class MisconfiguredError < StandardError; end #nodoc
+    class BadAccessError < StandardError; end #:nodoc
+    class MisconfiguredError < StandardError; end #:nodoc
 
     attr_accessor :username, :access_key, :client, :ip, :api_url
     attr_accessor :tunnels, :jobs
@@ -16,20 +16,23 @@ module Sauce
       @ip         = options[:ip]
 
       raise MisconfiguredError if @username.nil? or @access_key.nil?
-      @api_url = "https://#{@username}:#{@access_key}@saucelabs.com/rest/#{@username}/"
+      @api_url = "https://#{@username}:#{@access_key}@saucelabs.com/api/v1/#{@username}/"
       @client = RestClient::Resource.new @api_url
 
       @tunnels = Sauce::Tunnel
       @tunnels.client = @client
-      @tunnels.account = {:username => @username,
+      @tunnels.account = {
+        :username => @username,
         :access_key => @access_key,
         :ip => @ip}
 
       @jobs = Sauce::Job
       @jobs.client = @client
-      @jobs.account = {:username => @username,
+      @jobs.account = {
+        :username => @username,
         :access_key => @access_key,
-        :ip => @ip}
+        :ip => @ip
+      }
     end
   end
 end

data/test/test_jobs.rb

@@ -2,7 +2,7 @@ require 'helper'
 require 'json'
 
 class TestSauce < Test::Unit::TestCase
-  context "A jobs instance" do
+  context "A V1 jobs instance" do
     setup do
       # Create this file and put in your details to run the tests
       account = YAML.load_file "live_account.yml"
@@ -11,44 +11,124 @@ class TestSauce < Test::Unit::TestCase
       @ip = account["ip"]
       @client = Sauce::Client.new(:username => @username,
                                   :access_key => @access_key)
+
+      @example_data = YAML.load_file('example_data.yml')
     end    
 
     should "initialize with passed variables" do
-      job_json = JSON.parse '{"BrowserVersion": "3.", "Name": "example_job/name.rb", "_rev": "5-228269313", "CreationTime": 1266698090, "AssignmentTime": 1266698097, "Server": "192.168.0.1:4443", "AssignedTo": "f663372ba04444ce8cb3e6f61503f304", "ChefStartTime": 1266698101, "EndTime": 1266698139, "Type": "job", "Interactive": "true", "Status": "complete", "SeleniumServerLogUploadRequest": {"bucket": "sauce-userdata", "key": "sgrove/6337fe576deba0ba278dc1b5dfceac5f/selenium-server.log"}, "Tags": ["tag_1", "tag_2"], "ResultId": "6337fe576deba0ba278dc1b5dfceac5f", "AttachmentRequests": {}, "ModificationTime": 1266698139, "Browser": "firefox", "StartTime": 1266698101, "Owner": "sgrove", "_id": "01fc48caba6d15b46fad79e1b0562bbe", "OS": "Linux", "VideoUploadRequest": {"bucket": "sauce-userdata", "key": "sgrove/6337fe576deba0ba278dc1b5dfceac5f/video.flv"}}'
-
       client = Sauce::Client.new(:username => "test_user",
                                  :access_key => "abc123")
       
-      job = client.jobs.new(job_json)
+      job = client.jobs.new(JSON.parse(@example_data["example_job"]))
+
+      assert_equal "501aca56282545a9a21ad2fc592b03fa", job.id
+      assert_equal "joe", job.owner
+      assert_equal "complete", job.status
+      assert_equal "job-name", job.name 
+
+      assert_equal "firefox", job.browser
+      assert_equal "3.5.", job.browser_version
+      assert_equal "Windows 2003", job.os
+
+      assert_equal 1253856281, job.creation_time
+      assert_equal 1253856366, job.start_time
+      assert_equal 1253856465, job.end_time 
+
+      assert_equal "http://saucelabs.com/video/8b6bf8d360cc338cc7cf7f6e093264d0/video.flv", job.video_url
+      assert_equal "http://saucelabs.com/video/8b6bf8d360cc338cc7cf7f6e093264d0/selenium-server.log", job.log_url
+
+      assert_equal false, job.public
+      assert_equal ["test", "example", "python_is_fun"], job.tags
+    end
 
-      assert_equal "sgrove", job.owner
-      assert_equal "01fc48caba6d15b46fad79e1b0562bbe", job.id
-      assert_equal "example_job/name.rb", job.name 
-      assert_equal "5-228269313", job._rev 
-      assert_equal "192.168.0.1:4443", job.server
-      assert_equal "f663372ba04444ce8cb3e6f61503f304", job.assigned_to 
+    # Note: This won't pass until we have a canonical "test job" and its data
+    should "retrieve and parse a job via the api" do
+      job = @client.jobs.find("501aca56282545a9a21ad2fc592b03fa")
 
-      assert_equal "job", job.sauce_type
-      assert_equal "true", job.interactive
+      assert_equal "501aca56282545a9a21ad2fc592b03fa", job.id
+      assert_equal "joe", job.owner
       assert_equal "complete", job.status
-      assert_equal ["tag_1", "tag_2"], job.tags
-      assert_equal "6337fe576deba0ba278dc1b5dfceac5f", job.result_id
+      assert_equal "job-name", job.name 
+
+      assert_equal "firefox", job.browser
+      assert_equal "3.5.", job.browser_version
+      assert_equal "Windows 2003", job.os
+
+      assert_equal 1253856281, job.creation_time
+      assert_equal 1253856366, job.start_time
+      assert_equal 1253856465, job.end_time 
+
+      assert_equal "http://saucelabs.com/video/8b6bf8d360cc338cc7cf7f6e093264d0/video.flv", job.video_url
+      assert_equal "http://saucelabs.com/video/8b6bf8d360cc338cc7cf7f6e093264d0/selenium-server.log", job.log_url
+
+      assert_equal false, job.public
+      assert_equal ["test", "example", "python_is_fun"], job.tags
+    end
+
+    should "update writable properties" do
+      job = @client.jobs.find("501aca56282545a9a21ad2fc592b03fa")
+
+      # Make sure it's in the expected condition before changing
+      assert_equal false, job.public
+      assert_equal ["test", "example", "python_is_fun"], job.tags
+      assert_equal "job-name", job.name
 
-      # TODO: Buckets
-      #assert_equal , job.selenium_server_log_upload_request 
-      #assert_equal , job.attachment_requests 
-      #assert_equal , job.videoupload_request
+      job.public = true
+      job.tags = ["changed", "updated", "ruby_is_also_fun"]
+      job.name = "changed-job-name", job.name
+      job.save
 
+      # Fresh copy of the same job
+      job2 = @client.jobs.find("501aca56282545a9a21ad2fc592b03fa")
+
+      assert_equal true, job.public
+      assert_equal ["changed", "updated", "ruby_is_also_fun"], job.tags
+      assert_equal "changed-job-name", job.name
+
+      # Return the job to its original state and check it out
+      job.public = false
+      job.tags = ["test", "example", "python_is_fun"]
+      job.name = "job-name", job.name
+      job.save
+
+      # Check to see if the change took
+      job2.refresh!
+      assert_equal job.public, job2.public
+      assert_equal job.tags, job2.tags
+      assert_equal job.name, job2.name
+    end
+
+    should "not update read-only properties" do
+      job = @client.jobs.find("501aca56282545a9a21ad2fc592b03fa")
+
+      # Make sure it's in the expected condition before changing
+      assert_equal "complete", job.status
+      assert_equal "joe", job.owner
       assert_equal "Linux", job.os
-      assert_equal "firefox", job.browser
-      assert_equal "3.", job.browser_version
-
-      assert_equal 1266698090, job.creation_time
-      assert_equal 1266698097, job.assignment_time
-      assert_equal 1266698101, job.chef_start_time
-      assert_equal 1266698139, job.end_time 
-      assert_equal 1266698139, job.modification_time
-      assert_equal 1266698101, job.start_time
+
+      job.status = "groggy"
+      job.owner = "sjobs"
+      job.os = "darwin" # In a perfect world...
+      assert_equal "groggy", job.status
+      assert_equal "joe", job.owner
+      assert_equal "darwin", job.os
+      job.save
+
+      # Changes should go away when refreshed
+      job.refresh!
+      assert_equal "complete", job.status
+      assert_equal "joe", job.owner
+      assert_equal "Linux", job.os
+    end
+
+    should "list the 100 most recent jobs" do
+      jobs = @client.jobs.all
+
+      assert_equal 5, jobs.count
+    end
+
+    should "show the full job information on index if requested" do
+      flunk "TODO: implement this"
     end
 
     def teardown

data/test/test_jobs_old.rb

@@ -0,0 +1,58 @@
+require 'helper'
+require 'json'
+
+class TestSauce < Test::Unit::TestCase
+  context "A jobs instance" do
+    setup do
+      # Create this file and put in your details to run the tests
+      account = YAML.load_file "live_account.yml"
+      @username = account["username"]
+      @access_key = account["access_key"]
+      @ip = account["ip"]
+      @client = Sauce::Client.new(:username => @username,
+                                  :access_key => @access_key)
+    end    
+
+    should "initialize with passed variables" do
+      job_json = JSON.parse '{"BrowserVersion": "3.", "Name": "example_job/name.rb", "_rev": "5-228269313", "CreationTime": 1266698090, "AssignmentTime": 1266698097, "Server": "192.168.0.1:4443", "AssignedTo": "f663372ba04444ce8cb3e6f61503f304", "ChefStartTime": 1266698101, "EndTime": 1266698139, "Type": "job", "Interactive": "true", "Status": "complete", "SeleniumServerLogUploadRequest": {"bucket": "sauce-userdata", "key": "sgrove/6337fe576deba0ba278dc1b5dfceac5f/selenium-server.log"}, "Tags": ["tag_1", "tag_2"], "ResultId": "6337fe576deba0ba278dc1b5dfceac5f", "AttachmentRequests": {}, "ModificationTime": 1266698139, "Browser": "firefox", "StartTime": 1266698101, "Owner": "sgrove", "_id": "01fc48caba6d15b46fad79e1b0562bbe", "OS": "Linux", "VideoUploadRequest": {"bucket": "sauce-userdata", "key": "sgrove/6337fe576deba0ba278dc1b5dfceac5f/video.flv"}}'
+
+      client = Sauce::Client.new(:username => "test_user",
+                                 :access_key => "abc123")
+      
+      job = client.jobs.new(job_json)
+
+      assert_equal "sgrove", job.owner
+      assert_equal "01fc48caba6d15b46fad79e1b0562bbe", job.id
+      assert_equal "example_job/name.rb", job.name 
+      assert_equal "5-228269313", job._rev 
+      assert_equal "192.168.0.1:4443", job.server
+      assert_equal "f663372ba04444ce8cb3e6f61503f304", job.assigned_to 
+
+      assert_equal "job", job.sauce_type
+      assert_equal "true", job.interactive
+      assert_equal "complete", job.status
+      assert_equal ["tag_1", "tag_2"], job.tags
+      assert_equal "6337fe576deba0ba278dc1b5dfceac5f", job.result_id
+
+      # TODO: Buckets
+      #assert_equal , job.selenium_server_log_upload_request 
+      #assert_equal , job.attachment_requests 
+      #assert_equal , job.videoupload_request
+
+      assert_equal "Linux", job.os
+      assert_equal "firefox", job.browser
+      assert_equal "3.", job.browser_version
+
+      assert_equal 1266698090, job.creation_time
+      assert_equal 1266698097, job.assignment_time
+      assert_equal 1266698101, job.chef_start_time
+      assert_equal 1266698139, job.end_time 
+      assert_equal 1266698139, job.modification_time
+      assert_equal 1266698101, job.start_time
+    end
+
+    def teardown
+      @client.tunnels.destroy
+    end
+  end
+end

data/test/test_tunnels.rb

@@ -1,7 +1,7 @@
 require 'helper'
 
 class TestSauce < Test::Unit::TestCase
-  context "A Client instance" do
+  context "A V1 tunnel instance" do
     setup do
       # Create this file and put in your details to run the tests
       account = YAML.load_file "live_account.yml"
@@ -16,7 +16,7 @@ class TestSauce < Test::Unit::TestCase
     should "initialize with passed variables" do
       client = Sauce::Client.new(:username => "test_user",
                                  :access_key => "abc123")
-      assert_equal client.api_url, "https://test_user:abc123@saucelabs.com/rest/test_user/"
+      assert_equal "https://test_user:abc123@saucelabs.com/api/v1/test_user/", client.api_url
     end
 
     should "create a tunnel with the current user" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sauce
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Sean Grove
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-26 00:00:00 -08:00
+date: 2010-03-02 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -88,5 +88,6 @@ test_files:
 - test/helper.rb
 - test/irb_boot.rb
 - test/test_jobs.rb
+- test/test_jobs_old.rb
 - test/test_tunnels.rb
 - test/test_videos.rb