rsh 0.2.2 → 1.0.0

data/.document

@@ -1,6 +1,4 @@
-README.rdoc
+*.rdoc
 lib/**/*.rb
 bin/*
 features/**/*.feature
-LICENSE
-CHANGELOG

data/.gitignore

@@ -13,9 +13,13 @@ tmtags
 ## VIM
 *.swp
 
+## NETBEANS
+nbproject
+
 ## PROJECT::GENERAL
 coverage
 rdoc
+doc
 pkg
 
 ## PROJECT::SPECIFIC

data/{CHANGELOG → CHANGELOG.rdoc}

@@ -1,3 +1,96 @@
+[f5ac480 | Sun Oct 31 09:12:03 UTC 2010] Pavel Argentov <argentoff@gmail.com>
+
+ * Version 1.0.0 feature freeze
+
+    Version 1.0.0 features pure ruby rsh client. See Rsh class documentation for
+    details.
+
+[0b8dd96 | Sun Oct 31 09:08:02 UTC 2010] Pavel Argentov <argentoff@gmail.com>
+
+ * Version bump to 1.0.0
+
+[4062f8e | Sun Oct 31 09:04:02 UTC 2010] Pavel Argentov <argentoff@gmail.com>
+
+ * ruby_impl= optimization
+
+[7c3f811 | Sun Oct 31 08:44:43 UTC 2010] Pavel Argentov <argentoff@gmail.com>
+
+ * ./doc -> .gitignore
+
+[97c7732 | Sun Oct 31 08:43:27 UTC 2010] Pavel Argentov <argentoff@gmail.com>
+
+ * Kinda ready for test
+
+[e3feeca | Sun Oct 31 07:44:06 UTC 2010] Pavel Argentov <argentoff@gmail.com>
+
+ * First byte experiment
+
+    Looks like successful. Leave it in place.
+
+[0cb9667 | Sun Oct 31 07:26:45 UTC 2010] Pavel Argentov <argentoff@gmail.com>
+
+ * First byte experiment
+
+    Try to throw away first byte of server's output (it seems to be kinda 
+    signalling char [ref?]); also made the lookup of rsh binary mandatory 
+    again since :ruby_impl can change during the Rsh instance's lifetime.
+
+[1ff74ab | Sun Oct 31 06:43:19 UTC 2010] Pavel Argentov <argentoff@gmail.com>
+
+ * Fixed .document
+
+[eb3f789 | Sun Oct 31 06:35:14 UTC 2010] Pavel Argentov <argentoff@gmail.com>
+
+ * Docs cleanup
+
+[13171cc | Sun Oct 31 06:24:30 UTC 2010] Pavel Argentov <argentoff@gmail.com>
+
+ * Yet another documentation reorganization
+
+    Renamed LICENSE and CHANGELOG to *.rdoc
+
+[0e841ee | Sat Oct 30 19:38:52 UTC 2010] Pavel Argentov <argentoff@gmail.com>
+
+ * Added luser example to constructor's rdoc
+
+[7a60372 | Sat Oct 30 19:35:41 UTC 2010] Pavel Argentov <argentoff@gmail.com>
+
+ * Fixed :luser bug in constructor
+
+[27f985a | Sat Oct 30 19:28:13 UTC 2010] Pavel Argentov <argentoff@gmail.com>
+
+ * Merge all changes to rsh.rb
+
+    Merged all experimental code into rsh.rb, removed rsh_p_r.rb.
+
+[94de036 | Sat Oct 30 18:52:42 UTC 2010] Pavel Argentov <argentoff@gmail.com>
+
+ * Continuing work on RshPR
+
+    Added flag :ruby_impl to force ruby implementation if needed.
+
+[6e9cdb8 | Sat Oct 30 17:47:32 UTC 2010] Pavel Argentov <argentoff@gmail.com>
+
+ * More practical module
+
+    Made RshPR module more suitable to be used in Rsh class.
+
+[6ef45bd | Sat Oct 30 16:59:40 UTC 2010] Pavel Argentov <argentoff@gmail.com>
+
+ * Pure ruby RSH
+
+    Added rsh_p_r.rb: pure ruby rsh implementation. As a module to start with.
+
+[ef37141 | Thu Oct 28 03:39:10 UTC 2010] Pavel Argentov <argentoff@gmail.com>
+
+ * Netbeans adaptation
+
+    Added "nbproject" directory to git ignore list.
+
+[3abbddc | Wed Oct 27 15:01:04 UTC 2010] Pavel Argentov <argentoff@gmail.com>
+
+ * Finished working on v0.2.2
+
 [63b17fa | Wed Oct 27 14:50:57 UTC 2010] Pavel Argentov <argentoff@gmail.com>
 
  * Finished project documentation rework

data/Rakefile

@@ -14,8 +14,8 @@ begin
     gem.authors = ["Pavel Argentov"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.extra_rdoc_files = [
-      "LICENSE",
-      "CHANGELOG",
+      "LICENSE.rdoc",
+      "CHANGELOG.rdoc",
       "README.rdoc"
     ]
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
@@ -55,7 +55,7 @@ end
 
 desc 'update changelog'  
 task :changelog do  
-  File.open('CHANGELOG', 'w+') do |changelog|  
+  File.open('CHANGELOG.rdoc', 'w+') do |changelog|  
     `git log -z --abbrev-commit`.split("\0").each do |commit|  
       next if commit =~ /^Merge: \d*/  
       ref, author, time, _, title, _, message = commit.split("\n", 7)  

data/VERSION

@@ -1 +1 @@
-0.2.2
+1.0.0

data/lib/rsh.rb

@@ -1,9 +1,19 @@
-# = UNIX rsh(1) wrapper class
+# -*- Ruby -*-
+# Ruby remote shell protocol (RFC 1282) client.
+
+require 'socket' # we'll need it in pure ruby implementation
+
+# = Ruby remote shell protocol (RFC 1282) client
 # 
-# Creates and operates an 'rsh' command call instance. Parameters to rsh may
+# Creates and operates an rsh client instance. Parameters may
 # be specified through either constructor or attribute accessors. Result of
-# rsh execution (_String_) is either returned in functional style (<tt>execute!</tt> method call)
-# or in special attribute, _result_.
+# remote command execution (_String_) is either returned in functional style
+# (<tt>execute!</tt> method call) or in special attribute, _:result_.
+#
+# == New: pure ruby rsh client
+# As of ver. 1.0.0, pure ruby rsh client is implemented. It is used whether if
+# you set :ruby_impl to true or if 'rsh' program wasn't found in the system while
+# setting :ruby_impl to false.
 #
 # == Synopsis
 #
@@ -40,69 +50,88 @@
 #   % man 1 rsh
 #
 class Rsh
+  # flags whether to force pure ruby rsh client
+  attr_accessor :ruby_impl
   # path to rsh program, +String+
   attr_reader   :executable
-
   # result +String+
   attr_reader   :result
-
   # remote server hostname or IP, +String+
   attr_accessor :host
-
   # remote command, +String+
   attr_accessor :command
-
   # remote username, +String+
   attr_accessor :ruser
-
+  # Local user name, used in pure ruby implementation.
+  attr_accessor :luser
   # rsh timeout, +Integer+ (see man 1 rsh)
   attr_accessor :to
-
   # boolean knob for <tt>/dev/null</tt> redirection; see man rsh for further
   # information
   attr_accessor :nullr
 
-  # The Constructor. Checks the presence of rsh in the system (running,
+  # The Constructor. If :ruby_impl is false checks the presence of rsh in the system (running,
   # naturally, 'which rsh') and prepares the command to be run with <tt>execute!</tt>. 
   # rsh CLI arguments are either having default values, being collected from constructor 
   # call or specified via accessors.
   #
   # Call sequence:
-  #   Rsh.new -> Rsh instance
-  #   Rsh.new(:host => "hostname", :command => "example.sh", :ruser => "jack", :to => 5, :nullr => true) -> Rsh instance
+  #   Rsh.new #=> Rsh instance
+  #   Rsh.new(:host      => "hostname",
+  #           :command   => "example.sh",
+  #           :ruser     => "jack",
+  #           :to        => 5,
+  #           :nullr     => true
+  #           :ruby_impl => true) #=> Rsh instance
   # 
   # If called without arguments, the following default values are being used:
   # 
-  #   :host    => "localhost"
-  #   :command => ""
-  #   :ruser   => "nobody"
-  #   :to      => 3 
-  #   :nullr   => false
+  #   :host      => "localhost"
+  #   :command   => ""
+  #   :ruser     => "nobody"
+  #   :to        => 3
+  #   :nullr     => false
+  #   :ruby_impl => false
+  #   :luser     => ENV["USER"] || "nobody"
   #
   def initialize(args={})
-    args = {:host    => "localhost", 
-            :command => "", 
-	    :ruser   => "nobody",
-	    :to      => 3, 
-	    :nullr   => false}.merge!(args)
+    args = {
+      :host      => "localhost",
+      :command   => "",
+      :ruser     => "nobody",
+      :luser     => ENV["USER"] || "nobody",
+      :to        => 3,
+      :nullr     => false,
+      :ruby_impl => false
+    }.merge!(args)
+
+    @result     = ""
+    @ruby_impl  = args[:ruby_impl]
+    @host       = args[:host]
+    @command    = args[:command]
+    @ruser      = args[:ruser]
+    @luser      = args[:luser]
+    @to         = args[:to]
+    @nullr      = args[:nullr]
+
     begin
       open("| which rsh") do |io|
         @executable = io.gets.chomp
       end
     rescue => detail
-      raise "FATAL: Could not find rsh executable!"
+      @ruby_impl = true
     end
-    
-    @host    = args[:host]
-    @command = args[:command]
-    @ruser   = args[:ruser]
-    @to      = args[:to]
-    @nullr   = args[:nullr]
-    @result  = ""
+  end
+  
+  # :ruby_impl writer ensuring that we can set/reset :ruby_impl only
+  # if @executable is not nil.
+  def ruby_impl=(bool)
+    @executable ? @ruby_impl = bool : @ruby_impl
   end
 
-
-  # Executes rsh command using previously collected arguments. 
+  # Executes rsh command using previously collected arguments. If :ruby_impl is
+  # true or system rsh binary was not found during initialize runs pure ruby rsh
+  # client.
   #
   # If given a block, calls it for each line received from rsh output
   # (parameter _line_).
@@ -125,15 +154,45 @@ class Rsh
   def execute!(command=nil)
     @command = command if command
     @result = ""
-    open "|#{@executable} #{"-n" if @nullr} -l#{@ruser} -t#{@to} #{@host} #{@command}" do |io|
-      io.each do |line|
+    if @ruby_impl
+      # pure ruby implementation call
+      rsh_ruby do |line|
         yield(line) if block_given?
         @result << line
       end
+    else
+      # OS'es rsh(1) call
+      open "|#{@executable} #{"-n" if @nullr} -l#{@ruser} -t#{@to} #{@host} #{@command}" do |io|
+        io.each do |line|
+          yield(line) if block_given?
+          @result << line
+        end
+      end
     end
     @result
   end
 
+  private
+  # pure ruby rsh client
+  def rsh_ruby
+    r = ""
+    s = TCPSocket.new(@host, 514)
+    s.write "0\0"
+    s.write "#{@luser}\0"
+    s.write "#{@ruser}\0"
+    s.write "#{@command}\0"
+    s.getc # cutting off the first byte, signalling?
+    while line = s.gets
+      if block_given?
+        yield line
+      else
+        r << line
+      end
+    end
+    s.close
+    r == "" ? nil : r
+  end
+
   alias :execute :execute!
 
 end

data/rsh.gemspec

@@ -5,24 +5,24 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rsh}
-  s.version = "0.2.2"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Pavel Argentov"]
-  s.date = %q{2010-10-27}
+  s.date = %q{2010-10-31}
   s.description = %q{All freenixes (e.g. Linux, *BSD, etc.) have 'rsh' command.
       Here's the gem wrapping call to this command and handling the command's result/output.}
   s.email = %q{argentoff@gmail.com}
   s.extra_rdoc_files = [
-    "CHANGELOG",
-     "LICENSE",
+    "CHANGELOG.rdoc",
+     "LICENSE.rdoc",
      "README.rdoc"
   ]
   s.files = [
     ".document",
      ".gitignore",
-     "CHANGELOG",
-     "LICENSE",
+     "CHANGELOG.rdoc",
+     "LICENSE.rdoc",
      "README.rdoc",
      "Rakefile",
      "VERSION",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rsh
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 23
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Pavel Argentov
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-27 00:00:00 +04:00
+date: 2010-10-31 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,14 +43,14 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- CHANGELOG
-- LICENSE
+- CHANGELOG.rdoc
+- LICENSE.rdoc
 - README.rdoc
 files: 
 - .document
 - .gitignore
-- CHANGELOG
-- LICENSE
+- CHANGELOG.rdoc
+- LICENSE.rdoc
 - README.rdoc
 - Rakefile
 - VERSION