rsh 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Pavel Argentov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,14 @@
+= rsh
+
+Author:: Pavel Argentov (argentoff at gmail dot com)
+
+Here's a simple tiny wrapper which alows me to use rsh shell command in PORO
+(Plain Old Ruby Object) style. For all details see Rsh class rdoc.
+
+This gem was developed and tested on FreeBSD 8.1. If you find any
+incompatibilities and/or are ready to help me fix the problem feel free to
+write me on the public email listed above.
+
+== Copyright
+
+Copyright (c) 2010 Pavel Argentov. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rsh"
+    gem.summary = %Q{Simple wrapper for rsh cli command.}
+    gem.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.}
+    gem.email = "argentoff@gmail.com"
+    gem.homepage = "http://github.com/argent-smith/rsh"
+    gem.authors = ["Pavel Argentov"]
+    gem.rubyforge_project = "rsh"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rsh #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rsh.rb

@@ -0,0 +1,127 @@
+# = UNIX rsh(1) wrapper class
+# 
+# Creates and operates an 'rsh' command call instance. Parameters to rsh 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_.
+#
+# == Synopsis
+#
+#   require 'rsh'
+#
+#   rsh = Rsh.new(:host => "c7206", :ruser => "bill",
+#                 :command => "show clock")
+#
+#   rsh.execute do |line| puts line end
+#
+#   18:30:46.799 MSD Fri Oct 22 2010
+#
+# == See also
+#
+#   % man 1 rsh
+#
+class Rsh
+  # 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
+
+  # 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,
+  # 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-seq:
+  #   new(:host => "hostname", 
+  #       :command => "example.sh", 
+  #       :ruser => "jack", 
+  #       :to => 5, 
+  #       :nullr => true)
+  #
+  # Argument defaults are:
+  #   :host    => "localhost"
+  #   :command => ""
+  #   :ruser   => "nobody"
+  #   :to      => 3 
+  #   :nullr   => false
+  #
+  # Arguments hash is optional.
+  #
+  def initialize(args={})
+    args = {:host    => "localhost", 
+            :command => "", 
+	    :ruser   => "nobody",
+	    :to      => 3, 
+	    :nullr   => false}.merge!(args)
+    begin
+      open("| which rsh") do |io|
+        @executable = io.gets.chomp
+      end
+    rescue => detail
+      raise "FATAL: Could not find rsh executable!"
+    end
+    
+    @host    = args[:host]
+    @command = args[:command]
+    @ruser   = args[:ruser]
+    @to      = args[:to]
+    @nullr   = args[:nullr]
+    @result  = ""
+  end
+
+
+  # Executes rsh command using previously collected arguments. 
+  #
+  # If given a block, calls it for each line received from rsh output
+  # (parameter _line_).
+  #
+  # Returns:: the complete rsh output as one _String_. The result is also
+  #           stored and available via _result_ attribute.
+  #
+  def execute
+    @result = ""
+    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
+    @result
+  end
+
+  #
+  # :section: Example
+  #
+  # This is an example of rsh in action usin interactive Ruby.
+  #
+  #   irb(main):001:0> require 'rsh'
+  #   => true
+  #
+  #   irb(main):002:0> rsh = Rsh.new(:host => "c7206", :ruser => "bill",
+  #                                  :command => "show clock")
+  #   => #<Rsh:0x2853f390 @ruser="bill", @executable="/usr/bin/rsh", @result="", @command="show clock", @nullr=false, @host="c7206", @to=3>
+  #
+  #   irb(main):003:0> rsh.execute do |line| puts line end
+  #
+  #   18:30:46.799 MSD Fri Oct 22 2010
+  #   => "\r\n18:30:46.799 MSD Fri Oct 22 2010\n"
+  #
+
+end

data/rsh.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rsh}
+  s.version = "0.1.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-22}
+  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 = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/rsh.rb",
+     "rsh.gemspec",
+     "spec/rsh_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/argent-smith/rsh}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rsh}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Simple wrapper for rsh cli command.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/rsh_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/spec/rsh_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Rsh" do
+    it "creates rsh instance" do
+      rsh = Rsh.new
+    end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rsh'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: rsh
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Pavel Argentov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-22 00:00:00 +04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: |-
+  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.
+email: argentoff@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rsh.rb
+- rsh.gemspec
+- spec/rsh_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/argent-smith/rsh
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rsh
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple wrapper for rsh cli command.
+test_files: 
+- spec/spec_helper.rb
+- spec/rsh_spec.rb