sauce_whisk 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTVhMzg0MGRmMjk3NGZjMjEwMDA4Mzk5M2RiYzQ3N2I3Y2E0ZDQxOA==
+    YmIzOTdjOTU0M2IyNDIyOWE4YWRiZGIyYjdlNjY1ZTA5OTFjMWIxOQ==
   data.tar.gz: !binary |-
-    MDBiZDc3M2Q3MDc0OGYzYjlmMzk4YTNmNWZjZjI2ZWRiNmIyZjYyYQ==
+    YThkYzRhMTNiNTk5MTYwYTlmZTc0MzBlOTliMTQzMmJjNTk0ODgwNA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    Zjk3NDY0MmY2Y2I2NDc4YmYzNzljMGZhNDVhZmQ4Zjc0Yjg5NTQxOTkzZGE5
-    OWMzNGZkYzE4MmU2ZjY0MTIzYTVlYzZiYTU1NjM1ODIxN2Y2OGMxMzJlOWJl
-    YjgxMDQ1OGNmNDI0NTJkNzcyNzMyZTZiNjI4OTI2N2FkY2Y2OGI=
+    M2MwNWVkNTk0YzI0N2NmMmUxZGZmOTJjMDFjNmY2NmE0OTc1OWFjNjgyMDc5
+    ZWI3ZDE2ZTNiMzdhYTNkMmYzMWFjMTE4YzdlNjZhOWFhMzZhN2NlZTdkMzk0
+    MTViZjZiMWM3MDkyMDViMWEzZWYxOTBlM2YwZThlZDNhMzZiMDY=
   data.tar.gz: !binary |-
-    MmZjMGUwNGM5N2QyNGQxYWQ0NWMzMjgwYmJlZjFlMjFhYTAxMGYzNTQyYWFh
-    MzgwYTRhNWYwODhlOTcyNGRhYTE1YWEwNDE1ODU5YjcwNGVkZDM1NzM1MGIx
-    ZGQzYmU2NzMyYTVkZDYyYmZjZWI1MTVhNDlhODljNTFiMGQwNDc=
+    NmEwZjAzMDc2MDk1NTNjYTVkNDFjYmQ1NzE1Mzg0YjE5ZDVhODNiYWU1NmI2
+    NGJhZmY3MTFkN2M1ZjQ0NjhhYTg0YjQyOThhM2U3ZmI2ZTUwOGY5NzVmOWNm
+    ZmJkOTQwZGE4ZjE0NTgwYzI0NjNmMDExZTZjOGE2ZWIwMWQ3ZTQ=

data/README.md

@@ -18,15 +18,74 @@ Or install it yourself as:
 
     $ gem install sauce_whisk
 
+## Configuration
+
+You'll need a [Sauce Labs account](http://wwww.saucelabs.com/signup).  They're free to try and, if you're an open source project, [your access is always free](http://saucelabs.com/opensauce).
+
+Once you've got your account, set the following environment variables:
+
+```bash
+SAUCE_USERNAME=Your Sauce Username
+SAUCE_ACCESS_KEY=Your Access Key, found on the lower left of your Account page
+```
+
 ## Usage
     
-### Marking a Job as Passed
-
+### Marking jobs passed or failed
+```ruby
     SauceWhisk::Jobs.pass_job job_id
-    
-### Marking a Job as Failed
-   
     SauceWhisk::Jobs.fail_job job_id
+```    
+    
+### Creating Job Objects
+
+There are two ways to create a Job object.  
+
+```ruby
+# Create an 'empty' job (i.e. don't retrieve job details from the API)
+empty_job = Job.new job_id
+
+# Create a job with details fetched from the API
+fully_detailed_job = Jobs.fetch job_id
+```
+
+Use the first form when you just want a simple way to push details to the API.  Use the last form when you want to fetch details from the API.
+
+NB: It's not possible to create a new job on Sauce Labs' infrastructure with the API.
+
+### Updating Job Metadata
+
+```ruby
+job = Job.new job_id
+job.build = "12.3.04-beta"
+job.visibility = "public"
+job.tags = "new_user"
+job.name = "Determine if the User can Invite Friends"
+job.custom_data = {:executor => "jparth", :team_city_config => "standard_with_instrumentation"}
+job.passed = false
+
+job.save
+```
+
+It is not possible to alter any other job properties.
+
+### Assets
+
+There are three types of asset for Sauce Labs jobs: screenshots, video and logs.  Assets are represented as an Asset object, which include the name, asset type and data.
+
+#### Screenshots
+
+```ruby
+  job = Job.fetch job_id
+  screenshots = job.screenshots # An array of Screenshot assets
+```
+
+#### Video
+
+```ruby
+  job = Job.fetch job_id
+  video = job.video # A single Asset, holding the video
+```
 
 ## Contributing
 

