zabbix_manager 5.0.4 → 5.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 034a6a763df4c8337459dafae939113d20d243bb3a03edca7c53cb8f7e4735f5
-  data.tar.gz: 5cc9e8342583fff642f3e8190b4f92329e52076b94cc182e899bdea36ca1dda4
+  metadata.gz: a06ad87ced47aa4288d704ff5343ebeda605d34f7d6944459cecf4f69711d38d
+  data.tar.gz: 2e5e50ddf70f312b4c679d590d6a8aecbc6031764faf3f89e475c36958040772
 SHA512:
-  metadata.gz: c70af5c6c152c2a6673fd4580038180525c88d0eb40589bf4708894fc0cb7a73e9b59daf8de101823739cceceb799cea82f87e6bc6f787457e80196e68486a28
-  data.tar.gz: 2ea559104053fd3b3bd5b9e6c7026062e80108dbf5861ff17ac4c0a316655be22850f082683a8292992b63afbf036ab5aa224dbd8bb85b6057bd324a140475d9
+  metadata.gz: c6801af1c5372993075c7791ad45167c5b8a2f15a639861c7418e66d1ada84aee0e7c5bb7cb87369fcb662e93089d5bacee30623f7c110fee06f4bd95108ad48
+  data.tar.gz: 55c96cd371fa3a682ce39a421683606e60f444a1d2e1db60c3525e86bce946614757fad310dacaa9e21631e85524346e9328eec5a82f65779386b5ea8dfc9a63

data/CHANGELOG.md

@@ -1,5 +1,3 @@
-## [Unreleased]
+#CHANGELOG
 
-## [0.1.0] - 2021-12-17
-
-- Initial release
+### 5.0.7

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 TODO: Write your name
+Copyright (c) 2022 TODO: WENWU.YAN
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,43 +1,98 @@
-# ZabbixManager
+# Ruby Zabbix Api Module
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/zabbix_manager`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](http://img.shields.io/gem/v/zabbix_manager.svg)][gem]
+[![Build Status](https://github.com/anapsix/zabbix_manager/workflows/CI/badge.svg)][github-ci]
 
-TODO: Delete this and the text above, and describe your gem
+[gem]: https://rubygems.org/gems/zabbix_manager
+[github-ci]: https://github.com/express42/zabbix_manager/actions?query=workflow%3ACI
 
-## Installation
+Simple and lightweight ruby module for working with [Zabbix][Zabbix] via the [Zabbix API][Zabbix API]
 
-Add this line to your application's Gemfile:
+## Installation
+```sh
+# latest
+gem install zabbix_manager
 
-```ruby
-gem 'zabbix_manager'
+# specific version
+gem install zabbix_manager -v 4.2.0
 ```
 
