senedsa 0.0.5 → 0.0.7

data/README.md

@@ -11,33 +11,40 @@
 Options are as follows:
 
 	Senedsa options
-		-C, --config CONFIG              senedsa configuration file
+		-c, --config CONFIG              senedsa configuration file
 
 	NSCA options:
     	-H, --nsca_hostname HOSTNAME     NSCA server hostname                              [REQUIRED]
-    	-p, --nsca_port PORT             NSCA server port
+    	-P, --nsca_port PORT             NSCA server port
 
 	Send_Nsca options:
-	    -t, --send_nsca_timeout TIMEOUT  send_nsca connection timeout
-    	-d, --send_nsca_delim DELIM      send_nsca field delimited
-    	-c, --send_nsca_config CONFIG    send_nsca configuration file
-    	-b, --send_nsca_binary BINARY    send_nsca binary path
+	    -T, --send_nsca_timeout TIMEOUT  send_nsca connection timeout
+    	-D, --send_nsca_delim DELIM      send_nsca field delimited
+    	-C, --send_nsca_config CONFIG    send_nsca configuration file
+    	-B, --send_nsca_binary BINARY    send_nsca binary path
 
-	Service (svc_) options:
+	Service options:
     	-h, --svc_hostname HOSTNAME      service hostname                                  [REQUIRED]
     	-S, --svc_descr DESCR            service description                               [REQUIRED]
     	-s, --svc_status STATUS          service status: ok, warning, critical, unknown    [REQUIRED]
 
 	General options:
+		-d, --debug                      Enable debug mode
     	-a, --about                      Display senedsa information
     	-V, --version                    Display senedsa version
             --help                       Show this message
  
-With no options or arguments, `senedsa` displays help (as shown above). Options `-H`, `-h`, `-S` and `-s` are mandatory (unless specified in the configuration file); `svc_output` need not be quoted: anything passed as an argument is considered part of `svc_output`.
+With no options or arguments, `senedsa` displays help (as shown above). 
+
+Options `--nsca_hostname`, `--svc_hostname`, `--svc_descr` and `--svc_status` are mandatory (unless specified in the configuration file).
+
+ Finally, `svc_output` need not be quoted: anything passed as an argument is considered part of `svc_output`.
 
 # CONFIGURATION
 
-A YAML-based configuration (default location is `~/.senedsa/config`) can be used to set defaults for any option (except `senedsa_config`), which can then be overriden in the command line. This is useful, for instance, if the `send_nsca` binary is not in your PATH, its configuration file is not in the default location, or so that the NSCA server hostname need not be specified on the command line in every invocation. Use long option names to set the corresponding values:
+The priority of options is: command line options `>` configuration file options `>` default options
+
+A YAML-based configuration (default location is `~/.senedsa/config`) can be used to set defaults for any option (except `senedsa_config`), which can then be overriden in the command line. This is useful, for instance, if the `send_nsca` binary is not in the PATH, its configuration file is not in the default location, or so that the NSCA server hostname need not be specified on the command line in every invocation. Use long option names to set the corresponding values:
 
     ---
     :send_nsca_binary: /usr/local/bin/send_nsca
@@ -48,7 +55,7 @@ Thus, we can now run `senedsa` like so:
 
     senedsa -h myhost.example.com -S mypassiveservice -s ok Everthing ok with myservice
     
-In extreme cases, where `senedsa` is being used by some external script for a specific host and service (assume `send_nsca` is in the PATH and the configuration is its standard location), the configuration file `/etc/senedsa.foo` could be:
+In cases where `senedsa` is being used by some external script for a specific host and service (assuming `send_nsca` is in the PATH and the configuration is its standard location), the configuration file `/etc/senedsa/script_service` could be:
 
 	---
 	:nsca_hostname: nsca.example.com
@@ -57,22 +64,68 @@ In extreme cases, where `senedsa` is being used by some external script for a sp
 	
 Then, the script would invoke `senedsa` as follows:
 
-	senedsa -C /etc/senedsa.foo -s ok service is doing great
+	senedsa -c /etc/senedsa/script_service -s ok service is doing great
 
 # LIBRARY
 
-Using *Senedsa* as a library:
+To use *Senedsa* as a library, simply:
 
-    require 'senedsa/send_nsca'
+    require 'senedsa'
+    
+    svc_hostname = "foo.example.com"
+    svc_descr = "sample service description"
     
     begin
-      @send_nsca = SendNsca.new hostname, svc_descr, :nsca_hostname => nsca.example.com
-      @send_nsca.send(:ok,"Everything ok with my service")
+      s = SendNsca.new svc_hostname, svc_descr, :nsca_hostname => "nsca.example.com"
+      s.send :ok, "Everything ok with my service"
     rescue => e
       # rescue logic
     end
     