data/lib/sauce_whisk/assets.rb

@@ -1,25 +1,27 @@
-class Assets
-  extend RestRequestBuilder
+module SauceWhisk
+  class Assets
+    extend RestRequestBuilder
 
-  def self.resource
-    "#{SauceWhisk.username}/jobs"
-  end
+    def self.resource
+      "#{SauceWhisk.username}/jobs"
+    end
 
-  def self.fetch(job_id, asset, type=nil)
-    data = get "#{job_id}/assets/#{asset}"
-    Asset.new({:name => asset, :data => data, :job_id => job_id, :type => type})
+    def self.fetch(job_id, asset, type=nil)
+      data = get "#{job_id}/assets/#{asset}"
+      Asset.new({:name => asset, :data => data, :job_id => job_id, :type => type})
+    end
   end
-end
 
-class Asset
+  class Asset
 
-  attr_reader :asset_type, :name, :data, :job
+    attr_reader :asset_type, :name, :data, :job
 
-  def initialize(parameters={})
-    @asset_type = parameters[:type] || :screenshot
-    @name = parameters[:name]
-    @data = parameters[:data]
-    @job = parameters[:job_id]
-  end
+    def initialize(parameters={})
+      @asset_type = parameters[:type] || :screenshot
+      @name = parameters[:name]
+      @data = parameters[:data]
+      @job = parameters[:job_id]
+    end
 
+  end
 end

data/lib/sauce_whisk/jobs.rb

@@ -2,111 +2,113 @@ require 'json'
 
 require 'sauce_whisk/rest_request_builder'
 
-class Jobs
-  extend RestRequestBuilder
+module SauceWhisk
+  class Jobs
+    extend RestRequestBuilder
 
-  def self.resource
-    "#{SauceWhisk.username}/jobs"
-  end
+    def self.resource
+      "#{SauceWhisk.username}/jobs"
+    end
 
-  def self.all
-    all_jobs = JSON.parse get
-    all_jobs.map {|job| Job.new(job)}
-  end
+    def self.all
+      all_jobs = JSON.parse get
+      all_jobs.map {|job| Job.new(job)}
+    end
 
-  def self.change_status(job_id, status)
-    put job_id, {"passed" => status}.to_json
-  end
+    def self.change_status(job_id, status)
+      put job_id, {"passed" => status}.to_json
+    end
 
-  def self.pass_job(job_id)
-    change_status(job_id, true)    
-  end
+    def self.pass_job(job_id)
+      change_status(job_id, true)
+    end
 
-  def self.fail_job(job_id)
-    change_status(job_id, false)
-  end
+    def self.fail_job(job_id)
+      change_status(job_id, false)
+    end
 
-  def self.save(job)
-    fields_to_save = job.updated_fields.each_with_object(Hash.new) do |field, hsh|
-      hsh[field] = job.send(field.to_s)
+    def self.save(job)
+      fields_to_save = job.updated_fields.each_with_object(Hash.new) do |field, hsh|
+        hsh[field] = job.send(field.to_s)
+      end
+      put job.id, fields_to_save.to_json
     end
-    put job.id, fields_to_save.to_json
-  end
 