-And then execute:
+## Documentation
+[http://rdoc.info/gems/zabbix_manager][documentation]
+
+[documentation]: http://rdoc.info/gems/zabbix_manager
+
+## Examples
+[https://github.com/express42/zabbix_manager/tree/master/examples][examples]
+
+[examples]: https://github.com/express42/zabbix_manager/tree/master/examples
+
+## Version Policy
 
-    $ bundle install
+**NOTE:** `master` branch is used for ongoing development on Zabbix API 5.x (5.0 and 5.2).
 
-Or install it yourself as:
+We support only two last versions of zabbix (5.0 and 5.2), so you should consider all previous versions deprecated.
 
-    $ gem install zabbix_manager
+* Zabbix 1.8.2 (api version 1.2) | zabbix_manager 0.6.x | [branch zabbix1.8](https://github.com/express42/zabbix_manager/tree/zabbix1.8)
+* Zabbix 1.8.9 (api version 1.3) | zabbix_manager 0.6.x | [branch zabbix1.8](https://github.com/express42/zabbix_manager/tree/zabbix1.8)
+* Zabbix 2.0.x (api version 1.4 -> 2.0.10) | zabbix_manager 2.0.x | [branch zabbix2.0](https://github.com/express42/zabbix_manager/tree/zabbix2.0)
+* Zabbix 2.2.x (api version 2.2.x) | zabbix_manager 2.2.x | [branch zabbix2.2](https://github.com/express42/zabbix_manager/tree/zabbix2.2)
+* Zabbix 2.4.x (api version 2.2.x) | zabbix_manager 2.4.x | [branch zabbix2.4](https://github.com/express42/zabbix_manager/tree/zabbix2.4)
+* Zabbix 3.0.x (api version 3.0.x) | zabbix_manager 3.0.x | [branch zabbix3.0](https://github.com/express42/zabbix_manager/tree/zabbix3.0)
+* Zabbix 3.2.x (api version 3.2.x) | zabbix_manager 3.2.x | [branch zabbix3.2](https://github.com/express42/zabbix_manager/tree/zabbix3.2)
+* Zabbix 4.0.x (api version 4.0.x) | zabbix_manager 4.1.x | [branch zabbix4.0](https://github.com/express42/zabbix_manager/tree/zabbix4.0)
+* Zabbix 4.2.x (api version 4.2.x) | zabbix_manager 4.1.x | [branch zabbix4.0](https://github.com/express42/zabbix_manager/tree/zabbix4.0)
+* Zabbix 4.4.x (api version 4.4.x) | zabbix_manager 4.2.x | [branch zabbix4.2](https://github.com/express42/zabbix_manager/tree/zabbix4.2)
 
-## Usage
+## Supported Ruby Versions
+This library aims to support and is [tested against][github-ci] the following Ruby
+versions:
 
-TODO: Write usage instructions here
+* Ruby 2.5
+* Ruby 2.6
+* Ruby 2.7
+* JRuby 9.2.10.0
 
-## Development
+If something doesn't work on one of these versions, it's a bug.
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+This library may inadvertently work (or seem to work) on other Ruby versions,
+however support will only be provided for the versions listed above.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+If you would like this library to support another Ruby version or
+implementation, you may volunteer to be a maintainer. Being a maintainer
+entails making sure all tests run and pass on that implementation. When
+something breaks on your implementation, you will be responsible for providing
+patches in a timely fashion. If critical issues for a particular implementation
+exist at the time of a major release, support for that Ruby version may be
+dropped.
+
+## Dependencies
+
+* net/http
+* json
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/zabbix_manager. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/zabbix_manager/blob/master/CODE_OF_CONDUCT.md).
+* 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.
+
+## Zabbix documentation
+
+* [Zabbix Project Homepage][Zabbix]
+* [Zabbix API docs][Zabbix API]
+
+[Zabbix]: https://www.zabbix.com
+[Zabbix API]: https://www.zabbix.com/documentation/5.2/manual/api
 
-## License
+## Copyright
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+- Copyright (c) 2021 [contributors]
+- Copyright (c) 2015-2018 Express 42 and [contributors]
 
-## Code of Conduct
+See [LICENSE] for details.
 
-Everyone interacting in the ZabbixManager project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/zabbix_manager/blob/master/CODE_OF_CONDUCT.md).
+[LICENSE]: LICENSE.md
+[contributors]: https://github.com/express42/zabbix_manager/graphs/contributors

data/lib/zabbix_manager/basic/basic_alias.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Basic
     # Get Zabbix object data from API by id

data/lib/zabbix_manager/basic/basic_extend.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Basic
     # 新增 get_hostgroup_ids 方法，使用列表 flatten 功能拉平属组对象
     def get_hostgroup_ids(data)
       result = @client.api_request(
-        method: 'hostgroup.get',
+        method: "hostgroup.get",
         params: {
           output: "extend",
           filter: {
             name: [data].flatten
           }
         }
-      ).map { |item| { groupid: item['groupid'] } }
+      ).map { |item| { groupid: item["groupid"] } }
 
       # 检查是是否存在
       result.empty? ? nil : result.flatten
@@ -20,19 +22,19 @@ class ZabbixManager
     def get_or_create_hostgroups(data)
       [data].flatten.each do |item|
         # 是否存在设备属组，不存在则新建
-        begin
-          result = get_hostgroup_ids(item)
+
+        result = get_hostgroup_ids(item)
+        if result.nil?
           @client.api_request(
-            method: 'hostgroup.create',
+            method: "hostgroup.create",
             params: {
               name: item
             }
-          ) if result.nil?
-        rescue => e
-          ap e
+          )
         end
+      rescue StandardError => e
+        ap e
       end
     end
-
   end
 end

data/lib/zabbix_manager/basic/basic_func.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Basic
     # Log messages to stdout when debugging
@@ -26,12 +28,13 @@ class ZabbixManager
     # @param object [Array, Hash]
     # @return [Array, Hash]
     def symbolize_keys(object)
-      if object.is_a?(Array)
+      case object
+      when Array
         object.each_with_index do |val, index|
           object[index] = symbolize_keys(val)
         end
-      elsif object.is_a?(Hash)
-        object.keys.each do |key|
+      when Hash
+        object.each_key do |key|
           object[key.to_sym] = symbolize_keys(object.delete(key))
         end
       end
@@ -62,9 +65,10 @@ class ZabbixManager
       result = []
 
       array.each do |e|
-        if e.is_a?(Array)
+        case e
+        when Array
           result.push(normalize_array(e))
-        elsif e.is_a?(Hash)
+        when Hash
           result.push(normalize_hash(e))
         else
           result.push(e.to_s)

data/lib/zabbix_manager/basic/basic_init.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Basic
     # Initializes a new Basic object with ZabbixManager Client
@@ -12,7 +14,7 @@ class ZabbixManager
     #
     # @raise [ManagerError] Basic object does not directly support method_name
     def method_name
-      raise ManagerError.new("Can't call method_name here")
+      raise ManagerError, "Can't call method_name here"
     end
 
     # Placeholder for inherited objects to provide default options
@@ -26,21 +28,21 @@ class ZabbixManager
     #
     # @return [String]
     def keys
-      key + 's'
+      "#{key}s"
     end
 
     # Returns the object's id field name (identify) based on method_name + id
     #
     # @return [String]
     def key
-      method_name + 'id'
+      "#{method_name}id"
     end
 
     # Placeholder for inherited objects to provide object-specific id field name
     #
     # @raise [ManagerError] Basic object does not directly support identify
     def identify
-      raise ManagerError.new("Can't call identify here")
+      raise ManagerError, "Can't call identify here"
     end
   end
 end

data/lib/zabbix_manager/basic/basic_logic.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Basic
     # Create new Zabbix object using API (with defaults)
@@ -96,7 +98,7 @@ class ZabbixManager
           filter: {
             identify.to_sym => data[identify.to_sym]
           },
-          output: 'extend'
+          output: "extend"
         }
       )
     end
@@ -131,7 +133,7 @@ class ZabbixManager
           filter: {
             key.to_sym => data[key.to_sym]
           },
-          output: 'extend'
+          output: "extend"
         }
       )
     end
@@ -145,7 +147,7 @@ class ZabbixManager
       result = {}
       @client.api_request(
         method: "#{method_name}.get",
-        params: { output: 'extend' }
+        params: { output: "extend" }
       ).each do |item|
         result[item[identify]] = item[key]
       end
@@ -165,7 +167,7 @@ class ZabbixManager
       data = symbolize_keys(data) if data.key?(identify)
       # raise an error if identify name was not supplied
       name = data[identify.to_sym]
-      raise ManagerError.new("#{identify} not supplied in call to get_id") if name.nil?
+      raise ManagerError, "#{identify} not supplied in call to get_id" if name.nil?
 
       result = @client.api_request(
         method: "#{method_name}.get",
@@ -174,7 +176,7 @@ class ZabbixManager
           output: [key, identify]
         }
       )
-      id     = nil
+      id = nil
       result.each { |item| id = item[key].to_i if item[identify] == data[identify.to_sym] }
       id
     end

data/lib/zabbix_manager/classes/actions.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Actions < Basic
     # The method name used for interacting with Actions via Zabbix API
     #
     # @return [String]
     def method_name
-      'action'
+      "action"
     end
 
     # The id field name used for identifying specific Action objects via Zabbix API
     #
     # @return [String]
     def identify
-      'name'
+      "name"
     end
 
     # Get full/extended Action object data from API
@@ -29,11 +31,11 @@ class ZabbixManager
           filter: {
             identify.to_sym => data[identify.to_sym]
           },
-          output: 'extend',
+          output: "extend",
           selectOperations: "extend",
           selectRecoveryOperations: "extend",
           selectAcknowledgeOperations: "extend",
-          selectFilter: "extend",
+          selectFilter: "extend"
         }
       )
     end

data/lib/zabbix_manager/classes/applications.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Applications < Basic
     # The method name used for interacting with Applications via Zabbix API
     #
     # @return [String]
     def method_name
-      'application'
+      "application"
     end
 
     # The id field name used for identifying specific Application objects via Zabbix API
     #
     # @return [String]
     def identify
-      'name'
+      "name"
     end
 
     # Get or Create Application object using Zabbix API

data/lib/zabbix_manager/classes/configurations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Configurations < Basic
     # @return [Boolean]
@@ -9,14 +11,14 @@ class ZabbixManager
     #
     # @return [String]
     def method_name
-      'configuration'
+      "configuration"
     end
 
     # The id field name used for identifying specific Configuration objects via Zabbix API
     #
     # @return [String]
     def identify
-      'host'
+      "host"
     end
 
     # Export configuration data using Zabbix API
@@ -26,7 +28,7 @@ class ZabbixManager
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Hash]
     def export(data)
