relay 0.0.2 → 0.0.3

data/README.markdown

@@ -37,6 +37,12 @@ You can also add your public key to a remote server's authorized keys file:
 
     $ relay identify myserver
 
+Relay exposes the `execute` method, which returns the output of the command:
+
+    >> require "relay"
+    >> Relay.execute "echo foo", "myserver"
+    => ["foo\n"]
+
 Installation
 ------------
 

data/lib/relay.rb

@@ -4,8 +4,10 @@ require "thor"
 require "open3"
 
 class Ssh
-  def initialize(server)
+  def initialize(server, quiet = false)
     @server = server
+    @output = []
+    @quiet = quiet
   end
 
   def start
@@ -16,30 +18,44 @@ class Ssh
 
       threads << Thread.new do
         while line = stderr.gets
-          $stderr.puts(line)
+          $stderr.puts(line) unless @quiet
         end
       end
 
       threads << Thread.new do
         while line = stdout.gets
-          $stdout.puts(line)
+          @output << line
+          $stdout.puts(line) unless @quiet
         end
       end
 
       yield(self)
       stdin.close
       threads.each {|t| t.join }
+      @output
     end
   end
 
   def run(command)
-    puts "\e[1m\e[33m$ #{command.strip}\e[0m"
+    puts "\e[1m\e[33m$ #{command.strip}\e[0m" unless @quiet
     @stdin.puts(command)
   end
 end
 
 class Relay < Thor
 
+  # If you require the relay library, you can issue commands
+  # with the execute method:
+  #
+  # @example
+  #
+  #     >> require "relay"
+  #     >> Relay.execute "echo foo", "myserver"
+  #     => ["foo\n"]
+  def self.execute(*args)
+    start args.unshift("execute").push("--quiet")
+  end
+
   desc "identify SERVER", "Copies your public key to a remote server"
   method_option :key, :type => :string, :aliases => "-k"
   method_option :path, :type => :string, :aliases => "-p"
@@ -63,8 +79,9 @@ class Relay < Thor
   end
 
   desc "execute COMMAND SERVER", "Execute COMMAND in the context of SERVER"
+  method_option :quiet, :type => :boolean, :aliases => "-q"
   def execute(command, server)
-    Ssh.new(server).start do |session|
+    Ssh.new(server, options[:quiet]).start do |session|
       session.run(command)
     end
   end

data/relay.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = "relay"
-  s.version           = "0.0.2"
+  s.version           = "0.0.3"
   s.summary           = "Relay commands over SSH"
   s.description       = "Relay allows you to execute remote commands via SSH with ease."
   s.authors           = ["Damian Janowski", "Michel Martens"]

data/test/relay_test.rb

@@ -38,5 +38,10 @@ class TestRelay < Test::Unit::TestCase
         assert out["recipe.sh"]
       end
     end
+
+    should "return the output when used programmatically" do
+      assert_equal ["foo\n"], Relay.execute("echo foo", "localhost")
+      assert_equal ["foo\n", "bar\n", "baz\n"], Relay.execute("echo foo; echo bar; echo baz", "localhost")
+    end
   end
 end

data/test/test_helper.rb

@@ -1,6 +1,7 @@
 require "rubygems"
 require "contest"
 require "fileutils"
+require File.join(File.dirname(__FILE__), "..", "lib", "relay")
 
 ROOT = File.expand_path(File.join(File.dirname(__FILE__), ".."))
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: relay
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Damian Janowski