relay 0.0.3 → 0.1.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Michel Martens and Damian Janowski
+Copyright (c) 2009, 2010 Michel Martens and Damian Janowski
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.markdown

@@ -10,13 +10,22 @@ Relay is a simple library that allows you to send commands over SSH.
 It uses your own SSH, not a Ruby version, so you can profit from your
 settings and public/private keys.
 
+The following options are available:
+
+    -c command
+        Executes the command on the passed servers.
+
+    -f recipe
+        Reads commands from a file and executes them in the passed servers.
+
 Usage
 -----
 
-To send a command to a server called `myserver`:
+To send a command to two servers called `server1` and `server2`:
 
-    $ relay execute "ls -al" myserver
-    $ relay execute "cd foo; ls" myserver
+    $ relay -c "ls -al" server1 server2
+    $ relay -c "cd foo; ls" server1 server2
+    $ relay -c "cd foo" -c "ls" server1 server2
 
 If you want to send more commands, you can write a shell script:
 
@@ -25,33 +34,24 @@ If you want to send more commands, you can write a shell script:
       ls
       mkdir -p bar/baz
 
-    $ relay recipe.sh myserver
-
-It will execute those commands on `myserver` and show the output.
-
-This last form accepts one file as the recipe and one or many servers:
-
-    $ relay recipe.sh server1 server2 server3
+    $ relay -f recipe.sh server1 server2
 
-You can also add your public key to a remote server's authorized keys file:
+It will execute those commands on both servers and show the output.
 
-    $ relay identify myserver
 
-Relay exposes the `execute` method, which returns the output of the command:
+You can use each flag many times, so this is possible:
 
-    >> require "relay"
-    >> Relay.execute "echo foo", "myserver"
-    => ["foo\n"]
+    $ relay -f recipe1.sh -f recipe2.sh server1 server2 server3
 
 Installation
 ------------
 
-    $ sudo gem install relay
+    $ gem install relay
 
 License
 -------
 
-Copyright (c) 2009 Michel Martens and Damian Janowski
+Copyright (c) 2009, 2010 Michel Martens and Damian Janowski
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/Rakefile

@@ -1,5 +1,7 @@
 task :test do
-  system "cd test && ruby relay_test.rb"
+  require "cutest"
+
+  Cutest.run(Dir["test/relay_test.rb"])
 end
 
 task :default => :test

data/bin/relay

@@ -1,21 +1,64 @@
-#! /usr/bin/env ruby -rubygems
+#! /usr/bin/env ruby
 
-require File.join(File.dirname(__FILE__), "..", "lib", "relay")
+help = <<-EOS
+RELAY(1)
 
-# A way to extend Relay is to write tasks in a Thorfile in the project's root directory.
-# Relay loads the Thorfile if there is one, and all the tasks that are declared in the
-# class Relay become available.
-if File.exists?("Thorfile")
-  load("Thorfile")
-end
+NAME
+      relay -- Relay commands over SSH.
+
+SYNOPSIS
+      relay [-c command] [-f recipe] server1 [server2 ...]
+
+DESCRIPTION
+      Relay is a simple library that allows you to send commands over SSH. It uses
+      your own SSH, not a Ruby version, so you can profit from your settings and
+      public/private keys.
+
+      The following options are available:
+
+      -c command
+          Executes the command on the passed servers.
+
+      -f recipe
+          Reads commands from a file and executes them in the passed servers.
+
+USAGE
+      To send a command to two servers called `server1` and `server2`:
+
+          $ relay -c "ls -al" server1 server2
+          $ relay -c "cd foo; ls" server1 server2
+          $ relay -c "cd foo" -c "ls" server1 server2
+
+      If you want to send more commands, you can write a shell script:
+
+          $ cat recipe.sh
+            cd foo
+            ls
+            mkdir -p bar/baz
 
-# Start the relay tasks.
-if ARGV[0] && File.exists?(ARGV[0])
-  file = ARGV.shift
+          $ relay -f recipe.sh server1 server2
 
-  ARGV.each do |server|
-    Relay.new.recipe(file, server)
-  end
-else
-  Relay.start
+      It will execute those commands on both servers and show the output.
+
+
+      You can use each flag many times, so this is possible:
+
+          $ relay -f recipe1.sh -f recipe2.sh server1 server2 server3
+EOS
+
+if ARGV.empty?
+  puts help
+  exit
 end
+
+require "clap"
+
+require File.expand_path("../lib/relay", File.dirname(__FILE__))
+
+relay = Relay.new
+
+servers = Clap.run ARGV,
+  "-f" => relay.method(:recipe),
+  "-c" => relay.method(:command)
+
+relay.run(servers)

data/lib/relay.rb

@@ -1,6 +1,5 @@
 #! /usr/bin/env ruby
 
-require "thor"
 require "open3"
 
 class Ssh
@@ -42,47 +41,35 @@ class Ssh
   end
 end
 
-class Relay < Thor
+class Relay
+  VERSION = "0.1.0"
 
-  # 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")
+  def initialize
+    @recipes = []
+    @commands = []
   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"