-  def self.fetch(job_id)
-    job_hash = JSON.parse(get job_id)
-    assets = JSON.parse get "#{job_id}/assets"
-    screenshots = assets["screenshots"]
+    def self.fetch(job_id)
+      job_hash = JSON.parse(get job_id)
+      assets = JSON.parse get "#{job_id}/assets"
+      screenshots = assets["screenshots"]
 
-    job_hash.merge!({"screenshot_urls" => screenshots})
-    Job.new(job_hash)
-  end
+      job_hash.merge!({"screenshot_urls" => screenshots})
+      Job.new(job_hash)
+    end
 
-  def self.fetch_asset(job_id, asset)
-    asset = get "#{job_id}/assets/#{asset}"
+    def self.fetch_asset(job_id, asset)
+      asset = get "#{job_id}/assets/#{asset}"
+    end
   end
-end
-
-class Job
-  attr_writer :updated_fields
-  
-  def self.tracked_attr_accessor(*methods)
-    methods.each do |method|
-      attr_reader method
-      self.define_method("#{method}=") do |arg|
-        if method != arg 
-          updated_fields << method
-          instance_variable_set("@#{method}", arg)
+
+  class Job
+    attr_writer :updated_fields
+
+    def self.tracked_attr_accessor(*methods)
+      methods.each do |method|
+        attr_reader method
+        self.send(:define_method, "#{method}=") do |arg|
+          if method != arg
+            updated_fields << method
+            instance_variable_set("@#{method}", arg)
+          end
         end
       end
     end
-  end
 
-  attr_reader :id, :owner, :browser, :browser_version, :os, :log_url
-  attr_reader :error, :creation_time, :start_time, :end_time, :video_url
-  attr_reader :screenshot_urls
+    attr_reader :id, :owner, :browser, :browser_version, :os, :log_url
+    attr_reader :error, :creation_time, :start_time, :end_time, :video_url
+    attr_reader :screenshot_urls
 
-  tracked_attr_accessor :custom_data, :tags, :name, :visibility, :build, :passed
+    tracked_attr_accessor :custom_data, :tags, :name, :visibility, :build, :passed
 
-  def initialize(parameters={})
-    passed = parameters.delete "status"
-    cd = parameters.delete "custom-data"
-    visibility = parameters.delete "public"
+    def initialize(parameters={})
+      passed = parameters.delete "status"
+      cd = parameters.delete "custom-data"
+      visibility = parameters.delete "public"
 
-    self.passed = passed
-    self.custom_data = cd
-    self.visibility = visibility
+      self.passed = passed
+      self.custom_data = cd
+      self.visibility = visibility
 
-    parameters.each do |k,v|
-      self.instance_variable_set("@#{k}".to_sym, v)
-    end
+      parameters.each do |k,v|
+        self.instance_variable_set("@#{k}".to_sym, v)
+      end
 
-    @updated_fields = []
-  end
+      @updated_fields = []
+    end
 
-  def save
-    Jobs.save(self)
-  end
+    def save
+      Jobs.save(self)
+    end
 
-  def updated_fields
-    @updated_fields ||= []
-  end
+    def updated_fields
+      @updated_fields ||= []
+    end
 
-  def screenshots
-    unless @screenshots
-     @screenshots = screenshot_urls.map do |screenshot|
-        Assets.fetch id, screenshot
+    def screenshots
+      unless @screenshots
+       @screenshots = screenshot_urls.map do |screenshot|
+          Assets.fetch id, screenshot
+        end
       end
+
+      @screenshots
     end
 
-    @screenshots
-  end
+    def video
+      unless @video
+        @video = Assets.fetch id, "video.flv", :video
+      end
 
-  def video
-    unless @video
-      @video = Assets.fetch id, "video.flv", :video
+      @video
     end
-
-    @video
   end
 end

data/lib/sauce_whisk/rest_request_builder.rb

@@ -1,29 +1,31 @@
-module RestRequestBuilder
+module SauceWhisk
+  module RestRequestBuilder
 
