nagira 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0be37e447b15c8087f82209470877a5fb202d77d
-  data.tar.gz: e9670a022cfbe3184264353ac346d2133b6eb258
+  metadata.gz: fccef39db4a2a093a2f1012341d446dbd65da419
+  data.tar.gz: 2353f6f868237d0ac59d441c12395905af898659
 SHA512:
-  metadata.gz: 065f49e0b3c74dffb37dbffaf9273407a8a7d329b4cfd4448ce1c143a2426218f3b1119a3423795ccaf283d37f36ad1e096dd41ff675b662e607fe69f911519a
-  data.tar.gz: 7940f90fba42d4ab49f3fcb057a216654a2c7af9791a83fbc7d262dc99cdf48ba06d94c35cb5761d8f2817dc15a2653dba05c2b73355f95f1c8403e8a39ed285
+  metadata.gz: 11f7624063fe10514a995b2d6d97445b149aa59ed25452db6aca3a6f7a36565cc286ea8a0b10da51b71d026eeea341b437740c330baa423100086ce9690135e3
+  data.tar.gz: 9c1e64e4ca497953d794a5016473b94a401b4ef3e40095112d183a1fe3e5df7d687583737a7a1c1d85935d2318173a85978a0a2562a945862776ae9ca59057b1

data/History.md

@@ -1,3 +1,10 @@
+### v0.4.0
+* Wed Dec 24 2014 -- Dmytro Kovalov
+  - new API endpoints
+    - GET /\_status/_hosthgroup/:name
+    - GET /\_status/_hosthgroup/:name/_host
+    - GET /\_status/_hosthgroup/:name/_service
+  - update API docs (API.md)
 
 ### v.0.3.3
 * Tue May 27 2014 -- Dmytro Kovalov
@@ -43,11 +50,11 @@
 
 * Mon Apr 15 2013 -- Dmytro Kovalov
   - Extend ActiveResource support
-    - add prefix /ar 
+    - add prefix /ar
     - AR_PREFIX constant for the same
     - covert all output ot Array if it's ActiveResource
   - ActiveResource supportewd now in /_objects, /_status
-  
+
 ### v.0.2.6
 
 * Tue Mar 26 2013 -- Ivan Gusev
@@ -69,24 +76,24 @@
   - Add partial ActiveSupport routes
     - `/_objects/host` works as well as `/_objects/hosts`
     - selection objects by ID is TODO
-* Feb 19, 2013 -- Dmytro Kovalov    
-  - Background parser. 
-  
+* Feb 19, 2013 -- Dmytro Kovalov
+  - Background parser.
+
       To avoid delays on HTTP request from user. All data are parsed in separate thread.
     - configurable TTL for background parsing
     - can be disabled
-  - Start-up section for the Nagira app. 
+  - Start-up section for the Nagira app.
 
-      All Nagios files are validated at start-up, rather than on first HTTP request. 
+      All Nagios files are validated at start-up, rather than on first HTTP request.
 
       If there are permission problem or file don't exist error is reported to user.
-* Feb 9, 2013    
+* Feb 9, 2013
   - Merge all custom changes to `ruby-nagios` into upstream, use `ruby-nagios` as gem, not git sub-module
-  - `nagios.cfg` file selection is in `ruby-nagios` now. 
+  - `nagios.cfg` file selection is in `ruby-nagios` now.
 
       Look for config in `/etc/nagios*/` and `/usr/local/nagios/etc/`. Can be overridden by `NAGIOS_CFG_FILE` environment.
-  
-### v.0.2.1 
+
+### v.0.2.1
 
 * Wed Dec 19 2012 - Dmytro Kovalov
   - fix for DOS formatted and spaces in config ; better error reporting for spec. fixes #8
@@ -96,49 +103,48 @@
   - ERB  template for /etc/init./d file
   - Fixes for YARD formatting
   - Use Travis CI for Nagira testing
-* Thu Oct  4 19:45:00 JST 2012 
+* Thu Oct  4 19:45:00 JST 2012
 
 ###  v.0.2.0
 
   - lot of bug fixes
   - API: first working PUT API for process host status and process service status external commands
 * 2012-09-28 Dmytro Kovalov - v. 0.1.5
