zabbix_manager 5.1.0 → 5.1.1.pre.alpha1

data/lib/zabbix_manager/classes/usermacros.rb

@@ -19,7 +19,7 @@ class ZabbixManager
     # 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 [ManagerError] Error returned when there is a problem with the Zabbix API call or missing object's id field name (identify).
+    # @raise [ZbxError] 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)
@@ -29,7 +29,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, "#{identify} not supplied in call to get_id" if name.nil?
+      raise ZbxError, "#{identify} not supplied in call to get_id" if name.nil?
 
       result = request(data, "usermacro.get", "hostmacroid")
 
@@ -39,7 +39,7 @@ class ZabbixManager
     # 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 [ManagerError] Error returned when there is a problem with the Zabbix API call or missing object's id field name (identify).
+    # @raise [ZbxError] 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)
@@ -49,7 +49,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, "#{identify} not supplied in call to get_id_global" if name.nil?
+      raise ZbxError, "#{identify} not supplied in call to get_id_global" if name.nil?
 
       result = request(data, "usermacro.get", "globalmacroid")
 
@@ -59,7 +59,7 @@ class ZabbixManager
     # Get full/extended User macro data from Zabbix API
     #
     # @param data [Hash] Should include object's id field name (identify) and id value
-    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [ZbxError] 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)
@@ -71,7 +71,7 @@ class ZabbixManager
     # Get full/extended Global macro data from Zabbix API
     #
     # @param data [Hash] Should include object's id field name (identify) and id value
-    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [ZbxError] 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_global(data)
@@ -83,7 +83,7 @@ class ZabbixManager
     # Create new User macro object using Zabbix API (with defaults)
     #
     # @param data [Hash] Needs to include hostid, macro, and value to create User macro via Zabbix API
-    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [ZbxError] 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
@@ -94,7 +94,7 @@ class ZabbixManager
     # Create new Global macro object using Zabbix API (with defaults)
     #
     # @param data [Hash] Needs to include hostid, macro, and value to create Global macro via Zabbix API
-    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [ZbxError] 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
@@ -105,7 +105,7 @@ class ZabbixManager
     # Delete User macro object using Zabbix API
     #
     # @param data [Hash] Should include hostmacroid's of User macros to delete
-    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [ZbxError] 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
     # @return [Boolean] True/False if multiple objects are deleted
@@ -117,7 +117,7 @@ class ZabbixManager
     # Delete Global macro object using Zabbix API
     #
     # @param data [Hash] Should include hostmacroid's of Global macros to delete
-    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [ZbxError] 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
     # @return [Boolean] True/False if multiple objects are deleted
@@ -130,7 +130,7 @@ class ZabbixManager
     #
     # @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 [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [ZbxError] 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
@@ -142,7 +142,7 @@ class ZabbixManager
     #
     # @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 [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [ZbxError] 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
@@ -153,7 +153,7 @@ class ZabbixManager
     # Get or Create User macro object using Zabbix API
     #
     # @param data [Hash] Needs to include macro and hostid to properly identify User macros via Zabbix API
-    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [ZbxError] 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)
@@ -168,7 +168,7 @@ class ZabbixManager
     # Get or Create Global macro object using Zabbix API
     #
     # @param data [Hash] Needs to include macro and hostid to properly identify Global macros via Zabbix API
-    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [ZbxError] 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_global(data)
@@ -183,9 +183,9 @@ class ZabbixManager
     # Create or update User macro object using Zabbix API
     #
     # @param data [Hash] Needs to include macro and hostid to properly identify User macros via Zabbix API
-    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [ZbxError] 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
+    # @return [Integer, TrueClass, FalseClass, NilClass] 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)
@@ -194,36 +194,37 @@ class ZabbixManager
     # Create or update Global macro object using Zabbix API
     #
     # @param data [Hash] Needs to include macro and hostid to properly identify Global macros via Zabbix API
-    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [ZbxError] 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
+    # @return [Integer, TrueClass, FalseClass, NilClass] Zabbix object id
     def create_or_update_global(data)
       globalmacroid = get_id_global(macro: data[:macro], hostid: data[:hostid])
       globalmacroid ? update_global(data.merge(globalmacroid: globalmacroid)) : create_global(data)
     end
 
     private
