icinga2 0.9.2.1 → 0.9.2.8

data/lib/icinga2/tools.rb

@@ -45,7 +45,7 @@ module Icinga2
 
     # return count of handled problems
     #
-    # @param [Hash] objects
+    # @param [Array] objects
     # @param [Integer] state (nil)
     #
     # @example for host objects
@@ -66,16 +66,17 @@ module Icinga2
     #
     def count_problems( objects, state = nil )
 
-      compare_states = []
+      raise ArgumentError.new(format('wrong type. \'objects\' must be an Array, given \'%s\'', objects.class.to_s)) unless( objects.is_a?(Array) )
+      #raise ArgumentError.new('missing objects') if( objects.size.zero? )
 
-      unless( state.nil? )
+      raise ArgumentError.new(format('wrong type. \'state\' must be an Integer, given \'%s\'', state.class.to_s)) unless( state.nil? || state.is_a?(Integer) )
 
-        # 0 = "Up"   or "OK"
-        # 1 = "Down" or "Warning"
-        # 2 = "Critical"
-        # 3 = "Unknown"
-        compare_states = [1, 2, 3]
-      end
+      # 0 = "Up"   or "OK"
+      # 1 = "Down" or "Warning"
+      # 2 = "Critical"
+      # 3 = "Unknown"
+      compare_states = []
+      compare_states = [1, 2, 3] unless( state.nil? )
 
       compare_states.push(state) if( state.is_a?(Integer) )
 

data/lib/icinga2/usergroups.rb

@@ -9,8 +9,8 @@ module Icinga2
     # add a usergroup
     #
     # @param [Hash] params
-    # @option params [String] :user_group usergroup to create
-    # @option params [String] :display_name the displayed name
+    # @option params [String] user_group usergroup to create
+    # @option params [String] display_name the displayed name
     #
     # @example
     #   @icinga.add_usergroup(user_group: 'foo', display_name: 'FOO')
@@ -22,17 +22,19 @@ 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? )
 
