fissher 1.0.2 → 1.0.3

data/README.rdoc

@@ -5,16 +5,18 @@ Fissher is a simple utility to run commands on multiple servers, powered by Net:
 
 === Usage
 
-  fissher [flags] [command]
-    -G Hostgroup       Execute command on all hosts listed in the JSON config for the
-                       specified group.
-    -H Host1,Host2     Execute command on hosts listed on the command line
-    -g jumpbox         Manually specify/override a jump server, if necessary.
-    -s 		     Execute the provided commands with sudo.
-    -u username        Manually specify/override username to connect with.
-    -p                 Use password based authentication, specified via STDIN
-    -c config.json     Manually specify the path to your fissher config file
-    -n num             Number of concurrent connections. Enter 0 for unlimited.
+  fissher [flags] [command]:
+  -G Hostgroup       Execute command on all hosts listed in the JSON config for
+                     the specified group.
+  -H Host1,Host2     Execute command on hosts listed on the command line
+  -g jumpbox         Manually specify/override a jump server, if necessary.
+  -s 		   Execute the provided commands with sudo.
+  -u username        Manually specify/override username to connect with.
+  -p                 Use password based authentication, specified via STDIN
+  -c config.json     Manually specify the path to your fissher config file
+  -n num             Number of concurrent connections. Enter 0 for unlimited.
+  -U username	   Specify an alternate user in conjunction with -s
+                   (E.G. -U webmaster)
 
 === Installation
 

data/etc/fissher.conf.sample

@@ -2,6 +2,7 @@
   "user": "user",				   // Default user name
   "concurrency": "10", 				   // Set to 0 to disable max concurrency
   "default_gateway": "jumpbox1.sampledomain.com",  // Default jump box, if needed.
+  "enable_password": "false", 			   // Set this to true to enable -p by default.
   "hostgroups": {				   
     "app": {
       "gateway": "jumpbox2.sampledomain.com",  // Override the default

data/lib/fissher_base.rb

@@ -6,7 +6,9 @@ require 'net/ssh/multi'
 require 'fissher_conf'
 include FissherConf
 
+# Main class. This one does all the dirty work.
 class FissherBase
+  # The guts of the app. This handles putting everything together and running the commands via Net::SSH::Multi.
   def go_time
     opts = FissherConf.handle_opts unless !opts.nil?
     abort "No hosts specified! Please use -H or -G!\n" unless !opts[:hostlist].nil?

data/lib/fissher_conf.rb

@@ -7,13 +7,26 @@ require 'json'
 require 'highline/import'
 require 'getopt/std'
 
+# Module for all aspects of configuration within fissher.
 module FissherConf
+  
+  # Misc methods for doing dirty work within the app.
   class Misc
+    
+    # A wrapper function used to request the password from stdin.
+    #
+    # @param prompt [String] The banner displayed to the user.
+    # @return [String] The password, as entered by the user.
     def getpass(prompt="Enter remote password: ")
       ask(prompt) {|q| q.echo = false}
     end
 
     # Method for returning hosts from hostgroup.
+    #
+    # @param grp [String] The hostgroup, contained within the config.
+    # @param conf [Hash] The parsed configuration file
+    # @param conf_file [String] The configuration file, with path.
+    # @return [Array] An array of the hosts contained in the hostgroup within the config file.
     def group_hosts( grp,conf,conf_file )
       if conf[:hostgroups][:"#{grp}"] 
         conf[:hostgroups][:"#{grp}"][:hosts]
@@ -23,26 +36,33 @@ module FissherConf
     end
   end
 
+  # Print usage message
   def usage
-    puts "#{$0} [flags] [command]:\n"
-    puts "-G Hostgroup       Execute command on all hosts listed in the JSON config for the\n"
-    puts "                   specified group.\n"
+    app = File.basename($0)
+    puts "#{app} [flags] [command]:\n"
+    puts "-G Hostgroup       Execute command on all hosts listed in the JSON config for \n"
+    puts "                   the specified group.\n"
     puts "-H Host1,Host2     Execute command on hosts listed on the command line\n"
     puts "-g jumpbox         Manually specify/override a jump server, if necessary.\n"
-    puts "-s 		     Execute the provided commands with sudo."
+    puts "-s 		   Execute the provided commands with sudo."
     puts "-u username        Manually specify/override username to connect with.\n"
     puts "-p                 Use password based authentication, specified via STDIN\n"
     puts "-c config.json     Manually specify the path to your fissher config file\n"
     puts "-n num             Number of concurrent connections. Enter 0 for unlimited.\n"
-    puts "-U username	     Specify an alternate user in conjunction with -s (E.G. -U webmaster)\n"
+    puts "-U username	   Specify an alternate user in conjunction with -s\n" 
+    puts "                   (E.G. -U webmaster)\n"
   end
 
+  # A shortcut method to make errors a little more graceful.
+  #
+  # @param msg [String] the message to be displayed before the usage message.
   def die( msg )
     puts "#{msg}\n"
     usage
     exit 1
   end
 
+  # Parse command line options using getopt and options within the json config file.
   def handle_opts
     opt = Getopt::Std.getopts("pc:g:G:u:n:sH:hU:")
     ret = Hash.new
@@ -141,14 +161,6 @@ EOB
       end
     end
 
-    # Get our account password
-    if opt["p"]
-      p = Misc.new
-      ret[:password] = p.getpass()
-    else
-      ret[:password] = nil
-    end
-    
     # Our command
     if ARGV.count >= 1
       if sudo_cmd
@@ -159,6 +171,15 @@ EOB
     else
       die "No command specified!\n" unless !ret[:command].nil?
     end
+
+    # Get our account password
+    if (opt["p"] || config[:enable_password] == 'true')
+      p = Misc.new
+      ret[:password] = p.getpass()
+    else
+      ret[:password] = nil
+    end
+    
     ret
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fissher
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -113,3 +113,4 @@ signing_key:
 specification_version: 3
 summary: Fissher
 test_files: []
+has_rdoc: