simple_ssh 0.0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,6 @@
+=== 0.0.1
+
+* 1 major enhancement
+
+  * Birthday!
+  * initial commit

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Sandor Szücs
+
+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/Manifest.txt

@@ -0,0 +1,6 @@
+CHANGELOG.rdoc
+LICENSE
+Manifest.txt
+README.rdoc
+Rakefile
+lib/simple_ssh.rb

data/README.rdoc

@@ -0,0 +1,80 @@
+= SimpleSSH
+home :: https://github.com/szuecs/simple_ssh
+
+== DESCRIPTION
+simple_ssh is a simple wrapper around the net-ssh gem.
+
+* You want to execute a list of commands on a list of hosts using ssh?
+* You want to analyze the results within a script?
+
+If your answers for these questions are yes then simple_ssh is for you.
+
+=== Examples
+==== Configuration
+* Simple configuration of command list execution by hosts using a block. 
+
+    ssh = SimpleSsh::SimpleSSH.configure do |cfg|
+      cfg.user = "root"
+      cfg.hosts << "192.168.143.153"
+      cfg.cmds  << "whoami"
+      cfg.cmds  << "id"
+      cfg.keys  << "~/.ssh/id_rsa"
+    end
+    ssh.execute #=> {"192.168.143.153"=>{"whoami"=>"root", "id"=>"uid=0(root) gid=0(root) groups=0(root)"}}
+    puts ssh
+    #192.168.143.153:
+    #        whoami: root
+    #        id: uid=0(root) gid=0(root) groups=0(root)
+
+* Configuration by dictionary or block or both
+
+    ssh = SimpleSsh::SimpleSSH.configure(:cmds => ["ls -l / | wc", "hostname"], :user => "root") do |cfg|
+      cfg.hosts << "192.168.143.153"
+      cfg.cmds  << "whoami"
+      cfg.keys  << "~/.ssh/id_rsa"
+    end
+    
+==== Command execution
+* Execute the configured hosts and commands
+
+    ssh.execute
+
+* Execute a block
+  
+    ssh.execute do |ch|
+      ch.cmds << "echo yeaha"
+      ch.cmds << "echo yeaha | openssl dgst -sha1"
+    end
+    
+==== Using results
+* Get results by hosts dictionary
+
+    ssh.result_by_host["192.168.143.153"] #=> {"ls -l / | wc"=>"     23     206    1151", "hostname"=>"foreman-squeeze", "whoami"=>"root"}
+
+* Get results by cmd dictionary
+
+    ssh.result_by_cmd["whoami"] #=> {"192.168.143.153"=>"root"}
+
+* Dump yaml 
+
+    ssh.to_yaml #=> "--- \n192.168.143.153: \n  ls -l / | wc: \"     23     206    1151\"\n  hostname: foreman-squeeze\n  whoami: root\n"
+
+* Dump csv
+
+    ssh.to_csv(";") #=> "host;cmd;result\n192.168.143.153;ls -l / | wc;     23     206    1151\n192.168.143.153;hostname;foreman-squeeze\n192.168.143.153;whoami;root"
+
+== REQUIREMENTS
+
+* net-ssh
+
+== INSTALL
+
+% sudo gem install simple_ssh
+
+== AUTHORS
+
+Sandor Szücs, sandor.szuecs@fu-berlin.de
+  
+== LICENSE
+
+See LICENSE file.

data/Rakefile

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+
+require 'hoe'
+
+Hoe::add_include_dirs("lib")
+
+Hoe.plugins.delete :rubyforge
+Hoe.plugin :git
+
+Hoe.spec 'simple_ssh' do
+  developer "Sandor Szücs", 'sandor.szuecs@fu-berlin.de'
+  
+  self.flay_threshold = 100
+  
+  self.history_file = "CHANGELOG.rdoc"
+  self.readme_file = "README.rdoc"
+  
+  extra_deps << ['net-ssh', '~> 2.0']
+end
+
+# vim: syntax=ruby

data/lib/simple_ssh.rb

