zabbix_manager 5.1.0 → 5.1.1.pre.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b6d365a03157b9a76cfb41caeaacef8a27e030a358b5b21e4fc65156de9f5e0
-  data.tar.gz: 72ca3a28bfa6833545670193d6f4898a49ccdf040cdc9c61ff1c283164ce23e8
+  metadata.gz: 7f399a8e709f4dd599a96f7262fd9db1fe45df50517e1dbe6c03fb800802c842
+  data.tar.gz: 31bed21203fb1f34d2f334454a8e4bc4eeaba82f0cd15c2991b0b3a1c44bf6b2
 SHA512:
-  metadata.gz: f4bee7468445d37efbb38a5988eb11c833295e12574bd6b91d7c310d1e159292e932907eb2c2ba01a68a221507f3380c380ed981c39d41c189b609fd51873a69
-  data.tar.gz: 8470d3bdb4b3d1dfca93f67cc973972c1389139d93727285fe6f479f82d71c4f5d6ca62d56e3e73b96399b2b2c360665abfa2c51d97031a2792d4cfa6af05272
+  metadata.gz: 0bc102949b9b885ef3b66b29af279bab13c81fd3356cccb2a6e3bbd72db107f9bb6edd7fbc30dc9d157bae70de67076678a8f98f053040a7feb6fe81720ab9ad
+  data.tar.gz: 6ea4885896f47adace6df1b8c3ce8538a2af28d3cf7fe32a485bc2b285fe20f3e06a72fae6ac56503d59ad694b0861b6eb2cff90c109dfb8a03104c261e833c9

data/CHANGELOG.md

@@ -1,3 +1,11 @@
-#CHANGELOG
+# CHANGELOG
 
-### 5.0.7
+## 5.1.1
+* 新增基类查询方法：
+  * get_key_ids_by_identify：基于监控对象索引键(#{identify})查询 { "#{key}": id }；
+  * get_key_ids：基于监控对象索引建"#{identify}"查询 { "#{key}": id }；
+  * get_or_create_keys：批量创建或更新监控对象并返回 [{ "#{key}": id }];
+* 优化 Client 对象实例化逻辑：
+  * 增加入参检查：必须提供 url、user和password，以及 @id 缓存；
+  * 优化 debug 模式，接口请求入参和出参打印，均使用 JSON.pretty_unparse(data) 美化；
+* 完善项目注释，项目注释覆盖率90%；

data/{LICENSE.txt → LICENSE}

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2022 TODO: WENWU.YAN
+Copyright (c) 2023 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
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -4,7 +4,7 @@
 
 [gem]: https://rubygems.org/gems/zabbix_manager
 
-Most codes borrowed from zabbixapi, but fit for my everyday works well!
+Most of the code in the project is based on rewriting the ZabbixApi
 Simple and lightweight ruby module for working with [Zabbix][Zabbix] via the [Zabbix API][Zabbix API]
 
 ## Installation
@@ -13,7 +13,7 @@ Simple and lightweight ruby module for working with [Zabbix][Zabbix] via the [Za
 gem install zabbix_manager
 
 # specific version
-gem install zabbix_manager -v 4.2.0
+gem install zabbix_manager -v 5.1.1
 ```
 
 ## Documentation
@@ -50,6 +50,7 @@ dropped.
 
 * net/http
 * json
+* activesupport
 
 ## Contributing
 

data/lib/zabbix_manager/basic/basic_alias.rb

@@ -3,9 +3,9 @@
 class ZabbixManager
   class Basic
     # Get Zabbix object data from API by id
-    #
+    # @note 通用的查询方法
     # @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(data)
@@ -13,9 +13,9 @@ class ZabbixManager
     end
 
     # Add new Zabbix object using API create
-    #
+    # @note 通用的新增方法
     # @param data [Hash]
-    # @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
@@ -24,16 +24,14 @@ class ZabbixManager
     end
 
     # Destroy Zabbix object using API delete
-    #
+    # @note 通用的删除方法
     # @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 [Integer] The object id if a single object is deleted
     # @return [Boolean] True/False if multiple objects are deleted
     def destroy(data)
       delete(data)
     end
-
-    def method_name; end
   end
 end

data/lib/zabbix_manager/basic/basic_func.rb

@@ -3,19 +3,19 @@
 class ZabbixManager
   class Basic
     # Log messages to stdout when debugging
-    #
+    # @note 开启debug模式，打印日志
     # @param message [String]
     def log(message)
-      puts message.to_s if @client.options[:debug]
+      puts message if @client.options[:debug]
     end
 
     # Compare two hashes for equality
-    #
+    # @note 比较两个哈希是否相等
     # @param first_hash [Hash]
     # @param second_hash [Hash]
     # @return [Boolean]
     def hash_equals?(first_hash, second_hash)
-      normalized_first_hash = normalize_hash(first_hash)
+      normalized_first_hash  = normalize_hash(first_hash)
       normalized_second_hash = normalize_hash(second_hash)
 
       hash1 = normalized_first_hash.merge(normalized_second_hash)
@@ -24,25 +24,22 @@ class ZabbixManager
     end
 
     # Convert all hash/array keys to symbols
-    #
+    # @@note 将数组或哈希序列化
     # @param object [Array, Hash]
     # @return [Array, Hash]
     def symbolize_keys(object)
       case object
       when Array
-        object.each_with_index do |val, index|
-          object[index] = symbolize_keys(val)
-        end
+        object.map(&method(:symbolize_keys))
       when Hash
-        object.each_key do |key|
-          object[key.to_sym] = symbolize_keys(object.delete(key))
-        end
+        object.transform_keys(&:to_sym).transform_values(&method(:symbolize_keys))
+      else
+        object
       end
-      object
     end
 
     # Normalize all hash values to strings
-    #
+    # @note 将哈希元素序列化成字符串
     # @param hash [Hash]
     # @return [Hash]
     def normalize_hash(hash)
@@ -51,14 +48,14 @@ class ZabbixManager
       result.delete(:hostid) # TODO: remove to logig. TemplateID and HostID has different id
 
       result.each do |key, value|
-        result[key] = value.is_a?(Array) ? normalize_array(value) : value.to_s
+        result[key.to_sym] = value.is_a?(Array) ? normalize_array(value) : value.to_s
       end
 
       result
     end
 
     # Normalize all array values to strings
-    #
+    # @note 将数组元素序列化成字符串
     # @param array [Array]
     # @return [Array]
     def normalize_array(array)
@@ -79,18 +76,20 @@ class ZabbixManager
     end
 
     # Parse a data hash for id key or boolean to return
-    #
-    # @param data [Hash]
+    # @note 提取 zabbix 监控对象 CRUD key 或者 keys
+    # @param data
     # @return [Integer] The object id if a single object hash is provided with key
     # @return [Boolean] True/False if multiple class object hash is provided
     def parse_keys(data)
       case data
       when Hash
-        data.empty? ? nil : data[keys][0].to_i
+        data.empty? ? false : data[keys][0].to_i
       when TrueClass
         true
       when FalseClass
         false
+      else
+        false
       end
     end
 

data/lib/zabbix_manager/basic/basic_init.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 class ZabbixManager
+  # @author: WENWU YAN
+  # @email: 968828@gmail.com
+  # @date: 2023/3/25下午4:47
   class Basic
     # Initializes a new Basic object with ZabbixManager Client
-    #
+    # @note zabbix api 基类
     # @param client [ZabbixManager::Client]
     # @return [ZabbixManager::Client]
     def initialize(client)
@@ -11,38 +14,38 @@ class ZabbixManager
     end
 
     # Placeholder for inherited objects to provide object-specific method name
-    #
-    # @raise [ManagerError] Basic object does not directly support method_name
+    # @note 子类必须实现的方法 method_name
+    # @raise [ZbxError] Basic object does not directly support method_name
     def method_name
-      raise ManagerError, "Can't call method_name here"
+      raise ZbxError, "Can't call method_name here"
+    end
+
+    # Placeholder for inherited objects to provide object-specific id field name
+    # @note 子类必须实现的方法
+    # @raise [ZbxError] Basic object does not directly support identify
+    def identify
+      raise ZbxError, "Can't call identify here"
     end
 
     # Placeholder for inherited objects to provide default options
-    #
+    # @note 子类缺省的 options
     # @return [Hash]
     def default_options
       {}
     end
 
-    # 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 (identify) based on method_name + id
-    #
+    # @note 默认 key 为 "#{method_name}id"
     # @return [String]
     def key
       "#{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, "Can't call identify here"
+    # Returns the object's plural id field name (identify) based on key
+    # @note 默认 key 为 "#{method_name}ids"
+    # @return [String]
+    def keys
+      "#{key}s"
     end
   end
 end

data/lib/zabbix_manager/basic/basic_logic.rb

@@ -3,64 +3,31 @@
 class ZabbixManager
   class Basic
     # Create new Zabbix object using API (with defaults)
-    #
+    # @note 新增 zabbix 监控对象，返回监控对象 id
     # @param data [Hash]
-    # @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
     def create(data)
-      log "[DEBUG] Call create with parameters: #{data.inspect}"
+      log "[DEBUG] Call #{method_name}.create with parameters: #{data.inspect}"
 
-      # 判断是否绑定默认选项并重新生成配置
-      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)
-      # 判断是否执行成功并返回结果
+      params = default_options.merge(data)
+      result = @client.api_request(method: "#{method_name}.create", params: params)
       parse_keys result
     end
 
-    # Delete Zabbix object using 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 [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
-    def delete(data)
-      log "[DEBUG] Call delete with parameters: #{data.inspect}"
-
-      data_delete = [data]
-      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 (identify) and id value
-    # @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] 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
-
     # Update Zabbix object using API
-    #
+    # @note 更新 zabbix 监控对象，返回监控对象 id
     # @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 [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
     def update(data, force = false)
-      log "[DEBUG] Call update with parameters: #{data.inspect}"
+      log "[DEBUG] Call #{method_name}.update with parameters: #{data.inspect}"
+
       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
@@ -69,67 +36,85 @@ class ZabbixManager
         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)
+        result = @client.api_request(method: "#{method_name}.update", params: data)
         parse_keys result
       end
     end
 
-    # mojo_update 请求补丁函数
-    def mojo_update(method, data)
-      log "[DEBUG] Call update with parameters: #{data.inspect}"
-      @client.api_request(method: method, params: data)
-    end
+    # Delete Zabbix object using API
+    # @note 删除 zabbix 监控对象，返回监控对象 id
+    # @param data [Hash] Should include object's id field name (identify) and id value
+    # @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
+    def delete(data)
+      log "[DEBUG] Call #{method_name}.delete with parameters: #{data.inspect}"
 
-    # MOJO_UPDATE
+      result = @client.api_request(method: "#{method_name}.delete", params: data)
+      parse_keys result
+    end
 
-    # Get full/extended Zabbix object data from API
-    #
+    # Get or Create Zabbix object using API
+    # @note 创建或更新 zabbix 监控对象，返回监控对象 id
     # @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)
-      log "[DEBUG] Call get_full_data with parameters: #{data.inspect}"
+    # @return [Integer, Array, TrueClass, FalseClass] Zabbix object id
+    def get_or_create(data)
+      log "[DEBUG] Call #{method_name}.get_or_create with parameters: #{data.inspect}"
 
-      @client.api_request(
-        method: "#{method_name}.get",
-        params: {
-          filter: {
-            identify.to_sym => data[identify.to_sym]
-          },
-          output: "extend"
-        }
-      )
+      # Call get_id return object id if exists
+      if (id = get_id(identify.to_sym => data[identify.to_sym]))
+        id
+      else
+        create(data)
+      end
     end
 
-    # Get raw Zabbix object data from API
-    #
-    # @param data [Hash]
-    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+    # Get or Create Zabbix object [{ key: id }] using API
+    # @note 批量创建或更新监控对象并返回 [ { "#{key}": id } ]
+    # @param data [Hash, Array] Should include object's id field name (identify) and id value
+    # @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_raw(data)
-      log "[DEBUG] Call get_raw with parameters: #{data.inspect}"
+    # @return [Array] Zabbix object [{keys: id}]
+    def get_or_create_keys(data)
+      log "[DEBUG] Call #{method_name}.get_or_create_keys with parameters: #{data.inspect}"
+
+      ids = []
+      [data].flatten.each do |item|
+        if (id = get_or_create(item))
+          ids << { "#{key}": id }
+        end
+      end
+      ids
+    end
 
-      @client.api_request(
-        method: "#{method_name}.get",
-        params: data
-      )
+    # Create or update Zabbix object using API
+    # @note 创建或更新 zabbix 监控对象，入参为基于符号的哈希对象，返回监控对象 id
+    # @param data [Hash] Should include object's id field name (identify) and id value
+    # @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
+    def create_or_update(data)
+      log "[DEBUG] Call #{method_name}.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
 
     # Dump Zabbix object data by key from API
-    #
+    # @note 基于 "#{key}" 打印 zabbix 监控对象详情
     # @param data [Hash] Should include desired object's key and 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 dump_by_id(data)
-      log "[DEBUG] Call dump_by_id with parameters: #{data.inspect}"
+      log "[DEBUG] Call #{method_name}.dump_by_id with parameters: #{data.inspect}"
 
-      @client.api_request(
-        method: "#{method_name}.get",
-        params: {
+      get_raw(
+        {
           filter: {
             key.to_sym => data[key.to_sym]
           },
@@ -138,90 +123,109 @@ class ZabbixManager
       )
     end
 
-    # Get full/extended Zabbix data for all objects of type/class from API
-    #
-    # @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 [Array<Hash>] Array of matching objects
-    def all
-      result = {}
-      @client.api_request(
-        method: "#{method_name}.get",
-        params: { output: "extend" }
-      ).each do |item|
-        result[item[identify]] = item[key]
-      end
-      result
-    end
-
     # Get Zabbix object id from API based on provided data
-    #
+    # @note 基于 zabbix "#{identify}" 查询监控对象的 "#{key}"
     # @param data [Hash]
-    # @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
+    # @return [Integer, NilClass] Zabbix object id
     def get_id(data)
-      log "[DEBUG] Call get_id with parameters: #{data.inspect}"
+      log "[DEBUG] Call #{method_name}.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 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 = @client.api_request(
-        method: "#{method_name}.get",
-        params: {
+      result = get_raw(
+        {
           filter: data,
           output: [key, identify]
         }
       )
-      id = nil
-      result.each { |item| id = item[key].to_i if item[identify] == data[identify.to_sym] }
-      id
+
+      result.find { |item| item[identify] == data[identify.to_sym] }&.[](key)&.to_i
     end
 
-    # Get or Create Zabbix object using 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.
+    # Get Zabbix object [{ key: id }] from API based on provided data
+    # @note 基于监控对象索引建"#{identify}"查询 { "#{key}": id }
+    # @param data [Hash, Array]
+    # @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_or_create(data)
-      log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
-
-      unless (id = get_id(identify.to_sym => data[identify.to_sym]))
-        id = create(data)
+    # @return [Array] Zabbix object id
+    def get_key_ids(data)
+      log "[DEBUG] Call #{method_name}.get_key_ids with parameters: #{data.inspect}"
+
+      ids = []
+      [data].flatten.each do |item|
+        if (id = get_id(item))
+          ids << { "#{key}": id }
+        end
       end
-      id
+      ids
     end
 
-    # 根据数据自动创建
-    def create_raw(data)
-      log "[DEBUG] Call create_raw with parameters: #{data.inspect}"
-      # 请求创建数据
-      @client.api_request(
-        method: "#{method_name}.create",
-        params: data
+    # Get Zabbix object ID by name using Zabbix API
+    # @note 基于监控对象索引键(#{identify})查询 #{key}
+    # @param data [String, Array] Needs to include host to properly identify Zabbix Objects via Zabbix API
+    # @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 [Array, NilClass] Zabbix object id
+    def get_key_ids_by_identify(data)
+      log "[DEBUG] Call #{method_name}.get_ids_by_name with parameters: #{data.inspect}"
+
+      result = get_raw(
+        {
+          filter: { "#{identify}": [data].flatten },
+          output: ["#{key}"]
+        }
       )
+      result.empty? ? nil : result.map { |i| { "#{key}": i[key] } }
     end
 
-    # 根据数据自动更新数据
-    def update_raw(data)
-      log "[DEBUG] Call update_raw with parameters: #{data.inspect}"
-      # 请求创建数据
-      @client.api_request(
-        method: "#{method_name}.update",
-        params: data
+    # Get full/extended Zabbix data for all objects of type/class from API
+    # @note 查询 zabbix 监控对象所有的 "#{identify}: #{key}"
+    # @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] Array of matching objects
+    def all
+      result = {}
+      get_raw({ output: "extend" }).each do |item|
+        result[item[identify]] = item[key]
+      end
+      result
+    end
+
+    # Get full/extended Zabbix object data from API
+    # @note 基于 "#{identify}" 过滤 zabbix 监控对象，输出详情
+    # @param data [Hash] Should include object's id field name (identify) and id value
+    # @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)
+      log "[DEBUG] Call #{method_name}.get_full_data with parameters: #{data.inspect}"
+
+      get_raw(
+        {
+          filter: {
+            identify.to_sym => data[identify.to_sym]
+          },
+          output: "extend"
+        }
       )
     end
 
-    # 根据数据自动删除数据
-    def delete_raw(data)
-      log "[DEBUG] Call delete_raw with parameters: #{data.inspect}"
-      # 请求创建数据
+    # Get raw Zabbix object data from API
+    # @note zabbix 监控对象低阶查询方法，静默方法 debug 打印信息
+    # @param data [Hash]
+    # @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_raw(data)
+      # log "[DEBUG] Call #{method_name}.get_raw with parameters: #{data.inspect}"
       @client.api_request(
-        method: "#{method_name}.delete",
+        method: "#{method_name}.get",
         params: data
       )
     end