icinga2 0.9.2.1 → 0.9.2.8

data/lib/icinga2/network.rb

@@ -8,11 +8,11 @@ module Icinga2
     # 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
+    # @option params [String] host
+    # @option params [String] url
+    # @option params [String] headers
+    # @option params [String] options
+    # @option params [Hash] payload
     #
     #
     # @return [Hash]
@@ -22,25 +22,16 @@ module Icinga2
       raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
       raise ArgumentError.new('missing params') if( params.size.zero? )
 
-      url     = params.dig(:url)
-      headers = params.dig(:headers)
-      options = params.dig(:options)
-      payload = params.dig(:payload)
-
-      raise ArgumentError.new('Missing url') if( url.nil? )
-      raise ArgumentError.new('Missing headers') if( headers.nil? )
-      raise ArgumentError.new('Missing options') if( options.nil? )
+      url     = validate( params, required: true, var: 'url', type: String )
+      headers = validate( params, required: true, var: 'headers', type: Hash )
+      options = validate( params, required: true, var: 'options', type: Hash ).deep_symbolize_keys
+      payload = validate( params, required: false, var: 'payload', type: Hash )
 
       rest_client = RestClient::Resource.new( URI.encode( url ), options )
 
-      if( payload )
-        raise ArgumentError.new('only Hash for payload are allowed') unless( payload.is_a?(Hash) )
-        headers['X-HTTP-Method-Override'] = 'GET'
-        method = 'POST'
-      else
-        headers['X-HTTP-Method-Override'] = 'GET'
-        method = 'GET'
-      end
+      headers['X-HTTP-Method-Override'] = 'GET'
+      method = 'GET'
+      method = 'POST' if( payload )
 
       begin
         data = request( rest_client, method, headers, payload )
@@ -50,9 +41,7 @@ module Icinga2
         data = data.dig('results') if( data.is_a?(Hash) )
 
         return data
-
       rescue => e
-
         logger.error(e)
         logger.error(e.backtrace.join("\n"))
 
@@ -63,11 +52,11 @@ module Icinga2
     # static function for GET Requests without filters
     #
     # @param [Hash] params
-    # @option params [String] :host
-    # @option params [String] :url
-    # @option params [String] :headers
-    # @option params [String] :options
-    # @option params [Hash] :payload
+    # @option params [String] host
+    # @option params [String] url
+    # @option params [String] headers
+    # @option params [String] options
+    # @option params [Hash] payload
     #
     #
     # @return [Hash]
@@ -77,25 +66,16 @@ module Icinga2
       raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
       raise ArgumentError.new('missing params') if( params.size.zero? )
 
-      url     = params.dig(:url)
-      headers = params.dig(:headers)
-      options = params.dig(:options)
-
-      raise ArgumentError.new('Missing url') if( url.nil? )
-      raise ArgumentError.new('Missing headers') if( headers.nil? )
-      raise ArgumentError.new('Missing options') if( options.nil? )
+      url     = validate( params, required: true, var: 'url', type: String )
+      headers = validate( params, required: true, var: 'headers', type: Hash )
+      options = validate( params, required: true, var: 'options', type: Hash ).deep_symbolize_keys
 
       begin
-
         data = api_data( url: url, headers: headers, options: options )
         data = data.first if( data.is_a?(Array) )
 
-        data
-
         return data.dig('status') unless( data.nil? )
-
       rescue => e
-
         logger.error(e)
         logger.error(e.backtrace.join("\n"))
 
@@ -107,10 +87,10 @@ module Icinga2
     # static function for POST Requests
     #
     # @param [Hash] params
-    # @option params [String] :url
-    # @option params [String] :headers
-    # @option params [String] :options
-    # @option params [Hash] :payload
+    # @option params [String] url
+    # @option params [String] headers
+    # @option params [String] options
+    # @option params [Hash] payload
     #
     #
     # @return [Hash]
@@ -120,17 +100,13 @@ module Icinga2
       raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
       raise ArgumentError.new('missing params') if( params.size.zero? )
 
