elsewhere 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in elsewhere.gemspec
+gemspec

data/README.md

@@ -0,0 +1,20 @@
+#Elsewhere
+
+###Simple wrapper for Ruby Net::SSH for running commands remotely
+
+#Why?
+  This was abstracted from a larger project. There are many solutions out there that already do or require this paradigm like Capistrano or RemoteRun for Rake. But this code exists and 
+  Is used in several active projects so I thought it might be useful to others.
+
+#Usage:
+```Ruby
+r = Elsewhere::RemoteRun.new("www.example.com","app_user")
+r.commands << "source /etc/profile"
+r.commands << "cd ~/current"
+r.commands << "rake do:something:useful"
+
+r.execute
+```
+
+#Notes:
+   I'm still in the process of adding some tests and porting this over to a gem but the core library is used in a working project

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/elsewhere.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "elsewhere/version"
+
+Gem::Specification.new do |s|
+  s.name        = "elsewhere"
+  s.version     = Elsewhere::VERSION
+  s.authors     = ["Bill Chapman"]
+  s.email       = ["bchapman@academicmanagement.com"]
+  s.homepage    = ""
+  s.summary     = %q{ Simple wrapper for Net SSH to run a list of commands remotely }
+  s.description = %q{ Yet another way to run stuff remotely }
+
+  s.rubyforge_project = "elsewhere"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+  s.add_runtime_dependency 'minitest'
+  s.add_runtime_dependency 'net-ssh'
+  s.add_runtime_dependency 'net-ssh-gateway'
+  
+end

data/lib/elsewhere.rb

@@ -0,0 +1,6 @@
+require "elsewhere/version"
+require "elsewhere/remote_run"
+
+module Elsewhere
+  # Your code goes here...
+end

data/lib/elsewhere/remote_run.rb

@@ -0,0 +1,111 @@
+module Elsewhere
+
+# Execute commands on a remote server
+# I know capistrano already does this
+# This was abstracted from a more specific solution that we already had in place and I thought it was worth sharing
+# 
+# Usage:
+#
+#   r = RemoteRun.new("hostname","username")
+#   r.commands << "source /etc/profile"
+#   r.commands << "cd ~/current"
+#   r.commands << "rake extractor:run cas=3 users=12550"
+# 
+#   r.execute
+#
+  require 'net/ssh' 
+  require 'net/ssh/gateway'
+  require 'yaml'
+  class RemoteRun  
+    
+    #TODO: move to remote_run/exceptions.rb when we gemify this
+    class RemoteRunError < StandardError; end
+    
+    attr_accessor :hosts, :gateway_address, :gateway_user, :commands
+    
+    def initialize(hosts,user, options={})
+      @hosts        = [hosts].flatten #accept a single host or an array of hosts 
+      @gateway_address = options[:gateway_address]
+      @gateway_user = options[:gateway_user] 
+      @user         = user
+      @commands     = []
+    end
+    
+    #expects the config file to be formatted as yaml as follows
+    #environment:
+    #  group:
+    #    user: username
+    #    host: hostname
+    def self.initialize_from_config(config_file,environment,group,options={})
+      config_file = YAML.load_file(config_file)
+      env_config = config_file[environment][group]
+      options[:gateway_address] ||= env_config["gateway"]["host"] unless env_config["gateway"].nil?
+      options[:gateway_user]    ||= env_config["gateway"]["user"] unless env_config["gateway"].nil?
+      new(env_config["host"],env_config["user"],options)
+    end 
+    
+    #gateway wrapper when a gateway is specified
+    def gateway_wrapper
+      @gateway_host ||= if(@gateway_addr && @gateway_user)
+        Net::SSH::Gateway.new(@gateway_addr, @gateway_user, {:forward_agent => true})
+      else
+        nil
+      end
+    end
+    
+    def ssh_wrapper(host,command)
+       output = nil
+       Net::SSH.start(host, @user) do |ssh|
+         output = execute_over_ssh(ssh,command)
+       end
+       output
+    end
+    
+    # Run all of the items in the commands hash
+    # The joined_by paramenter dictates how to join the commands before execution
+    # Returns: A hash of the responses for each specified host 
+    def execute(joined_by = " && ") 
+      run_me = @commands.join(joined_by)
+      output = {}
+      
+      if @gateway_host
+        gateway_wrapper.ssh(host, @user, {:forward_agent => true}) do |gateway|
+          @hosts.uniq.each do |h|
+            gateway.ssh(host, options[:gateway_user], {:forward_agent => true}) do |ssh|
+              output[h] = execute_over_ssh(ssh, run_me)
+            end
+          end
+        end
+      else
+         @hosts.uniq.each{ |h| output[h] = ssh_wrapper(h,run_me) }
+      end
+      
+      return output
+    end
+    
+    #execute the given commend for the Net::SSH instance 
+    #return the data or raise an error depending on which stream is returned
+    def execute_over_ssh(ssh,command)
+      stdout = ""
+      ssh.exec!(command) do |channel,stream,data|
+         case stream
+         when :stderr
+           raise RemoteRunError, data 
+         else
+           stdout = data 
+         end
+       end
+       return stdout
+    end
+  
+  
+  end
+end
+
+if __FILE__ == $0
+  host = ""
+  user = ""
+  r = RemoteRun.new(host,user)
+  r.commands << "ls"
+  puts r.execute
+end

data/lib/elsewhere/version.rb

@@ -0,0 +1,3 @@
+module Elsewhere
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: elsewhere
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bill Chapman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &2169024520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2169024520
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: &2169024100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2169024100
+- !ruby/object:Gem::Dependency
+  name: net-ssh-gateway
+  requirement: &2169023680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2169023680
+description: ! ' Yet another way to run stuff remotely '
+email:
+- bchapman@academicmanagement.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- elsewhere.gemspec
+- lib/elsewhere.rb
+- lib/elsewhere/remote_run.rb
+- lib/elsewhere/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: elsewhere
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Simple wrapper for Net SSH to run a list of commands remotely
+test_files: []