rye 0.4.1 → 0.4.3

data/CHANGES.txt

@@ -5,6 +5,22 @@ TODO
 * Fingerprints: ssh-keygen -l -f id_rsa_repos.pub
 
 
+#### 0.4.3 (2009-04-14) #############################
+
+* ADDED: Rye::Box.missing_method to handle non existent commands
+* FIXED: All Rye::Cmd command methods accept *args to make calling consistent.
+
+
+#### 0.4.2 (2009-04-13) #############################
+
+* ADDED: More helpful debug output
+* ADDED: hostname command to Rye::Cmd
+* CHANGE: Using OpenSSL's ssh-agent but also let's Net::SSH handle
+  the ssh keys. 
+* ADDED: Rye::Box.connect now supports multiple password attempts if STDIN.tty returns true 
+* ADDED: Rye::Box.interactive_ssh for opening an SSH session to the given box.
+
+
 #### 0.4.1 (2009-04-06) #############################
 
 * FIXED: Rye::Box.authorize_keys was not disabling safe mode properly
@@ -18,7 +34,7 @@ TODO
 * ADDED: == method for Rye::Box
 * ADDED: exit code and exit signal to Rye::Rap objects
 * ADDED: commands now raise a Rye::CommandError exception 
-when the command returns an exit code greater than 0. 
+  when the command returns an exit code greater than 0. 
 * CHANGED: Box.add_command renamed to Box.run_command
 * FIXED: Box.run_command was parsing arguments incorrectly 
 * FIXED: Box.net_ssh_exec was working on nil stderr
@@ -32,7 +48,7 @@ when the command returns an exit code greater than 0.
 
 * FIXED: Module.instance_methods bug. In Ruby 1.9 it's Symbols (1.8 was Strings).
 * FIXED: Rye::Set#add_boxes didn't return self.
-# UPDATED: Lots of docs tweaks.
+* UPDATED: Lots of docs tweaks.
 
 
 #### 0.3 (2009-04-05) ###############################
@@ -42,9 +58,9 @@ when the command returns an exit code greater than 0.
 * FIXED: Rye::Box wasn't properly adding keypairs to SSH Agent
 * CHANGED: Moved all SSH key stuff to Rye (used to be done per Box)
 * ADDED: Supports all options provided by Net::SSH#start. This 
-includes support for password logins and proxies. 
+  includes support for password logins and proxies. 
 * ADDED: Safe mode can now be disabled (to allow file globs
-and environment variable access).
+  and environment variable access).
 * ADDED: Basic sanity test
 * FIXED: Rye::Box.method_missing Symbol/String ambiguity
 * ADDED: Mucho more rdocs and examples.

data/README.rdoc

@@ -1,6 +1,6 @@
 = Rye - v0.4
 
