zabbixapi 4.0.0 → 5.0.0.pre.alpha1

data/lib/zabbixapi/classes/server.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # @return [String] Zabbix API version number
     def initialize(client)
       @client = client
-      @version = @client.api_request(:method => 'apiinfo.version', :params => {})
+      @version = @client.api_version()
     end
   end
 end

data/lib/zabbixapi/classes/templates.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # The id field name used for identifying specific Template objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'host'
     end
 
@@ -21,7 +21,7 @@ class ZabbixApi
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Integer] The Template object id that was deleted
     def delete(data)
-      result = @client.api_request(:method => 'template.delete', :params => [data])
+      result = @client.api_request(method: 'template.delete', params: [data])
       result.empty? ? nil : result['templateids'][0].to_i
     end
 
@@ -32,11 +32,9 @@ class ZabbixApi
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Array] Returns array of Template ids
     def get_ids_by_host(data)
-      result = []
-      @client.api_request(:method => 'template.get', :params => data).each do |tmpl|
-        result << tmpl['templateid']
+      @client.api_request(method: 'template.get', params: data).map do |tmpl|
+        tmpl['templateid']
       end
-      result
     end
 
     # Get or Create Template object using Zabbix API
@@ -46,7 +44,7 @@ class ZabbixApi
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Integer] Zabbix object id
     def get_or_create(data)
-      unless (templateid = get_id(:host => data[:host]))
+      unless (templateid = get_id(host: data[:host]))
         templateid = create(data)
       end
       templateid