-If you wish to use a configuration file to set defaults:
+## CONSTRUCTORS
+
+*Senedsa* accepts four different constructors, aimed at fitting different situations.
+
+* `(SendNsca) initialize(config_file)`
+* `(SendNsca) initialize(config_hash)`
+* `(SendNsca) initialize(svc_hostname,svc_descr)`
+* `(SendNsca) initialize(svc_hostname,svc_descr,config_hash)`
+
+Where:
+
+* `config_file` is a path to a valid configuration file
+* `config_hash` is a hash keyed by long option names with their corresponding values
+* `svc_hostname` is the hostname of the service hostname
+* `svc_descr` is the service description of the service
+
+An instance does not need all options defined until the `send` method is invoked.
+
+## DEFAULTS
+
+`Senedsa` has sensible defaults for the following options, mostly following `send_nsca`'s documented defaults:
+
+* `nsca_port = 5667`
+* `send_nsca_timeout = 10`
+* `send_nsca_delim = '\t'`
+* `send_nsca_binary = 'send_nsca'`
+
+It is therefore not necessary to set these if your environment doesn't need them changed.
+
+## SETTERS, GETTERS and CONFIGURATION FILES
+
+All options are settable (and gettable) through attribute methods. For instance:
+
+	sn = SendNsca.new "foo.example.com", "web_service"
+	sn.nsca_hostname = "nsca.example.com"
+	sn.send :ok, "Service ok"
+	
+Another example:
+
+	sn = SendNsca.new "foo.example.com", "web_service", :nsca_hostname => "nsca.example.com"
+	sn.nsca_port = 55667
+	sn.send :ok, Service ok"
+
+If you wish to use a configuration file to set some defaults:
 
 	---
 	:nsca_hostname: nsca.example.com
@@ -80,34 +133,15 @@ If you wish to use a configuration file to set defaults:
 
 Then:
 
-	begin
-	  cfg_options = SendNsca.configure(cfg_file)
-      @send_nsca = SendNsca.new hostname, svc_descr, cfg_options
-      @send_nsca.send(:ok,"Everything ok with my service")
-    rescue => e
-      # rescue logic
-    end
+	config_file = '/etc/senedsa.cfg'
+    s = SendNsca.new config_file
+    s.svc_descr = "web_service"
+    s = s.send :ok, "Everything ok with web_service"
 
-Alternatively, you can set defaults in the `SendNsca` class before creating any instances:
+Alternatively you can set defaults in the `SendNsca` class before creating any instances:
 
     SendNsca.defaults[:nsca_hostname] = "nsca.example.com"
-    @send_nsca = SendNsca.new svc_hostname, svc_descr
-    @send_nsca.send :ok, "Everything ok with my service"
-
-After a SendNsca instance is created, changing the defaults has no effect on said instance. You must then make changes to the instance itself:
-
-	@send_nsca = SendNsca.new hostname, svc_descr
-	@send_nsca.hostname = "nsca.example.com"
-    
-If you have multiple services in the same host:
+    s = SendNsca.new svc_hostname, svc_descr
+    s.send :ok, "Everything ok with my service"
 
-	SendNsca.nsca.hostname = "nsca.example.com"                      # default NSCA server
-	SendNsca.send_nsca.binary = "/usr/local/bin/send_nsca"           # default binary location
-	SendNsca.send_nsca.config = "/local/etc/nagios/send_nsca.cfg"    # default config location
-	
-	svc1 = SendNsca.new hostname, "service 1"
-	svc2 = SendNsca.new hostname, "service 2"
-	
-	svc1.send :warning, "Service is flaking out"
-	svc2.send :critical, "Service is dead"
-	
+After a SendNsca instance is created, changing the defaults has no effect on said instance. You must then make changes to the instance itself.

data/bin/senedsa

@@ -4,6 +4,7 @@ lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
 $LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
 
 require 'senedsa'
+require 'senedsa/cli'
 
 module Senedsa
 

data/lib/senedsa/cli.rb

@@ -6,13 +6,13 @@ module Senedsa
   class CLI
 
     ID = File.basename($PROGRAM_NAME).to_sym
-    CFGFILE = File.join(ENV['HOME'],"/.#{ID}/config")
+    DEFAULT_CONFIG_FILE = File.join(ENV['HOME'],"/.#{ID}/config")
 
     attr_reader :options
 
     def initialize(arguments)
       @arguments = arguments
-      @cli_options = { :senedsa_config => CFGFILE, :debug => false }
+      @cli_options = { :debug => false }
       @options = {}
     end
 
@@ -22,12 +22,12 @@ module Senedsa
         config_options?
         arguments_valid?
         options_valid?
-      rescue ArgumentError, OptionParser::MissingArgument, StandardError => e
+        process_options
+        process_arguments
+        process_command
+      rescue ArgumentError, OptionParser::MissingArgument, SendNsca::ConfigurationError => e
         output_message e.message, 1
       end
-      process_options
-      process_arguments
-      process_command
     end
 
     protected
@@ -39,19 +39,19 @@ module Senedsa
           opts.separator ""
 
           opts.separator "Senedsa options"
-          opts.on('-C', '--config CONFIG',               String,                 "senedsa configuration file")                         { |config|    @cli_options[:senedsa_config] = config }
+          opts.on('-c', '--config CONFIG',               String,                 "senedsa configuration file")                         { |config|    @cli_options[:senedsa_config] = config }
           opts.separator ""
 
           opts.separator "NSCA options:"
           opts.on('-H', '--nsca_hostname HOSTNAME',      String,                 "NSCA server hostname")                               { |hostname|  @cli_options[:nsca_hostname] = hostname }
-          opts.on('-p', '--nsca_port PORT',              Integer,                "NSCA server port")                                   { |port|      @cli_options[:nsca_port] = port }
+          opts.on('-P', '--nsca_port PORT',              Integer,                "NSCA server port")                                   { |port|      @cli_options[:nsca_port] = port }
           opts.separator ""
 
           opts.separator "Send_Nsca options:"
-          opts.on('-t', '--send_nsca-timeout TIMEOUT',   Integer,                "send_nsca connection timeout")                       { |timeout|   @cli_options[:send_nsca_timeout] = timeout }
-          opts.on('-d', '--send_nsca-delim DELIM',       String,                 "send_nsca field delimited")                          { |delim|     @cli_options[:send_nsca_delim] = delim }
-          opts.on('-c', '--send_nsca-config CONFIG',     String,                 "send_nsca configuration file")                       { |config|    @cli_options[:send_nsca_config] = config }
-          opts.on('-b', '--send_nsca-binary BINARY',     String,                 "send_nsca binary path")                              { |binary|    @cli_options[:send_nsca_binary] = binary }
+          opts.on('-T', '--send_nsca-timeout TIMEOUT',   Integer,                "send_nsca connection timeout")                       { |timeout|   @cli_options[:send_nsca_timeout] = timeout }
+          opts.on('-D', '--send_nsca-delim DELIM',       String,                 "send_nsca field delimited")                          { |delim|     @cli_options[:send_nsca_delim] = delim }
+          opts.on('-C', '--send_nsca-config CONFIG',     String,                 "send_nsca configuration file")                       { |config|    @cli_options[:send_nsca_config] = config }
+          opts.on('-B', '--send_nsca-binary BINARY',     String,                 "send_nsca binary path")                              { |binary|    @cli_options[:send_nsca_binary] = binary }
           opts.separator ""
 
           opts.separator "Service options:"
@@ -61,9 +61,10 @@ module Senedsa
           opts.separator ""
 
           opts.separator "General options:"
+          opts.on('-d', '--debug',                                               "Enable debug mode")                                  { @cli_options[:debug] = true}
           opts.on('-a', '--about',                                               "Display #{ID} information")                          { output_message ABOUT, 0 }
           opts.on('-V', '--version',                                             "Display #{ID} version")                              { output_message VERSION, 0 }
-          opts.on_tail('--help',                                                 "Show this message")                                  { output_message opts; exit 0 }
+          opts.on_tail('--help',                                                 "Show this message")                                  { output_message opts 0 }
 
           output_message opts, 0 if @arguments.size == 0
 
@@ -74,10 +75,13 @@ module Senedsa
       end
 
       def config_options?
-        cfg_options = SendNsca.configure(@cli_options[:senedsa_config])
-        raise
-        cfg_options.delete(:senedsa_config) unless cfg_options[:senedsa_config].nil?
-        @options.merge!(cfg_options)
+        cfg_file = @cli_options[:senedsa_config] unless @cli_options[:senedsa_config].nil?
+        cfg_file = DEFAULT_CONFIG_FILE if @cli_options[:senedsa_config].nil? and File.readable? DEFAULT_CONFIG_FILE
+
+        unless cfg_file.nil?
+          @options.merge!(SendNsca.configure(cfg_file))
+          @options[:senedsa_config] = cfg_file
+        end
       end
 
       def options_valid?
@@ -98,7 +102,7 @@ module Senedsa
       end
 
       def process_arguments
-        @arguments = @arguments.join(' ')
+        @cli_options[:svc_output] = @arguments.join(' ')
       end
 
       def output_message(message, exitstatus=nil)