-  def identify(server)
-    path = options[:path] || "~/.ssh/authorized_keys"
-    keys = [options[:key], "~/.ssh/id_rsa.pub", "~/.ssh/id_dsa.pub"].compact
-    key = keys.find { |k| File.exists?(File.expand_path(k)) }
-
-    if system %Q{cat #{key} | ssh #{server} "cat >> #{path}"}
-      say_status :copied, "#{key} to #{server}:#{path}"
-    end
+  def recipe(recipe)
+    @recipes << recipe
   end
 
-  desc "recipe RECIPE SERVER", "Execute commands contained in RECIPE in the context of SERVER"
-  def recipe(recipe, server)
-    Ssh.new(server).start do |session|
-      File.readlines(recipe).each do |command|
-        session.run(command)
-      end
-    end
+  def command(command)
+    @commands << command
   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, options[:quiet]).start do |session|
-      session.run(command)
+  def run(servers)
+    servers.each do |server|
+      Ssh.new(server).start do |session|
+        @commands.each do |command|
+          session.run(command)
+        end
+
+        @recipes.each do |recipe|
+          File.readlines(recipe).each do |command|
+            session.run(command)
+          end
+        end
+      end
     end
   end
 end

data/relay.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = "relay"
-  s.version           = "0.0.3"
+  s.version           = "0.1.0"
   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"]
@@ -9,9 +9,9 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "relay"
 
-  s.executables << "relay"
+  s.executables.push("relay")
 
-  s.add_dependency("thor", "~> 0.11")
+  s.add_dependency("clap")
 
   s.files = ["LICENSE", "README.markdown", "Rakefile", "bin/relay", "lib/relay.rb", "relay.gemspec", "test/commands.rb", "test/relay_test.rb", "test/test_helper.rb"]
 end

data/test/commands.rb

@@ -1,7 +1,7 @@
 require "open3"
 require "socket"
 
-module Test::Commands
+module Commands
   def sh(cmd)
     out, err = nil
 

data/test/relay_test.rb

@@ -1,28 +1,18 @@
-require File.join(File.dirname(__FILE__), "test_helper")
+require File.expand_path("test_helper", File.dirname(__FILE__))
 
-class TestRelay < Test::Unit::TestCase
-  context "relay identify SERVER" do
-    should "copy the public key to SERVER" do
-      Dir.chdir(root("test", "tmp")) do
-        out, err = relay("identify localhost --path #{root("test", "tmp", "authorized_keys")}")
-
-        assert_match /copied/, out
-        assert File.exists?("authorized_keys")
-        assert File.read("authorized_keys")[/^ssh-/]
-      end
-    end
-
-    should "send a command to SERVER" do
+scope do
+  scope do
+    test "send a command to SERVER" do
       Dir.chdir(root("test", "tmp")) do
         FileUtils.touch("foobar")
 
-        out, err = relay("execute \"ls #{root("test", "tmp")}\" localhost")
+        out, err = relay("-c \"ls #{root("test", "tmp")}\" localhost")
 
-        assert_match /foobar/, out
+        assert out[/foobar/]
       end
     end
 
-    should "relay a recipe of commands to SERVER" do
+    test "relay a recipe of commands to SERVER" do
       Dir.chdir(root("test", "tmp")) do
         File.open("recipe.sh", "w") do |file|
           file.puts "cd #{root("test", "tmp")}"
@@ -30,7 +20,7 @@ class TestRelay < Test::Unit::TestCase
           file.puts "cat list"
         end
 
-        out, err = relay("recipe.sh localhost")
+        out, err = relay("-f recipe.sh localhost")
 
         assert out["$ cd #{root("test", "tmp")}"]
         assert out["$ ls -al > list"]
@@ -38,10 +28,5 @@ 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,34 +1,25 @@
 require "rubygems"
-require "contest"
 require "fileutils"
-require File.join(File.dirname(__FILE__), "..", "lib", "relay")
 
-ROOT = File.expand_path(File.join(File.dirname(__FILE__), ".."))
-
-$:.unshift ROOT
+require File.expand_path("../lib/relay", File.dirname(__FILE__))
+require File.expand_path("commands", File.dirname(__FILE__))
 
-require "test/commands"
+include Commands
 
-class Test::Unit::TestCase
-  include Test::Commands
+ROOT = File.expand_path(File.join(File.dirname(__FILE__), ".."))
 
-  def root(*args)
-    File.join(ROOT, *args)
-  end
+$:.unshift ROOT
 
-  def setup
-    Dir[root("test", "tmp", "*")].each do |file|
-      FileUtils.rm(file)
-    end
-  end
+def root(*args)
+File.join(ROOT, *args)
+end
 
-  def teardown
-    Dir[root("test", "tmp", "*")].each do |file|
-      FileUtils.rm(file)
-    end
+prepare do
+  Dir[root("test", "tmp", "*")].each do |file|
+    FileUtils.rm(file)
   end
+end
 
-  def relay(args = nil)
-    sh("ruby -rubygems #{root "bin/relay"} #{args}")
-  end
+def relay(args = nil)
+  sh("ruby -rubygems #{root "bin/relay"} #{args}")
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: relay
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Damian Janowski
@@ -10,19 +15,22 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-21 00:00:00 -03:00
+date: 2010-11-06 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: thor
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  name: clap
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: "0.11"
-    version: 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
 description: Relay allows you to execute remote commands via SSH with ease.
 email: 
 - djanowski@dimaion.com
@@ -53,21 +61,25 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: relay
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Relay commands over SSH