sshelper 0.0.1 → 0.1.0

data/README.md

@@ -1,24 +1,79 @@
 # Sshelper
 
-TODO: Write a gem description
+This gem is supposed to make your life easier if you have to do a lot of repetitive tasks over SSH. If you are sick 
+of doing the constant ```ssh user@example.org```, ```cd /opt/path/to/something```, ```./start.sh``` 
+etc, then this tool is for you!
+
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install it as follows:
 
-    gem 'sshelper'
+    $ gem install sshelper
 
-And then execute:
+## Usage
 
-    $ bundle
+After installation, you will have to create a '.sshelper.json' file in your home directory:
 
-Or install it yourself as:
+    $ touch ~/.sshelper.json
 
-    $ gem install sshelper
+Or, you can use the built in functionality to generate a template:
 
-## Usage
+    $ sshelper -t
+    
+Open it in your favorite editor:
+
+    $ nano ~/.sshelper.json
+    
+And use the following structure to add labels:
+```
+{
+  "my_label1": {
+    "description": "View the content of the newest file on example.org and test.com",
+    "servers": [
+        {
+          "host": "example.org",
+          "port": 22,
+          "user": "root"
+        },
+        {
+          "host": "test.com",
+          "port": 1234,
+          "user": "eddy"
+        }
+      ],
+    "commands": [
+        "ls -l",
+        "cat `ls -1rt | tail -1`"
+      ]
+  },
+  "my_label2": {
+    "description": "List 1 file on example.org"
+    "servers": [
+        {
+          "host": "example.org",
+          "port": 22,
+          "user": "root"
+        }
+      ],
+    "commands": [
+        "ls -1"
+      ]
+  }
+}
+
+```
+
+After you have added a configuration file with labels, servers and commands, you can do stuff like this:
+
+    $ sshelper my_label1
+    
+This will execute all commands defined under "my_label1" on all servers defined under that same block! Talking about
+enhancing your workflow...
+
+To list all the labels you have defined, you can do:
 
-TODO: Write usage instructions here
+    $ sshelper -l
 
 ## Contributing
 

data/bin/sshelper

@@ -2,15 +2,38 @@
 
 require 'sshelper'
 require 'optparse'
+require 'fileutils'
 
-Sshelper.prepare!
+trap("SIGINT") { puts "\nExiting...\n"; exit! }
 
 options = {}
  
 global = OptionParser.new do |opts|
   opts.banner = "Usage: sshelper [your_label]\n\n"
+  opts.on("-l", "--labels", "Show all labels") do
+    puts "Usage: sshelper [your_label]\n\n"
+    puts "Labels:"
+    Sshelper.prepare!
+    Sshelper.configuration.each do |key, value|
+      puts "\t#{key.to_s}: #{value.description}"
+    end
+    puts "\n\n"
+    exit!
+  end
+  
+  opts.on("-t", "--template", "Place a template configuration at ~/.sshelper.json") do
+    template = IO.read(File.expand_path('../../resources/template.json', __FILE__))
+    File.open(File.expand_path("~/.sshelper.json"), "w") { |f| f.write template }
+    exit!
+  end
 end
 
+global.order!
+command = ARGV.shift
+puts global if command.nil?
+
+Sshelper.prepare!
+
 subcommands = {}
 
 Sshelper.configuration.each do |key, value|
@@ -19,9 +42,6 @@ Sshelper.configuration.each do |key, value|
   end
 end
 
-global.order!
-command = ARGV.shift
-puts global if command.nil?
 subcommands[command].order! if subcommands.member? command
 
 Sshelper.execute_label command

data/lib/sshelper.rb

@@ -1,8 +1,11 @@
 require "sshelper/version"
 require "sshelper/hash"
+require "sshelper/string"
 require "net/ssh"
+require "net/ssh/telnet"
 require "json"
 require "fileutils"
+require "socket"
 
 module Sshelper
   @config
@@ -37,13 +40,18 @@ module Sshelper
     
     @config[label].servers.each do |server|
       port = (server.include?("port") ? server.port : 22)
-      Net::SSH.start(server.host, server.user, :port => port) do |ssh|
-        @config[label].commands.each do |command|
-          puts ssh.exec!(command)
-        end
+      ssh = Net::SSH.start(server.host, server.user, :port => port)
+      s = Net::SSH::Telnet.new("Session" => ssh)
+      puts "Logged in".pink
+      @config[label].commands.each do |command|
+        puts "\nExecuting: #{command}".red
+        puts '#### OUTPUT ####'.blue
+        puts "#{s.cmd(command).split("\n").join("\n ~> ")}"
+        puts '#### END ####'.blue
       end
-    end
-    
+      s.close
+      ssh.close
+    end   
   end
   
   def self.configuration

data/lib/sshelper/string.rb

@@ -0,0 +1,25 @@
+class String
+  def colorize(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def red
+    colorize(31)
+  end
+
+  def green
+    colorize(32)
+  end
+
+  def yellow
+    colorize(33)
+  end
+  
+  def blue
+    colorize(34)
+  end
+
+  def pink
+    colorize(35)
+  end
+end

data/lib/sshelper/version.rb

@@ -1,3 +1,3 @@
 module Sshelper
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/resources/template.json

@@ -0,0 +1,16 @@
+{
+  "my_label1": {
+    "description": "some description",
+    "servers": [
+        {
+          "host": "my.host.com",
+          "port": 22,
+          "user": "my_user"
+        }
+      ],
+    "commands": [ 
+        "cd /opt",
+        "ls -l"
+      ]
+  }
+}

data/sshelper.gemspec

@@ -22,5 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   
-  spec.add_dependency "net-ssh"
+  spec.add_dependency "net-ssh", "~> 2.1.0"
+  spec.add_dependency "net-ssh-telnet"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshelper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-30 00:00:00.000000000 Z
+date: 2013-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,6 +61,22 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: net-ssh-telnet
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -93,7 +109,9 @@ files:
 - bin/sshelper
 - lib/sshelper.rb
 - lib/sshelper/hash.rb
+- lib/sshelper/string.rb
 - lib/sshelper/version.rb
+- resources/template.json
 - spec/spec_helper.rb
 - spec/sshelper_spec.rb
 - sshelper.gemspec