sauce 0.20.0 → 1.0.0

data/README.markdown

@@ -1,13 +1,12 @@
-Sauce OnDemand is a Selenium testing cloud service, developed by Sauce
-Labs Inc (saucelabs.com). This is the Ruby client adapter for Sauce
-OnDemand.
+Sauce OnDemand is a Selenium testing cloud service, developed by Sauce Labs Inc
+(saucelabs.com). This is the Ruby client adapter for Sauce OnDemand.
 
 Features
 --------
 
 *   Drop-in replacement for Selenium::Client::Driver that takes care of connecting to Sauce OnDemand
 *   RSpec, Test::Unit, and Rails integration for tests, including automatic setup of Sauce Connect
-*   ActiveRecord-like interface for tunnels and jobs: Find/create/destroy
+*   ActiveRecord-like interface for job metadata: Find/create/destroy
 
 Install
 -------
@@ -189,12 +188,6 @@ If you want tests to go a bit faster, globally install the gems with native exte
 * gem install ffi sqlite3 json
 * rvm use default
 
-Plans
------
-
-*   Webrat integration
-*   Extend to automatic retrieval of jobs logs, videos, reverse tunnels
-
 Copyright
 ---------
 

data/lib/sauce.rb

@@ -1,6 +1,4 @@
-require 'rubygems'
 require 'sauce/utilities'
-require 'sauce/tunnel'
 require 'sauce/job'
 require 'sauce/client'
 require 'sauce/config'

data/lib/sauce/client.rb

@@ -9,7 +9,7 @@ module Sauce
 
     attr_accessor :client
     attr_accessor :protocol, :host, :port, :api_path, :api_version, :ip, :api_url
-    attr_accessor :tunnels, :jobs
+    attr_accessor :jobs
 
     def initialize(options={})
       config = Sauce::Config.new
@@ -24,13 +24,6 @@ module Sauce
       @api_url = "#{@protocol}://#{config.username}:#{config.access_key}@#{@host}:#{@port}/#{@api_path}/v#{@api_version}/#{config.username}/"
       @client = RestClient::Resource.new @api_url
 
-      @tunnels = Sauce::Tunnel
-      @tunnels.client = @client
-      @tunnels.account = {
-        :username => config.username,
-        :access_key => config.access_key,
-        :ip => @ip}
-
       @jobs = Sauce::Job
       @jobs.client = @client
       @jobs.account = {

data/lib/sauce/job.rb

@@ -1,8 +1,3 @@
-require 'net/telnet'
-require 'net/ssh'
-require 'net/ssh/gateway'
-require 'sauce/gateway_ext'
-
 module Sauce
   # Interact with a Sauce Labs selenium jobs as if it were a ruby object
   class Job

data/sauce.gemspec

@@ -2,13 +2,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sauce}
-  s.version = "0.20.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Eric Allen", "Sean Grove", "Steven Hazel"]
-  s.date = %q{2011-03-26}
+  s.date = %q{2011-04-11}
   s.default_executable = %q{sauce}
