em-ssh 0.0.3 → 0.1.0

data/README.md

@@ -96,7 +96,6 @@ See bin/em-ssh-shell for a more complex example usage of Shell.
 Em-ssh relies on Fibers. MRI 1.9.2-p290 on OSX Lion has been known to segfault when using Fibers.
 
 
-
 ##Copyright
 Copyright (c) 2011 Caleb Crane
 

data/bin/em-ssh-shell

@@ -47,7 +47,7 @@ abort("command is required") if commands.empty?
 
 
 EM.run do
-  EM::Ssh::Shell.new(host, options[:user], options[:password]) do |shell|
+  EM::Ssh::Shell.new(host, options[:user], options[:password], :net_ssh => options) do |shell|
     commands.each do |command|
       mys = shell.split
       mys.on(:closed) { info("#{mys} has closed") }

data/lib/em-ssh/connection.rb

@@ -10,9 +10,8 @@ module EventMachine
         # Allows other objects to register callbacks with events that occur on a Ssh instance
         include Callbacks
         
-        ##
-        # Transport related
-        
+        # maximum number of seconds to wait for a connection
+        TIMEOUT = 20
         # @return [String] The host to connect to, as given to the constructor.
         attr_reader :host
         
@@ -113,7 +112,10 @@ module EventMachine
           fire(:data, data)
         end
 
-
+        def connection_completed
+          @contimeout.cancel
+          @nocon.cancel
+        end # connection_completed
 
         def initialize(options = {})
           debug("#{self.class}.new(#{options})")
@@ -122,14 +124,18 @@ module EventMachine
           @password       = options[:password]
           @queue          = []
           @options        = options
-
+          @timeout        = options[:timeout] || TIMEOUT
+          
           begin
             on(:connected, &options[:callback]) if options[:callback]
+            @nocon          = on(:closed) { raise ConnectionFailed, @host }
+            @contimeout     = EM::Timer.new(@timeout) { raise ConnectionTimeout, @host }
+            
             @error_callback = lambda { |code| raise SshError.new(code) }
 
             @host_key_verifier = select_host_key_verifier(options[:paranoid])
             @server_version    = ServerVersion.new(self)
-            on(:version_negotiated) do 
+            on(:version_negotiated) do
               @data.consume!(@server_version.header.length)
               @algorithms = Net::SSH::Transport::Algorithms.new(self, options)
 
@@ -142,8 +148,8 @@ module EventMachine
                   if auth.authenticate("ssh-connection", user, options[:password])
                     fire(:connected, Session.new(self, options))
                   else
+                    fire(:error, Net::SSH::AuthenticationFailed.new(user))
                     close_connection
-                    raise Net::SSH::AuthenticationFailed, user
                   end # auth.authenticate("ssh-connection", user, options[:password])
                 end.resume # Fiber
               end # :algo_init
@@ -223,11 +229,10 @@ module EventMachine
         # @return [Callback] the callback that was registered
         def register_data_handler
           on(:data) do |data|
-            # @todo instead of while use a EM.next_tick
-            while (packet = @socket.poll_next_packet) 
+            while (packet = @socket.poll_next_packet)
               case packet.type
               when DISCONNECT
-                raise Net::SSH::Disconnect, "disconnected: #{packet[:description]} (#{packet[:reason_code]})"
+                close_connection
               when IGNORE
                 debug("IGNORE packet received: #{packet[:data].inspect}")
               when UNIMPLEMENTED
@@ -236,8 +241,12 @@ module EventMachine
                 log.send((packet[:always_display] ? :fatal : :debug), packet[:message])
               when KEXINIT
                 Fiber.new do
-                   algorithms.accept_kexinit(packet)
-                   fire(:algo_init) if algorithms.initialized?
+                  begin
+                    algorithms.accept_kexinit(packet)
+                    fire(:algo_init) if algorithms.initialized?
+                  rescue Exception => e
+                    fire(:error, e)
+                  end # begin
                 end.resume
               else
                 @queue.push(packet)

data/lib/em-ssh/shell.rb

@@ -32,8 +32,6 @@ module EventMachine
       attr_reader :shell
       # @return [Net::SSH::Connection]
       attr_reader :connection
