zabbixapi 4.2.0 → 5.0.0.pre.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58451fc1a06fa45c0ac63d0ec7d66c567455ae0eba7cc8a548cb223c8af3a987
-  data.tar.gz: 7574a95089d1a4c32bfb30273dfd731e726b2367e50edd849d8165e06e033868
+  metadata.gz: 872ce78b417080b9ad0affdf398753332f6c88fb3cfac7b5db991413711e2b65
+  data.tar.gz: 077a81ef6f1d562091f61ab58b973192f12b4d1579c9683d8421779c907e6e33
 SHA512:
-  metadata.gz: 3d432eb203cfe6723dea2d47fbc4a0c064131e9e732e08f6c753e6ed567d29f83e307335ee52c670b4ab8fc4e22381dbee8c614957e710785816eaf5fad50857
-  data.tar.gz: 75cfa60403d32ab616e5caf6670c4b2a4bb3014606d6966a383a88e13e24284b49034fce287d0209a9e0637e53043b4235fe39ca70d194150c163924af32cd6f
+  metadata.gz: c818c7285117d51cc70dc770ba43c75ae5c8cab4ded5e553b2ffcb5a1256b1578da4720faeec57cdc086c02dbc152ccc540c620aba27b02a0426ed0eefedd289
+  data.tar.gz: ba45247a6463b805aa8fbcd3c1bf8ec2d9531e6a3e5db9bf82805ba29fc9c6a972bf8a0f8cb8f063c69b7429337bd89b1a7fe30d9e0054cbd73e1ca64ff7ada3

data/README.md