-      user_group   = params.dig(:user_group)
-      display_name = params.dig(:display_name)
-
-      raise ArgumentError.new('Missing user_group') if( user_group.nil? )
+      user_group   = validate( params, required: true, var: 'user_group', type: String )
+      display_name = validate( params, required: false, var: 'display_name', type: String )
 
       payload = {
-        'attrs' => {
-          'display_name' => display_name
+        attrs: {
+          display_name: display_name
         }
       }
 
+      # remove all empty attrs
+      payload.reject!{ |_k, v| v.nil? }
+      payload[:attrs].reject!{ |_k, v| v.nil? }
+
       put(
         url: format( '%s/objects/usergroups/%s', @icinga_api_url_base, user_group ),
         headers: @headers,
@@ -43,22 +45,17 @@ module Icinga2
 
     # delete a usergroup
     #
-    # @param [Hash] params
-    # @option params [String] :user_group usergroup to delete
+    # @param [String] user_group usergroup to delete
     #
     # @example
-    #   @icinga.delete_usergroup(user_group: 'foo')
+    #   @icinga.delete_usergroup('foo')
     #
     # @return [Hash] result
     #
-    def delete_usergroup( 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? )
-
-      user_group = params.dig(:user_group)
+    def delete_usergroup( user_group )
 
-      raise ArgumentError.new('Missing user_group') if( user_group.nil? )
+      raise ArgumentError.new(format('wrong type. \'user_group\' must be an String, given \'%s\'', user_group.class.to_s)) unless( user_group.is_a?(String) )
+      raise ArgumentError.new('missing \'user_group\'') if( user_group.size.zero? )
 
       delete(
         url: format( '%s/objects/usergroups/%s?cascade=1', @icinga_api_url_base, user_group ),
@@ -69,27 +66,20 @@ module Icinga2
 
     # returns all usersgroups
     #
-    # @param [Hash] params
-    # @option params [String] :user_group ('') optional for a single usergroup
+    # @param [String] user_group (nil) optional for a single usergroup
     #
     # @example to get all users
     #    @icinga.usergroups
     #
     # @example to get one user
-    #    @icinga.usergroups(user_group: 'icingaadmins')
+    #    @icinga.usergroups('icingaadmins')
     #
     # @return [Hash] returns a hash with all usergroups
     #
-    def usergroups( params = {} )
-
-      user_group = params.dig(:user_group)
+    def usergroups( user_group = nil )
 
-      url =
-      if( user_group.nil? )
-        format( '%s/objects/usergroups'   , @icinga_api_url_base )
-      else
-        format( '%s/objects/usergroups/%s', @icinga_api_url_base, user_group )
-      end
+      url = format( '%s/objects/usergroups'   , @icinga_api_url_base )
+      url = format( '%s/objects/usergroups/%s', @icinga_api_url_base, user_group ) unless( user_group.nil? )
 
       api_data(
         url: url,
@@ -112,8 +102,8 @@ module Icinga2
       raise ArgumentError.new(format('wrong type. \'user_group\' must be an String, given \'%s\'', user_group.class.to_s)) unless( user_group.is_a?(String) )
       raise ArgumentError.new('Missing \'user_group\'') if( user_group.size.zero? )
 
-      result = usergroups( user_group: user_group )
-      result = JSON.parse( result ) if  result.is_a?( String )
+      result = usergroups( user_group )
+      result = JSON.parse( result ) if result.is_a?( String )
       result = result.first if( result.is_a?(Array) )
 
       return false if( result.is_a?(Hash) && result.dig('code') == 404 )

data/lib/icinga2/users.rb

@@ -9,43 +9,47 @@ module Icinga2
     # add a user
     #
     # @param [Hash] params
-    # @option params [String] :user_name ('') user to create
-    # @option params [String] :display_name ('') the displayed name
-    # @option params [String] :email ('') the user email
-    # @option params [String] :pager ('') optional a pager
-    # @option params [Bool] :enable_notifications (false) enable notifications for this user
-    # @option params [Array] :groups ([]) a hash with groups
+    # @option params [String] user_name  user to create
+    # @option params [String] display_name ('') the displayed name
+    # @option params [String] email ('') the user email
+    # @option params [String] pager ('') optional a pager
+    # @option params [Bool] enable_notifications (false) enable notifications for this user
+    # @option params [Array] groups ([]) a hash with groups
+    # @option params [String] period
+    # @option params [Array] states
+    # @option params [Array] types
+    # @option params [Hash] vars
     #
     # @example
-    #   @icinga.add_user(user_name: 'foo', display_name: 'FOO', email: 'foo@bar.com', pager: '0000', groups: ['icingaadmins'])
+    #    param = {
+    #      user_name: 'foo',
+    #      display_name: 'FOO',
+    #      email: 'foo@bar.com',
+    #      pager: '0000',
+    #      groups: ['icingaadmins']
+    #    }
+    #    @icinga.add_user(param)
     #
     # @return [Hash] result
+    #    * code [Integer]
+    #    * message [String]
+    #    * data (optional)
     #
     def add_user( 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? )
 
-      user_name     = params.dig(:user_name)
-      display_name  = params.dig(:display_name)
-      email         = params.dig(:email)
-      pager         = params.dig(:pager)
-      notifications = params.dig(:enable_notifications) || false
-      groups        = params.dig(:groups) || []
-
-      raise ArgumentError.new('Missing user_name') if( user_name.nil? )
-      raise ArgumentError.new('groups must be an array') unless( groups.is_a?( Array ) )
-
-      payload = {
-        'attrs' => {
-          'display_name'         => display_name,
-          'email'                => email,
-          'pager'                => pager,
-          'enable_notifications' => notifications
-        }
-      }
-
-      payload['attrs']['groups'] = groups unless  groups.empty?
+      user_name = validate( params, required: true, var: 'user_name', type: String )
+      display_name = validate( params, required: false, var: 'display_name', type: String )
+      email = validate( params, required: false, var: 'email', type: String )
+      pager = validate( params, required: false, var: 'pager', type: String )
+      notifications = validate( params, required: false, var: 'enable_notifications', type: Boolean ) || false
+      groups = validate( params, required: false, var: 'groups', type: Array ) || []
+      period = validate( params, required: false, var: 'period', type: String )
+      states = validate( params, required: false, var: 'states', type: Array )
+      types = validate( params, required: false, var: 'types', type: Array )
+      vars = validate( params, required: false, var: 'vars', type: Hash ) || {}
 
       group_validate = []
 
@@ -54,16 +58,31 @@ module Icinga2
       end
 
       if( group_validate.count != 0 )
-
-        groups = group_validate.join(', ')
-
         return {
-          status: 404,
-          message: "these groups are not exists: #{groups}",
-          data: params
+          'code' => 404,
+          'message' => format('these groups are not exists: \'%s\'', group_validate.join(', ')),
+          'data' => params
         }
       end
 
+      payload = {
+        attrs: {
+          display_name: display_name,
+          email: email,
+          pager: pager,
+          enable_notifications: notifications,
+          groups: groups,
+          period: period,
+          states: states,
+          types: types,
+          vars: vars
+        }
+      }
+
+      # remove all empty attrs
+      payload.reject!{ |_k, v| v.nil? }
+      payload[:attrs].reject!{ |_k, v| v.nil? }
+
       put(
         url: format( '%s/objects/users/%s', @icinga_api_url_base, user_name ),
         headers: @headers,
@@ -74,22 +93,17 @@ module Icinga2
 
     # delete a user
     #
-    # @param [Hash] params
-    # @option params [String] :user_name user to delete
+    # @param [String] user_name user to delete
     #
     # @example
-    #   @icinga.delete_user(user_name: 'foo')
+    #   @icinga.delete_user('foo')
     #
     # @return [Hash] result
     #
-    def delete_user( 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? )
-
-      user_name = params.dig(:user_name)
+    def delete_user( user_name )
 
-      raise ArgumentError.new('Missing user_name') if( user_name.nil? )
+      raise ArgumentError.new(format('wrong type. \'user_name\' must be an String, given \'%s\'',user_name.class.to_s)) unless( user_name.is_a?(String) )
+      raise ArgumentError.new('Missing user_name') if( user_name.size.zero? )
 
       delete(
         url: format( '%s/objects/users/%s?cascade=1', @icinga_api_url_base, user_name ),
@@ -100,29 +114,20 @@ module Icinga2
 
     # returns a named or all users
     #
-    # @param [Hash] params
-    # @option params [String] :user_name ('') optional for a single user
+    # @param [String] user_name ('') optional for a single user
     #
     # @example to get all users
     #    @icinga.users
     #
     # @example to get one user
-    #    @icinga.users(user_name: 'icingaadmin')
+    #    @icinga.users('icingaadmin')
     #
     # @return [Array]
     #
-    def users( params = {} )
-
-      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+    def users( user_name = nil )
 
-      user_name = params.dig(:user_name)
-
-      url =
-      if( user_name.nil? )
-        format( '%s/objects/users'   , @icinga_api_url_base )
-      else
-        format( '%s/objects/users/%s', @icinga_api_url_base, user_name )
-      end
+      url = format( '%s/objects/users'   , @icinga_api_url_base )
+      url = format( '%s/objects/users/%s', @icinga_api_url_base, user_name ) unless( user_name.nil? )
 
       api_data(
         url: url,
@@ -145,8 +150,8 @@ module Icinga2
       raise ArgumentError.new(format('wrong type. \'user_name\' must be an String, given \'%s\'', user_name.class.to_s)) unless( user_name.is_a?(String) )
       raise ArgumentError.new('Missing \'user_name\'') if( user_name.size.zero? )
 
-      result = users( user_name: user_name )
-      result = JSON.parse( result ) if  result.is_a?( String )
+      result = users( user_name )
+      result = JSON.parse( result ) if result.is_a?( String )
       result = result.first if( result.is_a?(Array) )
 
       return false if( result.is_a?(Hash) && result.dig('code') == 404 )

data/lib/icinga2/validator.rb

@@ -0,0 +1,59 @@
+
+class Hash
+  def assert_required_keys(*keys)
+    keys.flatten.each do |key|
+      raise ArgumentError.new("Required key: #{key.inspect}") unless key?(key)
+    end
+  end
+
+  def assert_valid_keys(params, *valid_keys)
+    valid_keys.flatten!
+    params.each_key do |k|
+      unless valid_keys.include?(k)
+        raise ArgumentError.new("Unknown key: #{k.inspect}. Valid keys are: #{valid_keys.map(&:inspect).join(', ')}")
+      end
+    end
+  end
+end
+
+
+module Icinga2
+
+  # namespace for validate options
+  module Validator
+
+    def validate_options!(params, options)
+      options[:optional] ||= []
+      options[:required] ||= []
+
+      params = params.deep_symbolize_keys
+      params.assert_required_keys(options[:required])
+      params.assert_valid_keys(params, options[:required] + options[:optional])
+    end
+
+    # validate( params, { required: true, var: name, type: String } )
+    def validate( params, options )
+      required = options.dig(:required) || false
+      var      = options.dig(:var)
+      type     = options.dig(:type)
+
+      params   = params.deep_symbolize_keys
+
+      variable = params.dig(var.to_sym)
+
+#       puts params
+#       puts options
+
+      clazz = Object.const_get(type.to_s)
+
+      if(required == true )
+        raise ArgumentError.new(format('\'%s\' is requiered and missing!', var)) if(variable.nil?)
+      end
+
+      raise ArgumentError.new(format('wrong type. \'%s\' must be an %s, given \'%s\'', var, type, variable.class.to_s)) unless( variable.nil? || variable.is_a?(clazz) )
+
+      variable
+    end
+
+  end
+end

data/lib/icinga2/version.rb

@@ -4,6 +4,6 @@
 module Icinga2
 
   # Current version of gem.
-  VERSION = '0.9.2.1' # [Version::MAJOR, Version::MINOR, Version::TINY, Version::PATCH].compact * '.'
+  VERSION = '0.9.2.8'.freeze # [Version::MAJOR, Version::MINOR, Version::TINY, Version::PATCH].compact * '.'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: icinga2
 version: !ruby/object:Gem::Version
-  version: 0.9.2.1
+  version: 0.9.2.8
 platform: ruby
 authors:
 - Bodo Schulz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-16 00:00:00.000000000 Z
+date: 2017-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_dig
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +53,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-notes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-checkstyle_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-nc
   requirement: !ruby/object:Gem::Requirement
@@ -187,6 +257,7 @@ files:
 - doc/usergroups.md
 - doc/users.md
 - examples/_blank.rb
+- examples/config.rb
 - examples/downtimes.rb
 - examples/hostgroups.rb
 - examples/hosts.rb
@@ -205,7 +276,6 @@ files:
 - lib/icinga2/hostgroups.rb
 - lib/icinga2/hosts.rb
 - lib/icinga2/network.rb
-- lib/icinga2/network.rb-SAVE
 - lib/icinga2/notifications.rb
 - lib/icinga2/servicegroups.rb
 - lib/icinga2/services.rb
@@ -213,6 +283,7 @@ files:
 - lib/icinga2/tools.rb
 - lib/icinga2/usergroups.rb
 - lib/icinga2/users.rb
+- lib/icinga2/validator.rb
 - lib/icinga2/version.rb
 - lib/logging.rb
 - lib/monkey_patches.rb