rye 0.9.7 → 0.9.8

data/CHANGES.txt

@@ -1,5 +1,11 @@
 RYE, CHANGES
 
+#### 0.9.8 (2013-02-06) #############################
+
+* ADDED: Rudimentary DSL (see tst/dsl_example.rb) [Randy D. Wallace Jr]
+* CHANGE: All releases will now be signed. See "Installation" in the readme.
+
+
 #### 0.9.7 (2012-07-06) #############################
 
 * FIXED: STDERR output was printing to STDOUT in one case (Thanks rrepen)
@@ -21,7 +27,7 @@ RYE, CHANGES
 
 #### 0.9.3 (2011-01-29) #############################
 
-* ADDED: Rye::Hop for gateway support. 
+* ADDED: Rye::Hop for gateway support.
   (https://github.com/delano/rye/issues/closed#issue/10)
 * CHANGE: Don't overwrite :paranoid option
 
@@ -39,7 +45,7 @@ RYE, CHANGES
 
 #### 0.9.0 (2010-08-19) #############################
 
-* FIXED: Pubkeys correctly added for first connection. 
+* FIXED: Pubkeys correctly added for first connection.
   (NOTE: some state seems to be maintained by ssh-agent)
 * ADDED: Interactive and non-interactive shell support (via Net::SSH)
 * ADDED: Basic readline support for interactive mode
@@ -55,7 +61,7 @@ RYE, CHANGES
 #### 0.8.19 (2010-06-28) #############################
 
 * ADDED: Rye::Box#root?
-* ADDED: Better sudo handling. 
+* ADDED: Better sudo handling.
 
 
 #### 0.8.18 (2010-06-19) #############################
@@ -91,7 +97,7 @@ RYE, CHANGES
 #### 0.8.12 (2010-01-16) #############################
 
 * FIXED: Removed dependency on ssh-agent. Also fixes starting
-  many instances of said executable. 
+  many instances of said executable.
 * FIXED: file_append was overwriting when supplied a String (!)
 * ADDED: Use SSH config file by default [Justin Case]
 
@@ -102,7 +108,7 @@ RYE, CHANGES
 
 #### 0.8.10 (2009-10-07) #############################
 
-* CHANGE: Improved startup time. 
+* CHANGE: Improved startup time.
 
 #### 0.8.9 (2009-08-26) #############################
 
@@ -118,7 +124,7 @@ RYE, CHANGES
 
 #### 0.8.7 (2009-08-11) #############################
 
-* FIXED: Rye::Box info level output is cleaner 
+* FIXED: Rye::Box info level output is cleaner
 * FIXED: file_upload / download now expanding local tildas when safemode is disabled
 * ADDED: Interactive handling for removing gems
 * ADDED: dir_upload and dir_download
@@ -132,11 +138,11 @@ RYE, CHANGES
 #### 0.8.5 (2009-07-14) #############################
 
 * CHANGE: Rye::Box#getenv now accepts an option key name
-* CHANGE: When not in safe mode, method missing will execute a 
+* CHANGE: When not in safe mode, method missing will execute a
   method name as a shell command
-* ADDED: Rye::Box#execute for running arbitrary commands when 
+* ADDED: Rye::Box#execute for running arbitrary commands when
   not in safe mode
-  
+
 
 #### 0.8.4 (2009-06-30) #############################
 
@@ -180,24 +186,24 @@ RYE, CHANGES
 
 #### 0.7.6 (2009-06-19) #############################
 
-* FIXED: Raise Rye::NoPty exception when Net::SSH returns message 
+* FIXED: Raise Rye::NoPty exception when Net::SSH returns message
   "Pseudo-terminal will not be allocated because stdin is not a terminal."
-* FIXED: Rye::Box#disconnect would hang in some instances. Now waits 3 seconds. 
+* FIXED: Rye::Box#disconnect would hang in some instances. Now waits 3 seconds.
 * FIXED: Bug in net_ssh_exec which was causing it to not return an exit code
-* CHANGE: All exceptions now inherit from Rye::Error (Runtimerror)  
+* CHANGE: All exceptions now inherit from Rye::Error (Runtimerror)
 * CHANGE: A NoPassword exception is raised when a password prompt returns nil.
-* CHANGE: pre_command_hook block arguments have changed: 
+* CHANGE: pre_command_hook block arguments have changed:
      NEW: complete command, user, host, nickname
      OLD: command, args, user, host, nickname
-     
-     
+
+
 #### 0.7.5 (2009-06-13) #############################
 
-* FIXED: Rye::Set methods were not accepting or passing blocks. 
+* FIXED: Rye::Set methods were not accepting or passing blocks.
 * ADDED: Rye::Set#user and Rye::Set#opts methods
 * ADDED: Rye::Box#nickname
 * ADDED: exception hooks for Rye::Box.
-* CHANGE: Rye::Set method missing now forwards to Rye::Box 
+* CHANGE: Rye::Set method missing now forwards to Rye::Box
   methods instead of Rye::Cmd
 
 
@@ -217,9 +223,9 @@ RYE, CHANGES
 * ADDED: Rye::Cmd#safely and Rye::Cmd#unsafely methods
 * ADDED: Rye::Cmd#digest_md5, Rye::Cmd#digest_sha1, Rye::Cmd#digest_sha2 methods
 * ADDED: Rye::Cmd#file_verified? method
-* ADDED: Rye::Box#net_ssh_exec! now checks and correctly prompts for a sudo response password. 
-  Note: this will be upgraded in for 0.8 to support any prompt. 
-* FIXED: Net::SSH paranoid now set to false when safe mode is disabled.  
+* ADDED: Rye::Box#net_ssh_exec! now checks and correctly prompts for a sudo response password.
+  Note: this will be upgraded in for 0.8 to support any prompt.
+* FIXED: Net::SSH paranoid now set to false when safe mode is disabled.
 
 
 #### 0.7.2 (2009-06-01) #############################
@@ -230,14 +236,14 @@ RYE, CHANGES
 
 * CHANGE: Removed broken grep method from Rye::Rap
 * FIXED: Bug which prevented setting relative paths in non-home directory
-* ADDED: Rye::Cmd#add_command helper for adding new command methods. 
+* ADDED: Rye::Cmd#add_command helper for adding new command methods.
 * ADDED: pre-command-hook now sends the hostname to the block
 
 
 #### 0.7.0 (2009-05-30) #############################
 
 * CHANGE: Rye::Box now uses unique instance variable names to encourage using
-  instance variables in batch command blocks. 
+  instance variables in batch command blocks.
 * ADDED: Rye::Box#file_append
 
 #### 0.6.6 (2009-05-21) #############################
@@ -253,7 +259,7 @@ RYE, CHANGES
 
 #### 0.6.4 (2009-05-04) #############################
 
-* FIXED: authorize_remote was not returning to the directory it started with. 
+* FIXED: authorize_remote was not returning to the directory it started with.
 * ADDED: pre and post command hooks to Rye::Box
 * ADDED: Rye::Box.batch
 * ADDED: Support for OS X for Rye::Box.guess_user_home
@@ -283,13 +289,13 @@ RYE, CHANGES
 * FIXED: handling of Process::Status ($?) in Rye.shell
 * FIXED: Removed reference to Rudy::Error in bin/rye
 * ADDED: Rye::Box.getenv
-* ADDED: Rye::Box.can? 
+* ADDED: Rye::Box.can?
 * ADDED: Rye::Box.umask= (a similar work around as cd / [])
 * ADDED: Rye::Box.file_exists?
 * ADDED: Rye::Box.authorize_keys_remote can now authorize for a different user
 * ADDED: Rye::Box.upload and Rye::Box.download
 * ADDED: Rye::SystemInfo.tmpdir
-* CHANGE: Rye::Box.prep_args doesn't treat multicharacter Symbols as 
+* CHANGE: Rye::Box.prep_args doesn't treat multicharacter Symbols as
 command-line options any more (single character ones are still converted)
 * CHANGE: Renamed Rye::Box.add_env to Rye::Box.setenv
 * CHANGE: rm and kill are available in Rye::Cmd by default
@@ -310,9 +316,9 @@ Rye.shell and Rye::Box.run_command (SSH) commands.
 #### 0.5.3 (2009-04-20) #############################
 
 * FIXED: Rye::Box.connect raises exceptions instead of exits
-* ADDED: Rye::Box.connect now rescues HostKeyMismatch exceptions and 
-  prompts for a response. 
-  
+* ADDED: Rye::Box.connect now rescues HostKeyMismatch exceptions and
+  prompts for a response.
+
 #### 0.5.2 (2009-04-19) #############################
 
 * FIXED: authorize-local command attempted to connect via SSH before authorizing.
@@ -336,21 +342,21 @@ Rye.shell and Rye::Box.run_command (SSH) commands.
 
 * ADDED: More helpful debug output
 * ADDED: hostname command to Rye::Cmd
-* ADDED: Rye::Box.connect now supports multiple password attempts if STDIN.tty returns true 
+* 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.
-* CHANGE: Using OpenSSH's ssh-agent but also let's Net::SSH handle the ssh keys. 
+* CHANGE: Using OpenSSH's ssh-agent but also let's Net::SSH handle the ssh keys.
 
 
 #### 0.4.1 (2009-04-06) #############################
 
 * FIXED: Rye::Box.authorize_keys_remote was not disabling safe mode properly
-* FIXED: Disabled debug mode. 
-* ADDED: "rye authorize" now specifically enforces the auth method order 
+* FIXED: Disabled debug mode.
+* ADDED: "rye authorize" now specifically enforces the auth method order
 
 
 #### 0.4.0 (2009-04-06) #############################
 
-* FIXED: Box.run_command was parsing arguments incorrectly 
+* FIXED: Box.run_command was parsing arguments incorrectly
 * FIXED: Box.net_ssh_exec was working on nil stderr
 * FIXED: bin/try handles the new command exceptions
 * ADDED: to_s and inspect methods for cleaner debugging output
@@ -359,8 +365,8 @@ Rye.shell and Rye::Box.run_command (SSH) commands.
 * ADDED: Command switches can now be sent as Symbols (rbox.ls(:h))
 * ADDED: Rye.host_keys
 * ADDED: bin/rye
-* ADDED: commands now raise a Rye::Err exception 
-  when the command returns an exit code greater than 0. 
+* ADDED: commands now raise a Rye::Err exception
+  when the command returns an exit code greater than 0.
 * CHANGE: Box.add_command renamed to Box.run_command
 
 
@@ -375,9 +381,9 @@ Rye.shell and Rye::Box.run_command (SSH) commands.
 
 * FIXED: Rye::Box wasn't properly adding keypairs to SSH Agent
 * FIXED: Rye::Box.method_missing Symbol/String ambiguity
-* ADDED: Rye::Set supports executing commands parallel 
+* ADDED: Rye::Set supports executing commands parallel
 * ADDED: Rye::Rap now contains STDERR output from command
-* ADDED: Supports all options provided by Net::SSH#start. This 
+* ADDED: Supports all options provided by Net::SSH#start. This
   includes support for password logins and proxies.
 * ADDED: Safe mode can now be disabled (to allow file globs
   and environment variable access).
@@ -398,5 +404,5 @@ Initial public release
 
 #### TODO ###########################################
 
-* Re-implement Rye::Rap as an Observable StringIO object for dynamic printing of output. 
+* Re-implement Rye::Rap as an Observable StringIO object for dynamic printing of output.
 * Fingerprints: ssh-keygen -l -f id_rsa_repos.pub

data/README.rdoc

@@ -1,9 +1,10 @@
 = Rye - v0.9
 
-<b>Safely run SSH commands on a bunch of machines at the same time (from Ruby)</b>.
+<strong>Safely run SSH commands on a bunch of machines at the same time (from Ruby)</stong>.
 
 Inspired by Rush[http://rush.heroku.com] and compatible with Ruby 1.8, 1.9, and JRuby 1.3+!
 
+<em>As of 0.9.8, all gem releases are signed. See Installation.</em>
 
 == Overview
 
@@ -14,14 +15,14 @@ Rye does not require anything to be installed on the server side (other than an
 
 == Example 1 -- Execute commands on a remote machine
 
-Shell commands are executed by calling methods on a Rye::Box object. 
-    
+Shell commands are executed by calling methods on a Rye::Box object.
+
     rbox = Rye::Box.new('hostname')
     rbox.pwd                               # => "/home/rye"
     rbox.uname :a                          # => "Darwin rye-stage 9.7.0 ..."
 
 Method arguments are sent directly as arguments to the shell command. Single-character Symbols are assumed to be single-character switches. <em>e.g. <tt>rbox.uname :a</tt> becomes <tt>uname -a</tt>.</em>
-    
+
 The return value for a command is a modified Array containing the contents of STDOUT split by line. It also gives access to STDERR and the exit code
 
     ret = rbox.uptime                      # => "11:02  up 16:01, 3 users"
@@ -41,12 +42,12 @@ You can change directories.
     rbox['/etc'].ls                        # => ['apache', 'init.d', ...]
     rbox.pwd                               # => '/etc'
     rbox.cd                                # => '/home/rye'
-    
+
 You can specify environment variables.
 
     rbox.setenv('TIPPLE', "Forty Creek")
-    rbox.getenv 'TIPPLE'                   # => "Forty Creek"    
-    
+    rbox.getenv 'TIPPLE'                   # => "Forty Creek"
+
 
 == Example 3 -- Adding and removing commands
 
@@ -54,7 +55,7 @@ You can add and remove commands to the whitelist.
 
     Rye::Cmd.add_command :anything, '/usr/bin/uptime'
     rbox = Rye::Box.new
-    rbox.anything                       
+    rbox.anything
     Rye::Cmd.remove_command :anything
     rbox.anything                          # => Rye::CommandNotFound exception
 
@@ -66,18 +67,18 @@ Safe mode can be disabled on one of the following ways.
     rbox = Rye::Box.new 'HOST', :safe => false
       OR
     rbox.disable_safe_mode
-  
+
 When safe-mode is disabled, you can run any command (regardless of what is defined in the whitelist) with any valid arguments (fileglobs, tildas, etc...).
 
     rbox.kill '-SIGHUP', 1928111
     rbox.rm 'path/2/*'
-    
+
 You can also execute any valid shell command.
 
     rbox.execute 'ps aux | grep ruby > /tmp/ruby-process-list'
 
 See the "About Safe Mode" section below for more information.
- 
+
 
 == Example 5a -- Accessing Multiple Machines
 
@@ -86,26 +87,26 @@ Shell commands can be executed on multiple machines using a Rye::Set object. Cre
     rbox = Rye::Box.new 'HOST1'
     rset = Rye::Set.new
     rset.add_boxes rbox, 'HOST2'           # Add boxes as hostnames or objects
-    
+
 Then call methods just like with Rye::Box, except now the return value is an Array of Arrays. The order of return values matches the order the machines were added to the set.
-    
+
     rset.hostname                          # => [["HOST1"], ["HOST2"]]
     rset.uname                             # => [["Darwin"], ["Linux"]]
-    
+
 == Example 5b -- Accessing Multiple Machines in Parallel
-   
+
 By default, Rye::Set connects to each machine sequentially in the order they were added to the set. Commands can also be run in parallel.
 
     rset = Rye::Set.new "SETNAME", :parallel => true
       OR
     rset.parallel = true
-   
-   
+
+
 == Example 6 -- File Transfers
 
     rbox = Rye::Box.new "localhost"
 
-    rbox.file_upload "README.rdoc", "/tmp" 
+    rbox.file_upload "README.rdoc", "/tmp"
 
     applejack = StringIO.new "Some in-memory content"
     rbox.file_upload applejack, "/tmp/applejack.txt"
@@ -152,7 +153,7 @@ When working with machines that are behind another host (assuming that you have
 
     rbox = Rye::Box.new('filibuster', :via => 'firewall.lan')
 
-The information for the Rye::Box is then relative from the position of the firewall. 
+The information for the Rye::Box is then relative from the position of the firewall.
 So, the hostname 'filibuster' is used from 'firewall.lan'
 
 == Example 8b -- Hopping Firewalls, in groups
@@ -165,6 +166,12 @@ So, the hostname 'filibuster' is used from 'firewall.lan'
     rset.uptime
         # => [[17:17:44 up 548 days, 13:37, 20 users,  load average: 0.12, 0.07, 0.06], [01:17:49 up 6 days,  1:39,  9 users,  load average: 0.13, 0.09, 0.09]]
 
+== Example 9 -- Disable password prompt
+
+If you're running in a terminal but you want <tt>Net::SSH::AuthenticationFailed</tt> to be raised instead of getting a password prompt when authentication fails, set <tt>:password_prompt</tt> option to false:
+
+    rbox = Rye::Box.new("foo.com", :user => "dan", :password => "inkorrect", :password_prompt => false)
+    rbox.uptime # => raises Net::SSH::AuthenticationFailed
 
 == About Safe-Mode
 
@@ -175,7 +182,7 @@ In safe-mode:
 * Pipes and operators don't work: <tt>|, &&, >, <, ||, ~</tt>, etc...
 * Backticks don't work either: <tt>procs=`ps aux`</tt>
 
-Why? In safe-mode, all command arguments are escaped which turns all arguments into their literal values. 
+Why? In safe-mode, all command arguments are escaped which turns all arguments into their literal values.
 
 Using a Ruby interface to execute shell commands is pretty awesome, particularly to run them on several machines simultaneously. That's a lot of power and it's potentially very dangerous. That's why Rye disables this stuff by default. There's probably a way to do it safely but it's not obvious yet (to me). If you have any ideas, I'd love to hear them!
 
@@ -198,43 +205,50 @@ Rye permits only a limited number of system commands to be run. This default whi
 
 == Installation
 
-Via Rubygems, one of:
+Via Rubygems:
 
     $ gem install rye
 
+However, in order to be sure the code you're install is the code I wrote, I recommended that you verify the signiture[http://docs.rubygems.org/read/chapter/21]. To do this
+
+    # Add the public key as a trusted certificate
+    # (You only need to do this once)
+    $ curl -O https://raw.github.com/delano/rye/master/gem-public_cert.pem
+    $ gem cert --add gem-public_cert.pem
+
+    $ gem install rye -P HighSecurity
+
+If you don't add the public key, you'll see an error like "Couldn't verify data signature". If you're still having trouble let me know and I'll give you a hand.
+
 or via download:
 
 * rye-latest.tar.gz[http://github.com/delano/rye/tarball/latest]
 * rye-latest.zip[http://github.com/delano/rye/zipball/latest]
 
-== Known Issues
-
-* Rye doesn't read the ~/.ssh/config file yet
-* No support for STDIN for commands.
-* Limited support for interactive shells. 
 
-If you find one let me know!
+== Contributing
 
+The easiest way to contribute is to open an issue[https://github.com/delano/rye/issues] for bugs and feature requests. I'm also very open to thoughtful and interesting pull[https://github.com/delano/rye/pulls] requests[https://github.com/delano/rye/pulls. Fork and be merry.
 
 == Thanks
 
 * 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. 
+* Mike Cline for giving the okay to use the Rye name.
 * Justin Case (http://github.com/justincase/) for fixes
 * Vincent Batts (http://hashbangbash.com/) for Rye::Hop
 
 
 == More Info
 
-* Codes[http://github.com/delano/rye]
+* Codes[https://github.com/delano/rye]
 * Rdocs[http://delano.github.com/rye]
 * Inspiration[http://www.youtube.com/watch?v=_StUVh6ENuw]
 
 
 == Related Projects
 
-* Rush[http://github.com/adamwiggins/rush]
+* Rush[https://github.com/adamwiggins/rush]
 
 
 == Credits

data/Rakefile

@@ -1,90 +1,49 @@
-require 'rubygems'
-require 'rake/clean'
-require 'rake/gempackagetask'
-require 'fileutils'
-include FileUtils
- 
-begin
- require 'hanna/rdoctask'
-rescue LoadError
- require 'rake/rdoctask'
-end
-
-
-task :default => :package
- 
-# CONFIG =============================================================
-
-# Change the following according to your needs
-README = "README.rdoc"
-CHANGES = "CHANGES.txt"
-LICENSE = "LICENSE.txt"
-
-# Files and directories to be deleted when you run "rake clean"
-CLEAN.include [ 'doc', 'pkg', '*.gem', '.config' ]
-
-# Virginia assumes your project and gemspec have the same name
-name = (Dir.glob('*.gemspec') || ['rye']).first.split('.').first
-load "#{name}.gemspec"
-version = @spec.version
+require "rubygems"
+require "rake"
+require "rake/clean"
+require "rdoc/task"
 
-# That's it! The following defaults should allow you to get started
-# on other things. 
+task :default => ["build"]
+CLEAN.include [ 'pkg', 'rdoc' ]
+name = "rye"
 
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require name
+version = Rye::VERSION.to_s
 
-# TESTS/SPECS =========================================================
-
-
-
-# INSTALL =============================================================
-
-Rake::GemPackageTask.new(@spec) do |p|
-  p.need_tar = true if RUBY_PLATFORM !~ /mswin/
-end
-
-task :build => [ :release ]
-task :release => [ :rdoc, :package ]
-task :install => [ :rdoc, :package ] do
-  sh %{sudo gem install pkg/#{name}-#{version}.gem}
-end
-task :uninstall => [ :clean ] do
-  sh %{sudo gem uninstall #{name}}
-end
-
-
-# RUBYFORGE RELEASE / PUBLISH TASKS ==================================
-
-if @spec.rubyforge_project
-  desc 'Publish website to rubyforge'
-  task 'publish:rdoc' => 'doc/index.html' do
-    sh "scp -rp doc/* rubyforge.org:/var/www/gforge-projects/#{name}/"
-  end
-
-  desc 'Public release to rubyforge'
-  task 'publish:gem' => [:package] do |t|
-    sh <<-end
-      rubyforge add_release -o Any -a #{CHANGES} -f -n #{README} #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.gem &&
-      rubyforge add_file -o Any -a #{CHANGES} -f -n #{README} #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.tgz 
-    end
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |s|
+    s.version = version
+    s.name = name
+    s.rubyforge_project = s.name
+    s.summary = "Run SSH commands on a bunch of machines at the same time (from Ruby)."
+    s.description = "Run SSH commands on a bunch of machines at the same time (from Ruby)."
+    s.email = "delano@solutious.com"
+    s.homepage = "https://github.com/delano/rye"
+    s.authors = ["Delano Mandelbaum"]
+    s.add_dependency 'annoy'
+    s.add_dependency 'sysinfo',         '>= 0.7.3'
+    s.add_dependency 'highline',        '>= 1.5.1'
+    s.add_dependency 'net-ssh',         '>= 2.0.13'
+    s.add_dependency 'net-scp',         '>= 1.0.2'
+    s.add_dependency 'docile',          '>= 1.0.1'
+
+    s.signing_key = File.join('/mnt/gem/', 'gem-private_key.pem')
+    s.cert_chain  = ['gem-public_cert.pem']
   end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
-
-
-# RUBY DOCS TASK ==================================
-
-Rake::RDocTask.new do |t|
-  t.rdoc_dir = 'doc'
-  t.title    = @spec.summary
-  t.options << '--line-numbers' << '-A cattr_accessor=object'
-  t.options << '--charset' << 'utf-8'
-  t.rdoc_files.include(LICENSE)
-  t.rdoc_files.include(README)
-  t.rdoc_files.include(CHANGES)
-  t.rdoc_files.include('bin/*')
-  t.rdoc_files.include('lib/**/*.rb')
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("LICENSE.txt")
+  rdoc.rdoc_files.include("VERSION")
+  rdoc.rdoc_files.include("bin/*.rb")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
-
-
-