delano-rye 0.6.0 → 0.6.1

data/CHANGES.txt

@@ -4,6 +4,12 @@ TODO
 
 * Fingerprints: ssh-keygen -l -f id_rsa_repos.pub
 
+#### 0.6.1 (2009-04-29) #############################
+
+* ADDED: Prints message to STDERR when passwordless login fails.
+* ADDED: Highline 1.5.1 to vendor to fix the Ruby 1.9 issue (Highline
+1.5.1 is not released as a gem yet)
+* CHANGE: Cleaned examples and links in README
 
 #### 0.6.0 (2009-04-28) #############################
 

data/README.rdoc

@@ -4,7 +4,6 @@ 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 and the "rm" command are disabled so unless otherwise specified, you can't do this: <tt>rbox.rm('-rf', '/etc/**/*')</tt>.
 
-See the examples below (which are taken from bin/try).
 
 == Installation
 
@@ -15,145 +14,48 @@ One of:
     $ git clone git://github.com/delano/rye.git
 
 
-== EXAMPLE 1 -- Basic Usage
-    
-    rbox = Rye::Box.new('localhost')
-    
-    # Commands are run as methods on the Rye::Box object
-    puts rbox.uptime                   # => 11:02  up 16:01, 3 users
-    
-    # The response value for all commands is a Rye::Rap object. The rap is a
-    # subclass of Array so you can treat it as an Array, but it can also act 
-    # like a String if there's only one element. 
-    puts rbox.ls('rye.test')           # => ""
-    puts rbox.ls('rye.test').stderr    # => ls: rye.test: No such file or directory
-    
-    puts rbox.touch('rye.test')        # => ""
-    puts rbox.rm('rye.test')           # => ""
-    
-    # You can change directories
-    puts rbox.pwd                      # => /home/rye
-    puts rbox['/usr/bin'].pwd          # => /usr/bin
-    puts rbox.pwd                      # => /usr/bin
-    puts rbox.cd('/home/rye').pwd      # => /home/rye
-    
-    # You can specify environment variables
-    rbox.setenv(:RYE, "Forty Creek")
-    rbox.env                           # => ['HOME=/home/rye', 'RYE=Forty Creek', ...]
-    
-    # The commands method returns an Array of available commands:                        
-    puts rbox.commands.join(', ')      # => pwd, touch, echo, wc, ...
-    
-    # When you're done you can disconnect explicitly. 
-    # (Although Rye does this automatically at exit.)
-    rbox.disconnect
+    See bin/try for examples!
 
 
-== EXAMPLE 2 -- Disabling Safe-Mode
+== EXAMPLE 1 -- SSH Authorization
 
-    rbox_safe = Rye::Box.new('localhost')
-    rbox_wild = Rye::Box.new('localhost', :safe => false)
+Does it annoy you to manually authorize remote SSH accounts? Rye can help!
 
-    # Safe-mode is enabled by default. In safe-mode, all command 
-    # arguments are thoroughly escaped. This prevents access to
-    # environment variables and file globs (among other things).
-    p rbox_safe.echo('$HOME')                                    # => "$HOME"
-    p rbox_safe['/etc'].ls('host*')  rescue Rye::CommandError    # Doesn't exist
-    p rbox_safe.ls('-l | wc -l')     rescue Rye::CommandError    # => '|' is not a valid ls arg
+Enable passwordless logins to HOST1 and HOST2:
 
-    # Here's the same commands with safe-mode disabled:
-    p rbox_wild.echo('$HOME')                   # => "/home/rye"
-    p rbox_wild['/etc'].ls('host*')             # => ["hostconfig", "hosts"]
-    p rbox_wild.ls('-l | wc -l')                # => 110
-    p rbox_wild.echo('$HOME > /tmp/rye-home')   # => 
-    p rbox_wild.cat('/tmp/rye-home')            # => "/home/rye"
+    $ rye authorize HOST1 HOST2    
 
+This will copy your public SSH keys to the <tt>~/.ssh/authorized_keys</tt> and <tt>~/.ssh/authorized_keys2</tt> files on the remote machine(s). 
 
-== EXAMPLE 3 -- Custom Commands
-
-    rbox = Rye::Box.new('localhost')
-    rbox.add_keys('/private/key/path')   # Specify additional private keys
+See <tt>rye -h</tt> for more info
     
-    # There's currently no rye900 command
-    p rbox.commands.member?('rye9000')   # => false
     
-    # But we can add our own commands to the Rye::Cmd class. They 
-    # automatically become available to all Rye::Box objects.
-    module Rye::Cmd
-      def rye9000(*args)
-        run_command("ls", args)
-      end
-      def somescript(*args)
-        run_command("/path/to/my/script", args)
-      end
-    end
+== EXAMPLE 2 -- Basic Usage
     
-    # We can now run rye9000 (with arguments)
-    p rbox.rye9000('-a')                 # => [".", "..", ".bashrc", ...]
-    p rbox.commands.member?('rye9000')   # => true
-
+    rbox = Rye::Box.new('localhost')
+    rbox.uptime                            # => 11:02  up 16:01, 3 users
+    rbox['/usr/bin'].pwd                   # => /usr/bin
+    
+You can specify environment variables
 
