sauce_whisk 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTVhMzg0MGRmMjk3NGZjMjEwMDA4Mzk5M2RiYzQ3N2I3Y2E0ZDQxOA==
+  data.tar.gz: !binary |-
+    MDBiZDc3M2Q3MDc0OGYzYjlmMzk4YTNmNWZjZjI2ZWRiNmIyZjYyYQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    Zjk3NDY0MmY2Y2I2NDc4YmYzNzljMGZhNDVhZmQ4Zjc0Yjg5NTQxOTkzZGE5
+    OWMzNGZkYzE4MmU2ZjY0MTIzYTVlYzZiYTU1NjM1ODIxN2Y2OGMxMzJlOWJl
+    YjgxMDQ1OGNmNDI0NTJkNzcyNzMyZTZiNjI4OTI2N2FkY2Y2OGI=
+  data.tar.gz: !binary |-
+    MmZjMGUwNGM5N2QyNGQxYWQ0NWMzMjgwYmJlZjFlMjFhYTAxMGYzNTQyYWFh
+    MzgwYTRhNWYwODhlOTcyNGRhYTE1YWEwNDE1ODU5YjcwNGVkZDM1NzM1MGIx
+    ZGQzYmU2NzMyYTVkZDYyYmZjZWI1MTVhNDlhODljNTFiMGQwNDc=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'psych', "2.0.0", :path => "./vendor/psych"
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dylan Lacey
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# SauceWhisk
+
+SauceWhisk provides an "ActiveRecord" style client for the [Sauce Labs](http://www.saucelabs.com) RESTful API.  If you're not using the [Sauce Gem](https://rubygems.org/gems/sauce) and you want a nice way to interact with our API, give this a try.
+
+[![Build Status](https://travis-ci.org/DylanLacey/sauce_whisk.png)](https://travis-ci.org/DylanLacey/sauce_whisk)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sauce_whisk'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sauce_whisk
+
+## Usage
+    
+### Marking a Job as Passed
+
+    SauceWhisk::Jobs.pass_job job_id
+    
+### Marking a Job as Failed
+   
+    SauceWhisk::Jobs.fail_job job_id
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Bundler::GemHelper.install_tasks
+
+task :default => :test
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/lib/*_spec.rb']
+  t.test_files = FileList['spec/*_spec.rb']
+end

data/lib/sauce_whisk/assets.rb

@@ -0,0 +1,25 @@
+class Assets
+  extend RestRequestBuilder
+
+  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})
+  end
+end
+
+class Asset
+
+  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
+
+end

data/lib/sauce_whisk/jobs.rb

@@ -0,0 +1,112 @@
+require 'json'
+
+require 'sauce_whisk/rest_request_builder'
+
+class Jobs
+  extend RestRequestBuilder
+
+  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.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.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)
+    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"]
+
+    job_hash.merge!({"screenshot_urls" => screenshots})
+    Job.new(job_hash)
+  end
+
+  def self.fetch_asset(job_id, asset)
+    asset = get "#{job_id}/assets/#{asset}"
+  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)
+        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
+
+  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"
+
+    self.passed = passed
+    self.custom_data = cd
+    self.visibility = visibility
+
+    parameters.each do |k,v|
+      self.instance_variable_set("@#{k}".to_sym, v)
+    end
+
+    @updated_fields = []
+  end
+
+  def save
+    Jobs.save(self)
+  end
+
+  def updated_fields
+    @updated_fields ||= []
+  end
+
+  def screenshots
+    unless @screenshots
+     @screenshots = screenshot_urls.map do |screenshot|
+        Assets.fetch id, screenshot
+      end
+    end
+
+    @screenshots
+  end
+
+  def video
+    unless @video
+      @video = Assets.fetch id, "video.flv", :video
+    end
+
+    @video
+  end
+end

data/lib/sauce_whisk/rest_request_builder.rb

@@ -0,0 +1,29 @@
+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 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 fully_qualified_resource
+    "#{SauceWhisk.base_url}/#{resource}"
+  end
+end

data/lib/sauce_whisk/version.rb

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

data/lib/sauce_whisk.rb

@@ -0,0 +1,23 @@
+require "sauce_whisk/version"
+require "sauce_whisk/jobs"
+require "sauce_whisk/assets"
+require "sauce_whisk/rest_request_builder"
+
+module SauceWhisk
+
+  def self.base_url
+    "https://saucelabs.com/rest/v1"
+  end
+
+  def self.username
+    ENV["SAUCE_USERNAME"]
+  end
+
+  def self.password
+    ENV["SAUCE_ACCESS_KEY"]
+  end
+
+  def self.pass_job(job_id)
+    Jobs.pass_job job_id
+  end
+end

data/sauce_whisk.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sauce_whisk/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sauce_whisk"
+  gem.version       = SauceWhisk::VERSION
+  gem.authors       = ["Dylan Lacey"]
+  gem.email         = ["github@dylanlacey.com"]
+  gem.description   = "A Wrapper for the Sauce Labs REST API."
+  gem.summary       = "Sauce_Whisk lets you mix extra data into your Sauce test results!\nFetch and update Job details, screenshots, videos and logs."
+  gem.homepage      = "http://www.github.com/dylanlacey/sauce_whisk"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.license       = "MIT"
+
+  gem.add_runtime_dependency     "rest-client"
+  gem.add_development_dependency "vcr"
+  gem.add_development_dependency "webmock"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
+end