zabbixapi 4.0.0 → 5.0.0.pre.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c92de7e8f577d018cb8da54114638729fb7117d5
-  data.tar.gz: 5dc0590f4332ba0590cb07eed6c2cb1f07c73d38
+SHA256:
+  metadata.gz: 872ce78b417080b9ad0affdf398753332f6c88fb3cfac7b5db991413711e2b65
+  data.tar.gz: 077a81ef6f1d562091f61ab58b973192f12b4d1579c9683d8421779c907e6e33
 SHA512:
-  metadata.gz: ef2229602eac1fac5257b9d32c2d45f079d163a989a3f25efa2ae80390ea3ffd840f6f8a637dcd73df593054480c21c3b7674b5c3f20b4300bd01a7ebf3f2f6f
-  data.tar.gz: 159e41fb0f8467456c808c0e4895e87aaf8f3ee0d0d462879815c568f8773ce3838be74234581eca655f466a234155c425a89d43b3018efa61e5f65c54476542
+  metadata.gz: c818c7285117d51cc70dc770ba43c75ae5c8cab4ded5e553b2ffcb5a1256b1578da4720faeec57cdc086c02dbc152ccc540c620aba27b02a0426ed0eefedd289
+  data.tar.gz: ba45247a6463b805aa8fbcd3c1bf8ec2d9531e6a3e5db9bf82805ba29fc9c6a972bf8a0f8cb8f063c69b7429337bd89b1a7fe30d9e0054cbd73e1ca64ff7ada3

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+#CHANGELOG
+
+## 4.2.0
+[PR #102](https://github.com/express42/zabbixapi/pull/102) Add events get method method.  Fixed all testing failures. (Thanks @kevin-j-smith)
+
+## 4.1.2
+[PR #99](https://github.com/express42/zabbixapi/pull/99) Patch addressing log error function not found
+
+## 4.1.1
+
+[PR #97](https://github.com/express42/zabbixapi/pull/97) Bumped version
+
+[PR #98](https://github.com/express42/zabbixapi/pull/98) Removed strict zabbix versioning error
+
+## 4.1.0
+
+[PR #82](https://github.com/express42/zabbixapi/pull/82) Add logout method (Thanks @baurmatt)
+
+[PR #86](https://github.com/express42/zabbixapi/pull/86) Feature: add support for Discovery Rules (`drule` API) (Thanks @lehn-etracker)
+
 ## 4.0.0
 
 [PR #90](https://github.com/express42/zabbixapi/pull/90) Add 4.0 support (Thanks @svdasein)

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2017 Express 42
+Copyright (c) 2015-2018 Express 42
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

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 (3.4 and 4.0), 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,18 +39,19 @@ We support only two last versions of zabbix (3.4 and 4.0), 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.0
-* Ruby 2.1
-* Ruby 2.2
-* Ruby 2.3
-* Ruby 2.4
-* JRuby 9.1.6.0
+* 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.
 
@@ -59,12 +69,12 @@ dropped.
 ## Dependencies
 
 * net/http
-* net/https
 * json
 
 ## 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.
@@ -75,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

@@ -10,6 +10,7 @@ require 'zabbixapi/classes/actions'
 require 'zabbixapi/classes/applications'
 require 'zabbixapi/classes/configurations'
 require 'zabbixapi/classes/errors'
+require 'zabbixapi/classes/events'
 require 'zabbixapi/classes/graphs'
 require 'zabbixapi/classes/hostgroups'
 require 'zabbixapi/classes/hosts'
@@ -18,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'
@@ -28,6 +31,7 @@ require 'zabbixapi/classes/usergroups'
 require 'zabbixapi/classes/usermacros'
 require 'zabbixapi/classes/users'
 require 'zabbixapi/classes/valuemaps'
+require 'zabbixapi/classes/drules'
 
 class ZabbixApi
   # @return [ZabbixApi::Client]
@@ -51,7 +55,13 @@ class ZabbixApi
   # @param data [Hash]
   # @return [Hash]
   def query(data)
-    @client.api_request(:method => data[:method], :params => data[:params])
+    @client.api_request(method: data[:method], params: data[:params])
+  end
+
+  # Invalidate current authentication token
+  # @return [Boolean]
+  def logout
+    @client.logout
   end
 
   # Initializes a new ZabbixApi object
@@ -77,6 +87,11 @@ class ZabbixApi
     @configurations ||= Configurations.new(@client)
   end
 
+  # @return [ZabbixApi::Events]
+  def events
+    @events ||= Events.new(@client)
+  end
+
   # @return [ZabbixApi::Graphs]
   def graphs
     @graphs ||= Graphs.new(@client)
@@ -112,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)
@@ -161,4 +186,9 @@ class ZabbixApi
   def valuemaps
     @valuemaps ||= ValueMaps.new(@client)
   end
+
+  # @return [ZabbixApi::Drules]
+  def drules
+    @drules ||= Drules.new(@client)
+  end
 end

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_func.rb

@@ -9,14 +9,15 @@ class ZabbixApi
 
     # Compare two hashes for equality
     #
-    # @param a [Hash]
-    # @param b [Hash]
+    # @param first_hash [Hash]
+    # @param second_hash [Hash]
     # @return [Boolean]
-    def hash_equals?(a, b)
-      a_new = normalize_hash(a)
-      b_new = normalize_hash(b)
-      hash1 = a_new.merge(b_new)
-      hash2 = b_new.merge(a_new)
+    def hash_equals?(first_hash, second_hash)
+      normalized_first_hash = normalize_hash(first_hash)
+      normalized_second_hash = normalize_hash(second_hash)
+
+      hash1 = normalized_first_hash.merge(normalized_second_hash)
+      hash2 = normalized_second_hash.merge(normalized_first_hash)
       hash1 == hash2
     end
 
@@ -91,12 +92,12 @@ class ZabbixApi
 
     # Merge two hashes into a single new hash
     #
-    # @param a [Hash]
-    # @param b [Hash]
+    # @param first_hash [Hash]
+    # @param second_hash [Hash]
     # @return [Hash]
-    def merge_params(a, b)
-      new = a.dup
-      new.merge(b)
+    def merge_params(first_hash, second_hash)
+      new = first_hash.dup
+      new.merge(second_hash)
     end
   end
 end

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

@@ -12,13 +12,13 @@ class ZabbixApi
 
       data_with_default = default_options.empty? ? data : merge_params(default_options, data)
       data_create = [data_with_default]
-      result = @client.api_request(:method => "#{method_name}.create", :params => data_create)
+      result = @client.api_request(method: "#{method_name}.create", params: data_create)
       parse_keys result
     end
 
     # 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
@@ -27,13 +27,13 @@ class ZabbixApi
       log "[DEBUG] Call delete with parameters: #{data.inspect}"
 
       data_delete = [data]
-      result = @client.api_request(:method => "#{method_name}.delete", :params => data_delete)
+      result = @client.api_request(method: "#{method_name}.delete", params: data_delete)
       parse_keys result
     end
 
     # 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.
@@ -64,14 +64,14 @@ class ZabbixApi
         data[key.to_sym].to_i
       else
         data_update = [data]
-        result = @client.api_request(:method => "#{method_name}.update", :params => data_update)
+        result = @client.api_request(method: "#{method_name}.update", params: data_update)
         parse_keys result
       end
     end
 
     # 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]
@@ -79,12 +79,12 @@ class ZabbixApi
       log "[DEBUG] Call get_full_data with parameters: #{data.inspect}"
 
       @client.api_request(
-        :method => "#{method_name}.get",
-        :params => {
-          :filter => {
-            indentify.to_sym => data[indentify.to_sym],
+        method: "#{method_name}.get",
+        params: {
+          filter: {
+            identify.to_sym => data[identify.to_sym]
           },
-          :output => 'extend',
+          output: 'extend'
         }
       )
     end
@@ -99,8 +99,8 @@ class ZabbixApi
       log "[DEBUG] Call get_raw with parameters: #{data.inspect}"
 
       @client.api_request(
-        :method => "#{method_name}.get",
-        :params => data
+        method: "#{method_name}.get",
+        params: data
       )
     end
 
@@ -114,12 +114,12 @@ class ZabbixApi
       log "[DEBUG] Call dump_by_id with parameters: #{data.inspect}"
 
       @client.api_request(
-        :method => "#{method_name}.get",
-        :params => {
-          :filter => {
-            key.to_sym => data[key.to_sym],
+        method: "#{method_name}.get",
+        params: {
+          filter: {
+            key.to_sym => data[key.to_sym]
           },
-          :output => 'extend',
+          output: 'extend'
         }
       )
     end
@@ -131,8 +131,8 @@ class ZabbixApi
     # @return [Array<Hash>] Array of matching objects
     def all
       result = {}
-      @client.api_request(:method => "#{method_name}.get", :params => {:output => 'extend'}).each do |item|
-        result[item[indentify]] = item[key]
+      @client.api_request(method: "#{method_name}.get", params: { output: 'extend' }).each do |item|
+        result[item[identify]] = item[key]
       end
       result
     end
@@ -140,38 +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],
+        method: "#{method_name}.get",
+        params: {
+          filter: data,
+          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