-      @client.api_request(method: 'configuration.export', params: data)
+      @client.api_request(method: "configuration.export", params: data)
     end
 
     # Import configuration data using Zabbix API
@@ -36,7 +38,7 @@ class ZabbixManager
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Hash]
     def import(data)
-      @client.api_request(method: 'configuration.import', params: data)
+      @client.api_request(method: "configuration.import", params: data)
     end
   end
 end

data/lib/zabbix_manager/classes/drules.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Drules < Basic
     # The method name used for interacting with Drules via Zabbix API
     #
     # @return [String]
     def method_name
-      'drule'
+      "drule"
     end
 
     # The id field name used for identifying specific Drule objects via Zabbix API
     #
     # @return [String]
     def identify
-      'name'
+      "name"
     end
 
     # The default options used when creating Drule objects via Zabbix API
@@ -22,7 +24,7 @@ class ZabbixManager
         name: nil,
         iprange: nil,
         delay: 3600,
-        status: 0,
+        status: 0
       }
     end
 

data/lib/zabbix_manager/classes/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class BaseError < RuntimeError
     attr_accessor :response, :error, :error_message
@@ -9,15 +11,14 @@ class ZabbixManager
       set_error! if @response
     end
 
-  private
-
-    def set_error!
-      @error = @response['error']
-      @error_message = "#{@error['message']}: #{@error['data']}"
-    rescue StandardError
-      @error = nil
-      @error_message = nil
-    end
+    private
+      def set_error!
+        @error = @response["error"]
+        @error_message = "#{@error["message"]}: #{@error["data"]}"
+      rescue StandardError
+        @error = nil
+        @error_message = nil
+      end
   end
 
   class ManagerError < BaseError