-      url     = params.dig(:url)
-      headers = params.dig(:headers)
-      options = params.dig(:options)
-      payload = params.dig(:payload)
-
-      raise ArgumentError.new('Missing url') if( url.nil? )
-      raise ArgumentError.new('Missing headers') if( headers.nil? )
-      raise ArgumentError.new('Missing options') if( options.nil? )
-      raise ArgumentError.new('only Hash for payload are allowed') unless( payload.is_a?(Hash) )
+      url     = validate( params, required: true, var: 'url', type: String )
+      headers = validate( params, required: true, var: 'headers', type: Hash )
+      options = validate( params, required: true, var: 'options', type: Hash ).deep_symbolize_keys
+      payload = validate( params, required: false, var: 'payload', type: Hash )
 
       rest_client = RestClient::Resource.new( URI.encode( url ), options )
+
       headers['X-HTTP-Method-Override'] = 'POST'
 
       begin
@@ -141,9 +117,7 @@ module Icinga2
         data = data.dig('results').first if( data.is_a?(Hash) )
 
         return { 'code' => data.dig('code').to_i, 'name' => data.dig('name'), 'status' => data.dig('status') } unless( data.nil? )
-
       rescue => e
-
         logger.error(e)
         logger.error(e.backtrace.join("\n"))
 
@@ -154,11 +128,11 @@ module Icinga2
     # 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
+    # @option params [String] host
+    # @option params [String] url
+    # @option params [String] headers
+    # @option params [String] options
+    # @option params [Hash] payload
     #
     #
     # @return [Hash]
@@ -168,21 +142,16 @@ module Icinga2
       raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
       raise ArgumentError.new('missing params') if( params.size.zero? )
 
-      url     = params.dig(:url)
-      headers = params.dig(:headers)
-      options = params.dig(:options)
-      payload = params.dig(:payload)
-
-      raise ArgumentError.new('Missing url') if( url.nil? )
-      raise ArgumentError.new('Missing headers') if( headers.nil? )
-      raise ArgumentError.new('Missing options') if( options.nil? )
-      raise ArgumentError.new('only Hash for payload are allowed') unless( payload.is_a?(Hash) )
+      url     = validate( params, required: true, var: 'url', type: String )
+      headers = validate( params, required: true, var: 'headers', type: Hash )
+      options = validate( params, required: true, var: 'options', type: Hash ).deep_symbolize_keys
+      payload = validate( params, required: false, var: 'payload', type: Hash )
 
       rest_client = RestClient::Resource.new( URI.encode( url ), options )
+
       headers['X-HTTP-Method-Override'] = 'PUT'
 
       begin
-
         data = request( rest_client, 'PUT', headers, payload )
         data = JSON.parse( data ) if( data.is_a?(String) )
         data = data.deep_string_keys
@@ -195,9 +164,7 @@ module Icinga2
         end
 
         return { 'code' => results.dig('code').to_i, 'name' => results.dig('name'), 'status' => results.dig('status') } unless( results.nil? )
-
       rescue => e
-
         logger.error(e)
         logger.error(e.backtrace.join("\n"))
 
@@ -208,9 +175,9 @@ module Icinga2
     # static function for DELETE Requests
     #
     # @param [Hash] params
-    # @option params [String] :url
-    # @option params [String] :headers
-    # @option params [String] :options
+    # @option params [String] url
+    # @option params [String] headers
+    # @option params [String] options
     #
     #
     # @return [Hash]
@@ -220,15 +187,12 @@ module Icinga2
       raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
       raise ArgumentError.new('missing params') if( params.size.zero? )
 
-      url     = params.dig(:url)
-      headers = params.dig(:headers)
-      options = params.dig(:options)
-
-      raise ArgumentError.new('Missing url') if( url.nil? )
-      raise ArgumentError.new('Missing headers') if( headers.nil? )
-      raise ArgumentError.new('Missing options') if( options.nil? )
+      url     = validate( params, required: true, var: 'url', type: String )
+      headers = validate( params, required: true, var: 'headers', type: Hash )
+      options = validate( params, required: true, var: 'options', type: Hash ).deep_symbolize_keys
 
       rest_client = RestClient::Resource.new( URI.encode( url ), options )
+
       headers['X-HTTP-Method-Override'] = 'DELETE'
 
       begin
@@ -245,7 +209,6 @@ module Icinga2
         end
 
         return { 'code' => results.dig('code').to_i, 'name' => results.dig('name'), 'status' => results.dig('status') } unless( results.nil? )
-
       rescue => e
         logger.error(e)
         logger.error(e.backtrace.join("\n"))