@@ -60,10 +58,10 @@ class ZabbixApi
     # @return [Boolean]
     def mass_update(data)
       result = @client.api_request(
-        :method => 'template.massUpdate',
-        :params => {
-          :hosts => data[:hosts_id].map { |t| {:hostid => t} },
-          :templates => data[:templates_id].map { |t| {:templateid => t} },
+        method: 'template.massUpdate',
+        params: {
+          hosts: data[:hosts_id].map { |t| { hostid: t } },
+          templates: data[:templates_id].map { |t| { templateid: t } }
         }
       )
       result.empty? ? false : true
@@ -77,10 +75,10 @@ class ZabbixApi
     # @return [Boolean]
     def mass_add(data)
       result = @client.api_request(
-        :method => 'template.massAdd',
-        :params => {
-          :hosts => data[:hosts_id].map { |t| {:hostid => t} },
-          :templates => data[:templates_id].map { |t| {:templateid => t} },
+        method: 'template.massAdd',
+        params: {
+          hosts: data[:hosts_id].map { |t| { hostid: t } },
+          templates: data[:templates_id].map { |t| { templateid: t } }
         }
       )
       result.empty? ? false : true
@@ -94,12 +92,12 @@ class ZabbixApi
     # @return [Boolean]
     def mass_remove(data)
       result = @client.api_request(
-        :method => 'template.massRemove',
-        :params => {
-          :hostids => data[:hosts_id],
-          :templateids => data[:templates_id],
-          :groupids => data[:group_id],
-          :force => 1,
+        method: 'template.massRemove',
+        params: {
+          hostids: data[:hosts_id],
+          templateids: data[:templates_id],
+          groupids: data[:group_id],
+          force: 1
         }
       )
       result.empty? ? false : true

data/lib/zabbixapi/classes/triggers.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # The id field name used for identifying specific Trigger objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'description'
     end
 
@@ -21,17 +21,17 @@ class ZabbixApi
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Hash]
     def dump_by_id(data)
-      log "[DEBUG] Call dump_by_id with parametrs: #{data.inspect}"
+      log "[DEBUG] Call dump_by_id with parameters: #{data.inspect}"
 
       @client.api_request(
-        :method => 'trigger.get',
-        :params => {
-          :filter => {
-            key.to_sym => data[key.to_sym],
+        method: 'trigger.get',
+        params: {
+          filter: {
+            key.to_sym => data[key.to_sym]
           },
-          :output => 'extend',
-          :select_items => 'extend',
-          :select_functions => 'extend',
+          output: 'extend',
+          select_items: 'extend',
+          select_functions: 'extend'
         }
       )
     end
@@ -68,7 +68,7 @@ class ZabbixApi
       else
         data[:expression] = old_expression
         # disable old trigger
-        log '[DEBUG] disable :' + @client.api_request(:method => "#{method_name}.update", :params => [{:triggerid => data[:triggerid], :status => '1'}]).inspect
+        log '[DEBUG] disable :' + @client.api_request(method: "#{method_name}.update", params: [{ triggerid: data[:triggerid], status: '1' }]).inspect
         # create new trigger
         data.delete(:triggerid)
         create(data)
@@ -84,7 +84,7 @@ class ZabbixApi
     def get_or_create(data)
       log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
 
-      unless (id = get_id(:description => data[:description], :hostid => data[:hostid]))
+      unless (id = get_id(description: data[:description], hostid: data[:hostid]))
         id = create(data)
       end
       id
@@ -97,8 +97,9 @@ class ZabbixApi
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Integer] Zabbix object id
     def create_or_update(data)
-      triggerid = get_id(:description => data[:description], :hostid => data[:hostid])
-      triggerid ? update(data.merge(:triggerid => triggerid)) : create(data)
+      triggerid = get_id(description: data[:description], hostid: data[:hostid])
+
+      triggerid ? update(data.merge(triggerid: triggerid)) : create(data)
     end
   end
 end

data/lib/zabbixapi/classes/unusable.rb

@@ -1,7 +1,7 @@
 class ZabbixApi
   class Triggers < Basic
     def create_or_update(data)
-      log "[DEBUG] Call create_or_update with parametrs: #{data.inspect}"
+      log "[DEBUG] Call create_or_update with parameters: #{data.inspect}"
       get_or_create(data)
     end
   end

data/lib/zabbixapi/classes/usergroups.rb

@@ -17,7 +17,7 @@ class ZabbixApi
     # The id field name used for identifying specific Usergroup objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
 
@@ -27,13 +27,13 @@ class ZabbixApi
     # @raise [ApiError] Error returned when there is a problem with the Zabbix API call.
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Integer] Zabbix object id (usergroup)
-    def set_perms(data)
+    def permissions(data)
       permission = data[:permission] || 2
       result = @client.api_request(
-        :method => 'usergroup.massAdd',
-        :params => {
-          :usrgrpids => [data[:usrgrpid]],
-          :rights => data[:hostgroupids].map { |t| {:permission => permission, :id => t} },
+        method: 'usergroup.update',
+        params: {
+          usrgrpid: data[:usrgrpid],
+          rights: data[:hostgroupids].map { |t| { permission: permission, id: t } }
         }
       )
       result ? result['usrgrpids'][0].to_i : nil
@@ -41,19 +41,13 @@ class ZabbixApi
 
     # Add users to usergroup using Zabbix API
     #
+    # @deprecated Zabbix has removed massAdd in favor of update.
     # @param data [Hash] Needs to include userids and usrgrpids to mass add users to groups
     # @raise [ApiError] Error returned when there is a problem with the Zabbix API call.
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Integer] Zabbix object id (usergroup)
     def add_user(data)
-      result = @client.api_request(
-        :method => 'usergroup.massAdd',
-        :params => {
-          :usrgrpids => data[:usrgrpids],
-          :userids => data[:userids],
-        }
-      )
-      result ? result['usrgrpids'][0].to_i : nil
+      update_users(data)
     end
 
     # Update users in usergroups using Zabbix API
@@ -63,12 +57,15 @@ class ZabbixApi
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Integer] Zabbix object id (usergroup)
     def update_users(data)
-      result = @client.api_request(
-        :method => 'usergroup.massUpdate',
-        :params => {
-          :usrgrpids => data[:usrgrpids],
-          :userids => data[:userids],
+      user_groups = data[:usrgrpids].map do |t|
+        {
+          usrgrpid: t,
+          userids: data[:userids],
         }
+      end
+      result = @client.api_request(
+        method: 'usergroup.update',
+        params: user_groups,
       )
       result ? result['usrgrpids'][0].to_i : nil
     end

data/lib/zabbixapi/classes/usermacros.rb

@@ -3,7 +3,7 @@ class ZabbixApi
     # The id field name used for identifying specific User macro objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'macro'
     end
 
@@ -17,17 +17,17 @@ class ZabbixApi
     # Get User macro object id from Zabbix API based on provided data
     #
     # @param data [Hash] Needs to include macro to properly identify user macros via Zabbix API
-    # @raise [ApiError] Error returned when there is a problem with the Zabbix API call or missing object's id field name (indentify).
+    # @raise [ApiError] Error returned when there is a problem with the Zabbix API call or missing object's id field name (identify).
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Integer] Zabbix object id
     def get_id(data)
       log "[DEBUG] Call get_id with parameters: #{data.inspect}"
 
       # symbolize keys if the user used string keys instead of symbols
-      data = symbolize_keys(data) if data.key?(indentify)
-      # raise an error if indentify name was not supplied
-      name = data[indentify.to_sym]
-      raise ApiError.new("#{indentify} not supplied in call to get_id") if name.nil?
+      data = symbolize_keys(data) if data.key?(identify)
+      # raise an error if identify name was not supplied
+      name = data[identify.to_sym]
+      raise ApiError.new("#{identify} not supplied in call to get_id") if name.nil?
 
       result = request(data, 'usermacro.get', 'hostmacroid')
 
@@ -37,17 +37,17 @@ class ZabbixApi
     # Get Global macro object id from Zabbix API based on provided data
     #
     # @param data [Hash] Needs to include macro to properly identify global macros via Zabbix API
-    # @raise [ApiError] Error returned when there is a problem with the Zabbix API call or missing object's id field name (indentify).
+    # @raise [ApiError] Error returned when there is a problem with the Zabbix API call or missing object's id field name (identify).
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Integer] Zabbix object id
     def get_id_global(data)
       log "[DEBUG] Call get_id_global with parameters: #{data.inspect}"
 
       # symbolize keys if the user used string keys instead of symbols
-      data = symbolize_keys(data) if data.key?(indentify)
-      # raise an error if indentify name was not supplied
-      name = data[indentify.to_sym]
-      raise ApiError.new("#{indentify} not supplied in call to get_id") if name.nil?
+      data = symbolize_keys(data) if data.key?(identify)
+      # raise an error if identify name was not supplied
+      name = data[identify.to_sym]
+      raise ApiError.new("#{identify} not supplied in call to get_id_global") if name.nil?
 
       result = request(data, 'usermacro.get', 'globalmacroid')
 
@@ -56,7 +56,7 @@ class ZabbixApi
 
     # Get full/extended User macro data from Zabbix API
     #
-    # @param data [Hash] Should include object's id field name (indentify) and id value
+    # @param data [Hash] Should include object's id field name (identify) and id value
     # @raise [ApiError] Error returned when there is a problem with the Zabbix API call.
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Hash]
@@ -68,7 +68,7 @@ class ZabbixApi
 
     # Get full/extended Global macro data from Zabbix API
     #