@@ -0,0 +1,114 @@
+require "net/ssh"
+
+module SimpleSsh
+  VERSION = '0.0.1'
+  
+  class SimpleSSH
+    
+    class << self
+      def configure(options={})
+        ssh = SimpleSsh::SimpleSSH.new(options)
+        yield(ssh) if block_given?
+        ssh
+      end
+    end # class methods end
+    
+    def initialize(options={})
+       @hosts = options[:hosts] ||  []
+       @cmds  = options[:cmds] || []
+       @keys = options[:keys] || []
+       @user = options[:user] || ""
+    end
+    
+    attr_accessor :keys, :user
+    
+    def hosts
+      @hosts ||= []
+    end
+
+    def cmds
+      @cmds ||= []
+    end
+    
+    def execute
+      if block_given?
+        @cmds.clear
+        @result_by_cmd.clear
+        yield(self)
+      end
+
+      results = {}
+      @hosts.each do |host|
+        results[host] = execute_cmds_on(user, host)
+      end
+      @result_by_host = results
+    end
+    
+    attr_reader :result_by_host
+    
+    def result_by_cmd
+      return @result_by_cmd if defined? @result_by_cmd and not @result_by_cmd.empty?
+      
+      @result_by_cmd = {}
+      @result_by_host.each do |host, cmd_dict|
+        cmd_dict.each do |cmd, res|
+          @result_by_cmd[cmd] ||= {}
+          @result_by_cmd[cmd][host]= res 
+        end
+      end
+      @result_by_cmd
+    end
+
+    def to_s
+      result_by_host.map do |host, cmd_dict|
+        res = "#{host}:\n"
+        cmd_dict.each do |cmd,cmd_res|
+          res << "\t#{cmd}: #{cmd_res.split("\n").join("\n\t\t")}\n"
+        end
+        res
+      end.join("")
+    end
+    
+    def to_yaml(by=:host)
+      require 'yaml' unless defined? YAML
+      s = send "result_by_#{by.to_s}".to_sym
+      YAML.dump(s)
+    end
+    
+    def to_csv(sep=",")
+      require "csv" unless defined? CSV
+      csv = []
+
+      cols = ["host", "cmd", "result"]
+      csv << cols.join(sep)
+
+      result_by_host.each do |host, cmd_dict|
+        cmd_dict.each do |cmd, res|
+          csv << (host + sep + cmd + sep + cmd_dict[cmd])
+        end
+      end
+
+      csv.join("\n")
+    end
+    
+    private
+    
+    def execute_cmds_on(user, host)
+      result = {}
+      begin
+        Net::SSH.start( host, user, :keys => keys) do |ssh|
+          @cmds.each do |cmd|
+            begin
+              result[cmd]= ssh.exec!(cmd).chomp
+            rescue Exception => e
+              $stderr.puts "Failed to execute #{cmd}"
+            end
+          end
+        end
+      rescue Exception => e
+        $stderr.puts "Could not open connection #{user}@#{host} using private key #{keys}"
+      end
+      result
+    end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: simple_ssh
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sandor Szücs
+autorequire: 
+bindir: bin
+cert_chain:
+- ! '-----BEGIN CERTIFICATE-----
+
+  MIIDQjCCAiqgAwIBAgIBADANBgkqhkiG9w0BAQUFADBHMRYwFAYDVQQDDA1zYW5k
+
+  b3Iuc3p1ZWNzMRkwFwYKCZImiZPyLGQBGRYJZnUtYmVybGluMRIwEAYKCZImiZPy
+
+  LGQBGRYCZGUwHhcNMTEwOTAyMTgyMjM0WhcNMTIwOTAxMTgyMjM0WjBHMRYwFAYD
+
+  VQQDDA1zYW5kb3Iuc3p1ZWNzMRkwFwYKCZImiZPyLGQBGRYJZnUtYmVybGluMRIw
+
+  EAYKCZImiZPyLGQBGRYCZGUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
+
+  AQCfTZrRtSgalAtriDgJXfjkKscwioBTJiEE6q93AE5/ij9QKPKXIQarZ8ywW6rr
+
+  LNU8i5UgxmAczX0aSvGJcF+Hi4uUW6KrIa51q58eTgkspkNKe7/5PgHcRmKmd5M9
+
+  /ePlN732OogNekY6+mXLcUVpiEVxRpqHScA22pNeO4e7a3o8yHk9ck6PDbH8xYVS
+
+  phIOFhA21c2O2pQ/37umnF6oSC5lKIQqJOZG3Qvi8bcNIzEE5PaN/75lZaSdeTvF
+
+  PztwxxwruXkbWvnx7rVBNNTb7z7RhmWVkuYIhEZLPJR7cLvxqwLJBCBmEVEPUzTb
+
+  zmVnrI3P61Hxy2flPlUEHGVxAgMBAAGjOTA3MAkGA1UdEwQCMAAwHQYDVR0OBBYE
+
+  FMiNx8VcXneWW6aCihufDbjxN1O3MAsGA1UdDwQEAwIEsDANBgkqhkiG9w0BAQUF
+
+  AAOCAQEATfQiXAXiFR6EBQ55WsxLMlf1WITnkB59c8xlwtLRzhmeGQS4kNjaNuMG
+
+  fkkpJzLfpQLmUElsJDxTuTzwvoxP1u0dKCKbdduspJZbhPbJDQfdKa3TkvM+h9kT
+
+  OXBP3qpDrsfvDqfvFNxvKdDWDzYFYFGE90OVdBgFbOzCVbyGeFUk3sz2YKc1TKdz
+
+  9vfvKROAX09+XFbNgAQl1ZZ8rvH2MEQTjoFX71iyMkgdu7hhFEJ+HR0G58Vp8++O
+
+  WS4A5NGvEAx1OVMHEl5VSh1W94lT3X2h3RclUQZ3rt0WtDHj3a66cqKIDq/5FTlg
+
+  zON3JzXsfb7Swn/Rj4wwFwsjZVTngw==
+
+  -----END CERTIFICATE-----
+
+'
+date: 2011-09-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: &2153607580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153607580
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &2153607120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: *2153607120
+description: ! 'simple_ssh is a simple wrapper around the net-ssh gem.
+
+
+  * You want to execute a list of commands on a list of hosts using ssh?
+
+  * You want to analyze the results within a script?
+
+
+  If your answers for these questions are yes then simple_ssh is for you.'
+email:
+- sandor.szuecs@fu-berlin.de
+executables: []
+extensions: []
+extra_rdoc_files:
+- Manifest.txt
+files:
+- CHANGELOG.rdoc
+- LICENSE
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/simple_ssh.rb
+homepage: https://github.com/szuecs/simple_ssh
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+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: simple_ssh
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: simple_ssh is a simple wrapper around the net-ssh gem
+test_files: []