nagira 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ba8c40871546f2f94e517df75a4041fc2e439c0
-  data.tar.gz: 609ac720f528e5d0a5d6a74eaf9d85ff9d215c4d
+  metadata.gz: b32464392f51f1065c6ee7bd2ac934e8d7c40a64
+  data.tar.gz: b3c93110e478dc8faf50b4bc1df85bd1ee47bb0f
 SHA512:
-  metadata.gz: e34c0161e542e366e1a3d0f83f53938c2a4d914c3a8aa8b81ac1503e21930374bee6f20901dafe59ea4cb20a017cd8865b7d7734a2f152135ef88899f544aaf8
-  data.tar.gz: c90991ee5002abc1d42625385765fc3acadb521027f1bf6cabe976cf1f9422f344eeeb2389159a5c5e183625564ab3a8485dd372b449bc31be5f3c88df06e7e0
+  metadata.gz: 649894c5163069cda283b7cf89233fff1a2d8cdb92c4edd95621837a535d9b24af7e040d78fb415e6f11b3f0682940926fbb9281f4c6a69f965261b321060f22
+  data.tar.gz: 570a91ef223e5b5a688dbbddcbc3a10cd027f74ba105b8dd2612eb6152e856d7b1cceda62ffdcaf80b71798ba68b10b4db26e8cb87f4580bd34b614f5b9161ac

data/History.md

@@ -1,19 +1,27 @@
+### v0.5.2
+* Tue Jan 19 2016 -- Dmytro Kovalov
+  - More refactoring
+
 ### v0.5.1
 * Thr Dec 17 2015 -- Dmytro Kovalov
   - Refactored parsing of Nagios files, cleaner code. No functionality changes.
+
 ### v0.5.0
 * Fri Nov 6 2015 -- Dmytro Kovalov
   - Add support for Service groups, new route `GET /_status/_servicegroup/`
   - Vagrantfile for Ubuntu development
+
 ### v0.4.2
 * Fri Oct 9 2015 -- Dmytro Kovalov
   - init.d script fixes
     - Fix for not detecting PID of the running Nagira, when ruby bibnary
       is like ruby1.9.1
     - Sanity checks for nagios user and log directory
+
 ### v0.4.1
 * Wed Dec 26 2014 -- Dmytro Kovalov (birthday release, NAgira tuns 4 years today :)
   - Added puma support, puma is default now
+
 ### v0.4.0
 * Wed Dec 24 2014 -- Dmytro Kovalov
   - new API endpoints
@@ -45,6 +53,7 @@
 * July, Aug 2013
   - RSpec tests
     - GET endpoints checks
+
 ### v.0.2.10, v.0.2.11
 * Fri Jul 19 2013 -- Dmytro Kovalov
   - Gem versions fixes in gemspec, use gemspec in Gemfile.
@@ -56,8 +65,10 @@
       - JSON structure specs for PUT methods
       - return 400 if PUT not success
       - specs for nagios.cmd writes
+
 ### v.0.2.9
   - Bugfix - library loading order change, for @format processing in PUT routes.
+
 ### v.0.2.8
 * Wed Apr 17 2013 -- Dmytro Kovalov
   - Bugfix - prevent tracedumps on nonexisting hostnames

data/Rakefile

@@ -1,5 +1,5 @@
 require 'fileutils'
-require_relative 'lib/nagira'
+require_relative 'app/app'
 
 Dir.glob(File.join(Nagira.root, 'lib', 'tasks','*.rake')).each do |rake|
   load rake

data/app/app.rb

@@ -1,326 +1,72 @@
-# @!macro  [attach] sinatra.get
-#
-#    @overload get "$1"
-#
-#    @return HTTP response. Hash formatted in the format defined by
-#         requested output type(XML, YAML or JSON).
-#
-#
-#
-# @!macro [new] type
-#     @param [String] :type Type is one of Nagios objects like  hosts, hostgroupsroups, etc.
-#
-# @!macro [new] name
-#       @param [String] :name
-#
-# @!macro [new] hostname
-#   @param [String] :hostname Configured Nagios hostname
-#
-# @!macro [new] service_name
-#   @param [String] :service_name Configured Nagios service for the host
-#
-# @!macro [new] accepted
-#
-#    <b>Accepted output type modifiers:</b>
-#
-# @!macro [new] list
-#
-#     - +/_list+ : Short list of available objects, depending on the
-#       current request context: hosts, services, etc.
-#
-# @!macro [new] state
-#
-#     - +/_state+ - Instead of full status information send only
-#       current state. For hosts up/down, for services OK, Warn,
-#       Critical, Unknown (0,1,2-1)
-#
-# @!macro [new] full
-#
-#     - +/_full+ - Show full status information. When used in
-#       /_status/_full call will display full hoststaus and
-#       servicestatus information for each host.
-#
-#
+require 'active_model/serialization'
+require 'active_model/serializers/xml' # for Hash.to_xml
 