-      # @return [Boolean] Default (false) halt on timeout value - when true any timeouts will be halt the shell by raising an exception
-      attr_reader :halt_on_timeout
       # @return [Hash] the options passed to initialize
       attr_reader :options
       # @return [Hash] the options to pass to connect automatically. They will be extracted from the opptions[:net_ssh] on initialization
@@ -62,11 +60,9 @@ module EventMachine
       # @param [String, nil] pass by default publickey and password auth will be attempted
       # @param [Hash] opts
       # @option opts [Hash] :net_ssh options to pass to Net::SSH; see Net::SSH.start
-      # @option opts [Boolean] :halt_on_timeout (false)
       # @option opts [Fixnum] :timeout (TIMEOUT) default timeout for all #wait_for and #send_wait calls
       # @option opts [Boolean] :reconnect when disconnected reconnect
       def initialize(address, user, pass, opts = {}, &blk)
-        @halt_on_timeout = opts[:halt_on_timeout] || false
         @timeout         = opts[:timeout].is_a?(Fixnum) ? opts[:timeout] : TIMEOUT
         @host            = address
         @user            = user
@@ -76,7 +72,7 @@ module EventMachine
         @connection      = opts[:connection]
         @parent          = opts[:parent]
         @children        = []
-        @reconnect    = opts[:reconnect]
+        @reconnect       = opts[:reconnect]
         
         block_given? ? Fiber.new { open(&blk) }.resume : open
       end
@@ -118,7 +114,7 @@ module EventMachine
       # @param [String] send_str
       # @return [String] all data in the buffer including the wait_str if it was found
       def send_and_wait(send_str, wait_str = nil, opts = {})
-        reconnect? ? connect : raise(Disconnected) unless connected?
+        reconnect? ? connect : raise(Disconnected) if !connected?
         raise ClosedChannel if closed?
         debug("send_and_wait(#{send_str.inspect}, #{wait_str.inspect}, #{opts})")
         send_data(send_str)
@@ -129,31 +125,37 @@ module EventMachine
       # @param [String, Regexp] strregex a string or regex to match the console output against.
       # @param [Hash] opts
       # @option opts [Fixnum] :timeout (Session::TIMEOUT) the maximum number of seconds to wait
-      # @option opts [Boolean] (false) :halt_on_timeout 
       # @return [String] the contents of the buffer
       def wait_for(strregex, opts = { })
         reconnect? ? connect : raise(Disconnected) unless connected?
         raise ClosedChannel if closed?
         debug("wait_for(#{strregex.inspect}, #{opts})")
-        opts      = { :timeout => @timeout, :halt_on_timeout => @halt_on_timeout }.merge(opts)
+        opts      = { :timeout => @timeout }.merge(opts)
         buffer    = ''
         found     = nil
         f         = Fiber.current
         
         timer   = nil
         timeout = proc do
+          debug("timeout #{timer} fired")
+          shell.on_data {|c,d| }
+          begin
+            raise TimeoutError.new("#{host}: timeout while waiting for #{strregex.inspect}; received: #{buffer.inspect}")
+          rescue Exception => e
+            error(e)
+            debug(e.backtrace)
+            fire(:error, e)
+          end # begin
+          f.resume(nil)
           shell.on_data {|c,d| }
-          # @todo fire an em errback
-          if opts[:halt_on_timeout]
-            raise TimeoutError("timeout while waiting for #{strregex.inspect}; received: #{buffer.inspect}")
-          else
-            warn("timeout while waiting for #{strregex.inspect}; received: #{buffer.inspect}")
-          end # opts[:halt_on_timeout]
         end # timeout
         
         shell.on_data do |ch,data|
           buffer = "#{buffer}#{data}"
+          debug("data: #{buffer.dump}")
           if strregex.is_a?(Regexp) ? buffer.match(strregex)  :  buffer.include?(strregex)
+            debug("data matched")
+            debug("canceling timer #{timer}")
             timer.respond_to?(:cancel) && timer.cancel
             shell.on_data {|c,d| }
             f.resume(buffer)
@@ -161,6 +163,7 @@ module EventMachine
         end #  |ch,data|
         
         timer = EM::Timer.new(opts[:timeout], &timeout)
+        debug("set timer: #{timer} for #{opts[:timeout]}")
         return Fiber.yield
       end # wait_for(strregex, opts = { })
       
@@ -169,8 +172,20 @@ module EventMachine
       # @return [self]
       def open(&blk)
         debug("open(#{blk})")
-        f = Fiber.current
-        connect unless connected?
+        f      = Fiber.current
+
+        conerr = nil
+        unless connected?
+          conerr = on(:error) do |e|
+            error("#{e} (#{e.class})")
+            debug(e.backtrace)
+            conerr = e
+            f.resume(e)
+          end #  |e|
+          connect
+        end # connected?
+        
+        connection || raise(ConnectionError, "failed to create shell for #{host}: #{conerr} (#{conerr.class})")
         
         connection.open_channel do |channel|
           debug "**** channel open: #{channel}"
@@ -178,6 +193,7 @@ module EventMachine
             debug "***** pty open: #{pty}; suc: #{suc}"
             pty.send_channel_request("shell") do |shell,success|
               raise ConnectionError, "Failed to create shell." unless success
+              conerr && conerr.cancel
               debug "***** shell open: #{shell}"
               @shell = shell
               Fiber.new { yield(self) if block_given? }.resume
@@ -213,10 +229,11 @@ module EventMachine
       def connect
         return if connected?
         f = Fiber.current
-        ::EM::Ssh.start(host, user, connect_opts) do |connection|
+        con = ::EM::Ssh.start(host, user, connect_opts) do |connection|
           @connection = connection
           f.resume
         end # |connection|
+        con.on(:error) { |e| fire(:error, e) }
         return Fiber.yield
       end # connect
       
@@ -231,6 +248,26 @@ module EventMachine
       end
       
       
+      def debug(msg = nil, &blk)
+        super("#{host} #{msg}", &blk)
+      end
+      
+      def info(msg = nil, &blk)
+        super("#{host} #{msg}", &blk)
+      end
+      
+      def fatal(msg = nil, &blk)
+        super("#{host} #{msg}", &blk)
+      end
+      
+      def warn(msg = nil, &blk)
+        super("#{host} #{msg}", &blk)
+      end
+      
+      def error(msg = nil, &blk)
+        super("#{host} #{msg}", &blk)
+      end
+      
     end # class::Shell
   end # class::Ssh
 end # module::EventMachine

data/lib/em-ssh/version.rb

@@ -1,5 +1,5 @@
 module EventMachine
   class Ssh
-    VERSION='0.0.3'
+    VERSION='0.1.0'
   end # class::Ssh
 end # module::EventMachine

data/lib/em-ssh.rb

@@ -22,7 +22,9 @@ module EventMachine
     class SshError < Net::SSH::Exception; include Error; end
     class TimeoutError < Timeout::Error; include Error; end
     class ClosedChannel < SshError; end
-    class DisconnectedChannel < SshError; end
+    class Disconnected < SshError; end
+    class ConnectionFailed < SshError; end
+    class ConnectionTimeout < ConnectionFailed; end
     
     
     class << self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: em-ssh
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-24 00:00:00.000000000 +09:00
-default_executable: 
+date: 2011-10-30 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &2160452560 !ruby/object:Gem::Requirement
+  requirement: &70168320140920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160452560
+  version_requirements: *70168320140920
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &2160424600 !ruby/object:Gem::Requirement
+  requirement: &70168320140460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160424600
+  version_requirements: *70168320140460
 - !ruby/object:Gem::Dependency
   name: ruby-termios
-  requirement: &2160412880 !ruby/object:Gem::Requirement
+  requirement: &70168320140040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160412880
+  version_requirements: *70168320140040
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &2160402840 !ruby/object:Gem::Requirement
+  requirement: &70168320139620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160402840
+  version_requirements: *70168320139620
 description: ''
 email:
 - em-ssh@simulacre.org
@@ -78,7 +77,6 @@ files:
 - bin/em-ssh
 - bin/em-ssh-shell
 - README.md
-has_rdoc: true
 homepage: http://github.com/simulacre/em-ssh
 licenses:
 - MIT
@@ -100,8 +98,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: An EventMachine compatible net-ssh
 test_files: []
+has_rdoc: