icinga2 0.6.1 → 0.6.2

data/lib/icinga2/network.rb

@@ -2,14 +2,21 @@
 # frozen_string_literal: true
 module Icinga2
 
-  #
-  #
-  #
+  # namespace for network handling
   module Network
 
+    # static function for GET Requests
     #
+    # @param [Hash] params
+    # @option params [String] :host
+    # @option params [String] :url
+    # @option params [String] :headers
+    # @option params [String] :options
+    # @option params [Hash] :payload
     #
     #
+    # @return [Hash]
+    #
     def self.get( params = {} )
 
       host    = params.dig(:host)
@@ -95,8 +102,18 @@ module Icinga2
 
     end
 
+    # static function for GET Requests with payload
+    # internal we use here an POST Request and overwrite a http header
+    #
+    # @param [Hash] params
+    # @option params [String] :host
+    # @option params [String] :url
+    # @option params [String] :headers
+    # @option params [String] :options
+    # @option params [Hash] :payload
     #
     #
+    # @return [Hash]
     #
     def self.get_with_payload( params = {} )
 
@@ -177,8 +194,16 @@ module Icinga2
 
     end
 
+    # static function for POST Requests
+    #
+    # @param [Hash] params
+    # @option params [String] :url
+    # @option params [String] :headers
+    # @option params [String] :options
+    # @option params [Hash] :payload
     #
     #
+    # @return [Hash]
     #
     def self.post( params = {} )
 
@@ -265,9 +290,18 @@ module Icinga2
       result
     end
 
+    # static function for PUT Requests
     #
+    # @param [Hash] params
+    # @option params [String] :host
+    # @option params [String] :url
+    # @option params [String] :headers
+    # @option params [String] :options
+    # @option params [Hash] :payload
     #
     #
+    # @return [Hash]
+    #
     def self.put( params = {} )
 
       host    = params.dig(:host)
@@ -369,8 +403,15 @@ module Icinga2
       result
     end
 
+    # static function for DELETE Requests
+    #
+    # @param [Hash] params
+    # @option params [String] :url
+    # @option params [String] :headers
+    # @option params [String] :options
     #
     #
+    # @return [Hash]
     #
     def self.delete( params = {} )
 

data/lib/icinga2/notifications.rb

@@ -3,34 +3,47 @@
 
 module Icinga2
 
-  #
-  #
-  #
+  # namespace for servicegroup handling
   module Notifications
 
+    # enable host notifications
     #
+    # @param [String] host
     #
+    # @example
+    #    @icinga.enable_host_notification('icinga')
+    #
+    # @return [Hash]
     #
     def enable_host_notification( host )
 
       host_notification( name: host, enable_notifications: true )
     end
 
+    # disable host notifications
+    #
+    # @param [String] host
     #
+    # @example
+    #    @icinga.disable_host_notification('icinga')
     #
+    # @return [Hash]
     #
     def disable_host_notification( host )
 
       host_notification( name: host, enable_notifications: false )
     end
 
+    # enable service notifications
     #
+    # @param [String] host
     #
+    # @example
+    #    @icinga.enable_service_notification('icinga')
     #
-    def enable_service_notification( params = {} )
-
-      host    = params.get(:host)
-      service = params.get(:service)
+    # @return [Hash]
+    #
+    def enable_service_notification( host )
 
       if( host.nil? )
 
@@ -40,52 +53,125 @@ module Icinga2
         }
       end
 
-      service_notification( name: host, service: service, enable_notifications: true )
+      service_notification( name: host, enable_notifications: true )
     end
 
+    # disable service notifications
+    #
+    # @param [String] host
     #
+    # @example
+    #    @icinga.disable_service_notification('icinga')
     #
+    # @return [Hash]
     #
     def disable_service_notification( host )
 
+      if( host.nil? )
+        return {
+          status: 404,
+          message: 'missing host name'
+        }
+      end
+
       service_notification( name: host, enable_notifications: false )
     end
 
+    # enable hostgroup notifications
     #
+    # @param [Hash] params
+    # @option params [String] host
+    # @option params [String] host_group
     #
+    # @example
+    #    @icinga.enable_hostgroup_notification(host: 'icinga2', host_group: 'linux-servers')
     #
-    def enable_hostgroup_notification( group )
+    # @return [Hash]
+    #
+    def enable_hostgroup_notification( params = {} )
+
+      host = params.dig(:host)
+      host_group = params.dig(:host_group)
+
+      if( host.nil? )
+        return {
+          status: 404,
+          message: 'missing host name'
+        }
+      end
+
+      if( host_group.nil? )
+        return {
+          status: 404,
+          message: 'missing host_group name'
+        }
+      end
 
-      hostgroup_notification( host_group: group, enable_notifications: true )
+      hostgroup_notification( host: host, host_group: host_group, enable_notifications: true )
     end
 
+    # disable hostgroup notifications
     #
+    # @param [Hash] params
+    # @option params [String] host
+    # @option params [String] host_group
     #
+    # @example
+    #    @icinga.disable_hostgroup_notification(host: 'icinga2', host_group: 'linux-servers')
     #
-    def disable_hostgroup_notification( group )
+    # @return [Hash]
+    #
+    def disable_hostgroup_notification( params = {} )
+
+      host = params.dig(:host)
+      host_group = params.dig(:host_group)
+
+      if( host.nil? )
+        return {
+          status: 404,
+          message: 'missing host name'
+        }
+      end
 
-      hostgroup_notification( host_group: group, enable_notifications: false )
+      if( host_group.nil? )
+        return {
+          status: 404,
+          message: 'missing host_group name'
+        }
+      end
+
+      hostgroup_notification( host: host, host_group: host_group, enable_notifications: false )
     end
 