-      # Custom request method to handle both User and Global macros in one
-      #
-      # @param data [Hash] Needs to include macro and hostid to properly identify Global macros via Zabbix API
-      # @param method [String] Zabbix API method to use for the request
-      # @param result_key [String] Which key to use for parsing results based on User vs Global macros
-      # @raise [ManagerError] 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 request(data, method, result_key)
-        # 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 })
-          else
-            @client.api_request(method: method, params: { filter: data })
-          end
-        else
-          result = @client.api_request(method: method, params: data)
 
-          result.key?(result_key) && !result[result_key].empty? ? result[result_key][0].to_i : nil
+    # Custom request method to handle both User and Global macros in one
+    #
+    # @param data [Hash] Needs to include macro and hostid to properly identify Global macros via Zabbix API
+    # @param method [String] Zabbix API method to use for the request
+    # @param result_key [String] Which key to use for parsing results based on User vs Global macros
+    # @raise [ZbxError] 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, TrueClass, FalseClass, NilClass] Zabbix object id
+    def request(data, method, result_key)
+      # 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 })
+        else
+          @client.api_request(method: method, params: { filter: data })
         end
+      else
+        result = @client.api_request(method: method, params: data)
+
+        result.key?(result_key) && !result[result_key].empty? ? result[result_key][0].to_i : nil
       end
+    end
   end
 end

data/lib/zabbix_manager/classes/users.rb

@@ -46,9 +46,9 @@ class ZabbixManager
     # Add media to users using Zabbix API
     #
     # @param data [Hash] Needs to include userids and media to mass add media to users
-    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [ZbxError] 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 (media)
+    # @return [Integer, NilClass] Zabbix object id (media)
     def add_medias(data)
       medias_helper(data, "update")
     end
@@ -56,9 +56,9 @@ class ZabbixManager
     # Update media for users using Zabbix API
     #
     # @param data [Hash] Needs to include userids and media to mass update media for users
-    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [ZbxError] 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 (user)
+    # @return [Integer, NilClass] Zabbix object id (user)
     def update_medias(data)
       medias_helper(data, "update")
     end

data/lib/zabbix_manager/classes/valuemaps.rb

@@ -26,24 +26,25 @@ class ZabbixManager
     # Get or Create ValueMap object using Zabbix API
     #
     # @param data [Hash] Needs to include valuemapids [List] to properly identify ValueMaps via Zabbix API
-    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [ZbxError] 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
+    # @return [Integer, TrueClass, FalseClass] Zabbix object id
     def get_or_create(data)
       log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
 
-      unless (id = get_id(valuemapids: data[:valuemapids]))
-        id = create(data)
+      if (id = get_id(valuemapids: data[:valuemapids]))
+        id
+      else
+        create(data)
       end
-      id
     end
 
     # Create or update Item object using Zabbix API
     #
     # @param data [Hash] Needs to include valuemapids to properly identify ValueMaps via Zabbix API
-    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [ZbxError] 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
+    # @return [Integer, TrueClass, FalseClass] Zabbix object id
     def create_or_update(data)
       valuemapid = get_id(name: data[:name])
       valuemapid ? update(data.merge(valuemapids: [:valuemapid])) : create(data)

data/lib/zabbix_manager/client.rb

@@ -4,57 +4,74 @@ require "net/http"
 require "json"
 require "openssl"
 
+# @author: WENWU YAN
+# @email: 968828@gmail.com
+# @date: 2023/3/25下午4:47
 class ZabbixManager
   class Client
-    # @param (see ZabbixManager::Client#initialize)
+    # @param
     # @return [Hash]
     attr_reader :options
 
     # @return [Integer]
     def id
-      rand 10_000
+      @id ||= rand 100_000
     end
 
     # Returns the API version from the Zabbix Server
-    #
+    # @note 获取 zabbix api 版本
     # @return [String, Hash]
     def api_version
       api_request(method: "apiinfo.version", params: {})
     end
 
+    # ZabbixManager::Basic.log does not like @client.options[:debug]
+    # @note 是否启用 debug 模式
+    # @return [boolean]
+    def debug?
+      !@options || @options[:debug]
+    end
+
+    # Log messages to stdout when debugging
+    # @note debug 打印信息
+    # @param message [String]
+    def log(message)
+      puts message if debug?
+    end
+
     # Log in to the Zabbix Server and generate an auth token using the API