-    # @param data [Hash] Should include object's id field name (indentify) and id value
+    # @param data [Hash] Should include object's id field name (identify) and id value
     # @raise [ApiError] Error returned when there is a problem with the Zabbix API call.
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Hash]
@@ -126,7 +126,7 @@ class ZabbixApi
 
     # Update User macro object using Zabbix API
     #
-    # @param data [Hash] Should include object's id field name (indentify), id value, and fields to update
+    # @param data [Hash] Should include object's id field name (identify), id value, and fields to update
     # @param force [Boolean] Whether to force an object update even if provided data matches Zabbix
     # @raise [ApiError] Error returned when there is a problem with the Zabbix API call.
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
@@ -138,7 +138,7 @@ class ZabbixApi
 
     # Update Global macro object using Zabbix API
     #
-    # @param data [Hash] Should include object's id field name (indentify), id value, and fields to update
+    # @param data [Hash] Should include object's id field name (identify), id value, and fields to update
     # @param force [Boolean] Whether to force an object update even if provided data matches Zabbix
     # @raise [ApiError] Error returned when there is a problem with the Zabbix API call.
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
@@ -157,7 +157,7 @@ class ZabbixApi
     def get_or_create(data)
       log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
 
-      unless (id = get_id(:macro => data[:macro], :hostid => data[:hostid]))
+      unless (id = get_id(macro: data[:macro], hostid: data[:hostid]))
         id = create(data)
       end
       id
@@ -172,7 +172,7 @@ class ZabbixApi
     def get_or_create_global(data)
       log "[DEBUG] Call get_or_create_global with parameters: #{data.inspect}"
 
-      unless (id = get_id_global(:macro => data[:macro], :hostid => data[:hostid]))
+      unless (id = get_id_global(macro: data[:macro], hostid: data[:hostid]))
         id = create_global(data)
       end
       id
