icinga2 0.6.1 → 0.6.2

data/lib/icinga2/users.rb

@@ -3,25 +3,34 @@
 
 module Icinga2
 
-  #
-  #
-  #
+  # namespace for User handling
   module Users
 
+    # add a user
     #
+    # @param [Hash] params
+    # @option params [String] :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
     #
+    # @example
+    #   @icinga.add_user(name: 'foo', display_name: 'FOO', email: 'foo@bar.com', pager: '0000', groups: ['icingaadmins'])
+    #
+    # @return [Hash] result
     #
     def add_user( params = {} )
 
       name          = params.dig(:name)
-      display_name   = params.dig(:display_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) || []
 
       if( name.nil? )
-
         return {
           status: 404,
           message: 'missing user name'
@@ -29,7 +38,6 @@ module Icinga2
       end
 
       unless( groups.is_a?( Array ) )
-
         return {
           status: 404,
           message: 'groups must be an array',
@@ -51,9 +59,7 @@ module Icinga2
       group_validate = []
 
       groups.each do |g|
-
         group_validate << g if  exists_usergroup?( g ) == false
-
       end
 
       if( group_validate.count != 0 )
@@ -61,77 +67,97 @@ module Icinga2
         groups = group_validate.join(', ')
 
         return {
-
           status: 404,
           message: "these groups are not exists: #{groups}",
           data: params
         }
-
       end
 
-      result = Network.put(         host: name,
+      Network.put(         host: name,
         url: format( '%s/v1/objects/users/%s', @icinga_api_url_base, name ),
         headers: @headers,
         options: @options,
         payload: payload )
 
-      JSON.pretty_generate( result )
-
+      # result:
+      #   {:status=>200, :name=>nil, :message=>"Object was created"}
     end
 
+    # delete a user
     #
+    # @param [Hash] params
+    # @option params [String] :name user to delete
     #
+    # @example
+    #   @icinga.delete_user(name: 'foo')
+    #
+    # @return [Hash] result
     #
     def delete_user( params = {} )
 
       name = params.dig(:name)
 
       if( name.nil? )
-
         return {
           status: 404,
           message: 'missing user name'
         }
       end
 
-      result = Network.delete(         host: name,
+      Network.delete(         host: name,
         url: format( '%s/v1/objects/users/%s?cascade=1', @icinga_api_url_base, name ),
         headers: @headers,
         options: @options )
 
-      JSON.pretty_generate( result )
-
+      # result:
+      #   {:status=>200, :name=>"foo", :message=>"Object was deleted."}
     end
 
+    # returns all users
+    #
+    # @param [Hash] params
+    # @option params [String] :name ('') optional for a single user
     #
+    # @example to get all users
+    #    @icinga.users
     #
+    # @example to get one user
+    #    @icinga.users(name: 'icingaadmin')
+    #
+    # @return [Hash] returns a hash with all users
     #
     def users( params = {} )
 
       name = params.dig(:name)
 
-      result = Network.get(         host: name,
+      Network.get(         host: name,
         url: format( '%s/v1/objects/users/%s', @icinga_api_url_base, name ),
         headers: @headers,
         options: @options )
 
-      JSON.pretty_generate( result )
-
+      # result:
+      #  - named user:
+      #   {:status=>200, :data=>{"icingaadmin"=>{:name=>"icingaadmin", :display_name=>"Icinga 2 Admin", :type=>"User"}}}
+      #  - all users:
+      #   {:status=>200, :data=>{"icingaadmin"=>{:name=>"icingaadmin", :display_name=>"Icinga 2 Admin", :type=>"User"}, "foo"=>{:name=>"foo", :display_name=>"FOO", :type=>"User"}}}
     end
 
+    # returns true if the user exists
     #
+    # @param [String] name the name of the user
     #
+    # @example
+    #    @icinga.exists_user?('icingaadmin')
     #
+    # @return [Bool] returns true if the user exists
     def exists_user?( name )
 
       result = users( 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
 
   end

data/lib/icinga2/version.rb

@@ -3,17 +3,19 @@
 
 module Icinga2
 
-  #
-  #
-  #
+  # namespace for version information
   module Version
 
+    # major part of version
     MAJOR = 0
+    # minor part of version
     MINOR = 6
-    TINY  = 1
+    # tiny part of version
+    TINY  = 2
 
   end
 
+  # Current version of gem.
   VERSION = [Version::MAJOR, Version::MINOR, Version::TINY].compact * '.'
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: icinga2
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Bodo Schulz
@@ -158,13 +158,24 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- doc/Icinga2.html
+- doc/Logging.html
+- doc/_index.html
+- doc/class_list.html
 - doc/downtimes.md
 - doc/examples
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
 - doc/hostgroups.md
 - doc/hosts.md
+- doc/index.html
+- doc/method_list.html
 - doc/notifications.md
 - doc/servicegroups.md
 - doc/services.md
+- doc/status.md
+- doc/top-level-namespace.html
 - doc/usergroups.md
 - doc/users.md
 - examples/test.rb
@@ -203,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Icinga2 API