@@ -264,10 +227,7 @@ module Icinga2
 
       raise ArgumentError.new('client must be an RestClient::Resource') unless( client.is_a?(RestClient::Resource) )
       raise ArgumentError.new('method must be an \'GET\', \'POST\', \'PUT\' or \'DELETE\'') unless( %w[GET POST PUT DELETE].include?(method) )
-
-      unless( data.nil? )
-        raise ArgumentError.new(format('data must be an Hash (%s)', data.class.to_s)) unless( data.is_a?(Hash) )
-      end
+      raise ArgumentError.new(format('data must be an Hash (%s)', data.class.to_s)) unless( data.nil? || data.is_a?(Hash) )
 
       max_retries = 3
       retried     = 0
@@ -286,16 +246,9 @@ module Icinga2
           client.put( data.to_json, headers ) do |response, req, _result|
 
             @req           = req
-            @response_raw  = response
             @response_body = response.body
             @response_code = response.code.to_i
 
-            # logger.debug('----------------------------')
-            # logger.debug(@response_raw)
-            # logger.debug(@response_body)
-            # logger.debug(@response_code)
-            # logger.debug('----------------------------')
-
             case response.code
             when 200
               return @response_body
@@ -313,7 +266,6 @@ module Icinga2
         when 'DELETE'
           response = client.delete( @headers )
         else
-          @logger.error( "Error: #{__method__} is not a valid request method." )
           return false
         end
 
@@ -327,28 +279,15 @@ module Icinga2
 
         response_body = JSON.parse(response_body) if response_body.is_a?(String)
 
-        return {
-         'results' => [{
-           'code' => 400,
-           'status' => response_body.nil? ? 'Bad Request' : response_body
-          }]
-        }
+        return { 'results' => [{ 'code' => 400, 'status' => response_body.nil? ? 'Bad Request' : response_body }] }
 
       rescue RestClient::Unauthorized
 
-        return {
-            'code' => 401,
-            'status' => format('Not authorized to connect \'%s\' - wrong username or password?', @icinga_api_url_base)
-        }
+        return { 'results' => [{ 'code'  => 401, 'status' => format('Not authorized to connect \'%s\' - wrong username or password?', @icinga_api_url_base) }] }
 
       rescue RestClient::NotFound
 
-        return {
-          'results' => [{
-            'code' => 404,
-            'status' => 'Object not Found'
-          }]
-        }
+        return { 'results' => [{ 'code' => 404, 'status' => 'Object not Found' }] }
 
       rescue RestClient::InternalServerError
 