-  - many changes for testing files nagios.cfg, objects, status. Tested to work both in dev/test and production environments. 
+  - many changes for testing files nagios.cfg, objects, status. Tested to work both in dev/test and production environments.
   - more documentation
   - API: additional modifier for output: `_full`. By default now `/_status` returns Hash with hoststatus only. Use ../_full to get both hoststatus and sevicestatus.
 
-### v. 0.1.4  
+### v. 0.1.4
 
-* 2012-09-26 Dmytro Kovalov - 
+* 2012-09-26 Dmytro Kovalov -
   - added support for JSON-P parameters (?callback=<nam>)
   - change API to have all keywords underscored, to avoid clashes with object names (`/_status`, `_objects`, `/_status/_list` etc).
 
-### v. 0.1.3  
+### v. 0.1.3
 
-* 2012-06-8 Dmytro Kovalov 
+* 2012-06-8 Dmytro Kovalov
   - specs for /config, /status, /objects - simple page loads and data
     checks;
   - /api route;
   - bugfixes;
   - YARD documentation;
 
-### v. 0.1.2  
+### v. 0.1.2
 
-* 2012-06-2 Dmytro Kovalov 
-  - spec for configuration files 
+* 2012-06-2 Dmytro Kovalov
+  - spec for configuration files
   - spec for basic responses from Sinatra (`GET /objects`, `GET /status`)
   - CONFIGURATION.rdoc
   - configuration cleanup
 * 2012-05-22 Dmytro Kovalov
-  - start using Gemfile 
+  - start using Gemfile
   - INSTALL.rdoc - simple description of installation procedure
 * 2012-01-12 Dmytro Kovalov
   - History.rdoc and version.txt files
   - Routes for objects configuration GET's
   - FEATURES.rdoc
-  - YARD documentation 
+  - YARD documentation
 * 2012-01-02 Dmytro Kovalov
   - First Sinatra application to return service state information
 * 2011-12-25 @dmytro
   - Started Github project
-

data/{lib → app}/app.rb

@@ -51,7 +51,6 @@ require 'nagira'
 # Nagios.
 #
 class Nagira < Sinatra::Base
-
   set :app_file, __FILE__
 
   ##
@@ -61,7 +60,7 @@ class Nagira < Sinatra::Base
   # @overload before("Initial Config")
   configure do
 
-    $nagios = { }
+    $nagios = {  }
     $nagios[:config]  = Nagios::Config.new Nagira.settings.nagios_cfg
     $nagios[:config].parse
 
@@ -276,12 +275,12 @@ class Nagira < Sinatra::Base
 
 
   ##
-  # @method argument_error 
+  # @method argument_error
   # @overload after("ArgumentError")
   #
   # Return 400 if result of PUT operation is not success.
   #
-  after do 
+  after do
     return unless request.put?
     halt [400, @data.send("to_#{@format}") ] if ! @data[:result]
   end
@@ -370,6 +369,6 @@ class Nagira < Sinatra::Base
 
 end
 
-require "app/routes/put/status"
-require "app/routes/put/host"
-require "app/routes/put"
+require "app/put/status"
+require "app/put/host"
+require "app/put"

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

@@ -1,3 +1,5 @@
+require_relative 'status/hostgroups'
+
 class Nagira < Sinatra::Base
   # @!macro  [attach] sinatra.get
   #
@@ -20,16 +22,16 @@ class Nagira < Sinatra::Base
   # @!macro [new] service_name
   #   @param [String] :service_name Configured Nagios service for the host
   #
-  # @!macro [new] accepted 
+  # @!macro [new] accepted
   #
   #    <b>Accepted output type modifiers:</b>
   #
-  # @!macro [new] list 
+  # @!macro [new] list
   #
   #     - +/_list+ : Short list of available objects, depending on the
   #       current request context: hosts, services, etc.
   #
-  # @!macro [new] state 
+  # @!macro [new] state
   #
   #     - +/_state+ - Instead of full status information send only
   #       current state. For hosts up/down, for services OK, Warn,
@@ -37,10 +39,10 @@ class Nagira < Sinatra::Base
   #
   # @!macro [new] full
   #
