rye 0.3.1 → 0.3.2

data/CHANGES.txt

@@ -1,9 +1,11 @@
 RYE, CHANGES
 
 
-#### 0.3.1 (2009-04-05) #############################
+#### 0.3.2 (2009-04-05) #############################
 
 * 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.
 
 
 #### 0.3 (2009-04-05) ###############################

data/README.rdoc

@@ -1,10 +1,10 @@
 = Rye - v0.3
 
-Run system commands via SSH locally and remotely in a Ruby way. 
+Safely run remote commands via SSH in 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>.
 
-See +bin/try+ for working examples.
+See bin/try for working examples.
 
 == Installation
 
@@ -136,9 +136,9 @@ One of:
 
 In safe-mode:
 
-* You can't use file globs. This means you can't do this: <tt>rbox.ls('*.rb')</tt>. 
-* 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>.
-* Pipes and operators don't work: <tt>|, &&, >, <, ||</tt>, etc...
+* 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>.
+* 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. 
@@ -146,6 +146,10 @@ Why? In safe-mode, all command arguments are escaped which turns all arguments i
 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!
 
 
+== Command Whitelist
+
+Rye permits only a limited number of system commands to be run. This default whitelist is defined in Rye::Cmd but you can add your own commands as you please (see Example 2).
+
 == Credits
 
 * Delano Mandelbaum (delano@solutious.com)
@@ -154,7 +158,7 @@ Using a Ruby interface to execute shell commands is pretty awesome, particularly
 == Thanks
 
 * Solutious Incorporated (http://solutious.com) for all the orange juice.
-* The country of Canada for making Rye Whiskey. 
+* The country of Canada for making Rye Whisky. 
 
 
 == Kudos
@@ -165,6 +169,11 @@ Using a Ruby interface to execute shell commands is pretty awesome, particularly
 * http://groups.google.com/group/ruby-talk-google/browse_thread/thread/674a6f6de15ceb49?pli=1
 * http://paste.lisp.org/display/6912
 
+== More Info
+
+* http://github.com/delano/rye
+* http://delano.github.com/rye
+* http://www.youtube.com/watch?v=_StUVh6ENuw
 
 == Credits
 

data/lib/rye/cmd.rb

@@ -22,25 +22,37 @@ module Rye;
     def cp(*args); cmd("cp", args); end
     def mv(*args); cmd("mv", args); end
     def ls(*args); cmd('ls', args); end
-    def rm(*args); cmd('rm', args); end
+    #def rm(*args); cmd('rm', args); end
     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 svn(*args); cmd('svn', args); end
+    def cvs(*args); cmd('cvs', args); end
+    def git(*args); cmd('git', args); end
+    def sed(*args); cmd('sed', args); end
+    def awk(*args); cmd('awk', args); end
     def cat(*args); cmd('cat', args); end
+    
+    #def kill(*args); cmd('kill', args); end
+    def sudo(*args); cmd('sudo', args); end
     def grep(*args); cmd('grep', args); end
     def date(*args); cmd('date', args); end
     def ruby(*args); cmd('ruby', args); end
     def perl(*args); cmd('perl', args); end
     def bash(*args); cmd('bash', args); end
     def echo(*args); cmd('echo', args); end
+    
+    def mount; cmd("mount"); end
     def sleep(seconds=1); cmd("sleep", seconds); end
     def touch(*args); cmd('touch', args); end
     def uname(*args); cmd('uname', args); end
-    def mount; cmd("mount"); end
-    def python(*args); cmd('python', args); end
+    
     def uptime; cmd("uptime"); end
+    def python(*args); cmd('python', args); end
     def printenv(*args); cmd('printenv', args); end
+    
     # Consider Rye.sysinfo.os == :unix
   end
 

data/lib/rye/set.rb

@@ -49,7 +49,7 @@ module Rye
       @boxes += boxes.collect do |box|
         box.is_a?(Rye::Box) ? box.add_keys(@keys) : Rye::Box.new(box, @opts)
       end
-      @boxes
+      self
     end
     alias :add_boxes :add_box
     

data/lib/rye.rb

@@ -9,12 +9,12 @@ require 'sys'
 
 # = Rye
 #
-# Run system commands via SSH locally and remotely in a Ruby way.
+# Safely run remote commands via SSH in 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: 
+# less dangerous (for safety). For example, file globs are  
+# disabled so unless otherwise specified, you can't do this: 
 # <tt>rbox.rm('/etc/**/*')</tt>. 
 #
 # * See +bin/try+ for a bunch of working examples. 

data/rye.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
   s.name = "rye"
   s.rubyforge_project = "rye"
-  s.version = "0.3.1"
+  s.version = "0.3.2"
   s.summary = "Rye: Run system commands via SSH locally and remotely in a Ruby way."
   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.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
 - Delano Mandelbaum