-== EXAMPLE 4 -- Accessing Multiple Machines
+    rbox.setenv(:RYE, "Forty Creek")
+    rbox.env             # => ['HOME=/home/rye', 'RYE=Forty Creek', ...]
+    
+    
+== EXAMPLE 3 -- Accessing Multiple Machines
 
     rset = Rye::Set.new
     rbox = Rye::Box.new
     
-    rset.add_keys('/private/key/path')     # For passwordless logins 
     rset.add_boxes(rbox, 'localhost')      # Add boxes as hostnames or objects
     
-    # Calling methods on Rye::Set objects is very similar to calling them on
-    # Rye::Box objects. In fact, it's identical:
+Calling methods on Rye::Set objects is very similar to calling them on Rye::Box objects. In fact, it's identical:
+
     p rset.uptime        # => [[14:19:02 up 32 days, 19:35 ...], [14:19:02 up 30 days, 01:35]]
     p rset['/etc'].ls    # => [['file1', 'file2', ...], ['life1', 'life2', ...]]
     
-    # Like Rye::Box, the response value is a Rye::Rap object containing the
-    # responses from each box. Each response is itself a Rye::Rap object.
-    unames = rset.uname
-    p unames                               # => [["Darwin"], ["Darwin"]]
-    puts unames.class                      # => Rye::Rap
     
-    # The Rye::Rap object also keeps a reference to the object that called the 
-    # command. In this case, it will keep a reference to Rye::Set:
-    puts unames.set.class                  # => Rye::Set
-    puts unames.set == rset                # => true
-    puts unames.size                       # => 2
-    puts unames.first                      # => Darwin
-    puts unames.first.class                # => Rye::Rap
-    puts unames.first.box.class            # => Rye::Box
-    puts unames.first.box == rbox          # => true
-    
-    # Envrionment variables can be set the same way as with Rye::Box
-    rset.setenv(:RYE, "Forty Creek")
-    p rset.env.first.select { |env| env =~ /RYE/ }  # => ["RYE=Forty Creek"]
-
-
-== EXAMPLE 5 -- ERROR HANDLING
-
-    rbox = Rye::Box.new('localhost', :safe => false)
-
-    # Rye follows the standard convention of taking exception to a non-zero 
-    # exit code by raising a Rye::CommandError. In this case, rye9000.test
-    # is not found by the ls command. 
-    begin
-      rbox.ls('rye9000.test')
-    rescue Rye::CommandError => ex
-      puts ex.exit_code                # => 1
-      puts ex.stderr                   # => ls: rye.test: No such file or directory
-    end
-
-    # The Rye:Rap response objects also give you the STDOUT and STDERR
-    # content separately. Here we redirect STDOUT to STDERR, so this
-    # will return nothing:
-    puts rbox.uname('-a 1>&2').stdout    # =>
-
-    # It all went to STDERR:
-    puts rbox.uname('-a 1>&2').stderr    # => Darwin ryehost 9.6.0 ...
-
-    # There were no actual error so the exit code should be 0.
-    puts rbox.uname('-a 1>&2').exit_code # => 0
-
-    
-== EXAMPLE 6 -- FILE TRANSFERS
+== EXAMPLE 4 -- FILE TRANSFERS
 
     rbox = Rye::Box.new("localhost", :info => true)
 
@@ -166,7 +68,7 @@ One of:
     applejack = StringIO.new("Some in-memory content")
     rbox.upload(applejack, "#{dir_upload}/applejack.txt")
 
-    p rbox.ls(dir_upload)            # => [README.rdoc, LICENSE.txt, applejack.txt]
+    p rbox.ls(dir_upload)      # => [README.rdoc, LICENSE.txt, applejack.txt]
     p rbox.cat("#{dir_upload}/applejack.txt")   # => "Some in-memory content"
 
     filecontent = StringIO.new
@@ -174,32 +76,13 @@ One of:
 
     p filecontent.read
 
-== EXAMPLE 7 -- rye
-
-Rye comes with a command-line utility called <tt>rye</tt>.
-
-    # Prints the paths to your private keys
-    $ rye keys
-
-    # Prints the server host keys (suitable for ~/.ssh/known_hosts)
-    $ rye hostkey HOST1 HOST2
-
-    # Add your public keys to authorized_keys and authorized_keys2 
-    # on a remote machine
-    $ rye authorize HOST1 HOST2
-More info:
-
-    $ rye -h
-    $ rye COMMAND -h
-    $ rye show-commands
-
 
 == About Safe-Mode
 
 In safe-mode:
 
 * You can't use file globs. This means you can't do this: <tt>rbox.ls('*.rb')</tt>. <tt>~</tt> also doesn't work!