@@ -109,10 +113,13 @@ module Senedsa
 
       def process_command
         begin
-          @send_nsca = SendNsca.new @options[:svc_hostname], @options[:svc_descr], @options
-          @send_nsca.send(@options[:svc_status],@arguments)
+          SendNsca.new(@options).send
         rescue => e
-          output_message e.message, 1
+          if @options[:debug]
+            output_message "%s\n%s" % [e.message,e.backtrace.join("\n   ")], 1
+          else
+            output_message e.message,1
+          end
         end
         exit 0
       end

data/lib/senedsa/send_nsca.rb

@@ -28,13 +28,17 @@ module Senedsa
       attr_accessor :defaults end
 
       def self.configure(cfg_file)
-        begin
-          cfg_options = YAML.load File.open(cfg_file)
-          raise ConfigurationError, "senedsa_config not allowed in configuration file (#{cfg_file})" unless cfg_options[:senedsa_config].nil?
-        rescue Psych::SyntaxError => e
-          raise StandardError, "syntax error in configuration file #{cfg_file}: #{e.message}"
-        rescue Errno::ENOENT, Errno::EACCES => e
-          raise StandardError, e.message
+        cfg_options = {}
+        unless cfg_file.nil?
+          raise ConfigurationError, "unable to read configuration file #{cfg_file}" unless File.readable? cfg_file
+          begin
+            cfg_options = YAML.load File.open(cfg_file)
+            raise ConfigurationError, "senedsa_config not allowed in configuration file (#{cfg_file})" unless cfg_options[:senedsa_config].nil?
+          rescue Psych::SyntaxError => e
+            raise ConfigurationError, "syntax error in configuration file #{cfg_file}: #{e.message}"
+          rescue Errno::ENOENT, Errno::EACCES => e
+           raise ConfigurationError, e.message
+          end
         end
         cfg_options
       end
@@ -44,11 +48,41 @@ module Senedsa
     class Error < StandardError; end
     class SendNscaError < Error; end
     class ConfigurationError < SendNscaError; end
+    class InitializationError < SendNscaError; end
+
+    def initialize(*args)
+
+      case args.size
+
+        when 1
+          if args[0].is_a? String
+            cfg_options = SendNsca.configure(args[0])
+            hsh_options = {}
+          elsif args[0].is_a? Hash
+            cfg_options = SendNsca.configure(args[0][:senedsa_config])
+            hsh_options = args[0]
+          else
+            raise InitializationError, "invalid argument types"
+          end
 
-    def initialize(svc_hostname,svc_descr,options)
-      @options = options.nil? ? SendNsca.defaults : SendNsca.defaults.merge(options)
-      @options[:svc_hostname] = svc_hostname
-      @options[:svc_descr] = svc_descr
+        when 2
+          raise InitializationError, "invalid argument types" unless args[0].is_a? String and args[1].is_a? String
+          cfg_options = SendNsca.configure(args[0][:senedsa_config])
+          hsh_options = { :svc_hostname => args[0], :svc_descr => args[1] }
+
+        when 3
+          raise InitializationError, "invalid argument types" unless args[0].is_a? String and args[1].is_a? String and args[2].is_a? Hash
+          cfg_options = SendNsca.configure(args[0][:senedsa_config])
+          hsh_options = args[2].merge({ :svc_hostname => args[0], :svc_descr => args[1] })
+
+        else
+          raise InitializationError, "invalid number of arguments"
+      end
+      @options = SendNsca.defaults.merge(cfg_options).merge(hsh_options)
+    end
+
+    def send(*args)
+      run(@options[:status],@options[:svc_output])
     end
 
     SendNsca.defaults.keys.each do |attr|
@@ -56,10 +90,6 @@ module Senedsa
       define_method(attr.to_s + '=') { |value| @options[attr.to_sym] = value }
     end
 
-    def send(status,svc_output)
-      run(status,svc_output)
-    end
-
     private
 
       def command

data/lib/senedsa/version.rb

@@ -1,3 +1,3 @@
 module Senedsa
-  VERSION = '0.0.5'
+  VERSION = '0.0.7'
 end

data/lib/senedsa.rb

@@ -1,7 +1,6 @@
 require 'senedsa/version'
 require 'senedsa/about'
 require 'senedsa/send_nsca'
-require 'senedsa/cli'
 
 module Senedsa
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: senedsa
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-29 00:00:00.000000000 Z
+date: 2012-05-30 00:00:00.000000000 Z
 dependencies: []
 description: Senedsa is a small utility and library wrapper for the Nagios send_nsca.
 email: gerir@evernote.com