-    #
+    # @note 用户鉴权，登录成功即可获取令牌
+    # @raise [ZbxError] Error returned when there is a problem with the Zabbix API call.
     # @return [Hash, String]
     def auth
       api_request(
         method: "user.login",
         params: {
-          user: @options[:user],
+          user:     @options[:user],
           password: @options[:password]
         }
       )
     end
 
-    # ZabbixManager::Basic.log does not like @client.options[:debug]
-    #
-    # @return [boolean]
-    def debug?
-      !@options || @options[:debug]
-    end
-
     # Initializes a new Client object
-    #
+    # @see 实例化 HTTP 客户端，同时进行用户权限签证
     # @param options [Hash]
-    # @option opts [String] :url The url of zabbix_manager(example: 'http://localhost/zabbix/api_jsonrpc.php')
-    # @option opts [String] :user
-    # @option opts [String] :password
+    # @option opts [String] :url The url of zabbix
+    # @example 'http://zabbix.com/api_jsonrpc.php'
+    # @see 'https://www.zabbix.com/documentation/current/en/manual/api/reference'
+    # @option opts [String] :user A user for api auth.(required)
+    # @option opts [String] :password A password for api auth.(required)
     # @option opts [String] :http_user A user for basic auth.(optional)
     # @option opts [String] :http_password A password for basic auth.(optional)
     # @option opts [Integer] :timeout Set timeout for requests in seconds.(default: 60)
-    #
+    # @raise [ZbxError] Error raised when api_version not support.
     # @return [ZabbixManager::Client]
     def initialize(options = {})
       @options = options
+      raise ZabbixManager::ZbxError, "Missing required argument: :url" unless @options.key?(:url)
+      raise ZabbixManager::ZbxError, "Missing required argument: :user" unless @options.key?(:user)
+      raise ZabbixManager::ZbxError, "Missing required argument: :password" unless @options.key?(:password)
+
       if !ENV["http_proxy"].nil? && options[:no_proxy] != true
         @proxy_uri               = URI.parse(ENV["http_proxy"])
         @proxy_host              = @proxy_uri.host
@@ -65,42 +82,45 @@ class ZabbixManager
       if api_version.match?(/^7\.\d+\.\d+$/)
         message = "Zabbix API version: #{api_version} is not supported by this version of zabbix_manager"
         if @options[:ignore_version]
-          puts "[WARNING] #{message}" if @options[:debug]
+          log "[WARNING] #{message}"
         else
-          raise ZabbixManager::ManagerError, message
+          raise ZabbixManager::ZbxError, message
         end
       end
 
       @auth_hash = auth
-      puts "[DEBUG] Auth token: #{@auth_hash}" if @options[:debug]
+      log "[DEBUG] Auth token: #{@auth_hash}"
     end
 
-    # Convert message body to JSON string for the Zabbix API
-    #
+    # Convert payload body to JSON string for the Zabbix API
+    # @note 将 ruby 数据结构转换为 json 字符串，除用户登录和获取API版本外均添加令牌
     # @param body [Hash]
     # @return [String]