-  s.description = %q{A Ruby interface to Sauce Labs' services. Start/stop tunnels, retrieve Selenium logs, access video replays, etc.}
+  s.description = %q{A Ruby interface to Sauce OnDemand.}
   s.email = %q{help@saucelabs.com}
   s.executables = ["sauce"]
   s.files = [
@@ -30,13 +30,11 @@ Gem::Specification.new do |s|
     "lib/sauce/client.rb",
     "lib/sauce/config.rb",
     "lib/sauce/connect.rb",
-    "lib/sauce/gateway_ext.rb",
     "lib/sauce/heroku.rb",
     "lib/sauce/integrations.rb",
     "lib/sauce/job.rb",
     "lib/sauce/raketasks.rb",
     "lib/sauce/selenium.rb",
-    "lib/sauce/tunnel.rb",
     "lib/sauce/utilities.rb",
     "sauce.gemspec",
     "support/sauce_connect",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sauce
 version: !ruby/object:Gem::Version 
-  hash: 79
+  hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
-  - 20
   - 0
-  version: 0.20.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Eric Allen
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-26 00:00:00 -07:00
+date: 2011-04-11 00:00:00 -07:00
 default_executable: sauce
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -142,7 +142,7 @@ dependencies:
         version: 1.5.0
   type: :runtime
   version_requirements: *id008
-description: A Ruby interface to Sauce Labs' services. Start/stop tunnels, retrieve Selenium logs, access video replays, etc.
+description: A Ruby interface to Sauce OnDemand.
 email: help@saucelabs.com
 executables: 
 - sauce
@@ -169,13 +169,11 @@ files:
 - lib/sauce/client.rb
 - lib/sauce/config.rb
 - lib/sauce/connect.rb
-- lib/sauce/gateway_ext.rb
 - lib/sauce/heroku.rb
 - lib/sauce/integrations.rb
 - lib/sauce/job.rb
 - lib/sauce/raketasks.rb
 - lib/sauce/selenium.rb
-- lib/sauce/tunnel.rb
 - lib/sauce/utilities.rb
 - sauce.gemspec
 - support/sauce_connect

data/lib/sauce/gateway_ext.rb

@@ -1,40 +0,0 @@
-# NOTE: This has been superseded by sauce/connect. Consider for deprecation
-
-# http://groups.google.com/group/capistrano/browse_thread/thread/455c0c8a6faa9cc8?pli=1
-class Net::SSH::Gateway
-  # Opens a SSH tunnel from a port on a remote host to a given host and port
-  # on the local side
-  # (equivalent to openssh -R parameter)
-  def open_remote(port, host, remote_port, remote_host = "127.0.0.1")
-    ensure_open!
-
-    begin
-      @session_mutex.synchronize do
-        result = @session.forward.remote(port, host, remote_port, remote_host)
-      end
-      
-      if block_given?
-        begin
-          yield [remote_port, remote_host]
-        ensure
-          close_remote(remote_port, remote_host)
-        end
-      else
-        return [remote_port, remote_host]
-      end
-    rescue Errno::EADDRINUSE
-      retry
-    end
-  end
-
-  # Cancels port-forwarding over an open port that was previously opened via
-  # #open_remote.
-  def close_remote(port, host = "127.0.0.1")
-    puts "Close the remote port #{host}:#{port}!"
-    ensure_open!
-
-    @session_mutex.synchronize do
-      @session.forward.cancel_remote(port, host)
-    end
-  end
-end

data/lib/sauce/tunnel.rb

@@ -1,239 +0,0 @@
-# NOTE: This has been superseded by sauce/connect. Consider for deprecation
-
-require 'net/telnet'
-require 'net/ssh'
-require 'net/ssh/gateway'
-require 'sauce/gateway_ext'
-
-module Sauce
-  # Interact with a Sauce Labs tunnel as if it were a ruby object
-  class Tunnel
-    class NoIDError < StandardError; end #nodoc
-
-    #{"Status": "running", "CreationTime": 1266545716, "ModificationTime": 1266545793, "Host": "ec2-184-73-16-13.compute-1.amazonaws.com", "LaunchTime": 1266545726, "Owner": "sgrove", "_id": "1090b4b0b50477cf40fc44c146b408a4", "Type": "tunnel", "id": "1090b4b0b50477cf40fc44c146b408a4", "DomainNames": ["sgrove.tst"]}
-
-    attr_accessor :owner, :access_key, :status
-    attr_accessor :id, :host, :domain_names, :timeout
-    attr_accessor :launch_time, :created_at, :updated_at
-    
-    attr_accessor :application_address, :gateway, :port, :thread
-
-    # 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
-
-    # Get the class @@client.
-    # TODO: Consider metaprogramming this away
-    def self.account
-      @@account
-    end
-
-    # Set the class @@client.
-    # TODO: Consider metaprogramming this away
-    def self.account=(account)
-      @@account = account
-    end
-
-    def self.first
-      self.all.first
-    end
-
-    def self.last
-      self.all.last
-    end
-
-    def self.all
-      responses = JSON.parse @@client[:tunnels].get.body
-      return responses.collect{|response| Sauce::Tunnel.new(response)}
-    end
-
-    def self.destroy_all
-      self.all.each { |tunnel| tunnel.destroy }
-    end
-
-    # Creates a new tunnel machine
-    def self.create(options)
-      response = JSON.parse @@client[:tunnels].post(options.to_json, :content_type => 'application/json').body
-      #puts response.inspect
-      Tunnel.new response
-    end
-
-    # Creates an instance representing a machine, but does not actually create the machine. See #create for that.
-    def initialize(options)
-      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
-      close_gateway
-      response = @@client["tunnels/#{@id}"].delete.body
-      refresh!
-    end
-
-    # Retrieves the latest information on this tunnel from the Sauce Labs' server
-    def refresh!
-      response = JSON.parse @@client["tunnels/#{@id}"].get.body
-      #puts "\Tunnel refresh with: #{response.inspect}"
-      build! response
-      self
-    end
-
-    # Shortcut method to find out if a tunnel is marked as dead
-    def preparing?
-      refresh!
-      status == "new" or status == "booting"
-    end
-
-    # Shortcut method to find out if a tunnel is marked as dead
-    def halting?
-      refresh!
-      status == "halting"
-    end
-
-    # Shortcut method to find out if a tunnel is marked as dead
-    def terminated?
-      refresh!
-      status == "terminated"
-    end
-
-    # A tunnel is healthy if 1.) its status is "running" and 2.) It says hello
-    def healthy?
-      # TODO: Implement 3.) We can reach through and touch a service on the reverse end of the tunnel
-      refresh!
-=begin
-      puts "\tRunning? #{self.status == 'running'}"
-      puts "\tSays hello? #{self.says_hello?}"
-      puts "\tThread running? #{self.still_running?}"
-=end
-      return true if not self.terminated? and self.status == "running" and self.says_hello? and self.still_running?
-      return false
-    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={})
-      return false unless self.status == "running" and not @host.nil?
-
-      # 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
-
-    # Debug method
-    def mini_repair
-      refresh!
-      if not self.terminated? and self.status == "running" and self.says_hello?
-        if not self.still_running?
-          open_gateway
-          return true if self.still_running?
-        end
-      end
-      return false
-    end
-
-    # Opens a reverse ssh tunnel to the tunnel machine
-    def open_gateway
-      # TODO: Make ports configurable
-
-      @gateway = Net::SSH::Gateway.new(host, owner, {:password => @@account[:access_key]})
-
-      # Notes for anyone looking at this method
-      # gateway.open_remote(3000,        # Port where your local application is running. Usually 3000 for rails dev
-      #                     "localhost", # Hostname/local ip your rails app is running on. Usually "localhost" for rails dev
-      #                     80,          # This is the port to run your selenium tests against, i.e. :url => "http://<some_host>:80"
-      #                                  #   <some_host> is the DomainNames you started the tunnel machine with.
-      #                     "0.0.0.0")   # Do not change this unless your god has commanded you to do so. I'm serious.
-      port = 3000
-      local_host = "localhost"
-      remote_port = 80
-      #puts "This is the experimental non-blocking gateway_open. Well done."
-      #puts "gateway.open_remote(#{port}, #{local_host}, #{remote_port}, 0.0.0.0)"
-      #gateway.open_remote(pair[0], local_host, pair[1], "0.0.0.0") do |rp, rh|
-
-      @thread = Thread.new(host, port, remote_port, owner, @@account[:access_key]) do
-        Thread.pass
-        @gateway.open_remote(3000,
-                             "localhost",
-                             80,
-                             "0.0.0.0") do |rp, rh|
-          while true do
-            sleep 10
-          end
-        end
-      end
-
-      @thread.run
-    end
-
-    # Closes the reverse ssh tunnel if open
-    def close_gateway
-      @thread.kill if @thread
-    end
-
-    # Returns true if this tunnel has a thread that needs to be monitored
-    def still_running?
-      #puts "\t\t#{@thread.inspect}.nil?"
-      not @thread.nil?
-    end
-
-    # Returns a json representation of the current state of the tunnel object
-    def to_json(options={})
-      json = {
-        :id =>              @id,
-        :owner =>           @owner,
-        :status =>          @status,
-        :host =>            @host,
-        :creation_time =>   @creation_time,
-        :start_time =>      @start_time,
-        :end_time =>        @end_time,
-        :domain_name =>     @domain_names
-      }
-
-      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
-
-    protected 
-
-    # Sets all internal variables from a hash
-    def build!(options)
-      options = options["tunnel"] unless options["tunnel"].nil?
-      #puts "\tBuild with #{options.inspect}"
-      @status = options["status"]
-      @owner  = options["owner"]
-      @id     = options["id"]
-      @host   = options["host"]
-      @creation_time = options["creation_time"]
-      @start_time = options["start_time"]
-      @end_time = options["end_time"]
-      @domain_names = options["domain_names"]
-
-      raise NoIDError if @id.nil?
-    end
-  end
-end