@@ -1,15 +1,21 @@
 # Ruby Zabbix Api Module
 
 [![Gem Version](http://img.shields.io/gem/v/zabbixapi.svg)][gem]
-[![Build Status](http://img.shields.io/travis/express42/zabbixapi.svg)][travis]
+[![Build Status](https://github.com/anapsix/zabbixapi/workflows/CI/badge.svg)][github-ci]
 
 [gem]: https://rubygems.org/gems/zabbixapi
-[travis]: https://travis-ci.org/express42/zabbixapi
+[github-ci]: https://github.com/express42/zabbixapi/actions?query=workflow%3ACI
 
 Simple and lightweight ruby module for working with [Zabbix][Zabbix] via the [Zabbix API][Zabbix API]
 
 ## Installation
-    gem install zabbixapi
+```sh
+# latest
+gem install zabbixapi
+
+# specific version
+gem install zabbixapi -v 4.2.0
+```
 
 ## Documentation
 [http://rdoc.info/gems/zabbixapi][documentation]
@@ -22,7 +28,10 @@ Simple and lightweight ruby module for working with [Zabbix][Zabbix] via the [Za
 [examples]: https://github.com/express42/zabbixapi/tree/master/examples
 
 ## Version Policy
-We support only two last versions of zabbix (4.0 and 4.2), so you should consider all previous versions deprecated.
+
+**NOTE:** `master` branch is used for ongoing development on Zabbix API 5.x (5.0 and 5.2).
+
+We support only two last versions of zabbix (5.0 and 5.2), so you should consider all previous versions deprecated.
 
 * Zabbix 1.8.2 (api version 1.2) | zabbixapi 0.6.x | [branch zabbix1.8](https://github.com/express42/zabbixapi/tree/zabbix1.8)
 * Zabbix 1.8.9 (api version 1.3) | zabbixapi 0.6.x | [branch zabbix1.8](https://github.com/express42/zabbixapi/tree/zabbix1.8)
@@ -30,15 +39,18 @@ We support only two last versions of zabbix (4.0 and 4.2), so you should conside
 * Zabbix 2.2.x (api version 2.2.x) | zabbixapi 2.2.x | [branch zabbix2.2](https://github.com/express42/zabbixapi/tree/zabbix2.2)
 * Zabbix 2.4.x (api version 2.2.x) | zabbixapi 2.4.x | [branch zabbix2.4](https://github.com/express42/zabbixapi/tree/zabbix2.4)
 * Zabbix 3.0.x (api version 3.0.x) | zabbixapi 3.0.x | [branch zabbix3.0](https://github.com/express42/zabbixapi/tree/zabbix3.0)
-* Zabbix 3.2.x (api version 3.2.x) | zabbixapi 3.0.x | [branch zabbix3.2](https://github.com/express42/zabbixapi/tree/zabbix3.2)
+* Zabbix 3.2.x (api version 3.2.x) | zabbixapi 3.2.x | [branch zabbix3.2](https://github.com/express42/zabbixapi/tree/zabbix3.2)
+* Zabbix 4.0.x (api version 4.0.x) | zabbixapi 4.1.x | [branch zabbix4.0](https://github.com/express42/zabbixapi/tree/zabbix4.0)
+* Zabbix 4.2.x (api version 4.2.x) | zabbixapi 4.1.x | [branch zabbix4.0](https://github.com/express42/zabbixapi/tree/zabbix4.0)
+* Zabbix 4.4.x (api version 4.4.x) | zabbixapi 4.2.x | [branch zabbix4.2](https://github.com/express42/zabbixapi/tree/zabbix4.2)
 
 ## Supported Ruby Versions
-This library aims to support and is [tested against][travis] the following Ruby
+This library aims to support and is [tested against][github-ci] the following Ruby
 versions:
 
-* Ruby 2.4
 * Ruby 2.5
 * Ruby 2.6
+* Ruby 2.7
 * JRuby 9.2.10.0
 
 If something doesn't work on one of these versions, it's a bug.
@@ -62,6 +74,7 @@ dropped.
 ## Contributing
 
 * Fork the project.
+* Base your work on the master branch.
 * Make your feature addition or bug fix, write tests, write documentation/examples.
 * Commit, do not mess with rakefile, version.
 * Make a pull request.
@@ -72,11 +85,14 @@ dropped.
 * [Zabbix API docs][Zabbix API]
 
 [Zabbix]: https://www.zabbix.com
-[Zabbix API]: https://www.zabbix.com/documentation/3.2/manual/api
+[Zabbix API]: https://www.zabbix.com/documentation/5.2/manual/api
 
 ## Copyright
-Copyright (c) 2015-2018 Express 42
 
-See [LICENSE][] for details.
+- Copyright (c) 2021 [contributors]
+- Copyright (c) 2015-2018 Express 42 and [contributors]
+
+See [LICENSE] for details.
 
-[license]: LICENSE.md
+[LICENSE]: LICENSE.md
+[contributors]: https://github.com/express42/zabbixapi/graphs/contributors

data/lib/zabbixapi.rb

@@ -19,6 +19,8 @@ require 'zabbixapi/classes/items'
 require 'zabbixapi/classes/maintenance'
 require 'zabbixapi/classes/mediatypes'
 require 'zabbixapi/classes/proxies'
+require 'zabbixapi/classes/problems'
+require 'zabbixapi/classes/roles'
 require 'zabbixapi/classes/screens'
 require 'zabbixapi/classes/scripts'
 require 'zabbixapi/classes/server'
@@ -125,11 +127,21 @@ class ZabbixApi
     @mediatypes ||= Mediatypes.new(@client)
   end
 
+  # @return [ZabbixApi::Problems]
+  def problems
+    @problems ||= Problems.new(@client)
+  end
+
   # @return [ZabbixApi::Proxies]
   def proxies
     @proxies ||= Proxies.new(@client)
   end
 
+  # @return [ZabbixApi::Roles]
+  def roles
+    @roles ||= Roles.new(@client)
+  end
+
   # @return [ZabbixApi::Screens]
   def screens
     @screens ||= Screens.new(@client)

data/lib/zabbixapi/basic/basic_alias.rb

@@ -2,7 +2,7 @@ class ZabbixApi
   class Basic
     # Get Zabbix object data from API by id
     #
-    # @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]
@@ -23,7 +23,7 @@ class ZabbixApi
 
     # Destroy Zabbix object using API delete
     #
-    # @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 [Integer] The object id if a single object is deleted

data/lib/zabbixapi/basic/basic_init.rb

@@ -22,14 +22,14 @@ class ZabbixApi
       {}
     end
 
-    # Returns the object's plural id field name (indentify) based on key
+    # Returns the object's plural id field name (identify) based on key
     #
     # @return [String]
     def keys
       key + 's'
     end
 
-    # Returns the object's id field name (indentify) based on method_name + id
+    # Returns the object's id field name (identify) based on method_name + id
     #
     # @return [String]
     def key
@@ -38,9 +38,9 @@ class ZabbixApi
 
     # Placeholder for inherited objects to provide object-specific id field name
     #
-    # @raise [ApiError] Basic object does not directly support indentify
-    def indentify
-      raise ApiError.new("Can't call indentify here")
+    # @raise [ApiError] Basic object does not directly support identify
+    def identify
+      raise ApiError.new("Can't call identify here")
     end
   end
 end

data/lib/zabbixapi/basic/basic_logic.rb

@@ -18,7 +18,7 @@ class ZabbixApi
 
     # Delete Zabbix object using 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 [Integer] The object id if a single object is deleted
@@ -33,7 +33,7 @@ class ZabbixApi
 
     # Create or update Zabbix object using 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 [Integer] The object id if a single object is created
@@ -41,13 +41,13 @@ class ZabbixApi
     def create_or_update(data)
       log "[DEBUG] Call create_or_update with parameters: #{data.inspect}"
 
-      id = get_id(indentify.to_sym => data[indentify.to_sym])
+      id = get_id(identify.to_sym => data[identify.to_sym])
       id ? update(data.merge(key.to_sym => id.to_s)) : create(data)
     end
 
     # Update Zabbix object using 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
     # @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.
@@ -71,7 +71,7 @@ class ZabbixApi
 
     # Get full/extended Zabbix object data from 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]
@@ -82,7 +82,7 @@ class ZabbixApi
         method: "#{method_name}.get",
         params: {
           filter: {
-            indentify.to_sym => data[indentify.to_sym]
+            identify.to_sym => data[identify.to_sym]
           },
           output: 'extend'
         }
@@ -132,7 +132,7 @@ class ZabbixApi
     def all
       result = {}
       @client.api_request(method: "#{method_name}.get", params: { output: 'extend' }).each do |item|
-        result[item[indentify]] = item[key]
+        result[item[identify]] = item[key]
       end
       result
     end
@@ -140,39 +140,39 @@ class ZabbixApi
     # Get Zabbix object id from API based on provided data
     #
     # @param data [Hash]
-    # @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 = @client.api_request(
         method: "#{method_name}.get",
         params: {
           filter: data,
-          output: [key, indentify]
+          output: [key, identify]
         }
       )
       id = nil
-      result.each { |item| id = item[key].to_i if item[indentify] == data[indentify.to_sym] }
+      result.each { |item| id = item[key].to_i if item[identify] == data[identify.to_sym] }
       id
     end
 
     # Get or Create Zabbix object using 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 [Integer] Zabbix object id
     def get_or_create(data)
       log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
 
-      unless (id = get_id(indentify.to_sym => data[indentify.to_sym]))
+      unless (id = get_id(identify.to_sym => data[identify.to_sym]))
         id = create(data)
       end
       id

data/lib/zabbixapi/classes/actions.rb

@@ -10,8 +10,32 @@ class ZabbixApi
     # The id field name used for identifying specific Action objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
+
+    # Get full/extended Action object data from API
+    #
+    # @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]
+    def get_full_data(data)
+      log "[DEBUG] Call get_full_data with parameters: #{data.inspect}"
+
+      @client.api_request(
+        method: "#{method_name}.get",
+        params: {
+          filter: {
+            identify.to_sym => data[identify.to_sym]
+          },
+          output: 'extend',
+          selectOperations: "extend",
+          selectRecoveryOperations: "extend",
+          selectAcknowledgeOperations: "extend",
+          selectFilter: "extend",
+        }
+      )
+    end
   end
 end

data/lib/zabbixapi/classes/applications.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # The id field name used for identifying specific Application objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
 

data/lib/zabbixapi/classes/configurations.rb

@@ -15,7 +15,7 @@ class ZabbixApi
     # The id field name used for identifying specific Configuration objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'host'
     end
 

data/lib/zabbixapi/classes/drules.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # The id field name used for identifying specific Drule objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
 

data/lib/zabbixapi/classes/events.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # The id field name used for identifying specific Event objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
   end

data/lib/zabbixapi/classes/graphs.rb

@@ -10,24 +10,24 @@ class ZabbixApi
     # The id field name used for identifying specific Graph objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
 
     # Get full/extended Graph 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]
     def get_full_data(data)
-      log "[DEBUG] Call get_full_data with parametrs: #{data.inspect}"
+      log "[DEBUG] Call get_full_data with parameters: #{data.inspect}"
 
       @client.api_request(
         method: "#{method_name}.get",
         params: {
           search: {
-            indentify.to_sym => data[indentify.to_sym]
+            identify.to_sym => data[identify.to_sym]
           },
           output: 'extend'
         }

data/lib/zabbixapi/classes/hostgroups.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # The id field name used for identifying specific HostGroup objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
 

data/lib/zabbixapi/classes/hosts.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # The id field name used for identifying specific Host 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 [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: 'host.get',

data/lib/zabbixapi/classes/httptests.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # The id field name used for identifying specific HttpTest objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
 

data/lib/zabbixapi/classes/items.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # The id field name used for identifying specific Item objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
 

data/lib/zabbixapi/classes/maintenance.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # The id field name used for identifying specific Maintenance objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
   end

data/lib/zabbixapi/classes/mediatypes.rb

@@ -10,8 +10,8 @@ class ZabbixApi
     # The id field name used for identifying specific MediaType objects via Zabbix API
     #
     # @return [String]
-    def indentify
-      'description'
+    def identify
+      'name'
     end
 
     # The default options used when creating MediaType objects via Zabbix API
@@ -19,7 +19,8 @@ class ZabbixApi
     # @return [Hash]
     def default_options
       {
-        description: '', # Name
+        name: '', # Name
+        description: '', # Description
         type: 0, # 0 - Email, 1 - External script, 2 - SMS, 3 - Jabber, 100 - EzTexting
         smtp_server: '',
         smtp_helo: '',
@@ -30,5 +31,79 @@ class ZabbixApi
         passwd: '' # Jabber password used by Zabbix server
       }
     end
+
+    # def log(message)
+    #   STDERR.puts
+    #   STDERR.puts message.to_s
+    #   STDERR.puts
+    # end
+
+    # Update MediaType object using API
+    #
+    # @param data [Hash] Should include object's id field name (identify) and id value
+    # @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.
+    # @return [Integer] The object id if a single object is created
+    # @return [Boolean] True/False if multiple objects are created
+    def update(data, force = false)
+      log "[DEBUG] Call update with parameters: #{data.inspect}"
+      if data[key.to_sym].nil?
+        data[key.to_sym] = get_id(data)
+        log "[DEBUG] Enriched data with id: #{data.inspect}"
+      end
+      dump = {}
+      dump_by_id(key.to_sym => data[key.to_sym]).each do |item|
+        dump = symbolize_keys(item) if item[key].to_i == data[key.to_sym].to_i
+      end
+      if hash_equals?(dump, data) && !force
+        log "[DEBUG] Equal keys #{dump} and #{data}, skip update"
+        data[key.to_sym].to_i
+      else
+        data_update = [data]
+        result = @client.api_request(method: "#{method_name}.update", params: data_update)
+        parse_keys result
+      end
+    end
+
+    # Get MediaType object id from API based on provided data
+    #
+    # @param data [Hash]
+    # @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?(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, #{data} (#{method_name})") if name.nil?
+
+      result = @client.api_request(
+        method: "#{method_name}.get",
+        params: {
+          filter: {name: name},
+          output: [key, identify]
+        }
+      )
+      id = nil
+      result.each { |item| id = item[key].to_i if item[identify] == data[identify.to_sym] }
+      id
+    end
+
+    # Create or update MediaType object using API
+    #
+    # @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 [Integer] The object id if a single object is created
+    # @return [Boolean] True/False if multiple objects are created
+    def create_or_update(data)
+      log "[DEBUG] Call create_or_update with parameters: #{data.inspect}"
+
+      id = get_id(identify.to_sym => data[identify.to_sym])
+      id ? update(data.merge(key.to_sym => id.to_s)) : create(data)
+    end
   end
 end

data/lib/zabbixapi/classes/problems.rb

@@ -0,0 +1,101 @@
+class ZabbixApi
+  class Problems < Basic
+    # The method name used for interacting with Hosts via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'problem'
+    end
+
+    # The id field name used for identifying specific Problem objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+
+    # The key field name used for Problem objects via Zabbix API
+    # However, Problem object does not have a unique identifier
+    #
+    # @return [String]
+    def key
+      'problemid'
+    end
+
+    # Returns the object's plural id field name (identify) based on key
+    # However, Problem object does not have a unique identifier
+    #
+    # @return [String]
+    def keys
+      'problemids'
+    end
+
+    # Dump Problem object data by key from Zabbix API
+    #
+    # @param data [Hash] Should include desired object's key and 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]
+    def dump_by_id(data)
+      log "[DEBUG] Call dump_by_id with parameters: #{data.inspect}"
+
+      @client.api_request(
+        method: 'problem.get',
+        params: {
+          filter: {
+            identify.to_sym => data[identify.to_sym]
+          },
+          output: 'extend'
+        }
+      )
+    end
+
+    # Get full/extended Problem data from Zabbix API
+    #
+    # @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]
+    def get_full_data(data)
+      log "[DEBUG] Call get_full_data with parameters: #{data.inspect}"
+
+      data = symbolize_keys(data)
+
+      @client.api_request(
+        method: "#{method_name}.get",
+        params: {
+          filter: {
+            identify.to_sym => data[identify.to_sym]
+          },
+          eventids: data[:eventids] || nil,
+          groupids: data[:groupids] || nil,
+          hostids: data[:hostids] || nil,
+          objectids: data[:objectids] || nil,
+          applicationids: data[:applicationids] || nil,
+          tags: data[:tags] || nil,
+          time_from: data[:time_from] || nil,
+          time_till: data[:time_till] || nil,
+          eventid_from: data[:eventid_from] || nil,
+          eventid_till: data[:eventid_till] || nil,
+          recent: data[:recent] || false,
+          sortfield: data[:sortfield] || ['eventid'],
+          sortorder: data[:sortorder] || 'DESC',
+          countOutput: data[:countOutput] || nil,
+          output: 'extend',
+          selectAcknowledges: 'extend',
+          selectTags: 'extend',
+          selectSuppressionData: 'extend'
+        }
+      )
+    end
+
+    # Get full/extended Zabbix data for Problem objects from API
+    #
+    # @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 [Array<Hash>] Array of matching objects
+    def all
+      get_full_data({})
+    end
+  end
+end

data/lib/zabbixapi/classes/proxies.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # The id field name used for identifying specific Proxy objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'host'
     end
 

data/lib/zabbixapi/classes/roles.rb

@@ -0,0 +1,114 @@
+class ZabbixApi
+  class Roles < Basic
+    # The method name used for interacting with Role via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'role'
+    end
+
+    # The key field name used for Role objects via Zabbix API
+    #
+    # @return [String]
+    def key
+      'roleid'
+    end
+
+    # The id field name used for identifying specific Role objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+
+    # Set permissions for usergroup using Zabbix API
+    #
+    # @param data [Hash] Needs to include usrgrpids and hostgroupids along with permissions to set
+    # @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 rules(data)
+      rules = data[:rules] || 2
+      result = @client.api_request(
+        method: 'role.update',
+        params: {
+          roleid: data[:roleid],
+          rules: data[:hostgroupids].map { |t| { permission: permission, id: t } }
+        }
+      )
+      result ? result['usrgrpids'][0].to_i : nil
+    end
+
+    # 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)
+      update_users(data)
+    end
+
+    # Dump Role object data by key from Zabbix API
+    #
+    # @param data [Hash] Should include desired object's key and 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]
+    def dump_by_id(data)
+      log "[DEBUG] Call dump_by_id with parameters: #{data.inspect}"
+
+      @client.api_request(
+        method: 'role.get',
+        params: {
+          output: 'extend',
+          selectRules: 'extend',
+          roleids: data[:id]
+        }
+      )
+    end
+
+    # Get Role ids by Role Name from Zabbix API
+    #
+    # @param data [Hash] Should include host value to query for matching graphs
+    # @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 [Array] Returns array of Graph ids
+    def get_ids_by_name(data)
+      result = @client.api_request(
+        method: 'role.get',
+        params: {
+          filter: {
+            name: data[:name]
+          },
+          output: 'extend'
+        }
+      )
+
+      result.map do |rule|
+        rule['roleid']
+      end.compact
+    end
+
+    # Update users in Userroles using Zabbix API
+    #
+    # @param data [Hash] Needs to include userids and usrgrpids to mass update users in 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 update_users(data)
+      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
+  end
+end

data/lib/zabbixapi/classes/screens.rb

@@ -29,7 +29,7 @@ class ZabbixApi
     # The id field name used for identifying specific Screen objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
 

data/lib/zabbixapi/classes/scripts.rb

@@ -7,7 +7,7 @@ class ZabbixApi
     # The id field name used for identifying specific Screen objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     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
 

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,7 +21,7 @@ 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',

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
 

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_global") 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.

data/lib/zabbixapi/classes/users.rb

@@ -24,7 +24,7 @@ class ZabbixApi
     # The id field name used for identifying specific User objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'alias'
     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
 

data/lib/zabbixapi/client.rb

@@ -60,9 +60,13 @@ class ZabbixApi
         @proxy_port = @proxy_uri.port
         @proxy_user, @proxy_pass = @proxy_uri.userinfo.split(/:/) if @proxy_uri.userinfo
       end
-      unless api_version =~ %r{^4.[0|4]\.\d+$}
+      unless api_version =~ %r{^5.[0|2]\.\d+$}
         message = "Zabbix API version: #{api_version} is not supported by this version of zabbixapi"
-        raise ZabbixApi::ApiError.new(message)
+        if @options[:ignore_version]
+          puts "[WARNING] #{message}" if @options[:debug]
+        else
+          raise ZabbixApi::ApiError.new(message)
+        end
       end
 
       @auth_hash = auth

data/lib/zabbixapi/version.rb

@@ -1,3 +1,3 @@
 class ZabbixApi
-  VERSION = '4.2.0'.freeze
+  VERSION = '5.0.0-alpha1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zabbixapi
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 5.0.0.pre.alpha1
 platform: ruby
 authors:
 - Vasiliev D.V.
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-31 00:00:00.000000000 Z
+date: 2021-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -82,7 +82,9 @@ files:
 - lib/zabbixapi/classes/items.rb
 - lib/zabbixapi/classes/maintenance.rb
 - lib/zabbixapi/classes/mediatypes.rb
+- lib/zabbixapi/classes/problems.rb
 - lib/zabbixapi/classes/proxies.rb
+- lib/zabbixapi/classes/roles.rb
 - lib/zabbixapi/classes/screens.rb
 - lib/zabbixapi/classes/scripts.rb
 - lib/zabbixapi/classes/server.rb
@@ -111,11 +113,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.1
 signing_key:
 specification_version: 4
 summary: Simple and lightweight ruby module for working with the Zabbix API