-    def message_json(body)
-      message = {
-        method: body[:method],
-        params: body[:params],
-        id: id,
+    def json_payload(body)
+      payload        = {
+        method:  body[:method],
+        params:  body[:params],
+        id:      id,
         jsonrpc: "2.0"
       }
 
-      # 除登录认证和获取版本后之外，都需要携带TOKEN查询
-      message[:auth] = @auth_hash unless body[:method] == "apiinfo.version" || body[:method] == "user.login"
+      payload[:auth] = @auth_hash unless body[:method] == "apiinfo.version" || body[:method] == "user.login"
 
-      JSON(message)
+      JSON(payload)
     end
 
+    # HTTP Request with the Zabbix API
+    # @note 实例化 Net::HTTP 对象，并发起 api 请求
     # @param body [String]
+    # @raise [ZbxError] 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 [String]
     def http_request(body)
       uri = URI.parse(@options[:url])
 
       # set the time out the default (60) or to what the user passed
       timeout = @options[:timeout].nil? ? 60 : @options[:timeout]
-      puts "[DEBUG] Timeout for request set to #{timeout} seconds" if @options[:debug]
+      log "[DEBUG] Timeout for request set to #{timeout} seconds"
 
       http =
         if @proxy_uri
@@ -121,48 +141,53 @@ class ZabbixManager
       request.basic_auth @options[:http_user], @options[:http_password] if @options[:http_user]
       request.add_field("Content-Type", "application/json-rpc")
       request.body = body
-      puts "[DEBUG] HTTP request params: #{request.body}" if @options[:debug]
+      log "[DEBUG] HTTP request params: #{pretty_body(request.body)}"
 
       response = http.request(request)
       raise HttpError.new("HTTP Error: #{response.code} on #{@options[:url]}", response) unless response.code == "200"
 
-      puts "[DEBUG] HTTP response answer: #{response.body}" if @options[:debug]
+      log "[DEBUG] HTTP response answer: #{pretty_body(response.body)}"
       response.body
     end
 
+    # Check the result returned by zabbix api is ok or not
+    # @note 发起 api 调用并对响应结果进行解析，如接口报错则抛出异常
+    # @@note 返回的数据为基于字符串索引，需要自行适配为符号索引
     # @param body [String]
+    # @raise [ZbxError] Error returned when there is a problem with the Zabbix API call.
     # @return [Hash, String]
     def _request(body)
       result = JSON.parse(http_request(body))
-      # 异常信息抛出
       if result["error"]
-        raise ManagerError.new(
+        raise ZbxError.new(
           "Server answer API error\n #{JSON.pretty_unparse(result["error"])}\n on request:\n #{pretty_body(body)}", result
         )
+      else
+        result["result"]
       end
-
-      result["result"]
     end
 
+    # Pretty print json body
+    # @note 将 ruby 数据结构美化成 json 字符串后打印输出
+    # @param body [String]
+    # @return [Hash, String]
     def pretty_body(body)
-      parsed_body = JSON.parse(body)
+      data = JSON.parse(body)
 
       # If password is in body hide it
-      if parsed_body["params"].is_a?(Hash) && parsed_body["params"].key?("password")
-        parsed_body["params"]["password"] =
-          "***"
+      if data["params"].is_a?(Hash) && data["params"].key?("password")
+        data["params"]["password"] = "***"
       end
 
-      JSON.pretty_unparse(parsed_body)
+      JSON.pretty_unparse(data)
     end
 
     # Execute Zabbix API requests and return response
-    #
+    # @note 通用的 api 调用发起方法
     # @param body [Hash]
     # @return [Hash, String]
     def api_request(body)
-      # ap body
-      _request message_json(body)
+      _request json_payload(body)
     end
   end
 end

data/lib/zabbix_manager/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 class ZabbixManager
-  VERSION = "5.1.0"
+  # @note find ./* -type f -exec sed -i 's/\[X\]/\[Y\]/g' {} +
+  VERSION = "5.1.1.pre.alpha1"
 end

data/lib/zabbix_manager.rb

@@ -1,40 +1,13 @@
 # frozen_string_literal: true
 
-require "zabbix_manager/version"
-require "zabbix_manager/client"
-
-require "zabbix_manager/basic/basic_alias"
-require "zabbix_manager/basic/basic_func"
-require "zabbix_manager/basic/basic_init"
-require "zabbix_manager/basic/basic_logic"
-
-require "zabbix_manager/classes/actions"
-require "zabbix_manager/classes/applications"
-require "zabbix_manager/classes/configurations"
-require "zabbix_manager/classes/errors"
-require "zabbix_manager/classes/events"
-require "zabbix_manager/classes/graphs"
-require "zabbix_manager/classes/hostgroups"
-require "zabbix_manager/classes/hosts"
-require "zabbix_manager/classes/httptests"
-require "zabbix_manager/classes/items"
-require "zabbix_manager/classes/maintenance"
-require "zabbix_manager/classes/mediatypes"
-require "zabbix_manager/classes/proxies"
-require "zabbix_manager/classes/problems"
-require "zabbix_manager/classes/roles"
-require "zabbix_manager/classes/screens"
-require "zabbix_manager/classes/scripts"
-require "zabbix_manager/classes/server"
-require "zabbix_manager/classes/templates"
-require "zabbix_manager/classes/triggers"
-require "zabbix_manager/classes/unusable"
-require "zabbix_manager/classes/usergroups"
-require "zabbix_manager/classes/usermacros"
-require "zabbix_manager/classes/users"
-require "zabbix_manager/classes/valuemaps"
-require "zabbix_manager/classes/drules"
+# Dynamically load Ruby modules
+Dir.glob(File.join(__dir__, "zabbix_manager", "**", "*.rb")).sort.each do |module_rb|
+  require module_rb
+end
 
+# @author: WENWU YAN
+# @email: 968828@gmail.com
+# @date: 2023/3/25下午4:47
 class ZabbixManager
   # @return [ZabbixManager::Client]
   attr_reader :client
@@ -47,27 +20,29 @@ class ZabbixManager
     new(options)
   end
 
+  # @note TODO
   # @return [ZabbixManager]
   def self.current
     @current ||= ZabbixManager.new
   end
 
   # Executes an API request directly using a custom query
-  #
+  # @note 通用的查询方法，自行提供 method 和 params
   # @param data [Hash]
-  # @return [Hash]
+  # @return [Hash, String]
   def query(data)
-    @client.manager_request(method: data[:method], params: data[:params])
+    @client.api_request(method: data[:method], params: data[:params])
   end
 
   # Invalidate current authentication token
+  # @note TODO
   # @return [Boolean]
   def logout
     @client.logout
   end
 
   # Initializes a new ZabbixManager object
-  #
+  # @note 实例化 ZabbixManager 对象，Client.new 进行参数检查
   # @param options [Hash]
   # @return [ZabbixManager::Client]
   def initialize(options = {})
@@ -104,6 +79,11 @@ class ZabbixManager
     @hostgroups ||= HostGroups.new(@client)
   end
 
+  # @return [ZabbixManager::HostInterfaces]
+  def hostinterfaces
+    @hostinterfaces ||= HostInterfaces.new(@client)
+  end
+
   # @return [ZabbixManager::Hosts]
   def hosts
     @hosts ||= Hosts.new(@client)

data/zabbix_manager.gemspec

@@ -8,31 +8,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "zabbix_manager/version"
 
 Gem::Specification.new do |spec|
-  spec.add_dependency "http", ">= 4.0.0"
-  spec.add_dependency "json", ">= 2.0"
-  spec.add_development_dependency "bundler", ">= 2.0"
-
-  spec.add_development_dependency "rspec", "~> 3.11"
-  spec.add_development_dependency "yard", "~> 0.9.27"
-  spec.add_development_dependency "yardstick", ">= 0.9.9"
+  spec.add_dependency "http", "5.1.1"
+  spec.add_dependency "json", "2.6.3"
+  spec.add_dependency "activesupport", "~> 7.0.4"
 
   spec.name    = "zabbix_manager"
   spec.version = ZabbixManager::VERSION
   spec.authors = ["WENWU YAN"]
   spec.email   = ["careline@foxmail.com"]
 
-  spec.summary     = "Simple and lightweight ruby module for working with the Zabbix API, support 4.0 5.0 6.0"
-  spec.description = "Most codes borrowed from ZabbixApi, But changed some logic for everyday jobs. Support Zabbix 4.0 5.0 6.0"
+  spec.summary     = "Common code for Zabbix API clients"
+  spec.description = "A Ruby interface to the Zabbix API"
   spec.homepage    = "https://github.com/snmpd/zabbix_manager"
   spec.licenses    = "MIT"
 
-  # spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
   spec.metadata["homepage_uri"]    = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/snmpd/zabbix_manager"
   spec.metadata["changelog_uri"]   = "https://github.com/snmpd/zabbix_manager"
 
-  spec.files                 = %w[CHANGELOG.md LICENSE.txt CODE_OF_CONDUCT.md README.md zabbix_manager.gemspec] + Dir["lib/**/*.rb"]
+  spec.files                 = %w[CHANGELOG.md LICENSE README.md zabbix_manager.gemspec] + Dir["lib/**/*.rb"]
   spec.require_paths         = "lib"
   spec.required_ruby_version = ">= 2.7.0"
 end