rye 0.8.11 → 0.8.12

data/CHANGES.txt

@@ -1,6 +1,17 @@
 RYE, CHANGES
 
-* TODO: file_append overwrites file
+
+#### 0.8.12 (2010-01-16) #############################
+
+* FIXED: Removed dependency on ssh-agent. Also fixes starting
+  many instances of said executable. 
+* FIXED: file_append was overwriting when supplied a String (!)
+* ADDED: Use SSH config file by default [Justin Case]
+
+
+#### 0.8.12 (2009-11-06) #############################
+
+* ADDED: Use SSH config file by default
 
 #### 0.8.11 (2009-10-30) #############################
 

data/README.rdoc

@@ -227,6 +227,7 @@ If you find one let me know!
 * Kalin Harvey (http://rely.ca)
 * Rush[http://github.com/adamwiggins/rush] and Capistrano[http://github.com/jamis/capistrano/blob/master/lib/capistrano/shell.rb] for the inspiration.
 * Mike Cline for giving the okay to use the Rye name. 
+* Justin Case (http://github.com/justincase/) for fixes
 
 
 == More Info

data/lib/rye.rb

@@ -42,7 +42,7 @@ require 'esc'
 module Rye
   extend self
   
-  VERSION = "0.8.11".freeze unless defined?(VERSION)
+  VERSION = "0.8.12".freeze unless defined?(VERSION)
   
   @@sysinfo = nil
   @@agent_env = Hash.new  # holds ssh-agent env vars
@@ -94,7 +94,7 @@ module Rye
   end
   
   # Looks for private keys in +path+ and returns and Array of paths
-  # to the files it fines. Raises an Exception if path does not exist.
+  # to the files it finds. Raises an Exception if path does not exist.
   # If path is a file rather than a directory, it will check whether
   # that single file is a private key.
   def find_private_keys(path)
@@ -127,8 +127,7 @@ module Rye
   end
   
   # Returns an Array of info about the currently available
-  # SSH keys, as provided by the SSH Agent. See
-  # Rye.start_sshagent_environment
+  # SSH keys, as provided by the SSH Agent.
   #
   # Returns: [[bits, finger-print, file-path], ...]
   #
@@ -262,74 +261,8 @@ module Rye
   
   private 
   
-  # Start the SSH Agent locally. This is important
-  # primarily because Rye relies on it for SSH key
-  # management. If the agent doesn't start then 
-  # passwordless logins won't work. 
-  #
-  # This method starts an instances of ssh-agent
-  # and sets the appropriate environment so all
-  # local commands run by Rye will have access be aware
-  # of this instance of the agent too. 
-  #
-  # The equivalent commands on the shell are:
-  # 
-  #     $ ssh-agent -s
-  #     SSH_AUTH_SOCK=/tmp/ssh-tGvaOXIXSr/agent.12951; export SSH_AUTH_SOCK;
-  #     SSH_AGENT_PID=12952; export SSH_AGENT_PID;
-  #     $ SSH_AUTH_SOCK=/tmp/ssh-tGvaOXIXSr/agent.12951; export SSH_AUTH_SOCK;
-  #     $ SSH_AGENT_PID=12952; export SSH_AGENT_PID;
-  #
-  # NOTE: The OpenSSH library must be installed for this to work.
-  # 
-  def start_sshagent_environment
-    return if @@agent_env["SSH_AGENT_PID"]
-    lines = Rye.shell("ssh-agent", '-s') || []
-    lines.each do |line|
-      next unless line.index("echo").nil?
-      line = line.slice(0..(line.index(';')-1))
-      key, value = line.chomp.split( /=/ )
-      @@agent_env[key] = value
-    end
-    ENV["SSH_AUTH_SOCK"] = @@agent_env["SSH_AUTH_SOCK"]
-    ENV["SSH_AGENT_PID"] = @@agent_env["SSH_AGENT_PID"]
-    
-    Rye.shell("ssh-add") # Add the user's default keys
-    nil
-  end
-  
-  # Kill the local instance of the SSH Agent we started.
-  #
-  # Calls this command via the local shell:
-  #
-  #     $ ssh-agent -k
-  #
-  # which uses the SSH_AUTH_SOCK and SSH_AGENT_PID environment variables 
-  # to determine which ssh-agent to kill. 
-  #
-  def end_sshagent_environment
-    pid = @@agent_env["SSH_AGENT_PID"]
-    Rye.shell("ssh-agent", '-k') || []
-    #Rye.shell("kill", ['-9', pid]) if pid
-    @@agent_env.clear
-    nil
-  end
-  
   Rye.reload
   
-  unless Rye.sysinfo.os == :windows
-    begin
-      @@mutex.synchronize {                   # One thread only
-        start_sshagent_environment            # Run this now
-        at_exit { end_sshagent_environment }  # Run this before Ruby exits
-      }
-    rescue => ex
-      STDERR.puts "Error initializing the SSH Agent (is OpenSSH installed?):"
-      STDERR.puts ex.message
-      STDERR.puts ex.backtrace
-      exit 1
-    end
-  end
 end
 
 

data/lib/rye/box.rb

@@ -32,7 +32,7 @@ module Rye
     def host; @rye_host; end
     def opts; @rye_opts; end
     def safe; @rye_safe; end
-    def user; (@rye_opts || {})[:user]; end
+    def user; @rye_user; end
     
     # Returns the current value of the stash +@rye_stash+
     def stash; @rye_stash; end
@@ -70,13 +70,14 @@ module Rye
     # A Hash. The keys are exception classes, the values are Procs to execute
     def exception_hook=(val); @rye_exception_hook = val; end
 
-    # * +host+ The hostname to connect to. The default is localhost.
+    # * +host+ The hostname to connect to. Default: localhost.
+    # * +user+ The username to connect as. Default: SSH config file or current shell user.
     # * +opts+ a hash of optional arguments.
     #
     # The +opts+ hash excepts the following keys:
     #
-    # * :user => the username to connect as. Default: the current user. 
     # * :safe => should Rye be safe? Default: true
+    # * :port => remote server ssh port. Default: SSH config file or 22
     # * :keys => one or more private key file paths (passwordless login)
     # * :info => an IO object to print Rye::Box command info to. Default: nil
     # * :debug => an IO object to print Rye::Box debugging info to. Default: nil
@@ -88,14 +89,20 @@ module Rye
     # Net::SSH.start that is not already mentioned above.
     #
     def initialize(host='localhost', opts={})
+      ssh_opts = ssh_config_options(host)
       @rye_exception_hook = {}
       @rye_host = host
       
+      if opts[:user]
+        @rye_user = opts[:user]
+      else
+        @rye_user = ssh_opts[:user] || Rye.sysinfo.user
+      end
+
       # These opts are use by Rye::Box and also passed to Net::SSH
       @rye_opts = {
-        :user => Rye.sysinfo.user, 
         :safe => true,
-        :port => 22,
+        :port => ssh_opts[:port],
         :keys => [],
         :info => nil,
         :debug => nil,
@@ -141,6 +148,10 @@ module Rye
 
     end
     
+    # Parse SSH config files for use with Net::SSH
+    def ssh_config_options(host)
+      return Net::SSH::Config.for(host)
+    end
     
     # Change the current working directory (sort of). 
     #
@@ -201,7 +212,7 @@ module Rye
     def switch_user(newuser)
       return if newuser.to_s == self.user.to_s
       @rye_opts ||= {}
-      @rye_opts[:user] = newuser
+      @rye_user = newuser
       disconnect
     end
 
@@ -215,7 +226,7 @@ module Rye
     def interactive_ssh(run=true)
       debug "interactive_ssh with keys: #{Rye.keys.inspect}"
       run = false unless STDIN.tty?      
-      cmd = Rye.prepare_command("ssh", "#{@rye_opts[:user]}@#{@rye_host}")
+      cmd = Rye.prepare_command("ssh", "#{@rye_user}@#{@rye_host}")
       return cmd unless run
       system(cmd)
     end
@@ -613,12 +624,12 @@ module Rye
       raise Rye::NoHost unless @rye_host
       return if @rye_ssh && !reconnect
       disconnect if @rye_ssh 
-      debug "Opening connection to #{@rye_host} as #{@rye_opts[:user]}"
+      debug "Opening connection to #{@rye_host} as #{@rye_user}"
       highline = HighLine.new # Used for password prompt
       retried = 0
       @rye_opts[:keys].compact!  # A quick fix in Windows. TODO: Why is there a nil?
       begin
-        @rye_ssh = Net::SSH.start(@rye_host, @rye_opts[:user], @rye_opts || {}) 
+        @rye_ssh = Net::SSH.start(@rye_host, @rye_user, @rye_opts || {}) 
       rescue Net::SSH::HostKeyMismatch => ex
         STDERR.puts ex.message
         print "\a" if @rye_info # Ring the bell
@@ -632,7 +643,7 @@ module Rye
         print "\a" if retried == 0 && @rye_info # Ring the bell once
         retried += 1
         if STDIN.tty? && retried <= 3
-          STDERR.puts "Passwordless login failed for #{@rye_opts[:user]}"
+          STDERR.puts "Passwordless login failed for #{@rye_user}"
           @rye_opts[:password] = highline.ask("Password: ") { |q| q.echo = '' }
           @rye_opts[:auth_methods] ||= []
           @rye_opts[:auth_methods] << 'password'
@@ -967,7 +978,7 @@ module Rye
         self.mkdir(:p, target) unless self.file_exists?(target)
       end
       
-      Net::SCP.start(@rye_host, @rye_opts[:user], @rye_opts || {}) do |scp|
+      Net::SCP.start(@rye_host, @rye_user, @rye_opts || {}) do |scp|
         transfers = []
         prev = ""
         files.each do |file|

data/lib/rye/cmd.rb

@@ -150,12 +150,13 @@ module Rye;
     # it will be created. If +backup+ is specified, +filepath+ will be 
     # copied to +filepath-previous+ before appending. 
     def file_append(filepath, newcontent, backup=false)
+      content = StringIO.new
+      
       if self.file_exists?(filepath)
         self.cp filepath, "#{filepath}-previous" if backup
-        file_content = self.file_download filepath
+        content = self.file_download filepath
       end
-
-      content = StringIO.new
+      
       if newcontent.is_a?(StringIO)
         newcontent.rewind
         content.puts newcontent.read

data/rye.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
   s.name = "rye"
   s.rubyforge_project = "rye"
-  s.version = "0.8.11"
+  s.version = "0.8.12"
   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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rye
 version: !ruby/object:Gem::Version 
-  version: 0.8.11
+  version: 0.8.12
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-23 00:00:00 -05:00
+date: 2010-01-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency