icinga2 0.9.0.1 → 0.9.2.1

data/lib/icinga2/statistics.rb

@@ -10,7 +10,6 @@ module Icinga2
     # return statistic data for latency and execution_time
     #
     # @example
-    #    @icinga.cib_data
     #    latency, execution_time = @icinga.average_statistics.values
     #
     #    h = @icinga.average_statistics
@@ -21,6 +20,9 @@ module Icinga2
     #    * execution_time (Float)
     #
     def average_statistics
+
+      cib_data if((Time.now.to_i - @last_cib_data_called).to_i > @last_call_timeout)
+
       avg_latency        = @avg_latency.nil?        ? 0 : @avg_latency
       avg_execution_time = @avg_execution_time.nil? ? 0 : @avg_execution_time
 
@@ -33,7 +35,6 @@ module Icinga2
     # return statistic data for intervall data
     #
     # @example
-    #    @icinga.cib_data
     #    hosts_active_checks, hosts_passive_checks, services_active_checks, services_passive_checks = @icinga.interval_statistics.values
     #
     #    i = @icinga.interval_statistics
@@ -47,6 +48,8 @@ module Icinga2
     #
     def interval_statistics
 
+      cib_data if((Time.now.to_i - @last_cib_data_called).to_i > @last_call_timeout)
+
       # take a look into https://github.com/Icinga/pkg-icinga2-debian/blob/master/lib/icinga/cib.cpp
 
       hosts_active_checks     = @hosts_active_checks_1min.nil?     ? 0 : @hosts_active_checks_1min
@@ -65,7 +68,6 @@ module Icinga2
     # return statistic data for services
     #
     # @example
-    #    @icinga.cib_data
     #    ok, warning, critical, unknown, pending, in_downtime, ack = @icinga.service_statistics.values
     #
     #    s = @icinga.service_statistics
@@ -82,6 +84,8 @@ module Icinga2
     #
     def service_statistics
 
+      cib_data if((Time.now.to_i - @last_cib_data_called).to_i > @last_call_timeout)
+
       services_ok           = @services_ok.nil?           ? 0 : @services_ok
       services_warning      = @services_warning.nil?      ? 0 : @services_warning
       services_critical     = @services_critical.nil?     ? 0 : @services_critical
@@ -104,7 +108,6 @@ module Icinga2
     # return statistic data for hosts
     #
     # @example
-    #    @icinga.cib_data
     #    up, down, pending, unreachable, in_downtime, ack = @icinga.host_statistics.values
     #
     #    h = @icinga.host_statistics
@@ -120,6 +123,8 @@ module Icinga2
     #
     def host_statistics
 
+      cib_data if((Time.now.to_i - @last_cib_data_called).to_i > @last_call_timeout)
+
       hosts_up           = @hosts_up.nil?           ? 0 : @hosts_up
       hosts_down         = @hosts_down.nil?         ? 0 : @hosts_down
       hosts_pending      = @hosts_pending.nil?      ? 0 : @hosts_pending
@@ -148,7 +153,7 @@ module Icinga2
     def work_queue_statistics
 
       stats  = {}
-      data   = Network.api_data(
+      data   = api_data(
         url: format( '%s/status', @icinga_api_url_base ),
         headers: @headers,
         options: @options
@@ -156,12 +161,11 @@ module Icinga2
 
       return stats if data.nil?
 
-      if( data.dig(:status).nil? )
-        results = data.dig('results')
+      if( data.is_a?(Array) )
 
-        json_rpc_data  = results.find { |k| k['name'] == 'ApiListener' }
-        graphite_data  = results.find { |k| k['name'] == 'GraphiteWriter' }
-        ido_mysql_data = results.find { |k| k['name'] == 'IdoMysqlConnection' }
+        json_rpc_data  = data.find { |k| k['name'] == 'ApiListener' }
+        graphite_data  = data.find { |k| k['name'] == 'GraphiteWriter' }
+        ido_mysql_data = data.find { |k| k['name'] == 'IdoMysqlConnection' }
 
         json_rpc_data  = json_rpc_data.dig('status', 'api', 'json_rpc') unless( json_rpc_data.nil? )
         graphite_data  = graphite_data.dig('status', 'graphitewriter', 'graphite')       unless( graphite_data.nil? )

data/lib/icinga2/tools.rb

@@ -14,7 +14,7 @@ module Icinga2
     # @return [Bool]
     #
     def object_has_been_checked?( object )
-      object.dig('attrs', 'last_check').positive?
+      object.dig('attrs', 'last_check') > 0
     end
 
     # parse version string and extract version and revision

data/lib/icinga2/usergroups.rb

@@ -19,8 +19,8 @@ module Icinga2
     #
     def add_usergroup( params )
 
-      raise ArgumentError.new('only Hash are allowed') unless( params.is_a?(Hash) )
-      raise ArgumentError.new('missing params') if( params.size.zero? )
+      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)
@@ -33,7 +33,7 @@ module Icinga2
         }
       }
 
