runsible 0.1.4.3 → 0.1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d98266f134d55a614fb28d95ef94fd025cb748fa
-  data.tar.gz: c003878d2bf6afc4c7a1dc095c0a08cf66306a6d
+  metadata.gz: 3c6e97e7684c0473f0b015ef7458fd181e3758aa
+  data.tar.gz: 0683c11734db25fb288d7c27ccc0ec15dfb607c1
 SHA512:
-  metadata.gz: b6378116f873e96a2f421cf9ce9be3b999be0741bd99fb8d40f3501b55cf75049e7cdf49691840cc056ef9c68d3b21159ea5509f019ecb92949a47381fda0d02
-  data.tar.gz: 733f030f5f7b692a090f9e47dcf466533d6ba8a922f37c3d3f93550fd881937b48b8605d1a147dd915a9b8197dd6e857dc3dbbcec71e3b42058137174c4a6d80
+  metadata.gz: ec0617e974d77b203aeb318c14c9ec132e1f3907cde4ef02b4e68185559d018931993eb33b7fb82bf630b0abc509e750ea749a6909d789df136eaa15180e8302
+  data.tar.gz: efea1d51af58e32a02ff17a49b85ecc8b29da012c47357245d681e78b053ea9c31cfc990355d575a4f3bffecf310d8044baaa772ab236a44316f1fd7c14977f9

data/VERSION

@@ -1 +1 @@
-0.1.4.3
+0.1.4.5

data/lib/runsible.rb

@@ -26,10 +26,12 @@ module Runsible
   # Utility stuff
   #
 
+  # provide a better string representation for all Exceptions
   def self.excp(excp)
     "#{excp.class}: #{excp.message}"
   end
 
+  # return SETTINGS with string keys
   def self.default_settings
     hsh = {}
     SETTINGS.each { |sym, v|
@@ -38,10 +40,12 @@ module Runsible
     hsh
   end
 
+  # read VERSION from filesystem
   def self.version
     File.read(File.join(__dir__, '..', 'VERSION'))
   end
 
+  # send alert depending on settings['alerts']['backend']
   def self.alert(topic, message, settings)
     backend = settings['alerts'] && settings['alerts']['backend']
     case backend
@@ -60,11 +64,13 @@ module Runsible
     end
   end
 
+  # send warnings to both STDOUT and STDERR
   def self.warn(msg)
     $stdout.puts msg
     $stderr.puts msg
   end
 
+  # warn, alert, exit 1
   def self.die!(msg, settings)
     self.warn(msg)
     self.alert("runsible:fatal:#{Process.pid}", msg, settings)
@@ -85,6 +91,7 @@ module Runsible
     self.ssh_runlist(settings, yaml['runlist'] || Array.new, ssh_options, yaml)
   end
 
+  # parse CLI arguments
   def self.slop_parse
     d = SETTINGS # display defaults
     Slop.parse do |o|
@@ -109,6 +116,7 @@ module Runsible
     end
   end
 
+  # load yaml from CLI arguments
   def self.extract_yaml(opts)
     yaml_filename = opts.arguments.shift
     self.usage(opts, "yaml_file is required") if yaml_filename.nil?
@@ -121,6 +129,7 @@ module Runsible
     yaml
   end
 
+  # provide a friendly message for the user
   def self.usage(opts, msg=nil)
     puts opts
     puts
@@ -234,6 +243,8 @@ module Runsible
   # Necessities
   #
 
+  # opts has symbol keys, overrides settings (string keys)
+  # return a hash with string keys
   def self.merge(opts, settings)
     Runsible::SETTINGS.keys.each { |sym|
       settings[sym.to_s] = opts[sym] if opts[sym]
@@ -242,18 +253,22 @@ module Runsible
     settings
   end
 
+  # delimits the beginning of command output
   def self.begin_banner(msg)
     "RUNSIBLE >>> [#{self.timestamp}] >>> #{msg} >>>>>"
   end
 
+  # delimits the end of command output
   def self.end_banner(msg)
     "<<<<< #{msg} <<< [#{self.timestamp}] <<< RUNSIBLE"
   end
 
+  # self-explanatory
   def self.timestamp(t = Time.now)
     t.strftime("%b%d %H:%M:%S")
   end
 
+  # display begin/end banners, yielding to the block in between
   def self.banner_wrap(msg)
     self.warn self.begin_banner(msg)
     val = block_given? ? yield : true

data/runsible.gemspec

@@ -21,6 +21,4 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'pony', '~> 1.0'
 
   s.add_development_dependency 'buildar', '~> 2.0'
-
-  s.has_rdoc = false
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runsible
 version: !ruby/object:Gem::Version
-  version: 0.1.4.3
+  version: 0.1.4.5
 platform: ruby
 authors:
 - Rick Hull