nagira 0.5.1 → 0.5.2

data/app/filters/configure.rb

@@ -0,0 +1,34 @@
+class Nagira < Sinatra::Base
+  set :app_file, __FILE__
+
+  Dir["#{Nagira::BASE}/app/{parsers,writers,loggers}/*.rb"].each { |file| require file }
+
+  ##
+  # Do some necessary tasks at start and then run Sinatra app.
+  #
+  # @method   startup_configuration
+  # @overload before("Initial Config")
+  configure do
+
+    Parser.config   = settings.nagios_cfg
+    Parser.status   = settings.status_cfg   || Parser.config.status_file
+    Parser.objects  = settings.objects_cfg  || Parser.config.object_cache_file
+
+    Writer.commands = settings.command_file || Parser.config.command_file
+
+    BackgroundParser.ttl    = ::DEFAULT[:ttl].to_i
+    BackgroundParser.start  = ::DEFAULT[:start_background_parser]
+
+    Logger.log "Starting Nagira application"
+    Logger.log "Version #{Nagira::VERSION}"
+    Logger.log "Running in #{Nagira.settings.environment} environment"
+
+    Parser.state.to_h.keys.each do |x|
+      Logger.log "Using nagios #{x} file: #{Parser.state[x].path}"
+    end
+    Logger.log "Using nagios command file: #{Writer.commands.path}"
+
+    BackgroundParser.run if BackgroundParser.configured?
+  end
+
+end

data/app/helpers/put_helpers.rb

@@ -0,0 +1,11 @@
+class Nagira < Sinatra::Base
+
+
+    # Small helper to submit data to ::Nagios::ExternalCommands
+    # object. For status updates sends external coond via
+    # ::Nagios::ExternalCommands.send method.
+    def update_service_status params
+      Writer.new(:PROCESS_SERVICE_CHECK_RESULT).put params
+    end
+
+end

data/{lib/nagira → app/parsers}/parser.rb

@@ -8,7 +8,6 @@ class Nagira < Sinatra::Base
   #    Parser.config   = < path to nagios.cfg file>
   #    Parser.status   = < path to status.cfg file>
   #    Parser.objects  = < path to object_cache file>
-  #    Parser.commands = < path to the external command execution file >
   #
   class Parser
     include Singleton
@@ -95,16 +94,9 @@ class Nagira < Sinatra::Base
       def objects
         state
           .send(with_inflight?(:objects))
-          .objects
+          .objects || []
       end
 
-      def commands=(commands_file)
-        state.commands = Nagios::ExternalCommands.new(commands_file)
-      end
-
-      def commands
-        state.commands
-      end
     end
   end
 end

data/app/routes/get.rb

@@ -0,0 +1,50 @@
+class Nagira < Sinatra::Base
+
+  ##
+  # @method get_api
+  # @overload get(/_api)
+  #
+  # Provide information about API routes
+  #
+  get "/_api" do
+    ApiHelpController.get
+  end
+
+  ##
+  # @method get_runtime_config
+  # @overload get(/_runtime)
+  #
+  # Print out nagira runtime configuration
+  get "/_runtime" do
+    {
+      application: self.class,
+      version: VERSION,
+      runtime: {
+        environment: Nagira.settings.environment,
+        home: ENV['HOME'],
+        user: ENV['LOGNAME'],
+        nagiosFiles: Parser.state.to_h.keys.map {  |x| {  x:  Parser.state.to_h[x].path }},
+        commandFile: Writer.commands.path
+      }
+    }
+  end
+
+  # @method get_slash
+  # @overload get(/)
+  #
+  # Returns application information: name, version, github repository.
+  get "/" do
+    {
+      :application => self.class,
+      :version => VERSION,
+      :source => GITHUB,
+      :apiUrl => request.url.sub(/\/$/,'') + "/_api",
+    }
+  end
+  # Other resources in parsed status file. Supported are => ["hosts",
+  # "info", "process", "contacts"]
+  # get "/:resource" do |resource|
+  #   respond_with $nagios.status[resource], @format
+  # end
+
+end

data/app/routes/get/config.rb

@@ -0,0 +1,11 @@
+class Nagira < Sinatra::Base
+
+  # @method get_config
+  # @overload get("/_config")
+  #
+  # Get Nagios configuration hash form parsing main Nagios
+  # configuration file nagios.cfg
+  get "/_config" do
+    Parser.config.configuration
+  end
+end

data/app/{get → routes/get}/objects.rb

@@ -1,8 +1,8 @@
 class Nagira < Sinatra::Base
+  include OutputTypeable
   #
   # Objects routes
   # ============================================================
-
   ##
   # @method get_objects
   #
@@ -14,13 +14,7 @@ class Nagira < Sinatra::Base
   # @macro list
   #
   get "/_objects" do