+require 'active_support/inflector'
+require 'active_support/inflector/inflections'
+require 'active_support/core_ext/hash/slice' # for Hash.slice
 
+require 'json'
+require 'yaml'
+require 'fileutils'
+require 'sinatra/base'
+require 'sinatra/reloader'
+require 'singleton'
+
+require_relative "../config/defaults"
+require_relative "../config/environment"
+
+Dir.glob("#{Nagira::BASE}/lib/**/*.rb").each { |file| require file }
+Dir.glob("#{Nagira::BASE}/app/{loggers,parsers,concerns,helpers}/*.rb").each { |file| require file }
+
+Dir.glob("#{Nagira::BASE}/app/**/*.rb").each { |file| require file }
 
-require 'nagira'
 
 ##
 # Main class of Nagira application implementing RESTful API for
 # Nagios.
 #
 class Nagira < Sinatra::Base
-  set :app_file, __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
-    Parser.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
-
-    BackgroundParser.run if BackgroundParser.configured?
-  end
-
-
-  ##
-  # Parse nagios files.
-  #
-  # Note: *.parse methods are monkey-patched here (if you have required
-  # 'lib/nagira' above) to set min parsing interval to avoid file paring
-  # on each HTTP request. File is parsed only if it was changed and if
-  # it was parsed more then 60 (default) seconds ago. See
-  # +lib/nagira/timed_parse.rb+ for mor more info.
-  #
-  # In development mode use files located under +./test/data+
-  # directory. This allows to do development on the host where Nagios is
-  # notinstalled. If you want to change this edit configuration in
-  # config/environment.rb file.
-  #
-  # See also comments in config/default.rb file regarding nagios_cfg,
-  # status_cfg, objects_cfg.
-  #
-  # @method   parse_nagios_files
-  # @overload before("Parse Nagios files")
-  before do
-    Logger.log("BackgroundParser is not running", :warning) if
-      BackgroundParser.configured? && BackgroundParser.dead?
-
-    Parser.parse
-
-    @status = Parser.status['hosts']
-    @objects = Parser.objects
-
-    #
-    # Add plural keys to use ActiveResource with Nagira
-    #
-    @objects.keys.each do |singular|
-      @objects[singular.to_s.pluralize.to_sym] = @objects[singular]
-    end
-  end
-
-  ##
-  # @method     clear_instance_data
-  # @overload before("clear data")
-  #
-  # Clear values onf instance variables before start.
-  #
-  before do
-    @data = []
-    @format = @output = nil
-  end
-
-  ##
-  # @method     strip_extensions
-  # @overload before("detect format")
-  #
-  # Detect and strip output format extension
-  #
-  # Strip extension (@format) from HTTP route and set it as instance
-  # variable @format. Valid formats are .xml, .json, .yaml. If format
-  # is not specified, it is set to default format
-  # (Nagira.settings.format).
+  # @!macro  [attach] sinatra.get
   #
-  # \@format can be assigned one of the symbols: :xml, :json, :yaml.
+  #    @overload get "$1"
   #
-  # = Examples
+  #    @return HTTP response. Hash formatted in the format defined by
+  #         requested output type(XML, YAML or JSON).
   #
-  #     GET /_objects              # => default format
-  #     GET /_objects.json         # => :json
-  #     GET /_status/_list.yaml    # => :yaml
   #