-  #     - +/_full+ - Show full status information. When used in 
-  #       /_status/_full call will display full hoststaus and 
+  #     - +/_full+ - Show full status information. When used in
+  #       /_status/_full call will display full hoststaus and
   #       servicestatus information for each host.
-  #       
+  #
   #
 
   # Status routes
@@ -48,6 +50,7 @@ class Nagira < Sinatra::Base
 
   ##
   # @method get_status_hostname_services_service_name
+  # @overload get("/_status/:hostname/_services/:service_name")
   #
   # @!macro hostname
   # @!macro service_name
@@ -75,13 +78,13 @@ class Nagira < Sinatra::Base
   # @method get_status_hostname_services
   # @!macro hostname
   #
-  # Endpoints: 
+  # Endpoints:
   # -  GET /_status/:hostname/_services
   # -  GET /_status/:hostname/_hostcomments
   # -  GET /_status/:hostname/_servicecomments
   #
   # Read +services+, +hostcomments+ or +servicecomments+ for single
-  # host. 
+  # host.
   #
   # @!macro accepted
   # @!macro state
@@ -91,12 +94,12 @@ class Nagira < Sinatra::Base
 
     hostname = hostname.to_i if hostname =~ /^\d+$/
     key = case service
-          when 'services' 
+          when 'services'
             'servicestatus'
           else
             service
           end
-            
+
     if @status && @status[hostname]
       case @output
       when :list
@@ -114,7 +117,7 @@ class Nagira < Sinatra::Base
   ##
   # @method get_status
   #
-  # Return all hosts status. 
+  # Return all hosts status.
   #
   # If no output modifier provided, outputs full hosttatus information
   # for each host. Not including services information. When +_full+
@@ -133,12 +136,12 @@ class Nagira < Sinatra::Base
   # Support for (see API):
   # - plural resources: N/A
   # - object access by ID: N/A
-  
+
   get /^\/_status(\/_hosts)?$/ do
 
     @data = @status.dup
 
-    case @output 
+    case @output
     when :state
       @data.each { |k,v| @data[k] = v['hoststatus'].slice("host_name", "current_state") }
     when :list
@@ -151,7 +154,7 @@ class Nagira < Sinatra::Base
 
     nil
   end
-  
+
   # Hoststatus for single host
   #
   # @method get_status_hostname
@@ -174,7 +177,7 @@ class Nagira < Sinatra::Base
 
     hostname = hostname.to_i if hostname =~ /^\d+$/
     @data =  @status[hostname]['hoststatus'].dup if @status.has_key? hostname
-    
+
     if @output == :state
       @data = @data.slice("host_name", "current_state")
     end

data/app/get/status/hostgroups.rb

@@ -0,0 +1,49 @@
+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).
+  #
+
+
+  require 'pry'
+
+  register Sinatra::Namespace
+  namespace "/_status/_hostgroup" do
+
+    ##
+    # @method get_status_hostgroup
+    #
+    # Return full status of the hostgroup: including host status and
+    # service status.
+    #
+    get "/:hostgroup" do |hostgroup|
+      @data = Hostgroup.new(hostgroup).full
+      nil
+    end
+
+    ##
+    # @method get_status_hostgroup_service
+    #
+    # Endpoint:
+    # -  GET /_status/_hostgroup/:hostgroup/_service
+    #
+    get "/:hostgroup/_service" do |hostgroup|
+      @data = Hostgroup.new(hostgroup).service_status
+      nil
+    end
+
+    ##
+    # @method get_status_hostgroup_host
+    # @overload get("/_status/_hostgroup/:hostgroup/_host")
+    #
+    # Endpoint:
+    # -  GET /_status/_hostgroup/:host
+    get "/:hostgroup/_host" do |hostgroup|
+      @data = Hostgroup.new(hostgroup).host_status
+      nil
+    end
+  end
+end

data/bin/nagira

@@ -4,8 +4,8 @@ begin
   require 'app.rb'
 rescue LoadError => e
   require 'rubygems'
