sauce 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Sauce Labs Inc
+
+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.rdoc

@@ -0,0 +1,17 @@
+= sauce
+
+Ruby access to SauceLab's features
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I 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.
+
+== Copyright
+
+Copyright (c) 2010 Sauce Labs Inc. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sauce"
+    gem.summary = "Ruby access to Sauce Labs' features"
+    gem.description = "A ruby interface to Sauce Labs' services. Start/stop tunnels, retrieve Selenium logs, access video replays, etc."
+    gem.email = "sean@saucelabs.com"
+    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 is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sauce #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rest.rb

@@ -0,0 +1,37 @@
+require 'rest_client'
+require 'json'
+
+module Sauce
+  class Client
+    class BadAccessError < StandardError; end #nodoc
+    class MisconfiguredError < StandardError; end #nodoc
+
+    attr_accessor :username, :access_key, :client, :api_url
+
+    def initialize(options)
+      @username   = options[:username]
+      @access_key = options[:access_key]
+
+      raise MisconfiguredError if @username.nil? or @access_key.nil?
+      @api_url = "https://#{@username}:#{@access_key}@saucelabs.com/rest/#{@username}/"
+      @client = RestClient::Resource.new @api_url
+    end
+
+    def create_tunnel(options)
+      response = JSON.parse @client[:tunnels].post(options.to_json, :content_type => 'application/json')
+      raise Sauce::Client::BadAccessError unless response["error"].nil?
+      Sauce::Tunnel.new(@client, response)
+    end
+
+    def tunnels(options = {})
+      response = JSON.parse @client[:tunnels].get
+      return response.collect{|r| Sauce::Tunnel.new(@client, r)}
+    end
+
+    def destroy_all_tunnels(options={})
+      tunnels.each do |t|
+        t.destroy
+      end
+    end
+  end
+end

data/lib/sauce.rb

@@ -0,0 +1,2 @@
+require 'rest'
+require 'tunnel'

data/lib/tunnel.rb

@@ -0,0 +1,39 @@
+module Sauce
+  # Interact with a Sauce Labs tunnel as if it were a ruby object
+  class Tunnel
+    class NoIDError < StandardError; end #nodoc
+
+    attr_accessor :client, :application_address, :username, :access_key, :timeout
+    attr_accessor :status, :owner, :creation_time, :id, :host
+
+    def initialize(client, options)
+      @client = client
+      build!(options)
+    end
+
+    # Hits the destroy url for this tunnel, and then refreshes. Keep in mind it takes some time to completely teardown a tunnel.
+    def destroy
+      response = @client["tunnels/#{@id}"].delete
+      refresh!
+    end
+
+    # Retrieves the latest information on this tunnel from the Sauce Labs' server
+    def refresh!
+      response = JSON.parse @client["tunnels/#{@id}"].get
+      build! response
+    end
+
+    protected 
+
+    # Sets all internal variables from a hash
+    def build!(options)
+      @status = options["Status"]
+      @owner = options["Owner"]
+      @id = options["_id"]
+      @id = options["id"] if @id.nil? or @id.empty?
+      @host = options["Host"]
+
+      raise NoIDError if @id.nil? or @id.empty?
+    end
+  end
+end

data/test/debug.rb

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

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'sauce'
+
+class Test::Unit::TestCase
+end

data/test/test_sauce.rb

@@ -0,0 +1,57 @@
+require 'helper'
+
+class TestSauce < Test::Unit::TestCase
+  context "A Client instance" do
+    setup do
+      # Create this file and put in your details to run the tests
+      account = YAML.load_file "live_account.yml"
+      @client = Sauce::Client.new(:username => account["username"],
+                                  :access_key => account["access_key"])
+      @client.destroy_all_tunnels
+    end
+
+    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/"
+    end
+
+    should "create a tunnel with the current user" do
+      tunnel = @client.create_tunnel('DomainNames' => ["123.456.789.123"])
+      tunnel.refresh!
+      assert_not_nil tunnel
+      assert_equal "sgrove", tunnel.owner
+    end
+
+    should "list current tunnels" do
+      @client.create_tunnel('DomainNames' => ["111.111.111.111"])
+      @client.create_tunnel('DomainNames' => ["111.111.111.112"])
+      @client.create_tunnel('DomainNames' => ["111.111.111.113"])
+
+      tunnels = @client.tunnels
+      assert_equal 3, tunnels.select{|t| t.status != "halting"}.count
+    end
+
+    should "destroy a tunnel" do
+      tunnel = @client.create_tunnel('DomainNames' => ["111.111.111.114"])
+      tunnel.destroy
+      assert_equal "halting", tunnel.status
+    end
+
+    should "destroy all tunnels" do
+      @client.create_tunnel('DomainNames' => ["111.111.111.115"])
+      @client.create_tunnel('DomainNames' => ["111.111.111.116"])
+      @client.create_tunnel('DomainNames' => ["111.111.111.117"])
+
+      @client.destroy_all_tunnels
+
+      @client.tunnels.each do |tunnel|
+        assert_equal "halting", tunnel.status
+      end
+    end
+
+    def teardown
+      @client.destroy_all_tunnels
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: sauce
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Sean Grove
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-16 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A ruby interface to Sauce Labs' services. Start/stop tunnels, retrieve Selenium logs, access video replays, etc.
+email: sean@saucelabs.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rest.rb
+- lib/sauce.rb
+- lib/tunnel.rb
+- test/helper.rb
+- test/test_sauce.rb
+has_rdoc: true
+homepage: http://github.com/sgrove/sauce
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby access to Sauce Labs' features
+test_files: 
+- test/debug.rb
+- test/helper.rb
+- test/test_sauce.rb