-  def get(resource_to_fetch=nil)
-    resource_url = fully_qualified_resource
-    resource_url << "/#{resource_to_fetch}" if resource_to_fetch
-    RestClient::Request.execute({:method => :get, :url => resource_url}.merge auth_details)
-  end
+    def get(resource_to_fetch=nil)
+      resource_url = fully_qualified_resource
+      resource_url << "/#{resource_to_fetch}" if resource_to_fetch
+      RestClient::Request.execute({:method => :get, :url => resource_url}.merge auth_details)
+    end
 
-  def put(resource_id, body)
-    url = "#{fully_qualified_resource}/#{resource_id}"
-    length = body.length
-    headers = {"Content-Length" => length}
-    req_params = {
-        :method => :put, 
-        :url => url, 
-        :payload => body,
-        :content_type => "application/json"
-    }
-    RestClient::Request.execute(req_params.merge auth_details)
-  end
+    def put(resource_id, body)
+      url = "#{fully_qualified_resource}/#{resource_id}"
+      length = body.length
+      headers = {"Content-Length" => length}
+      req_params = {
+          :method => :put,
+          :url => url,
+          :payload => body,
+          :content_type => "application/json"
+      }
+      RestClient::Request.execute(req_params.merge auth_details)
+    end
 
-  def auth_details
-    {:user => SauceWhisk.username, :password => SauceWhisk.password}
-  end
+    def auth_details
+      {:user => SauceWhisk.username, :password => SauceWhisk.password}
+    end
 
-  def fully_qualified_resource
-    "#{SauceWhisk.base_url}/#{resource}"
+    def fully_qualified_resource
+      "#{SauceWhisk.base_url}/#{resource}"
+    end
   end
-end
+end

data/lib/sauce_whisk/version.rb

@@ -1,3 +1,3 @@
 module SauceWhisk
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/lib/sauce_whisk/asset_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe Asset do
+describe SauceWhisk::Asset do
 
   describe "#initialize" do
     let(:data) {"DEDEDEDEDED"}
@@ -11,7 +11,7 @@ describe Asset do
     before :each do
       params = {:data => data, :name => name, :type => type, :job_id => job_id}
 
-      @asset = Asset.new params
+      @asset = SauceWhisk::Asset.new params
     end
 
     it "should store the name" do
@@ -33,7 +33,7 @@ describe Asset do
 
   describe "#type" do
     it "should default to screenshot" do
-      Asset.new.asset_type.should eq :screenshot
+      SauceWhisk::Asset.new.asset_type.should eq :screenshot
     end
   end
 end

data/spec/lib/sauce_whisk/assets_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe Assets do
+describe SauceWhisk::Assets do
   let(:auth) {"#{ENV["SAUCE_USERNAME"]}:#{ENV["SAUCE_ACCESS_KEY"]}"}
 
   describe "#fetch", :vcr => {:cassette_name => "assets"} do
@@ -8,17 +8,17 @@ describe Assets do
     let(:asset_name)  {"0000screenshot.png"}
 
     it "fetches an asset for the requested job" do
-      Assets.fetch job_id, asset_name
+      SauceWhisk::Assets.fetch job_id, asset_name
 
       assert_requested :get, "https://#{auth}@saucelabs.com/rest/v1/dylanatsauce/jobs/#{job_id}/assets/#{asset_name}"
     end
 
     it "returns an asset" do
-      Assets.fetch(job_id, asset_name).should be_an_instance_of Asset
+      SauceWhisk::Assets.fetch(job_id, asset_name).should be_an_instance_of SauceWhisk::Asset
     end
 
     it "initializes the asset properly" do
-      asset = Assets.fetch job_id, asset_name
+      asset = SauceWhisk::Assets.fetch job_id, asset_name
       asset.name.should eq asset_name
       asset.job.should eq job_id
       asset.asset_type.should eq :screenshot

data/spec/lib/sauce_whisk/job_spec.rb

@@ -1,8 +1,8 @@
 require "spec_helper"
 