-
-    @data = begin
-              @output == :list ? @objects.keys : @objects
-            rescue NoMethodError
-              nil
-            end
-    nil
+    body_with_list @objects
   end
 
   ##
@@ -34,15 +28,7 @@ class Nagira < Sinatra::Base
   #
   #
   get "/_objects/:type" do |type|
-    begin
-      @data = @objects[type.to_sym]
-      @data = @data.keys if @output == :list
-
-    rescue NoMethodError
-      nil
-    end
-
-    nil
+    body_with_list @objects[type.to_sym]
   end
 
   ##
@@ -57,12 +43,6 @@ class Nagira < Sinatra::Base
   # * none
   #
   get "/_objects/:type/:name" do |type,name|
-    begin
-      @data = @objects[type.to_sym][name]
-    rescue NoMethodError
-      nil
-    end
-
-    nil
+    @objects[type.to_sym][name]
   end
 end

data/app/routes/get/status.rb

@@ -0,0 +1,98 @@
+require_relative 'status/hostgroups'
+require_relative 'status/servicegroups'
+
+class Nagira < Sinatra::Base
+
+  ##
+  # @method get_status_hostname_services_service_name
+  # @overload get("/_status/:hostname/_services/:service_name")
+  #
+  # @!macro hostname
+  # @!macro service_name
+  #
+  # Full or short status information for single service on single
+  # host.
+  #
+  # @!macro accepted
+  # @!macro state
+  #
+  get "/_status/:hostname/_services/:service_name" do |hostname,service|
+    ServiceStatusController.new(
+      @status, hostname: hostname, service_name: service, output: @output
+    ).get
+  end
+
+  ##
+  # @method get_status_hostname_services
+  # @!macro hostname
+  #
+  # Endpoints:
+  # -  GET /_status/:hostname/_services
+  # -  GET /_status/:hostname/_hostcomments
+  # -  GET /_status/:hostname/_servicecomments
+  #
+  # Read +services+, +hostcomments+ or +servicecomments+ for single
+  # host.
+  #
+  # @!macro accepted
+  # @!macro state
+  # @!macro list
+  # @!macro full
+  get %r{^/_status/(?<hostname>#{hostname_regex})/_(?<resource>(services|hostcomments|servicecomments))$} do |hostname,resource|
+
+    # hostname = hostname.to_i if hostname =~ /^\d+$/
+    ResourceStatusController.new(
+      @status, hostname: hostname, output: @output, resource: resource
+    ).get
+
+  end
+
+  ##
+  # @method get_status
+  #
+  # Return all hosts status.
+  #
+  # If no output modifier provided, outputs full hosttatus information
+  # for each host. Not including services information. When +_full+
+  # modifier is provided data include hoststatus, servicestatus and
+  # all comments (servicecomments and hostcomments) for hosts.
+  #
+  # Alias: get /_status is the same thing as get /_status/_hosts with
+  # ActiveResource compatibility, i.e. for */_hosts request Nagira
+  # returns array instead of hash.
+  #
+  # @!macro accepted
+  # @!macro state
+  # @!macro list
+  # @!macro full
+  #
+  # Support for (see API):
+  # - plural resources: N/A
+  # - object access by ID: N/A
+
+  get %r{^/_status(/_hosts)?$} do
+    HostStatusController.new(@status, output: @output).get
+  end
+
+  # Hoststatus for single host or all services.
+  #
+  # @method get_status_hostname
+  #
+  # Endpoint
+  #
+  # - get "/_status/:hostname"
+  #
+  # @!macro hostname
+  #
+  # @!macro accepted
+  # @!macro state
+  #
+  # Support for:
+  # - plural resources: N/A
+  # - object access by ID: NO (TODO)
+
+  get %r{^/_status/(?<hostname>#{hostname_regex})$} do |hostname|
+    HostStatusController.new(@status, output: @output, hostname: hostname).get
+  end
+
+end

data/app/{get → routes/get}/status/hostgroups.rb

@@ -1,12 +1,4 @@
 class Nagira < Sinatra::Base
-  # @!macro  [attach] sinatra.get
-  #
-  #    @overload get "$1"
-  #
-  #    @return HTTP response. Hash formatted in the format defined by
-  #         requested output type(XML, YAML or JSON).
-  #
-
 
   ##
   # @method get_status_hostgroup
@@ -15,8 +7,7 @@ class Nagira < Sinatra::Base
   # service status.
   #
   get "/_status/_hostgroup/:hostgroup" do |hostgroup|
-    @data = Hostgroup.new(hostgroup).full
-    nil
+    HostgroupController.new(hostgroup).full
   end
 
   ##
@@ -26,8 +17,7 @@ class Nagira < Sinatra::Base
   # -  GET /_status/_hostgroup/:hostgroup/_service
   #
   get "/_status/_hostgroup/:hostgroup/_service" do |hostgroup|
-    @data = Hostgroup.new(hostgroup).service_status
-    nil
+    HostgroupController.new(hostgroup).service_status
   end
 
   ##
@@ -37,7 +27,6 @@ class Nagira < Sinatra::Base
   # Endpoint:
   # -  GET /_status/_hostgroup/:host
   get "/_status/_hostgroup/:hostgroup/_host" do |hostgroup|
-    @data = Hostgroup.new(hostgroup).host_status
-    nil
+    HostgroupController.new(hostgroup).host_status
   end
 end

data/app/routes/get/status/servicegroups.rb

@@ -0,0 +1,16 @@
+class Nagira < Sinatra::Base
+
+  ##
+  # @method get_status_servicegroup
+  #
+  # Endpoint:
+  # -  GET /_status/_servicegroup/:servicegroup
+  #
+  # Supported extensions: _state, _list
+  #
+
+  get "/_status/_servicegroup/:servicegroup" do |group_name|
+    ServicegroupController.new(group_name).send(@output)
+  end
+
+end

data/app/{put → routes/put}/host.rb

@@ -33,10 +33,7 @@ class Nagira < Sinatra::Base
   #      "plugin_output" : "ping OK"
   #     }
   put "/_status/:host_name" do
-    @data = update_host_status @input.first.merge({
-      'host_name' => params['host_name']
-    })
-    nil
+    HostStatusController.new({}, hostname: params['host_name']).put(@input.first)
   end
 
   # Same as /_status/:host_name (Not implemented)

data/app/{put → routes/put}/status.rb

@@ -51,38 +51,32 @@ class Nagira < Sinatra::Base
   #       ]
   #
   #
-  put "/_status/:host_name/_services" do
+  put "/_status/:host_name/_services" do |hostname|
 
     data, result = [], true
 
     @input.each do |datum|
       # FIXME - this calls update for each service. Should be batching them together
       update = update_service_status(
-                                      datum.merge({ 
-                                                    'host_name' => params['host_name']
-                                                  })
+        datum.merge({
+          'host_name' => hostname
+        })
                                       )
       data << update[:object].first
       result &&= update[:result]
     end
-    @data = { result: result, object: data }
-    nil
-
+    { result: result, object: data }
   end
-  
+
   # Update single service on a single host by JSON data.
-  put "/_status/:host_name/_services/:service_description" do
-    @data = update_service_status \
-    @input.first.merge({ 
-                         'service_description' => params['service_description'],
-                         'host_name' => params['host_name']
-                       })
-    nil
+  put "/_status/:host_name/_services/:service_description" do |hostname,service|
+    ServiceStatusController.new({  }, hostname: hostname, service_name: service)
+      .put @input.first
   end
 
   # @method put_status_as_http_parms
   # @overload  put(/_status/:host_name/_services/:service_description/_return_code/:return_code/_plugin_output/:plugin_output)
-  # 
+  #
   # Update single service status on a single host. Use data provided
   # in RESTful path as parameters.
   #
@@ -90,9 +84,8 @@ class Nagira < Sinatra::Base
   #      curl  -d "test data" \
   #        -X PUT http://localhost:4567/_status/viy/_services/PING/_return_code/0/_plugin_output/OK
   #       # => ok
-  put "/_status/:host_name/_services/:service_description/_return_code/:return_code/_plugin_output/:plugin_output" do 
-    @data = update_service_status params
-    nil
+  put "/_status/:host_name/_services/:service_description/_return_code/:return_code/_plugin_output/:plugin_output" do
+    update_service_status params
   end
-  
+
 end

data/app/writers/external_command_writer.rb

@@ -0,0 +1,52 @@
+class Nagira < Sinatra::Base
+  # Singleton class. Handles updates to the of the Nagios external commands file.
+  #
+  # Example usage:
+  #
+  #    Writer.commands = <path to the external command execution file>
+  #
+  class Writer
+
+    @@commands = nil
+
+    def initialize(action)
+      @action = action
+    end
+
+    # Send PUT update to Nagios::ExternalCommands
+    #
+    # @param action [Symbol] Nagios external command name
+    # @param params [Hash] Parsed Hash from PUT request input.
+    #
+    # FIXME: This only accepts single service. Modify to use Arrays too
+    def put(params)
+
+      res = @@commands.write(
+        params.merge({ :action => @action })
+      )
+      { :result => res[:result], :object => res[:data]}
+    end
+
+    def write
+    end
+
+    # State structure keep all the Nagios parsed state information for
+    # :objects, :status, :config, etc. as well as "inflight" data.
+    attr_accessor :state
+
+    class << self
+
+      def commands=(commands_file)
+        @@commands = Nagios::ExternalCommands.new(commands_file)
+      end
+
+      def commands
+        @@commands
+      end
+
+
+
+
+    end
+  end
+end