-  before do
-    request.path_info.sub!(/#{settings.format_extensions}/, '')
-    @format = ($1 || settings.format).to_sym
-    content_type "application/#{@format.to_s}"
-  end
-
-  ##
-  # @method   detect_ar_type
-  # @overload before('detect ActiveResource mode')
   #
-  # Detect if this a request for ActiveResource PATH
+  # @!macro [new] type
+  #     @param [String] :type Type is one of Nagios objects like  hosts, hostgroupsroups, etc.
   #
-  before do
-    @active_resource = request.path_info =~ %r{^#{Nagira::AR_PREFIX}/}
-  end
-
-  ##
-  # @method   strip_output_type
-  # @overload before('detect output mode')
+  # @!macro [new] name
+  #       @param [String] :name
   #
-  # Detect output mode modifier
+  # @!macro [new] hostname
+  #   @param [String] :hostname Configured Nagios hostname
   #
-  # Detect and strip output type from HTTP route. Full list of
-  # output types is +:list+, +:state+ or +:full+, corresponding to
-  # (+/list, +/state+, +/full+ routes).
+  # @!macro [new] service_name
+  #   @param [String] :service_name Configured Nagios service for the host
   #
-  # Output type defined by route modifier appended to the end of HTTP
-  # route. If no output type specfied it is set to +:full+. Output
-  # mode can be followed by format extension (+.json+, +.xml+ or
-  # +.yaml+).
+  # @!macro [new] accepted
   #
-  # = Examples
+  #    <b>Accepted output type modifiers:</b>
   #
-  #     GET /_objects/_list     # => :list
-  #     GET /_status/_state     # => :state
-  #     GET /_status/:hostname  # => :full
-  #     GET /_status            # => :normal
+  # @!macro [new] list
   #
-  before do
-    request.path_info.sub!(/\/_(list|state|full)$/, '')
-    @output = ($1 || :normal).to_sym
-  end
-
-  ##
-  # @method find_jsonp_callback
-  # @overload before('find callback name')
+  #     - +/_list+ : Short list of available objects, depending on the
+  #       current request context: hosts, services, etc.
   #
-  # Detects if request is using jQuery JSON-P and sets @callback
-  # variable. @callback variable is used if after method and prepends
-  # JSON data with callback function name.
+  # @!macro [new] state
   #
-  # = Example
+  #     - +/_state+ - Instead of full status information send only
+  #       current state. For hosts up/down, for services OK, Warn,
+  #       Critical, Unknown (0,1,2-1)
   #
-  #      GET /_api?callback=jQuery12313123123 # @callback == jQuery12313123123
+  # @!macro [new] full
   #
-  # JSONP support is based on the code from +sinatra/jsonp+ Gem
-  # https://github.com/shtirlic/sinatra-jsonp.
-  #
-  before do
-    if @format == :json
-      ['callback','jscallback','jsonp','jsoncallback'].each do |x|
-        @callback = params.delete(x) unless @callback
-      end
-    end
-  end
-
-  ##
-  # @method   object_not_found
-  # @overload after("Object not found or bad request")
-  #
-  # If result-set of object/status search is empty return HTTP 404 .
-  # This can happen when you are requesting status for not existing
-  # host and/or service.
-  #
-  #
-  after do
-    if ! @data || @data.empty?
-      halt [404, {
-              :message => "Object not found or bad request",
-              :error => "HTTP::Notfound"
-            }.send("to_#{@format}")
-           ]
-    end
-  end
-
-  ##
-  # @method argument_error
-  # @overload after("ArgumentError")
+  #     - +/_full+ - Show full status information. When used in
+  #       /_status/_full call will display full hoststaus and
+  #       servicestatus information for each host.
   #
-  # Return 400 if result of PUT operation is not success.
   #
-  after do
-    return unless request.put?
-    halt [400, @data.send("to_#{@format}") ] if ! @data[:result]
-  end
-
-  ##
-  # @method   convert_to_active_resource
-  # @overload after("Return Array for ActiveResouce routes")
-  #
-  #
-  after do
-    @data = @data.values if @active_resource && @data.is_a?(Hash)
-  end
-
-  ##
-  # @method   return_jsonp_data
-  # @overload after("Return formatted data")
-  #
-  # If it's a JSON-P request, return its data with prepended @callback
-  # function name. JSONP request is detected by +before+ method.
-  #
-  # If no callback paramete given, then simply return formatted data
-  # as XML, JSON, or YAML in response body.
-  #
-  # = Example
-  #
-  #     $ curl  'http://localhost:4567/?callback=test'
-  #         test(["{\"application\":\"Nagira\",\"version\":\"0.1.3\",\"url\":\"http://dmytro.github.com/nagira/\"}"])
-  #
-  after do
-    body( @callback ? "#{@callback.to_s} (#{@data.to_json})" : @data.send("to_#{@format}") )
-  end
-
-  ##
-  # @method get_api
-  # @overload get(/_api)
-  #
-  # Provide information about API routes
-  #
-  get "/_api" do
-    @data = self.api
-    nil
-  end
-
-  ##
-  # @method get_runtime_config
-  # @overload get(/_runtime)
-  #
-  # Print out nagira runtime configuration
-  get "/_runtime" do
-    @data = {
-      application: self.class,
-      version: VERSION,
-      runtime: {
-        environment: Nagira.settings.environment,
-        home: ENV['HOME'],
-        user: ENV['LOGNAME'],
-        nagiosFiles: $nagios.to_h.keys.map {  |x| {  x =>  $nagios[x].path }}
-      }
-    }
-    nil
-  end
-
-  # @method get_slash
-  # @overload get(/)
-  #
-  # Returns application information: name, version, github repository.
-  get "/" do
-    @data = {
-      :application => self.class,
-      :version => VERSION,
-      :source => GITHUB,
-      :apiUrl => request.url.sub(/\/$/,'') + "/_api",
-    }
-    nil
-  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
-
-require "app/put/status"
-require "app/put/host"
-require "app/put"

data/app/concerns/host_status_name_concerneable.rb

@@ -0,0 +1,18 @@
+module HostStatusNameConcerneable
+
+  attr_accessor :hostname, :service_name, :resource
+
+  def status
+    @status ||=
+      Nagira::HostStatusController.new(@nagios_status, hostname: hostname, output: :full)
+      .status[hostname][resource]
+  end
+
+  def with_service_name
+    if service_name
+      { service_name => status[service_name] }
+    else
+      status
+    end
+  end
+end