em-ssh 0.0.1 → 0.0.2

data/README.md

@@ -56,8 +56,24 @@ See [http://net-ssh.github.com/ssh/v2/api/index.html](http://net-ssh.github.com/
 Em-ssh provides an exepct-like shell abstraction layer on top of net-ssh in EM::Ssh::Shell
 
 ### Example
+	require 'em-ssh/shell'
 	EM.run {
-		EM::Ssh::Shell.new(host, 'caleb', 'password') do	|shell|
+	  EM::Ssh::Shell.new(host, 'caleb', "") do |shell|
+	    shell.should be_a(EventMachine::Ssh::Shell)
+	    shell.wait_for(']$')
+	    shell.send_and_wait('uname -a', ']$')
+	    shell.wait_for(']$')
+	    shell.send_and_wait('/sbin/ifconfig -a', ']$')
+	    timer.cancel
+	    EM.stop
+	  end
+	}
+
+#### Synchrony Example
+	require 'em-ssh/shell'
+	EM.run {
+		Fiber.new {
+			shell = EM::Ssh::Shell.new(host, 'caleb', '')
 			shell.wait_for(']$')
 			shell.send_and_wait('sudo su -', 'password for caleb: ')
 			shell.send_and_wait('password', ']$')
@@ -65,7 +81,7 @@ Em-ssh provides an exepct-like shell abstraction layer on top of net-ssh in EM::
 			# ...
 			shell.send_and_wait('exit', ']$')
 			shell.send_data('exit')
-		end
+		}.resume
 	}
 
 
@@ -75,6 +91,11 @@ See bin/em-ssh for an example of a basic replacement for system ssh.
 
 See bin/em-ssh-shell for a more complex example usage of Shell.
 
+## Known Issues
+
+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,27 +47,25 @@ abort("command is required") if commands.empty?
 
 
 EM.run do
-  Fiber.new {
-    shell = EM::Ssh::Shell.new(host, options[:user], options[:password])
-     commands.each do |command|
-       mys = shell.split
-       mys.on(:closed) { info("#{mys} has closed") }
-     
-       EM.next_tick do
-         Fiber.new {
-           debug("#{mys} waited for: '#{mys.wait_for(waitstr)}'")
-           mys.line_terminator = "\n"
-           debug("#{mys} send: #{command.inspect}")
-           puts "#{mys} result: '#{mys.send_and_wait(command, waitstr)}'"
-           mys.close        
-         }.resume
-       end # 
-     end #  |command|
-     
-     shell.on(:childless) do
-       info("#{shell}'s children all closed")
-       shell.close
-       EM.stop
-     end # :childless
-  }.resume  
+  EM::Ssh::Shell.new(host, options[:user], options[:password]) do |shell|
+    commands.each do |command|
+      mys = shell.split
+      mys.on(:closed) { info("#{mys} has closed") }
+      
+      EM.next_tick do
+        Fiber.new {
+          debug("#{mys} waited for: '#{mys.wait_for(waitstr)}'")
+          debug("#{mys} send: #{command.inspect}")
+          puts "#{mys} result: '#{mys.send_and_wait(command, waitstr)}'"
+          mys.close
+        }.resume
+      end
+    end #  |command|
+    
+    shell.on(:childless) do
+      info("#{shell}'s children all closed")
+      shell.close
+      EM.stop
+    end # :childless
+  end #  |shell|
 end # EM.run

data/lib/em-ssh/shell.rb

@@ -51,7 +51,7 @@ module EventMachine
       attr_reader :parent
       # @return [String] a string (\r\n) to append to every command
       def line_terminator
-        @line_terminator ||= "\r\n"
+        @line_terminator ||= "\n"
       end
       # [String]
       attr_writer :line_terminator
@@ -76,7 +76,7 @@ module EventMachine
         @parent          = opts[:parent]
         @children        = []
         
-        block_given? ? open(&blk) : open
+        block_given? ? Fiber.new { open(&blk) }.resume : open
       end
       
       # Close the connection to the server and all child shells.
@@ -125,7 +125,7 @@ module EventMachine
       # @return [String] the contents of the buffer
       def wait_for(strregex, opts = { })
         raise ClosedChannel if closed?
-        debug("wait_for(#{strregex}, #{opts})")
+        debug("wait_for(#{strregex.inspect}, #{opts})")
         opts      = { :timeout => @timeout, :halt_on_timeout => @halt_on_timeout }.merge(opts)
         buffer    = ''
         found     = nil
@@ -146,9 +146,8 @@ module EventMachine
           buffer = "#{buffer}#{data}"
           if strregex.is_a?(Regexp) ? buffer.match(strregex)  :  buffer.include?(strregex)
             timer.respond_to?(:cancel) && timer.cancel
-            result = buffer.clone
             shell.on_data {|c,d| }
-            f.resume(result)
+            f.resume(buffer)
           end
         end #  |ch,data|
         
@@ -159,7 +158,8 @@ module EventMachine
       # Open a shell on the server.
       # You generally don't need to call this.
       # @return [self]
-      def open
+      def open(&blk)
+        debug("open(#{blk})")
         f = Fiber.current
         connect unless connected?
         
@@ -171,6 +171,7 @@ module EventMachine
               raise ConnectionError, "Failed to create shell." unless success
               debug "***** shell open: #{shell}"
               @shell = shell
+              Fiber.new { yield(self) if block_given? }.resume
               f.resume(self)
             end # |shell,success|
           end # |pty,suc|
@@ -201,6 +202,7 @@ module EventMachine
       # Does not open the shell; use #open or #split
       # You generally won't need to call this on your own.
       def connect
+        return if connected?
         f = Fiber.current
         ::EM::Ssh.start(host, user, connect_opts) do |connection|
           @connection = connection
@@ -215,7 +217,7 @@ module EventMachine
       # @see #send_and_wait
       # @param [String] d the data to send encoded as a string
       def send_data(d)
-        #debug("send_data: #{d.inspect}#{line_terminator}")
+        #debug("send_data: #{d.dump}#{line_terminator.dump}")
         shell.send_data("#{d}#{line_terminator}")
       end
       

data/lib/em-ssh/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: em-ssh
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-10-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70157793111680 !ruby/object:Gem::Requirement
+  requirement: &70157590491700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70157793111680
+  version_requirements: *70157590491700
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &70157793111020 !ruby/object:Gem::Requirement
+  requirement: &70157590491240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70157793111020
+  version_requirements: *70157590491240
 - !ruby/object:Gem::Dependency
   name: ruby-termios
-  requirement: &70157793110100 !ruby/object:Gem::Requirement
+  requirement: &70157590490760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70157793110100
+  version_requirements: *70157590490760
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &70157793109680 !ruby/object:Gem::Requirement
+  requirement: &70157590490300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70157793109680
+  version_requirements: *70157590490300
 description: ''
 email:
 - em-ssh@simulacre.org