-describe Job do
-  let(:job) {Job.new}
-  subject {Job.new}
+describe SauceWhisk::Job do
+  let(:job) {SauceWhisk::Job.new}
+  subject {SauceWhisk::Job.new}
 
   it {should respond_to :id}
 
@@ -26,7 +26,7 @@ describe Job do
       "custom_data" => ""
     }}
 
-    subject {Job.new(params)}
+    subject {SauceWhisk::Job.new(params)}
 
     it "sets parameters at init" do
       params.each do |k,v|
@@ -47,20 +47,20 @@ describe Job do
     end
 
     it "has empty updated_fields for new instances" do
-      new_job = Job.new(params)
+      new_job = SauceWhisk::Job.new(params)
       new_job.updated_fields.should eq []
     end
 
     describe "#save" do
-      subject {Job.new(params)}
+      subject {SauceWhisk::Job.new(params)}
 
       context "with changed values" do
         before(:each) do
           subject.name = "New_Name"
         end
 
-        it "calls the save method of the Jobs object" do
-          Jobs.should_receive(:save).with(subject)
+        it "calls the save method of the SauceWhisk::Jobs object" do
+          SauceWhisk::Jobs.should_receive(:save).with(subject)
           subject.save
         end
       end
@@ -90,7 +90,7 @@ describe Job do
   end
 
   context "fetched from the API" do
-    subject {Jobs.fetch "bd9c43dd6b5549f1b942d1d581d98cac"}
+    subject {SauceWhisk::Jobs.fetch "bd9c43dd6b5549f1b942d1d581d98cac"}
 
     describe "#screenshots", :vcr => {:cassette_name => "assets"} do
       it "contains all the screenshots for that job" do
@@ -98,14 +98,14 @@ describe Job do
       end
 
       it "contains actual screenshots" do
-        subject.screenshots.first.should be_a_kind_of Asset
+        subject.screenshots.first.should be_a_kind_of SauceWhisk::Asset
         subject.screenshots.first.asset_type.should eq :screenshot
       end
     end
 
     describe "#video", :vcr => {:cassette_name => "assets"} do
       it "should be a video asset" do
-        subject.video.should be_a_kind_of Asset
+        subject.video.should be_a_kind_of SauceWhisk::Asset
         subject.video.asset_type.should eq :video
       end
     end

data/spec/lib/sauce_whisk/jobs_spec.rb

@@ -1,28 +1,28 @@
 require "spec_helper"
 
-describe Jobs do
+describe SauceWhisk::Jobs do
   let(:auth) {"#{ENV["SAUCE_USERNAME"]}:#{ENV["SAUCE_ACCESS_KEY"]}"}
   describe "#all", :vcr => {:cassette_name => 'jobs'} do
 
     it "should return an enumerable" do
-      Jobs.all.should be_an Enumerable
+      SauceWhisk::Jobs.all.should be_an Enumerable
     end
 
     it "should return a set of jobs" do
-      jobs_found = Jobs.all
-      jobs_found.each {|job| job.should be_a Job}
+      jobs_found = SauceWhisk::Jobs.all
+      jobs_found.each {|job| job.should be_a SauceWhisk::Job}
     end
   end
 
   describe "##change_status", :vcr => {:cassette_name => "jobs"} do
     let(:pass_string) {{:passed => true}.to_json}
     it "exists" do
-      Jobs.respond_to? :change_status
+      SauceWhisk::Jobs.respond_to? :change_status
     end
 
     it "passes a test status to the REST api" do
       job_id = "bd9c43dd6b5549f1b942d1d581d98cac"
-      Jobs.change_status job_id, true
+      SauceWhisk::Jobs.change_status job_id, true
       assert_requested :put, "https://#{auth}@saucelabs.com/rest/v1/dylanatsauce/jobs/#{job_id}", :body => pass_string, :content_type => "application/json"
     end
   end
@@ -30,41 +30,41 @@ describe Jobs do
   describe "##pass_job" do
     it "Calls the API and passes the given job" do
       job_id = "rerfreferf"