data/lib/zabbix_manager/classes/events.rb

@@ -1,18 +1,19 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Events < Basic
     # The method name used for interacting with Events via Zabbix API
     #
     # @return [String]
     def method_name
-      'event'
+      "event"
     end
 
     # The id field name used for identifying specific Event objects via Zabbix API
     #
     # @return [String]
     def identify
-      'name'
+      "name"
     end
-
   end
 end

data/lib/zabbix_manager/classes/graphs.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Graphs < Basic
     # The method name used for interacting with Graphs via Zabbix API
     #
     # @return [String]
     def method_name
-      'graph'
+      "graph"
     end
 
     # The id field name used for identifying specific Graph objects via Zabbix API
     #
     # @return [String]
     def identify
-      'name'
+      "name"
     end
 
     # Get full/extended Graph data from Zabbix API
@@ -29,7 +31,7 @@ class ZabbixManager
           search: {
             identify.to_sym => data[identify.to_sym]
           },
-          output: 'extend'
+          output: "extend"
         }
       )
     end
@@ -42,22 +44,22 @@ class ZabbixManager
     # @return [Array] Returns array of Graph ids
     def get_ids_by_host(data)
       result = @client.api_request(
-        method: 'graph.get',
+        method: "graph.get",
         params: {
           filter: {
             host: data[:host]
           },
-          output: 'extend'
+          output: "extend"
         }
       )
 
-      result.map do |graph|
-        num  = graph['graphid']
-        name = graph['name']
+      result.filter_map do |graph|
+        num  = graph["graphid"]
+        name = graph["name"]
         filter = data[:filter]
 
         num if filter.nil? || /#{filter}/ =~ name
-      end.compact
+      end
     end
 
     # Get Graph Item object using Zabbix API
@@ -68,10 +70,10 @@ class ZabbixManager
     # @return [Hash]
     def get_items(data)
       @client.api_request(
-        method: 'graphitem.get',
+        method: "graphitem.get",
         params: {
           graphids: [data],
-          output: 'extend'
+          output: "extend"
         }
       )
     end

data/lib/zabbix_manager/classes/hostgroups.rb

@@ -1,37 +1,39 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class HostGroups < Basic
     # The method name used for interacting with HostGroups via Zabbix API
     #
     # @return [String]
     def method_name
-      'hostgroup'
+      "hostgroup"
     end
 
     # The id field name used for identifying specific HostGroup objects via Zabbix API
     #
     # @return [String]
     def identify
-      'name'
+      "name"
     end
 
     # The key field name used for HostGroup objects via Zabbix API
     #
     # @return [String]
     def key
-      'groupid'
+      "groupid"
     end
 
     # 新增 get_hostgroup_ids 方法，使用列表 flatten 功能拉平属组对象
     def get_hostgroup_ids(data)
       result = @client.api_request(
-        method: 'hostgroup.get',
+        method: "hostgroup.get",
         params: {
           output: "extend",
           filter: {
             name: [data].flatten
           }
         }
-      ).map { |item| { groupid: item['groupid'] } }
+      ).map { |item| { groupid: item["groupid"] } }
 
       # 检查是是否存在
       result.empty? ? nil : result.flatten
@@ -41,17 +43,17 @@ class ZabbixManager
     def get_or_create_hostgroups(data)
       # 是否存在设备属组，不存在则新建
       [data].flatten.each do |item|
-        begin
-          result = get_hostgroup_ids(item)
+        result = get_hostgroup_ids(item)
+        if result.nil?
           @client.api_request(
-            method: 'hostgroup.create',
+            method: "hostgroup.create",
             params: {
               name: item
             }
-          ) if result.nil?
-        rescue => e
-          ap e
+          )
         end
+      rescue StandardError => e
+        ap e
       end
     end
   end