-* Command arguments cannot contain environment variables (however, environment variables are available to the commands you run). This means you can't do this: <tt>rbox.echo('$HOME')</tt>.
+* You can't use environment variables as arguments. This means you can't do this: <tt>rbox.echo('$HOME')</tt>. However, environment variables are available to the commands you run.
 * Pipes and operators don't work: <tt>|, &&, >, <, ||, ~</tt>, etc...
 * Backticks don't work either: <tt>procs=`ps aux`</tt>
 
@@ -221,28 +104,28 @@ Rye permits only a limited number of system commands to be run. This default whi
   * highline
   * drydock
 
+
 == Known Issues
 
 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
 
 * Solutious Incorporated (http://solutious.com) for all the orange juice.
-* http://github.com/adamwiggins/rush
-* http://github.com/jamis/capistrano/blob/master/lib/capistrano/shell.rb
-* http://www.nofluffjuststuff.com/blog/david_bock/2008/10/ruby_s_closure_cleanup_idiom_and_net_ssh.html
-* http://groups.google.com/group/ruby-talk-google/browse_thread/thread/674a6f6de15ceb49?pli=1
-* http://paste.lisp.org/display/6912
+* Kalin Harvey (http://rely.ca)
+* Rush[http://github.com/adamwiggins/rush]
+* Capistrano[http://github.com/jamis/capistrano/blob/master/lib/capistrano/shell.rb]
+
 
 == More Info
 
-* http://github.com/delano/rye
-* http://delano.github.com/rye
-* http://www.youtube.com/watch?v=_StUVh6ENuw
+* GitHub[http://github.com/delano/rye]
+* Rdocs[http://delano.github.com/rye]
+* Inspiration[http://www.youtube.com/watch?v=_StUVh6ENuw]
 
 == Credits
 

data/bin/rye

@@ -35,7 +35,8 @@ after do
 
 end
 
-desc "Add your public keys to one or more remote machines"
+about "Add your public keys to one or more remote machines"
+usage "rye authorize [-u username] host"
 option :u, :user, String, "Username"
 argv :hostname
 command :authorize do |obj|
@@ -56,7 +57,7 @@ command :authorize do |obj|
 end
 command_alias :authorize, :authorise
 
-desc "Add your public keys to your current account on this machine"
+about "Add your public keys to your current account on this machine"
 command :authorize_local do |obj|
   user = Rye.sysinfo.user
   puts "Authorizing #{user}@localhost"
@@ -68,11 +69,11 @@ end
 command_alias :local_authorize, :local_authorise
 
 
-desc "Generate a public key from a private key"
+about "Generate a public key from a private key"
 
 
 
-desc "Fetch the host keys for remote machines (suitable for your ~/.ssh/known_hosts file)"
+about "Fetch the host keys for remote machines (suitable for your ~/.ssh/known_hosts file)"
 usage "rye hostkey HOSTNAME [HOSTNAME2 HOSTNAME3 ...]"
 argv :hostname
 command :hostkeys do |obj|
@@ -84,14 +85,14 @@ end
 command_alias :hostkeys, :hostkey
 
 
-desc "Display your private keys"
+about "Display your private keys"
 command :keys do |obj|
   Rye.keys.each do |key|
     puts key.join(' ')
   end
 end
 
-desc "Display your public SSH keys"
+about "Display your public SSH keys"
 usage "rye pubkeys [--pem] [KEYPATH]"
 option :p, :pem, "Output in PEM format"
 argv :keypath

data/lib/rye.rb

@@ -1,5 +1,7 @@
 
-require 'rubygems' unless defined? Gem
+# Temporary fix before Highline 1.5.1 is release. This fixes
+# a the issue with Ruby 1.9 that causes the prompts to hang.
+$:.unshift File.join(File.dirname(__FILE__), '..', 'vendor', 'highline-1.5.1')
 
 require 'tempfile'
 require 'logger'
@@ -32,6 +34,12 @@ require 'sys'
 # * See +bin/try+ for a bunch of working examples. 
 # * See Rye::Box#initialize for info about disabling safe-mode.
 #
+#--
+# The following posts were really helpful when I first wrote Rye:
+# http://www.nofluffjuststuff.com/blog/david_bock/2008/10/ruby_s_closure_cleanup_idiom_and_net_ssh.html
+# http://groups.google.com/group/ruby-talk-google/browse_thread/thread/674a6f6de15ceb49?pli=1
+# http://paste.lisp.org/display/6912
+#++
 module Rye
   extend self
 

data/lib/rye/box.rb

@@ -182,6 +182,7 @@ module Rye
         print "\a" if retried == 0 && @info # Ring the bell once
         retried += 1
         if STDIN.tty? && retried <= 3
+          STDERR.puts "Passwordless login failed for #{@opts[:user]}"
           @opts[:password] = highline.ask("Password: ") { |q| q.echo = '' }
           @opts[:auth_methods] ||= []
           @opts[:auth_methods] << 'password'

data/rye.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
   s.name = "rye"
   s.rubyforge_project = "rye"
-  s.version = "0.6.0"
+  s.version = "0.6.1"
   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: delano-rye
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors: 
 - Delano Mandelbaum