Chee 0.3.0 → 0.4.0

data/README.md

@@ -2,8 +2,14 @@
 Chee
 ================
 
-Send commands through SSH, but using a tty/pty and STDIN.
-That's right: Interactive SSH sessions. 
+A Ruby gem that allows interactive `User <-> Ruby <-> SSH` sessions. 
+It uses Net::SSH and a pseudo-terminal.
+
+Thanks
+------
+
+This post by `jtzero` provided the solution for using STDIN and Net::SSH:
+[http://stackoverflow.com/questions/6942279/ruby-net-ssh-channel-dies](http://stackoverflow.com/questions/6942279/ruby-net-ssh-channel-dies)
 
 Limitations
 -----------
@@ -12,8 +18,9 @@ Limitations
 Apt-get and 
 other programs that request input in a simple manner should work well enough.
 
-* PTY (psuedo-terminal) is used. Which means it runs in a sub-shell. 
-Which leads to *no* STDERR access. All output is done on STDOUT.
+* A pseudo-terminal is used. Which means it runs in a sub-shell. 
+Which leads to *no* STDERR access. All returning output from your command
+is done on STDOUT.
 
 Installation
 ------------
@@ -27,14 +34,12 @@ You could include the DSL into your own object:
 
     require "Chee"
     Class My_SSH
-
       include Chee::DSL
+    end
 
-      def ssh cmd
-        super cmd.strip
-      end
-
-    end # === Class My_SSH
+    o = My_SSH.new
+    o.server 'my_server'
+    o.ssh "uptime"
 
 Or you could use Chee directly:
 
@@ -42,31 +47,50 @@ Or you could use Chee directly:
     Chee.server 'my_server'
     Chee.ssh "uptime"
 
+`:server` accepts the same options as `Net::SSH.start`:
+    
+    Chee.server(
+      'localhost', 
+      'me', 
+      :password => "try to use private/public keys", 
+      :timeout  => 3  
+    )
+    
 `:ssh` returns a `Chee::Result` object:
 
     result = Chee.ssh( "uptime" )
-    
     result.out         # ==> output from STDOUT
     result.exit_status 
 
+Usage: Printing Output
+-----
+
+Override default printing with `:print_data`:
+
+    def print_data data
+      # ignore data
+    end
+
+    # The default is:
+    def print_data data
+      print data   
+      STDOUT.flush
+    end
+
+You can still get the output with the returned value of `:ssh` 
+or `:ssh_to_all`:
+
+    o.ssh( "uptime" ).out
+
+    o.ssh_to_all("uptime").map(&:out)
+
 Usage: Single Server
 -----
 
     require "Chee"
     
-    # If you configured server using ~/.ssh/config:
     Chee.server "my_server"  
     
-    # You can also use the same options you would send to
-    # Net::SSH:
-    Chee.server(
-      'localhost', 
-      'me', 
-      :password => "try to use private/public keys", 
-      :timeout  => 3  
-    )
-    
-    # Send a command
     Chee.ssh %^ sudo add-apt-repository ppa:nginx/stable ^
 
 
@@ -99,11 +123,13 @@ Multiple servers, multiple commands:
     Chee.server 'localhost'
     Chee.server 'my_other_host'
     
-    Chee.ssh_to_all %^
+    Chee.ssh_to_all('
       echo "a"
       echo "b"
-    ^
-    # ---> [ Chee::Result, Chee::Result, Chee::Result, Chee::Result ]
+    ')
+    .map(&:out)
+    
+    # ---> [ "a", "b", "a", "b" ]
     
 Run Tests
 ---------

data/lib/Chee.rb

@@ -29,10 +29,9 @@ class Chee
       @server = args
     end
 
-    def print_data &blok
-      @print_data ||= proc { |d| print d; STDOUT.flush; } 
-      return(@print_data) if blok.nil? 
-      @print_data = blok
+    def print_data d
+      print d
+      STDOUT.flush
     end
 
     def ssh_to_all command
@@ -127,7 +126,7 @@ class Chee
               stdout << d # .sub(%r!\r?\n\Z!,'')
 
               unless prev_cmd.to_s.strip == d.strip
-                print_data.call d
+                print_data d
               end
 
               prev_data = d

data/lib/Chee/version.rb

@@ -1,3 +1,3 @@
 class Chee
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/main.rb

@@ -9,8 +9,7 @@ class My_SSH
 
   include Chee::DSL
 
-  def print_data
-    @print_data ||= proc {}
+  def print_data data
   end
   
 end # === My_SSH

data/spec/tests/Chee.rb

@@ -10,11 +10,14 @@ describe "Chee :ssh" do
     ]
     
     Chee.server @localhost
-    @data = ''
     
-    Chee.print_data { |d|
-      @data << d
-    }
+    def Chee.data
+      @data
+    end
+
+    def Chee.print_data d
+      @data = d
+    end
   end
   
   it 'accepts a String for the server info.' do
@@ -29,7 +32,7 @@ describe "Chee :ssh" do
 
   it 'uses :print_data to print data' do
     Chee.ssh 'echo c'
-    @data.strip.should == 'c'
+    Chee.data.strip.should == 'c'
   end
 
   it 'uses a PTY' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Chee
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors: