relay 0.0.1 → 0.0.2

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2008 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
+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.markdown

@@ -0,0 +1,69 @@
+Relay
+=====
+
+Relay commands over SSH.
+
+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.
+
+Usage
+-----
+
+To send a command to a server called `myserver`:
+
+    $ relay execute "ls -al" myserver
+    $ relay execute "cd foo; ls" myserver
+
+If you want to send more commands, you can write a shell script:
+
+    $ cat recipe.sh
+      cd foo
+      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
+
+You can also add your public key to a remote server's authorized keys file:
+
+    $ relay identify myserver
+
+Installation
+------------
+
+    $ sudo gem install relay
+
+License
+-------
+
+Copyright (c) 2009 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 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/Rakefile

@@ -0,0 +1,5 @@
+task :test do
+  system "cd test && ruby relay_test.rb"
+end
+
+task :default => :test

data/bin/relay

@@ -0,0 +1,21 @@
+#! /usr/bin/env ruby -rubygems
+
+require File.join(File.dirname(__FILE__), "..", "lib", "relay")
+
+# 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
+
+# Start the relay tasks.
+if ARGV[0] && File.exists?(ARGV[0])
+  file = ARGV.shift
+
+  ARGV.each do |server|
+    Relay.new.recipe(file, server)
+  end
+else
+  Relay.start
+end

data/lib/relay.rb

@@ -0,0 +1,71 @@
+#! /usr/bin/env ruby
+
+require "thor"
+require "open3"
+
+class Ssh
+  def initialize(server)
+    @server = server
+  end
+
+  def start
+    Open3.popen3("ssh -T #{@server}") do |stdin, stdout, stderr|
+      threads = []
+
+      @stdin, @stdout, @stderr = stdin, stdout, stderr
+
+      threads << Thread.new do
+        while line = stderr.gets
+          $stderr.puts(line)
+        end
+      end
+
+      threads << Thread.new do
+        while line = stdout.gets
+          $stdout.puts(line)
+        end
+      end
+
+      yield(self)
+      stdin.close
+      threads.each {|t| t.join }
+    end
+  end
+
+  def run(command)
+    puts "\e[1m\e[33m$ #{command.strip}\e[0m"
+    @stdin.puts(command)
+  end
+end
+
+class Relay < Thor
+
+  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
+  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
+  end
+
+  desc "execute COMMAND SERVER", "Execute COMMAND in the context of SERVER"
+  def execute(command, server)
+    Ssh.new(server).start do |session|
+      session.run(command)
+    end
+  end
+end

data/relay.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name              = "relay"
+  s.version           = "0.0.2"
+  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"]
+  s.email             = ["djanowski@dimaion.com", "michel@soveran.com"]
+  s.homepage          = "http://github.com/soveran/relay"
+
+  s.rubyforge_project = "relay"
+
+  s.executables << "relay"
+
+  s.add_dependency("thor", "~> 0.11")
+
+  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

@@ -0,0 +1,72 @@
+require "open3"
+require "socket"
+
+module Test::Commands
+  def sh(cmd)
+    out, err = nil
+
+    Open3.popen3(cmd) do |_in, _out, _err|
+      out = _out.read
+      err = _err.read
+    end
+
+    [out, err]
+  end
+
+  # Runs a command in the background, silencing all output.
+  # For debugging purposes, set the environment variable VERBOSE.
+  def sh_bg(cmd)
+    if ENV["VERBOSE"]
+      streams_to_silence = []
+    else
+      streams_to_silence = [$stdout, $stderr]
+      cmd = "#{cmd} 2>&1>/dev/null"
+    end
+
+    silence_stream(*streams_to_silence) do
+      (pid = fork) ? Process.detach(pid) : exec(cmd)
+    end
+  end
+
+  def listening?(host, port)
+    begin
+      socket = TCPSocket.new(host, port)
+      socket.close unless socket.nil?
+      true
+    rescue Errno::ECONNREFUSED,
+      Errno::EBADF,           # Windows
+      Errno::EADDRNOTAVAIL    # Windows
+      false
+    end
+  end
+
+  def wait_for_service(host, port, timeout = 3)
+    start_time = Time.now
+
+    until listening?(host, port)
+      if timeout && (Time.now > (start_time + timeout))
+        raise SocketError.new("Socket #{host}:#{port} did not open within #{timeout} seconds")
+      end
+    end
+
+    true
+  end
+
+  def suspects(port)
+    list = sh("lsof -i :#{port}").first.split("\n")[1..-1] || []
+    list.map {|s| s[/^.+? (\d+)/, 1] }
+  end
+
+  def silence_stream(*streams) #:yeild:
+    on_hold = streams.collect{ |stream| stream.dup }
+    streams.each do |stream|
+      stream.reopen(RUBY_PLATFORM =~ /mswin/ ? 'NUL:' : '/dev/null')
+      stream.sync = true
+    end
+    yield
+  ensure
+    streams.each_with_index do |stream, i|
+      stream.reopen(on_hold[i])
+    end
+  end
+end

data/test/relay_test.rb

@@ -0,0 +1,42 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+
+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
+      Dir.chdir(root("test", "tmp")) do
+        FileUtils.touch("foobar")
+
+        out, err = relay("execute \"ls #{root("test", "tmp")}\" localhost")
+
+        assert_match /foobar/, out
+      end
+    end
+
+    should "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")}"
+          file.puts "ls -al > list"
+          file.puts "cat list"
+        end
+
+        out, err = relay("recipe.sh localhost")
+
+        assert out["$ cd #{root("test", "tmp")}"]
+        assert out["$ ls -al > list"]
+        assert out["$ cat list"]
+        assert out["recipe.sh"]
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,33 @@
+require "rubygems"
+require "contest"
+require "fileutils"
+
+ROOT = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+
+$:.unshift ROOT
+
+require "test/commands"
+
+class Test::Unit::TestCase
+  include Test::Commands
+
+  def root(*args)
+    File.join(ROOT, *args)
+  end
+
+  def setup
+    Dir[root("test", "tmp", "*")].each do |file|
+      FileUtils.rm(file)
+    end
+  end
+
+  def teardown
+    Dir[root("test", "tmp", "*")].each do |file|
+      FileUtils.rm(file)
+    end
+  end
+
+  def relay(args = nil)
+    sh("ruby -rubygems #{root "bin/relay"} #{args}")
+  end
+end

metadata

@@ -1,30 +1,50 @@
 --- !ruby/object:Gem::Specification 
 name: relay
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
-- TBD
+- Damian Janowski
+- Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-08-07 00:00:00 -03:00
+date: 2009-11-21 00:00:00 -03:00
 default_executable: 
-dependencies: []
-
-description: TBD
-email: TBD
-executables: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thor
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.11"
+    version: 
+description: Relay allows you to execute remote commands via SSH with ease.
+email: 
+- djanowski@dimaion.com
+- michel@soveran.com
+executables: 
+- relay
 extensions: []
 
 extra_rdoc_files: []
 
-files: []
-
+files: 
+- LICENSE
+- README.markdown
+- Rakefile
+- bin/relay
+- lib/relay.rb
+- relay.gemspec
+- test/commands.rb
+- test/relay_test.rb
+- test/test_helper.rb
 has_rdoc: true
-homepage: 
+homepage: http://github.com/soveran/relay
 licenses: []
 
 post_install_message: 
@@ -46,10 +66,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: relay
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: TBD
+summary: Relay commands over SSH
 test_files: []