@@ -361,12 +300,7 @@ module Icinga2
         errors  = errors.first if( errors.is_a?(Array) )
         errors  = errors.sub(/ \'.*\'/,'')
 
-        return {
-          'results' => [{
-            'code' => 500,
-            'status' => format('%s (%s)', status, errors).delete('.')
-          }]
-        }
+        return { 'results' => [{ 'code' => 500, 'status' => format('%s (%s)', status, errors).delete('.') }] }
 
       rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH => e
 
@@ -375,7 +309,7 @@ module Icinga2
         raise format( "Maximum retries (%d) against '%s' reached. Giving up ...", max_retries, @icinga_api_url_base ) if( retried >= max_retries )
 
         retried += 1
-        $stderr.puts(format("Cannot execute request against '%s': '%s' (retry %d / %d)", @icinga_api_url_base, e, retried, max_retries))
+        warn(format("Cannot execute request against '%s': '%s' (retry %d / %d)", @icinga_api_url_base, e, retried, max_retries))
         sleep(3)
         retry
 
@@ -386,13 +320,7 @@ module Icinga2
         @logger.error( @headers )
         @logger.error( JSON.pretty_generate( response_headers ) )
 
-
-        return {
-          'results' => [{
-            'code' => 500,
-            'status' => e
-          }]
-        }
+        return { 'results' => [{ 'code' => 500, 'status' => e }] }
       end
 
     end

data/lib/icinga2/notifications.rb

@@ -84,50 +84,40 @@ module Icinga2
 
     # enable hostgroup notifications
     #
-    # @param [Hash] params
-    # @option params [String] host
-    # @option params [String] host_group
+    # @param [String] host_group
     #
     # @example
-    #    @icinga.enable_hostgroup_notification(host: 'icinga2', host_group: 'linux-servers')
+    #    @icinga.enable_hostgroup_notification('linux-servers')
     #
     # @return [Hash]
     #
-    def enable_hostgroup_notification( params )
+    def enable_hostgroup_notification( host_group )
 
-      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
-      raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
+      raise ArgumentError.new(format('wrong type. \'host_group\' must be an String, given \'%s\'', host_group.class.to_s)) unless( host_group.is_a?(String) )
+      raise ArgumentError.new('missing \'host_group\'') if( host_group.size.zero? )
 
-      host_group = params.dig(:host_group)
-      raise ArgumentError.new('Missing host_group') if( host_group.nil? )
-
-      return { 'code' => 404, 'status' => 'Object not Found' } if( exists_hostgroup?( host_group ) == false )
+      return { 'code' => 404, 'status' => 'Object not Found' } unless( exists_hostgroup?( host_group ) )
 
       hostgroup_notification( host_group: host_group, enable_notifications: true )
     end
 
     # disable hostgroup notifications
     #
-    # @param [Hash] params
-    # @option params [String] host
-    # @option params [String] host_group
+    # @param [String] host_group
     #
     # @example
-    #    @icinga.disable_hostgroup_notification(host: 'icinga2', host_group: 'linux-servers')
+    #    @icinga.disable_hostgroup_notification('linux-servers')
     #
     # @return [Hash]
     #
-    def disable_hostgroup_notification( params )
+    def disable_hostgroup_notification( host_group )
 
-      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
-      raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
-
-      host_group = params.dig(:host_group)
-      raise ArgumentError.new('Missing host_group') if( host_group.nil? )
+      raise ArgumentError.new(format('wrong type. \'host_group\' must be an String, given \'%s\'', host_group.class.to_s)) unless( host_group.is_a?(String) )
+      raise ArgumentError.new('missing \'host_group\'') if( host_group.size.zero? )
 
       return { 'code' => 404, 'status' => 'Object not Found' } if( exists_hostgroup?( host_group ) == false )
 
-      hostgroup_notification( host_group: host_group, enable_notifications: true )
+      hostgroup_notification( host_group: host_group, enable_notifications: false )
     end
 
     # return all notifications
@@ -154,16 +144,15 @@ module Icinga2
     #
     # @return [Hash]
     #
-    def host_notification( params = {} )
+    def host_notification( params )
 
-      name          = params.dig(:name)
-      notifications = params.dig(:enable_notifications) || false
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing params') if( params.size.zero? )
 
-      payload = {
-        'attrs'     => {
-          'enable_notifications' => notifications
-        }
-      }
+      name = validate( params, required: true, var: 'name', type: String )
+      notifications = validate( params, required: false, var: 'enable_notifications', type: Boolean ) || false
+
+      payload = { attrs: { enable_notifications: notifications } }
 
       post(
         url: format( '%s/objects/hosts/%s', @icinga_api_url_base, name ),
@@ -177,21 +166,22 @@ module Icinga2
     # @api protected
     #
     # @param [Hash] params
-    # @option params [String] host_group
-    # @option params [Bool] enable_notifications (false)
+    # @option params [String] :host_group
+    # @option params [Bool] :enable_notifications (false)
     #
     # @return [Hash]
     #
-    def hostgroup_notification( params = {} )
+    def hostgroup_notification( params )
 
-      group         = params.dig(:host_group)
-      notifications = params.dig(:enable_notifications) || false
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing params') if( params.size.zero? )
+
+      group = validate( params, required: true, var: 'host_group', type: String )
+      notifications = validate( params, required: false, var: 'enable_notifications', type: Boolean ) || false
 
       payload = {
-        'filter'    => format( '"%s" in host.groups', group ),
-        'attrs'     => {
-          'enable_notifications' => notifications
-        }
+        filter: format( '"%s" in host.groups', group ),
+        attrs: { enable_notifications: notifications }
       }
 
       post(
@@ -211,16 +201,17 @@ module Icinga2
     #
     # @return [Hash]
     #
-    def service_notification( params = {} )
+    def service_notification( params )
+
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing params') if( params.size.zero? )
 
-      name          = params.dig(:name)
-      notifications = params.dig(:enable_notifications) || false
+      name = validate( params, required: true, var: 'name', type: String )
+      notifications = validate( params, required: false, var: 'enable_notifications', type: Boolean ) || false
 
       payload = {
-        'filter'    => format( 'host.name=="%s"', name ),
-        'attrs'     => {
-          'enable_notifications' => notifications
-        }
+        filter: format( 'host.name=="%s"', name ),
+        attrs: { enable_notifications: notifications }
       }
 
       post(