-      Jobs.should_receive(:change_status).with(job_id, true) {}
+      SauceWhisk::Jobs.should_receive(:change_status).with(job_id, true) {}
 
-      Jobs.pass_job job_id
+      SauceWhisk::Jobs.pass_job job_id
     end
   end
 
   describe "##fail_job" do
     it "Calls change_status to fail the job" do
       job_id = "rcercer"
-      Jobs.should_receive(:change_status).with(job_id, false) {}
+      SauceWhisk::Jobs.should_receive(:change_status).with(job_id, false) {}
 
-      Jobs.fail_job job_id
+      SauceWhisk::Jobs.fail_job job_id
     end
   end
 
   describe "##save", :vcr => {:cassette_name => "jobs"} do
     it "sends a put request" do
       job_id = "bd9c43dd6b5549f1b942d1d581d98cac"
-      job = Job.new({:id => job_id})
-      Jobs.save (job)
+      job = SauceWhisk::Job.new({:id => job_id})
+      SauceWhisk::Jobs.save (job)
       assert_requested :put, "https://#{auth}@saucelabs.com/rest/v1/dylanatsauce/jobs/#{job.id}", :body => anything, :content_type => "application/json"
     end
 
     it "only sends updated information" do
       job_id = "bd9c43dd6b5549f1b942d1d581d98cac"
-      job = Job.new({:id => job_id})
+      job = SauceWhisk::Job.new({:id => job_id})
       job.name = "Updated Name"
-      Jobs.save (job)
+      SauceWhisk::Jobs.save (job)
       expected_body = {:name => "Updated Name"}.to_json
       assert_requested :put, "https://#{auth}@saucelabs.com/rest/v1/dylanatsauce/jobs/#{job.id}", :body => expected_body, :content_type => "application/json"
     end
   end
 
   describe "##fetch", :vcr => {:cassette_name => "jobs"} do
-    let(:job) {Jobs.fetch("bd9c43dd6b5549f1b942d1d581d98cac")}
+    let(:job) {SauceWhisk::Jobs.fetch("bd9c43dd6b5549f1b942d1d581d98cac")}
 
     it "contains the list of screenshots for the job" do
       job.screenshot_urls.should be_a_kind_of Enumerable
@@ -72,7 +72,7 @@ describe Jobs do
     end
 
     it "returns a job when a valid one is fetched" do
-      job.should be_an_instance_of Job
+      job.should be_an_instance_of SauceWhisk::Job
     end
   end
 end

data/spec/lib/sauce_whisk/rest_request_builder_spec.rb

@@ -1,10 +1,10 @@
 require "spec_helper"
 require "rest_client"
 
-describe RestRequestBuilder do
+describe SauceWhisk::RestRequestBuilder do
   let(:dummy_client) { 
       Class.new do 
-        extend RestRequestBuilder
+        extend SauceWhisk::RestRequestBuilder
 
         def self.resource
           "dummy"

data/spec/lib/sauce_whisk/sauce_whisk_spec.rb

@@ -20,7 +20,7 @@ describe SauceWhisk do
   describe "##pass_job" do
     it "should call #pass on the jobs object" do
       job_id = "0418999"
-      Jobs.should_receive(:pass_job).with(job_id) {true}
+      SauceWhisk::Jobs.should_receive(:pass_job).with(job_id) {true}
       SauceWhisk.pass_job job_id
     end
   end

data/spec/spec_helper.rb

@@ -16,8 +16,6 @@ VCR.configure do |config|
   }
   config.filter_sensitive_data("<SAUCE_USERNAME>") { ENV["SAUCE_USERNAME"] }
   config.filter_sensitive_data("<SAUCE_ACCESS_KEY>") { ENV["SAUCE_ACCESS_KEY"] }
-
-  #config.debug_logger = STDOUT
 end
 
 RSpec.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sauce_whisk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dylan Lacey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-28 00:00:00.000000000 Z
+date: 2013-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client