@@ -185,8 +185,8 @@ class ZabbixApi
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Integer] Zabbix object id
     def create_or_update(data)
-      hostmacroid = get_id(:macro => data[:macro], :hostid => data[:hostid])
-      hostmacroid ? update(data.merge(:hostmacroid => hostmacroid)) : create(data)
+      hostmacroid = get_id(macro: data[:macro], hostid: data[:hostid])
+      hostmacroid ? update(data.merge(hostmacroid: hostmacroid)) : create(data)
     end
 
     # Create or update Global macro object using Zabbix API
@@ -196,8 +196,8 @@ class ZabbixApi
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Integer] Zabbix object id
     def create_or_update_global(data)
-      hostmacroid = get_id_global(:macro => data[:macro], :hostid => data[:hostid])
-      hostmacroid ? update_global(data.merge(:globalmacroid => globalmacroid)) : create_global(data)
+      globalmacroid = get_id_global(macro: data[:macro], hostid: data[:hostid])
+      globalmacroid ? update_global(data.merge(globalmacroid: globalmacroid)) : create_global(data)
     end
 
   private
@@ -214,12 +214,12 @@ class ZabbixApi
       # Zabbix has different result formats for gets vs updates
       if method.include?('.get')
         if result_key.include?('global')
-          @client.api_request(:method => method, :params => {:globalmacro => true, :filter => data})
+          @client.api_request(method: method, params: { globalmacro: true, filter: data })
         else
-          @client.api_request(:method => method, :params => {:filter => data})
+          @client.api_request(method: method, params: { filter: data })
         end
       else
-        result = @client.api_request(:method => method, :params => data)
+        result = @client.api_request(method: method, params: data)
 
         result.key?(result_key) && !result[result_key].empty? ? result[result_key][0].to_i : nil
       end

data/lib/zabbixapi/classes/users.rb

@@ -24,10 +24,23 @@ class ZabbixApi
     # The id field name used for identifying specific User objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'alias'
     end
 
+    def medias_helper(data, action)
+      result = @client.api_request(
+        method: "user.#{action}",
+        params: data[:userids].map do |t|
+          {
+            userid: t,
+            user_medias: data[:media],
+          }
+        end,
+      )
+      result ? result['userids'][0].to_i : nil
+    end
+
     # Add media to users using Zabbix API
     #
     # @param data [Hash] Needs to include userids and media to mass add media to users
@@ -35,14 +48,7 @@ class ZabbixApi
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Integer] Zabbix object id (media)
     def add_medias(data)
-      result = @client.api_request(
-        :method => 'user.addMedia',
-        :params => {
-          :users => data[:userids].map { |t| {:userid => t} },
-          :medias => data[:media],
-        }
-      )
-      result ? result['mediaids'][0].to_i : nil
+      medias_helper(data, 'update')
     end
 
     # Update media for users using Zabbix API
@@ -52,14 +58,7 @@ class ZabbixApi
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Integer] Zabbix object id (user)
     def update_medias(data)
-      result = @client.api_request(
-        :method => 'user.updateMedia',
-        :params => {
-          :users => data[:userids].map { |t| {:userid => t} },
-          :medias => data[:media],
-        }
-      )
-      result ? result['userids'][0].to_i : nil
+      medias_helper(data, 'update')
     end
   end
 end

data/lib/zabbixapi/classes/valuemaps.rb

@@ -17,7 +17,7 @@ class ZabbixApi
     # The id field name used for identifying specific ValueMap objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
 
@@ -30,7 +30,7 @@ class ZabbixApi
     def get_or_create(data)
       log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
 
-      unless (id = get_id(:valuemapids => data[:valuemapids]))
+      unless (id = get_id(valuemapids: data[:valuemapids]))
         id = create(data)
       end
       id
@@ -43,8 +43,8 @@ class ZabbixApi
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Integer] Zabbix object id
     def create_or_update(data)
-      valuemapid = get_id(:name => data[:name])
-      valuemapid ? update(data.merge(:valuemapids => [:valuemapid])) : create(data)
+      valuemapid = get_id(name: data[:name])
+      valuemapid ? update(data.merge(valuemapids: [:valuemapid])) : create(data)
     end
   end
 end