+    # return all notifications
     #
+    # @param [Hash] params
+    # @option params [String] name
     #
+    # @return [Hash]
     #
     def notifications( params = {} )
 
       name = params.dig(:name)
 
-      result = Network.get(         host: name,
+      Network.get(         host: name,
         url: format( '%s/v1/objects/notifications/%s', @icinga_api_url_base, name ),
         headers: @headers,
         options: @options )
 
-      JSON.pretty_generate( result )
-
     end
 
 
-    # PRIVATE SECTION
+    # function for host notifications
+    # @private
     #
+    # @param [Hash] params
+    # @option params [String] name
+    # @option params [Bool] enable_notifications (false)
+    #
+    # @return [Hash]
+    #
+    private
     def host_notification( params = {} )
 
       name          = params.dig(:name)
@@ -97,21 +183,27 @@ module Icinga2
         }
       }
 
-      result = Network.post(         host: name,
+      Network.post(         host: name,
         url: format( '%s/v1/objects/hosts/%s', @icinga_api_url_base, name ),
         headers: @headers,
         options: @options,
         payload: payload )
 
-      JSON.pretty_generate( result )
-
     end
 
+    # function for hostgroup notifications
+    # @private
     #
+    # @param [Hash] params
+    # @option params [String] host_group
+    # @option params [Bool] enable_notifications (false)
     #
+    # @return [Hash]
     #
+    private
     def hostgroup_notification( params = {} )
 
+      host          = params.dig(:host)
       group         = params.dig(:host_group)
       notifications = params.dig(:enable_notifications) || false
 
@@ -122,19 +214,24 @@ module Icinga2
         }
       }
 
-      result = Network.post(         host: name,
+      Network.post(         host: host,
         url: format( '%s/v1/objects/services', @icinga_api_url_base ),
         headers: @headers,
         options: @options,
         payload: payload )
 
-      JSON.pretty_generate( result )
-
     end
 
+    # function for service notifications
+    # @private
     #
+    # @param [Hash] params
+    # @option params [String] name
+    # @option params [Bool] enable_notifications (false)
     #
+    # @return [Hash]
     #
+    private
     def service_notification( params = {} )
 
       name          = params.dig(:name)
@@ -147,14 +244,12 @@ module Icinga2
         }
       }
 
-      result = Network.post(         host: name,
+      Network.post(         host: name,
         url: format( '%s/v1/objects/services', @icinga_api_url_base ),
         headers: @headers,
         options: @options,
         payload: payload )
 
-      JSON.pretty_generate( result )
-
     end
 
   end

data/lib/icinga2/servicegroups.rb

@@ -3,17 +3,25 @@
 
 module Icinga2
 
-  #
-  #
-  #
+  # namespace for servicegroup handling
   module Servicegroups
 
+    # add a servicegroup
     #
+    # @param [Hash] params
+    # @option params [String] :name servicegroup to create
+    # @option params [String] :display_name the displayed name
     #
+    # @example
+    #   @icinga.add_servicegroup(name: 'foo', display_name: 'FOO')
+    #
+    # @return [Hash] result
     #
     def add_servicegroup( params = {} )
+
       name = params.dig(:name)
       display_name = params.dig(:display_name)
+
       if( name.nil? )
         return {
           status: 404,
@@ -23,20 +31,28 @@ module Icinga2
 
       payload = { 'attrs' => { 'display_name' => display_name } }
 
-      result = Network.put(         host: name,
+      Network.put(         host: name,
         url: format( '%s/v1/objects/servicegroups/%s', @icinga_api_url_base, name ),
         headers: @headers,
         options: @options,
         payload: payload )
 
-      JSON.pretty_generate( result )
     end
 
+    # delete a servicegroup
+    #
+    # @param [Hash] params
+    # @option params [String] :name servicegroup to delete
     #
+    # @example
+    #   @icinga.delete_servicegroup(name: 'foo')
     #
+    # @return [Hash] result
     #
     def delete_servicegroup( params = {} )
+
       name = params.dig(:name)
+
       if( name.nil? )
         return {
           status: 404,
@@ -44,34 +60,52 @@ module Icinga2
         }
       end
 
-      result = Network.delete(         host: name,
+      Network.delete(         host: name,
         url: format( '%s/v1/objects/servicegroups/%s?cascade=1', @icinga_api_url_base, name ),
         headers: @headers,
         options: @options )
 
-      JSON.pretty_generate( result )
     end
 
+    # returns all servicegroups
+    #
+    # @param [Hash] params
+    # @option params [String] :name ('') optional for a single servicegroup
     #
+    # @example to get all users
+    #    @icinga.servicegroups
     #
+    # @example to get one user
+    #    @icinga.servicegroups(name: 'disk')
+    #
+    # @return [Hash] returns a hash with all servicegroups
     #
     def servicegroups( params = {} )
+
       name = params.dig(:name)
-      result = Network.get(         host: name,
+
+      Network.get(         host: name,
         url: format( '%s/v1/objects/servicegroups/%s', @icinga_api_url_base, name ),
         headers: @headers,
         options: @options )
 
-      JSON.pretty_generate( result )
     end
 
+    # returns true if the servicegroup exists
     #
+    # @param [String] name the name of the servicegroups
     #
+    # @example
+    #    @icinga.exists_servicegroup?('disk')
+    #
+    # @return [Bool] returns true if the servicegroup exists
     #
     def exists_servicegroup?( name )
       result = servicegroups( name: name )
       result = JSON.parse( result ) if  result.is_a?( String )
-      status = result.dig('status')
+
+      status = result.dig(:status)
+
       return true if  !status.nil? && status == 200
       false
     end