-      Network.put(
+      put(
         url: format( '%s/objects/usergroups/%s', @icinga_api_url_base, user_group ),
         headers: @headers,
         options: @options,
@@ -53,14 +53,14 @@ module Icinga2
     #
     def delete_usergroup( params )
 
-      raise ArgumentError.new('only Hash are allowed') unless( params.is_a?(Hash) )
-      raise ArgumentError.new('missing params') if( params.size.zero? )
+      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)
 
       raise ArgumentError.new('Missing user_group') if( user_group.nil? )
 
-      Network.delete(
+      delete(
         url: format( '%s/objects/usergroups/%s?cascade=1', @icinga_api_url_base, user_group ),
         headers: @headers,
         options: @options
@@ -91,15 +91,11 @@ module Icinga2
         format( '%s/objects/usergroups/%s', @icinga_api_url_base, user_group )
       end
 
-      data = Network.api_data(
+      api_data(
         url: url,
         headers: @headers,
         options: @options
       )
-
-      return data.dig('results') if( data.dig(:status).nil? )
-
-      nil
     end
 
     # returns true if the usergroup exists
@@ -113,15 +109,16 @@ module Icinga2
     #
     def exists_usergroup?( user_group )
 
-      raise ArgumentError.new('only String are allowed') unless( user_group.is_a?(String) )
-      raise ArgumentError.new('Missing user_group') if( user_group.size.zero? )
+      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 = result.first if( result.is_a?(Array) )
 
-      return true if  !result.nil? && result.is_a?(Array)
+      return false if( result.is_a?(Hash) && result.dig('code') == 404 )
 
-      false
+      true
     end
 
   end

data/lib/icinga2/users.rb

@@ -23,8 +23,8 @@ module Icinga2
     #
     def add_user( params )
 
-      raise ArgumentError.new('only Hash are allowed') unless( params.is_a?(Hash) )
-      raise ArgumentError.new('missing params') if( params.size.zero? )
+      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)
@@ -64,7 +64,7 @@ module Icinga2
         }
       end
 
-      Network.put(
+      put(
         url: format( '%s/objects/users/%s', @icinga_api_url_base, user_name ),
         headers: @headers,
         options: @options,
@@ -84,14 +84,14 @@ module Icinga2
     #
     def delete_user( params )
 
-      raise ArgumentError.new('only Hash are allowed') unless( params.is_a?(Hash) )
-      raise ArgumentError.new('missing params') if( params.size.zero? )
+      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)
 
       raise ArgumentError.new('Missing user_name') if( user_name.nil? )
 
-      Network.delete(
+      delete(
         url: format( '%s/objects/users/%s?cascade=1', @icinga_api_url_base, user_name ),
         headers: @headers,
         options: @options
@@ -109,10 +109,12 @@ module Icinga2
     # @example to get one user
     #    @icinga.users(user_name: 'icingaadmin')
     #
-    # @return [Hash] returns a hash
+    # @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) )
+
       user_name = params.dig(:user_name)
 
       url =
@@ -122,15 +124,11 @@ module Icinga2
         format( '%s/objects/users/%s', @icinga_api_url_base, user_name )
       end
 
-      data = Network.api_data(
+      api_data(
         url: url,
         headers: @headers,
         options: @options
       )
-
-      return data.dig('results') if( data.dig(:status).nil? )
-
-      nil
     end
 
     # checks if the user exists
@@ -144,15 +142,16 @@ module Icinga2
     #
     def exists_user?( user_name )
 
-      raise ArgumentError.new('only String are allowed') unless( user_name.is_a?(String) )
-      raise ArgumentError.new('Missing user_name') if( user_name.size.zero? )
+      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 = JSON.parse( result ) if  result.is_a?( String )
+      result = result.first if( result.is_a?(Array) )
 
-      return true if( !result.nil? && result.is_a?(Array) )
+      return false if( result.is_a?(Hash) && result.dig('code') == 404 )
 
-      false
+      true
     end
 
   end

data/lib/icinga2/version.rb

@@ -3,21 +3,7 @@
 
 module Icinga2
 
-  # namespace for version information
-  module Version
-
-    # major part of version
-    MAJOR = 0
-    # minor part of version
-    MINOR = 9
-    # tiny part of version
-    TINY  = 0
-    # patch part
-    PATCH = 1
-
-  end
-
   # Current version of gem.
-  VERSION = [Version::MAJOR, Version::MINOR, Version::TINY, Version::PATCH].compact * '.'
+  VERSION = '0.9.2.1' # [Version::MAJOR, Version::MINOR, Version::TINY, Version::PATCH].compact * '.'
 
 end

data/lib/monkey_patches.rb

@@ -0,0 +1,89 @@
+
+# -----------------------------------------------------------------------------
+# Monkey patches
+
+# Modify `Object` (https://gist.github.com/Integralist/9503099)
+
+# None of the above solutions work with a multi-level hash
+# They only work on the first level: {:foo=>"bar", :level1=>{"level2"=>"baz"}}
+# The following two variations solve the problem in the same way
+# transform hash keys to symbols
+# multi_hash = { 'foo' => 'bar', 'level1' => { 'level2' => 'baz' } }
+# multi_hash = multi_hash.deep_string_keys
+
+class Object
+
+  def deep_symbolize_keys
+
+    if( is_a?( Hash ) )
+      return inject({}) do |memo, (k, v)|
+        memo.tap { |m| m[k.to_sym] = v.deep_string_keys }
+      end
+    elsif( is_a?( Array ) )
+      return map(&:deep_string_keys)
+    end
+
+    self
+  end
+
+  def deep_string_keys
+
+    if( is_a?( Hash ) )
+      return inject({}) do |memo, (k, v)|
+        memo.tap { |m| m[k.to_s] = v.deep_string_keys }
+      end
+    elsif( is_a?( Array ) )
+      return map(&:deep_string_keys)
+    end
+
+    self
+  end
+
+end
+
+# -----------------------------------------------------------------------------
+
+class Array
+  def compare( comparate )
+    to_set == comparate.to_set
+  end
+end
+
+# -----------------------------------------------------------------------------
+
+# filter hash
+# example:
+# tags = [ 'foo', 'bar', 'fii' ]
+# useableTags = tags.filter( 'fii' )
+
+class Hash
+  def filter( *args )
+    if( args.size == 1 )
+      args[0] = args[0].to_s if  args[0].is_a?( Symbol )
+      select { |key| key.to_s.match( args.first ) }
+    else
+      select { |key| args.include?( key ) }
+    end
+  end
+end
+
+# -----------------------------------------------------------------------------
+
+class Time
+  def add_minutes(m)
+    self + (60 * m)
+  end
+end
+
+# -----------------------------------------------------------------------------
+
+# https://stackoverflow.com/questions/3028243/check-if-ruby-object-is-a-boolean/3028378#3028378
+
+module Boolean; end
+class TrueClass; include Boolean; end
+class FalseClass; include Boolean; end
+
+true.is_a?(Boolean) #=> true
+false.is_a?(Boolean) #=> true
+
+# -----------------------------------------------------------------------------

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: icinga2
 version: !ruby/object:Gem::Version
-  version: 0.9.0.1
+  version: 0.9.2.1
 platform: ruby
 authors:
 - Bodo Schulz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-25 00:00:00.000000000 Z
+date: 2017-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: ruby_dig
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: openssl
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -150,7 +150,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: Ruby Class for the Icinga2 API
+description: An enhanced ruby gem to communicate with Icinga2 API
 email: bodo@boone-schulz.de
 executables: []
 extensions: []
@@ -186,8 +186,20 @@ files:
 - doc/top-level-namespace.html
 - doc/usergroups.md
 - doc/users.md
+- examples/_blank.rb
+- examples/downtimes.rb
+- examples/hostgroups.rb
+- examples/hosts.rb
+- examples/informations.rb
+- examples/notifications.rb
+- examples/servicegroups.rb
+- examples/services.rb
+- examples/statistics.rb
 - examples/test.rb
+- examples/usergroups.rb
+- examples/users.rb
 - lib/icinga2.rb
+- lib/icinga2/client.rb
 - lib/icinga2/converts.rb
 - lib/icinga2/downtimes.rb
 - lib/icinga2/hostgroups.rb
@@ -203,6 +215,7 @@ files:
 - lib/icinga2/users.rb
 - lib/icinga2/version.rb
 - lib/logging.rb
+- lib/monkey_patches.rb
 homepage: https://github.com/bodsch/ruby-icinga2
 licenses:
 - LGPL-2.1+
@@ -215,7 +228,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="