-  path = File.expand_path '../../lib', __FILE__
-  $:.unshift(path) if File.directory?(path) && !$:.include?(path)
-  require 'app.rb'
+  root = File.dirname(File.dirname(__FILE__))
+  $: << (File.expand_path 'lib', root) << (File.expand_path 'app', root)
+  require 'app'
 end
 Nagira.run!

data/config/defaults.rb

@@ -11,7 +11,7 @@
 
 
 DEFAULT = {
-   
+
   format_extensions: '\.(json|yaml|xml)$', #  Regex for available
                                            #  formats: xml, json, yaml
 
@@ -21,15 +21,15 @@ DEFAULT = {
 
   # No path to file configuration file by default. Main nagios config
   # is defined by +nagios_cfg_glob+ or by Sintra's
-  # +settings.nagios_cfg+ variable. 
+  # +settings.nagios_cfg+ variable.
   #
   # status_cfg and objects_cfg are defined by parsing of nagios_cfg
   # file. Sinatra's setting override parsed values.
-  nagios_cfg: nil, 
+  nagios_cfg: nil,
   status_cfg: nil,
   objects_cfg: nil,
   command_file: nil,
-  
+
   ##
   # ttl used in Nagios::TimedParse module - extension
   # to Nagios modules.
@@ -40,9 +40,9 @@ DEFAULT = {
   # if file changes often, we do not want to parse it more often, then
   # this number of seconds. To disable timed parsing, set
   # ttl to 0 or negative number.
-  
+
   ttl: ENV['NAGIRA_TTL'].to_i || 5,
-  
+
   ##
   # start_background_parser used in Nagios::BackgroundParse class.
   #
@@ -59,13 +59,13 @@ DEFAULT = {
   # By default hostname regular expression accepts alpha-numerics,
   # dashes and dots, as specified by http://tools.ietf.org/html/rfc952
   # for hostnames. Extended to accept dots in the middle for FQHN's.
-  # 
+  #
   #
   # - default: '\w([\w\-\.]+)?\w'
   # - simple hostname: '\w([\w\-]+)?\w'
-  # - allow space in hostname: '\w([\w\-\.(%20)]+)?\w' 
+  # - allow space in hostname: '\w([\w\-\.(%20)]+)?\w'
   #
-  # Explanation regarding spaces: 
+  # Explanation regarding spaces:
   # ---------------------------------
   #
   # Nagios works OK with hostnames with spaces. This is against RFC's
@@ -75,7 +75,6 @@ DEFAULT = {
 
   hostname_regex: ENV['NAGIOS_HOST_CUSTOM_REGEX'] || '\w([\w\-\.]+)?\w'
 
-
 }
 
 require 'sinatra'

data/config/environment.rb

@@ -6,25 +6,24 @@ class Nagira < Sinatra::Base
 
   set :port, ENV['NAGIRA_PORT'].to_i if ENV['NAGIRA_PORT']
   set :bind, ENV['NAGIRA_BIND'] if ENV['NAGIRA_BIND']
+  set :root, File.dirname(File.dirname(__FILE__))
 
-  configure do 
+  configure do
     set :format, :json
   end
 
-  if development?
-    require 'sinatra/reloader'
-    register Sinatra::Reloader
-    also_reload(File.dirname(File.dirname(__FILE__))+"/*.rb")
-    also_reload(File.dirname(File.dirname(__FILE__))+"/{app,lib}/**/*.rb")
-  end
+  require 'sinatra/reloader'  if development?
 
   ##
   # Development and test environments use local files located in the
   # development tree: ./test/data.
-  configure :development, :test do 
+  configure :development, :test do
+    register Sinatra::Reloader
+    also_reload("#{root}/*.rb")
+    also_reload("#{root}/{config,app,lib}/**/*.rb")
 
     dir = File.expand_path(File.dirname(__FILE__) + '/../test/data/')
-    
+
     set :nagios_cfg, "#{dir}/nagios.cfg"
     set :status_cfg, "#{dir}/status.dat"
     set :objects_cfg, "#{dir}/objects.cache"
@@ -32,7 +31,7 @@ class Nagira < Sinatra::Base
 
     set :show_exceptions, false
   end
-  
+
 
 # configure :production do
 #   # If your nagios.cfg file is in 'standard' location (in RH and