sauce 0.1.0 → 0.2.0

data/README.markdown

@@ -0,0 +1,57 @@
+sauce
+=====
+
+Ruby access to SauceLab's features
+
+Features
+--------
+Current:
+
+*   Treat tunnels like ruby objects. Find/create/destroy
+
+Planned:
+
+*   ActiveRecord-like interface for video recordings, jobs logs, reverse tunnels
+*   Start/stop local instances of Sauce RC
+
+Install
+-------
+Make sure you're pulling in gems from gemcutter, and then:
+
+`gem install sauce`
+
+Example
+-------
+Here's how to start a tunnel using the Sauce gem
+    require 'rubygems'
+    require 'sauce'
+    
+    account = YAML.load_file "live_account.yml"
+    client = Sauce::Client.new(:username => account["username"],
+                               :access_key => account["access_key"])
+    tunnel = client.create_tunnel('DomainNames' => ["123.456.789.123"])
+    tunnel.refresh!
+    
+    client.tunnels # => [#<Sauce::Tunnel:0x1250e6c
+                             @host=nil,
+                             @status="running",
+                             @id="389a1c2a3d49861474c512e9a904be9e",
+                             @client=#<RestClient::Resource:0x1257fb4
+                               @block=nil,
+                               @url="https://username:access_key@saucelabs.com/rest/username/",
+                               @options={}>,
+                             @owner="username">]
+
+    tunnel.destroy # or client.destroy_all_tunnels
+
+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/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/rest.rb

@@ -2,11 +2,13 @@ require 'rest_client'
 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
 
     attr_accessor :username, :access_key, :client, :api_url
+    attr_accessor :tunnels
 
     def initialize(options)
       @username   = options[:username]
@@ -15,23 +17,9 @@ module Sauce
       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
+      @tunnels = Sauce::Tunnel
+      @tunnels.client = @client
     end
   end
 end

data/lib/tunnel.rb

@@ -3,26 +3,81 @@ module Sauce
   class Tunnel
     class NoIDError < StandardError; end #nodoc
 
-    attr_accessor :client, :application_address, :username, :access_key, :timeout
+    attr_accessor :application_address, :username, :access_key, :timeout
     attr_accessor :status, :owner, :creation_time, :id, :host
 
-    def initialize(client, options)
-      @client = client
+    def self.create(options)
+      response = JSON.parse @@client[:tunnels].post(options.to_json, :content_type => 'application/json')
+      Tunnel.new response
+    end
+
+    def initialize(options)
       build!(options)
     end
 
+    # 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)
+      @@client = client
+    end
+
+    def self.first
+      self.all.first
+    end
+
+    def self.last
+      self.all.last
+    end
+
+    def self.all
+      responses = JSON.parse @@client[:tunnels].get
+      return responses.collect{|response| Sauce::Tunnel.new(response)}
+    end
+
+    def self.destroy
+      self.all.each { |tunnel| tunnel.destroy }
+    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
+      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
+      response = JSON.parse @@client["tunnels/#{@id}"].get
       build! response
     end
 
+    # Sauce Labs' server will say hello on port 1025 as a sanity check. If no hello, something is wrong. TODO: Make it say hello on port 1025. Currently a hack.
+    def says_hello?(options={})
+      # TODO: Read from options if necessary
+      connection = {}
+      connection[:host]        = @host
+      connection[:port]        = 22
+      connection[:prompt]      = /[$%#>] \z/n
+      connection[:telnet_mode] = true
+      connection[:timeout]     = 10
+
+      host = Net::Telnet::new("Host"       => connection[:host],
+                              "Port"       => connection[:port],
+                              "Prompt"     => connection[:prompt],
+                              "Telnetmode" => connection[:telnet_mode],
+                              "Timeout"    => connection[:timeout])
+      line = host.lines.first.chomp
+
+      # Temporary workaround port 1025 problem
+      prefix = "SSH-2.0-Twisted"
+      line[0,prefix.length] == prefix
+    end
+
     protected 
 
     # Sets all internal variables from a hash

data/test/debug.rb

@@ -1,7 +1,11 @@
 require 'helper'
 
-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/helper.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'test/unit'
 require 'shoulda'
+require 'net/telnet'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/test_sauce.rb

@@ -5,9 +5,12 @@ class TestSauce < Test::Unit::TestCase
     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
+      @username = account["username"]
+      @access_key = account["access_key"]
+      @ip = account["ip"]
+      @client = Sauce::Client.new(:username => @username,
+                                  :access_key => @access_key)
+      @client.tunnels.destroy
     end
 
     should "initialize with passed variables" do
@@ -17,41 +20,55 @@ class TestSauce < Test::Unit::TestCase
     end
 
     should "create a tunnel with the current user" do
-      tunnel = @client.create_tunnel('DomainNames' => ["123.456.789.123"])
+      tunnel = @client.tunnels.create('DomainNames' => ["192.168.0.110"])
       tunnel.refresh!
       assert_not_nil tunnel
-      assert_equal "sgrove", tunnel.owner
+      assert_equal @username, 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"])
+      @client.tunnels.create('DomainNames' => ["192.168.0.111"])
+      @client.tunnels.create('DomainNames' => ["192.168.0.112"])
+      @client.tunnels.create('DomainNames' => ["192.168.0.113"])
 
-      tunnels = @client.tunnels
+      tunnels = @client.tunnels.all
       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 = @client.tunnels.create('DomainNames' => ["192.168.0.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"])
+      tunnel = @client.tunnels.create('DomainNames' => ["192.168.0.115"])
+      tunnel = @client.tunnels.create('DomainNames' => ["192.168.0.116"])
+      tunnel = @client.tunnels.create('DomainNames' => ["192.168.0.117"])
 
-      @client.destroy_all_tunnels
+      @client.tunnels.destroy
 
-      @client.tunnels.each do |tunnel|
+      @client.tunnels.all.each do |tunnel|
         assert_equal "halting", tunnel.status
       end
     end
 
+    should "say hello on port 1025 if healthy" do
+      tunnel = @client.tunnels.create('DomainNames' => [@ip])
+
+      max_retries = 30
+      retries = 0
+      until tunnel.status == "running" or retries >= max_retries
+        sleep 5
+        retries += 1
+        tunnel.refresh!
+      end
+
+      assert_equal true, tunnel.says_hello?
+    end
+
     def teardown
-      @client.destroy_all_tunnels
+      @client.tunnels.destroy
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sauce
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Sean Grove
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-16 00:00:00 -08:00
+date: 2010-02-18 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,12 +40,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - lib/rest.rb

data/README.rdoc

@@ -1,17 +0,0 @@
-= 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.