-Safely run remote commands via SSH in Ruby. 
+Safely run SSH commands on a bunch of machines at the same time (from Ruby).
 
 Rye is similar to Rush[http://rush.heroku.com] but everything happens over SSH (no HTTP daemon) and the default settings are less powerful (for safety). For example, file globs are disabled so unless otherwise specified, you can't do this: <tt>rbox.rm('-rf', '/etc/**/*')</tt>.
 
@@ -205,6 +205,8 @@ Rye permits only a limited number of system commands to be run. This default whi
 This list will grow. If you find one let me know!
 
 * Rye doesn't read the ~/.ssh/config file yet
+* Highline 1.5 not working in Ruby 1.9 (password prompts hang)
+* Rye uses OpenSSL's ssh-agent (if it exists). Rye starts it up as a child process and shuts it down using at_exit. If you have code in an at_exit that rely's on Rye, make sure your code runs before Rye's at_exit block is called. For example, Drydock uses at_exit too which is why in bin/rye you can see that Drydock is called explicitly so that Rye's at_exit is executed after Drydock executes a command. 
 
 == Thanks
 

data/Rakefile

@@ -74,7 +74,7 @@ Rake::RDocTask.new do |t|
   t.rdoc_files.include(LICENSE)
   t.rdoc_files.include(README)
   t.rdoc_files.include(CHANGES)
-  #t.rdoc_files.include('bin/*')
+  t.rdoc_files.include('bin/*')
   t.rdoc_files.include('lib/**/*.rb')
 end
 

data/bin/rye

@@ -21,7 +21,6 @@ include Drydock
 global :p, :path, String, "A directory containing SSH private keys or the path to a private key"
 
 before do |obj|
-  STDERR.puts
   # Load private keys if specified
   if obj.global.path
     keys = Rye.find_private_keys(obj.global.path) 
@@ -30,7 +29,7 @@ before do |obj|
 end
 
 after do
-  STDERR.puts
+
 end
 
 desc "Add your public keys to one or more remote machines"
@@ -39,44 +38,16 @@ argv :hostname
 command :authorize do |obj|
   raise "You must specify a host" unless obj.argv.hostname
   
-  highline = HighLine.new # Used for password prompt
-  
   opts = { :debug => nil, :auth_methods => %w(publickey hostbased) }
   opts[:user] = obj.option.user if obj.option.user
   
   obj.argv.each do |hostname|
     
-    
-    retried = 0
-    begin
-      rbox = Rye::Box.new(hostname, opts).connect
-      puts "Authorizing #{rbox.opts[:user]}@#{hostname}" if retried == 0
-      
-      # We know we're already authorized b/c we didn't have to give a password
-      if retried == 0
-        puts "%s is already authorized" % rbox.opts[:user]
-        puts
-        next
-      end
-      
-    # An authentication failure means either the requested user doesn't
-    # exist on the remote machine or we need to supply a password. 
-    rescue Net::SSH::AuthenticationFailed => ex
-      STDERR.puts
-      retried += 1
-      if retried <= 3
-        #opts[:password] = highline.ask("Password: ") { |q| q.echo = '' }
-        opts[:auth_methods] = %w(password keyboard-interactive)
-        retry
-      else
-        STDERR.puts "Authentication failed."
-        exit 1 
-      end
-    end
-    
+    rbox = Rye::Box.new(hostname, opts).connect
+    puts "Authorizing #{rbox.opts[:user]}@#{hostname}"
     puts "Added public keys for: ", rbox.authorize_keys
+    puts "Now try: " << "ssh #{rbox.opts[:user]}@#{hostname}"
     
-    puts
   end
   
 end
@@ -124,7 +95,7 @@ command_alias :pubkeys, :pubkey
 default :keys
 debug :off
 
-# We can Drydock specifically otherwise it will run at_exit. Rye also
+# We call Drydock specifically otherwise it will run at_exit. Rye also
 # uses at_exit for shutting down the ssh-agent. Ruby executes at_exit
 # blocks in reverse order so if Drydock is required first, it's block
 # will run after Rye shuts down the ssh-agent. 

data/bin/try

@@ -105,7 +105,7 @@ puts %Q(
 #   EXAMPLE 4 -- Accessing Multiple Machines
 #)
 
-rset = Rye::Set.new
+rset = Rye::Set.new('default', :parallel => true)
 rbox = Rye::Box.new
 
 rset.add_keys('/private/key/path')     # For passwordless logins 

data/lib/rye.rb

@@ -22,6 +22,12 @@ require 'sys'
 # disabled so unless otherwise specified, you can't do this: 
 # <tt>rbox.rm('/etc/**/*')</tt>. 
 #
+# However, you can do this:
+#
+# rset = Rye::Set.new("dev-machines")
+# rset.add_boxes('host1', 'host2', 'host3', 'host4')
+# rset.ps('aux').grep
+#
 # * See +bin/try+ for a bunch of working examples. 
 # * See Rye::Box#initialize for info about disabling safe-mode.
 #
@@ -103,8 +109,7 @@ module Rye
   def add_keys(*keys)
     keys = keys.flatten.compact || []
     return if keys.empty?
-    Rye.shell("ssh-add", keys) if keys
-    keys
+    Rye.shell("ssh-add", keys)
   end
   
   # Returns an Array of info about the currently available
@@ -214,6 +219,10 @@ module Rye
     safe ? Escape.shell_command(cmd, *args).to_s : [cmd, args].flatten.compact.join(' ')
   end
   
+  def sshagent_info
+    @@agent_env
+  end
+  
   
   private 
   

data/lib/rye/box.rb

@@ -17,7 +17,7 @@ module Rye
   #
   #     rbox = Rye::Box.new('localhost') 
   #     rbox.hostname   # => localhost
-  #     rbox.uname      # => Darwin
+  #     rbox.uname(:a)  # => Darwin vanya 9.6.0 ...
   #
   class Box 
     include Rye::Cmd
@@ -78,11 +78,16 @@ module Rye
       @debug = @opts.delete(:debug)
       @error = @opts.delete(:error)
       
+      debug @opts.inspect
+            
       add_keys(@opts[:keys])
       
       # We don't want Net::SSH to handle the keypairs. This may change
       # but for we're letting ssh-agent do it. 
-      @opts.delete(:keys)
+      #@opts.delete(:keys)
+      
+
+      debug "ssh-agent info: #{Rye.sshagent_info.inspect}"
       
     end
     
@@ -123,15 +128,47 @@ module Rye
     # Open an SSH session with +@host+. This called automatically
     # when you the first comamnd is run if it's not already connected.
     # Raises a Rye::NoHost exception if +@host+ is not specified.
+    # Will attempt a password login up to 3 times if the initial 
+    # authentication fails. 
     def connect
       raise Rye::NoHost unless @host
       disconnect if @ssh 
       debug "Opening connection to #{@host}"
-      @ssh = Net::SSH.start(@host, @opts[:user], @opts || {}) 
+      highline = HighLine.new # Used for password prompt
+      retried = 0
+      begin
+        @ssh = Net::SSH.start(@host, @opts[:user], @opts || {}) 
+      rescue Net::SSH::AuthenticationFailed => ex
+        retried += 1
+        if STDIN.tty? && retried <= 3
+          @opts[:password] = highline.ask("Password: ") { |q| q.echo = '' }
+          @opts[:auth_methods] ||= []
+          @opts[:auth_methods] = %w(password)
+          retry
+        else
+          STDERR.puts "Authentication failed."
+          exit 0
+        end
+      end
+      
       @ssh.is_a?(Net::SSH::Connection::Session) && !@ssh.closed?
       self
     end
-
+    
+    # Open an interactive SSH session. This only works if STDIN.tty?
+    # returns true. Otherwise it returns the SSH command that would 
+    # have been run. This requires the SSH command-line executable (ssh).
+    # * +run+ when set to false, it will return the SSH command as a String
+    # and not open an SSH session.
+    #
+    def interactive_ssh(run=true)
+      debug "interactive_ssh with keys: #{Rye.keys.inspect}"
+      run = false unless STDIN.tty?      
+      cmd = Rye.prepare_command("ssh", "#{@opts[:user]}@#{@host}")
+      return cmd unless run
+      system(cmd)
+    end
+    
     # Close the SSH session  with +@host+. This is called 
     # automatically at exit if the connection is open. 
     def disconnect
@@ -146,7 +183,13 @@ module Rye
     # Returns the instance of Box
     def add_keys(*additional_keys)
       additional_keys = [additional_keys].flatten.compact || []
-      Rye.add_keys(additional_keys)
+      return if additional_keys.empty?
+      ret = Rye.add_keys(additional_keys)
+      if ret.is_a?(Rye::Rap)
+        debug "ssh-add exit_code: #{ret.exit_code}" 
+        debug "ssh-add stdout: #{ret.stdout}"
+        debug "ssh-add stderr: #{ret.stderr}"
+      end
       self
     end
     alias :add_key :add_keys
@@ -202,7 +245,7 @@ module Rye
         path = key[2]
         debug "# Public key for #{path}"
         k = Rye::Key.from_file(path).public_key.to_ssh2
-        self.mkdir('-p', '$HOME/.ssh') # Silently create dir if it doesn't exist
+        self.mkdir(:p, :m, '700', '$HOME/.ssh') # Silently create dir if it doesn't exist
         self.echo("'#{k}' >> $HOME/.ssh/authorized_keys")
         self.echo("'#{k}' >> $HOME/.ssh/authorized_keys2")
         self.chmod('-R', '0600', '$HOME/.ssh/authorized_keys*')
@@ -212,11 +255,17 @@ module Rye
       added_keys
     end
     
+    # A handler for undefined commands. 
+    # Raises Rye::CommandNotFound exception.
+    def method_missing(meth, *args, &block)
+      raise Rye::CommandNotFound, "#{meth.to_s} (args: #{args.join(' ')})"
+    end
+    
   private
       
     
-    def debug(msg); @debug.puts msg if @debug; end
-    def error(msg); @error.puts msg if @error; end
+    def debug(msg="unknown debug msg"); @debug.puts msg if @debug; end
+    def error(msg="unknown error msg"); @error.puts msg if @error; end
 
     
     # Add the current environment variables to the beginning of +cmd+
@@ -230,6 +279,7 @@ module Rye
     end
     
 
+
     # Execute a command over SSH
     #
     # * +args+ is a command name and list of arguments. 
@@ -248,6 +298,8 @@ module Rye
     # but if it fails it will raise a Rye::NotConnected exception. 
     # 
     def run_command(*args)
+      debug "run_command with keys: #{Rye.keys.inspect}"
+      
       connect if !@ssh || @ssh.closed?
       args = args.flatten.compact
       args = args.first.split(/\s+/) if args.size == 1
@@ -301,7 +353,7 @@ module Rye
           channel[:exit_signal] = data.read_long
         end
         # For long-running commands like top, this will print the output.
-        # It cool, but we'd also need to enable STDIN to interact with 
+        # It's cool, but we'd also need to enable STDIN to interact with 
         # command. 
         #channel.on_data do |ch, data|
         #  puts "got stdout: #{data}"

data/lib/rye/cmd.rb

@@ -14,8 +14,8 @@ module Rye;
   #       def special(*args); cmd("/your/special/command", args); end
   #     end
   #
-  #     rbox = Rye::Box.new
-  #     rbox.special        # => "your output"
+  #     rbox = Rye::Box.new('somehost')
+  #     rbox.special        # => "special on somehost"
   #
   module Cmd
     def wc(*args); cmd('wc', args); end
@@ -26,8 +26,8 @@ module Rye;
     def ps(*args); cmd('ps', args); end
     def sh(*args); cmd('sh', args); end
     
-    def env; cmd "env"; end
-    def pwd; cmd "pwd"; end
+    def env(*args); cmd "env"; end
+    def pwd(*args); cmd "pwd"; end
     def svn(*args); cmd('svn', args); end
     def cvs(*args); cmd('cvs', args); end
     def git(*args); cmd('git', args); end
@@ -45,16 +45,17 @@ module Rye;
     def echo(*args); cmd('echo', args); end
     def test(*args); cmd('test', args); end
     
-    def mount; cmd("mount"); end
+    def mount(*args); cmd("mount"); end
     def sleep(seconds=1); cmd("sleep", seconds); end
     def mkdir(*args); cmd('mkdir', args); end
     def touch(*args); cmd('touch', args); end
     def uname(*args); cmd('uname', args); end
     def chmod(*args); cmd('chmod', args); end
     
-    def uptime; cmd("uptime"); end
+    def uptime(*args); cmd("uptime"); end
     def python(*args); cmd('python', args); end
     def printenv(*args); cmd('printenv', args); end
+    def hostname(*args); cmd('hostname', args); end
     
   
     #  def copy_to(*boxes)

data/lib/rye/rap.rb

@@ -73,10 +73,19 @@ module Rye;
       super
     end
     
-    def >>(*other)
-      p other
+    # NOTE: This is broken!
+    def grep *args
+      self.select do |boxrap|
+        b = boxrap.grep(*args)
+        b.empty? ? false : b
+      end
     end
     
+    
+    #def >>(*other)
+    #  p other
+    #end
+    
     #---
     # If Box's shell methods return Rap objects, then 
     # we can do stuff like this

data/lib/rye/set.rb

@@ -128,6 +128,8 @@ module Rye
         end
       end
       
+      # Should it bubble up the exception for a single box?
+      # socket errors?
       threads.each do |t| 
         sleep 0.01        # Give the thread some breathing room
         t.join            # Wait for the thread to finish

data/lib/sys.rb

@@ -6,51 +6,52 @@ require 'socket'
 # Portions of this code were originally from Amazon's EC2 AMI tools, 
 # specifically lib/platform.rb. 
 class SystemInfo #:nodoc:all
-  VERSION = 2
-  IMPLEMENTATIONS = [
+  unless defined?(IMPLEMENTATIONS)
+    VERSION = 4.freeze
+    IMPLEMENTATIONS = [
     
-    # These are for JRuby, System.getproperty('os.name'). 
-    # For a list of all values, see: http://lopica.sourceforge.net/os.html
-    [/mac\s*os\s*x/i,     :unix,    :osx     ],  
-    [/sunos/i,            :unix,    :solaris ], 
-    [/windows\s*ce/i,     :win32,   :windows ],
-    [/windows/i,          :win32,   :windows ],  
-    [/osx/i,              :unix,    :osx     ],
+      # These are for JRuby, System.getproperty('os.name'). 
+      # For a list of all values, see: http://lopica.sourceforge.net/os.html
+      [/mac\s*os\s*x/i,     :unix,    :osx     ],  
+      [/sunos/i,            :unix,    :solaris ], 
+      [/windows\s*ce/i,     :win32,   :windows ],
+      [/windows/i,          :win32,   :windows ],  
+      [/osx/i,              :unix,    :osx     ],
     
-    # TODO: implement other windows matches: # /djgpp|(cyg|ms|bcc)win|mingw/ (from mongrel)
+      # TODO: implement other windows matches: # /djgpp|(cyg|ms|bcc)win|mingw/ (from mongrel)
     
-    # These are for RUBY_PLATFORM and JRuby
-    [/java/i,    :java,    :java             ],
-    [/darwin/i,  :unix,    :osx              ],
-    [/linux/i,   :unix,    :linux            ],
-    [/freebsd/i, :unix,    :freebsd          ],
-    [/netbsd/i,  :unix,    :netbsd           ],
-    [/solaris/i, :unix,    :solaris          ],
-    [/irix/i,    :unix,    :irix             ],
-    [/cygwin/i,  :unix,    :cygwin           ],
-    [/mswin/i,   :win32,   :windows          ],
-    [/mingw/i,   :win32,   :mingw            ],
-    [/bccwin/i,  :win32,   :bccwin           ],
-    [/wince/i,   :win32,   :wince            ],
-    [/vms/i,     :vms,     :vms              ],
-    [/os2/i,     :os2,     :os2              ],
-    [nil,        :unknown, :unknown          ],
+      # These are for RUBY_PLATFORM and JRuby
+      [/java/i,    :java,    :java             ],
+      [/darwin/i,  :unix,    :osx              ],
+      [/linux/i,   :unix,    :linux            ],
+      [/freebsd/i, :unix,    :freebsd          ],
+      [/netbsd/i,  :unix,    :netbsd           ],
+      [/solaris/i, :unix,    :solaris          ],
+      [/irix/i,    :unix,    :irix             ],
+      [/cygwin/i,  :unix,    :cygwin           ],
+      [/mswin/i,   :win32,   :windows          ],
+      [/mingw/i,   :win32,   :mingw            ],
+      [/bccwin/i,  :win32,   :bccwin           ],
+      [/wince/i,   :win32,   :wince            ],
+      [/vms/i,     :vms,     :vms              ],
+      [/os2/i,     :os2,     :os2              ],
+      [nil,        :unknown, :unknown          ],
     
-  ]
+    ].freeze
 
-  ARCHITECTURES = [
-    [/(i\d86)/i,  :i386             ],
-    [/x86_64/i,   :x86_64           ],
-    [/x86/i,      :i386             ],  # JRuby
-    [/ia64/i,     :ia64             ],
-    [/alpha/i,    :alpha            ],
-    [/sparc/i,    :sparc            ],
-    [/mips/i,     :mips             ],
-    [/powerpc/i,  :powerpc          ],
-    [/universal/i,:universal        ],
-    [nil,         :unknown          ],
-  ]
-  
+    ARCHITECTURES = [
+      [/(i\d86)/i,  :i386             ],
+      [/x86_64/i,   :x86_64           ],
+      [/x86/i,      :i386             ],  # JRuby
+      [/ia64/i,     :ia64             ],
+      [/alpha/i,    :alpha            ],
+      [/sparc/i,    :sparc            ],
+      [/mips/i,     :mips             ],
+      [/powerpc/i,  :powerpc          ],
+      [/universal/i,:universal        ],
+      [nil,         :unknown          ],
+    ].freeze
+  end
 
 
   attr_reader :os 

data/rye.gemspec

@@ -1,8 +1,8 @@
 @spec = Gem::Specification.new do |s|
   s.name = "rye"
   s.rubyforge_project = "rye"
-  s.version = "0.4.1"
-  s.summary = "Rye: Run system commands via SSH locally and remotely in a Ruby way."
+  s.version = "0.4.3"
+  s.summary = "Rye: Safely run SSH commands on a bunch of machines at the same time (from Ruby)."
   s.description = s.summary
   s.author = "Delano Mandelbaum"
   s.email = "delano@solutious.com"

data/try/copying.rb

@@ -5,8 +5,7 @@
 $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'rye'
-
-boxA = Rye::Box.new('ryehost', :user => "root")
+boxA = Rye::Box.new('localhost', :user => "delano")
 boxB = Rye::Box.new('127.0.0.1', :user => 'delano', :safe => false, :debug => STDOUT)
 set = Rye::Set.new
 set.add_boxes(boxA, boxB)

data/try/keys.rb

@@ -2,6 +2,8 @@
 
 # THIS IS A SCRAP FILE.
 
+
+
 __END__
 require 'openssl'
 key = OpenSSL::PKey::RSA.generate(1024)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rye
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-05 00:00:00 -04:00
+date: 2009-04-14 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,7 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: "Rye: Run system commands via SSH locally and remotely in a Ruby way."
+description: "Rye: Safely run SSH commands on a bunch of machines at the same time (from Ruby)."
 email: delano@solutious.com
 executables: 
 - rye
@@ -91,7 +91,7 @@ post_install_message:
 rdoc_options: 
 - --line-numbers
 - --title
-- "Rye: Run system commands via SSH locally and remotely in a Ruby way."
+- "Rye: Safely run SSH commands on a bunch of machines at the same time (from Ruby)."
 - --main
 - README.rdoc
 require_paths: 
@@ -114,6 +114,6 @@ rubyforge_project: rye
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: "Rye: Run system commands via SSH locally and remotely in a Ruby way."
+summary: "Rye: Safely run SSH commands on a bunch of machines at the same time (from Ruby)."
 test_files: []