zabbix_manager 5.1.5 → 6.0.0

data/lib/zabbix_manager.rb

@@ -1,168 +1,133 @@
 # frozen_string_literal: true
 
+require "active_support/core_ext/hash/indifferent_access"
+require "active_support/core_ext/hash/keys"
+require "active_support/core_ext/hash/deep_transform_values"
+require "active_support/core_ext/enumerable"
+require "active_support/core_ext/array/wrap"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/object/deep_dup"
 require "zabbix_manager/version"
+require "zabbix_manager/classes/errors"
+require "zabbix_manager/log_sanitizer"
+require "zabbix_manager/http_transport"
+require "zabbix_manager/configuration"
 require "zabbix_manager/client"
 
-# 动态加载基础类
-Dir.glob(File.join(__dir__, "zabbix_manager/basic", "**", "*.rb")).sort.each do |basic_class|
-  require basic_class
-end
-
-# 动态加载扩展类
-Dir.glob(File.join(__dir__, "zabbix_manager/classes", "**", "*.rb")).sort.each do |extend_class|
-  require extend_class
-end
-
+require "zabbix_manager/resource"
+
+require "zabbix_manager/classes/actions"
+require "zabbix_manager/classes/applications"
+require "zabbix_manager/classes/configurations"
+require "zabbix_manager/classes/events"
+require "zabbix_manager/classes/graphs"
+require "zabbix_manager/classes/host_groups"
+require "zabbix_manager/classes/host_interfaces"
+require "zabbix_manager/classes/hosts"
+require "zabbix_manager/classes/http_tests"
+require "zabbix_manager/classes/items"
+require "zabbix_manager/classes/maintenance"
+require "zabbix_manager/classes/media_types"
+require "zabbix_manager/classes/proxies"
+require "zabbix_manager/classes/proxy_groups"
+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/user_groups"
+require "zabbix_manager/classes/user_macros"
+require "zabbix_manager/classes/users"
+require "zabbix_manager/classes/value_maps"
+require "zabbix_manager/classes/discovery_rules"
+require "zabbix_manager/monitoring"
+require "zabbix_manager/traffic"
+
+# 管理一个已认证客户端及其资源、监控和流量入口；连接生命周期由调用方负责。
+# 原生 API 透传不代替应用层授权，资源对象共享同一客户端凭据。
 class ZabbixManager
+  # @return [ZabbixManager::Client]
   attr_reader :client
 
-  # 初始化一个新的 ZabbixManager 对象
-  def self.connect(options = {})
-    new(options)
-  end
-
-  # 获取当前 ZabbixManager 对象
-  def self.current
-    @current ||= new
-  end
-
-  # 直接使用自定义查询执行 API 请求
-  def query(data)
-    @client.api_request(method: data[:method], params: data[:params])
-  end
-
-  # 注销当前身份验证令牌
+  # 使用显式配置创建管理器，并立即查询 API 版本、完成认证。
+  #
+  # @param options [Hash]
+  # @return [ZabbixManager]
+  # @raise [Invalid, ApiError, TransportError] 配置、认证或连接失败
+  def self.connect(**options)
+    new(**options)
+  end
+
+  # 仅使用文档列出的连接环境变量创建管理器。
+  # 显式选项覆盖环境配置，包含显式传入的 nil。
+  # @param env [#[]] 包含四个约定 ZABBIX_* 环境变量的映射
+  # @param options [Hash] 显式连接配置
+  # @return [ZabbixManager] 已认证管理器，其生命周期由调用方负责
+  def self.from_env(env: ENV, **options)
+    new(**Configuration.from_env(env, options))
+  end
+
+  # 直接执行调用方指定的 Zabbix API 方法。
+  #
+  # @param method [String]
+  # @param params [Hash, Array]
+  # @return [Object]
+  # @raise [ApiError] 服务端明确拒绝请求
+  # @raise [TransportError, ProtocolError] 未获得可确认结果；写请求不可盲目重试
+  def query(method:, params: {})
+    @client.api_request(method: method, params: params)
+  end
+
+  # 注销用户名会话并关闭连接。
+  # @return [Boolean]
   def logout
     @client.logout
   end
 
-  # 初始化一个新的 ZabbixManager 对象
-  def initialize(options = {})
-    @client = Client.new(options)
-  end
-
-  # 返回 ZabbixManager::Actions 对象
-  def actions
-    @actions ||= Actions.new(@client)
-  end
-
-  # 返回 ZabbixManager::Applications 对象
-  def applications
-    @applications ||= Applications.new(@client)
-  end
-
-  # 返回 ZabbixManager::Configurations 对象
-  def configurations
-    @configurations ||= Configurations.new(@client)
-  end
-
-  # 返回 ZabbixManager::Events 对象
-  def events
-    @events ||= Events.new(@client)
-  end
-
-  # 返回 ZabbixManager::Graphs 对象
-  def graphs
-    @graphs ||= Graphs.new(@client)
-  end
-
-  # 返回 ZabbixManager::HostGroups 对象
-  def hostgroups
-    @hostgroups ||= HostGroups.new(@client)
-  end
-
-  # 返回 ZabbixManager::HostInterfaces 对象
-  def hostinterfaces
-    @hostinterfaces ||= HostInterfaces.new(@client)
-  end
-
-  # 返回 ZabbixManager::Hosts 对象
-  def hosts
-    @hosts ||= Hosts.new(@client)
+  # 关闭持久 HTTP 连接但不改变远端凭据。
+  # @return [true] 下次请求可按需重新连接
+  def close
+    @client.close
   end
 
-  # 返回 ZabbixManager::HttpTests 对象
-  def httptests
-    @httptests ||= HttpTests.new(@client)
+  # 初始化管理器并创建唯一共享客户端。
+  #
+  # @param options [Hash]
+  # @raise [Invalid, ApiError, TransportError] 配置、认证或连接失败
+  def initialize(**options)
+    @client = Client.new(**options)
+    @resources = {}
   end
 
-  # 返回 ZabbixManager::Items 对象
-  def items
-    @items ||= Items.new(@client)
-  end
-
-  # 返回 ZabbixManager::Maintenance 对象
-  def maintenance
-    @maintenance ||= Maintenance.new(@client)
-  end
-
-  # 返回 ZabbixManager::Mediatypes 对象
-  def mediatypes
-    @mediatypes ||= Mediatypes.new(@client)
-  end
-
-  # 返回 ZabbixManager::Problems 对象
-  def problems
-    @problems ||= Problems.new(@client)
-  end
-
-  # 返回 ZabbixManager::Proxies 对象
-  def proxies
-    @proxies ||= Proxies.new(@client)
-  end
-
-  # 返回 ZabbixManager::Roles 对象
-  def roles
-    @roles ||= Roles.new(@client)
-  end
-
-  # 返回 ZabbixManager::Screens 对象
-  def screens
-    @screens ||= Screens.new(@client)
-  end
-
-  # 返回 ZabbixManager::Scripts 对象
-  def scripts
-    @scripts ||= Scripts.new(@client)
-  end
-
-  # 返回 ZabbixManager::Server 对象
-  def server
-    @server ||= Server.new(@client)
-  end
-
-  # 返回 ZabbixManager::Templates 对象
-  def templates
-    @templates ||= Templates.new(@client)
-  end
-
-  # 返回 ZabbixManager::Triggers 对象
-  def triggers
-    @triggers ||= Triggers.new(@client)
-  end
-
-  # 返回 ZabbixManager::Usergroups 对象
-  def usergroups
-    @usergroups ||= Usergroups.new(@client)
-  end
-
-  # 返回 ZabbixManager::Usermacros 对象
-  def usermacros
-    @usermacros ||= Usermacros.new(@client)
-  end
+  # 各资源对象共享当前管理器的已认证客户端。
+  RESOURCES = {
+    actions: Actions, applications: Applications, configurations: Configurations,
+    events: Events, graphs: Graphs, host_groups: HostGroups, host_interfaces: HostInterfaces,
+    hosts: Hosts, http_tests: HttpTests, items: Items, maintenance: Maintenance,
+    media_types: MediaTypes, problems: Problems, proxies: Proxies, proxy_groups: ProxyGroups, roles: Roles,
+    screens: Screens, scripts: Scripts, server: Server, templates: Templates,
+    triggers: Triggers, user_groups: UserGroups, user_macros: UserMacros, users: Users,
+    value_maps: ValueMaps, discovery_rules: DiscoveryRules
+  }.freeze
+  private_constant :RESOURCES
 
-  # 返回 ZabbixManager::Users 对象
-  def users
-    @users ||= Users.new(@client)
+  # 在加载期按固定映射生成 actions、host_groups 等访问器，避免重复的资源工厂方法。
+  # 名称不来自外部输入；实例按管理器缓存，认证和连接由共享 Client 持有。
+  RESOURCES.each do |name, resource_class|
+    define_method(name) { @resources[name] ||= resource_class.new(@client) }
   end
 
-  # 返回 ZabbixManager::ValueMaps 对象
-  def valuemaps
-    @valuemaps ||= ValueMaps.new(@client)
+  # 返回仅使用 Zabbix 原生 API 的设备、接口和线路监控编排入口。
+  # @return [ZabbixManager::Monitoring] 同一 manager 复用同一业务实例
+  def monitoring
+    @monitoring ||= Monitoring.new(self)
   end
 
-  # 返回 ZabbixManager::Drules 对象
-  def drules
-    @drules ||= Drules.new(@client)
+  # 查询数值监控项的历史或趋势序列，不访问数据库、不补造缺失观测。
+  # @return [ZabbixManager::Traffic] 同一 manager 复用同一查询实例
+  def traffic
+    @traffic ||= Traffic.new(self)
   end
 end

data/zabbix_manager.gemspec

@@ -1,34 +1,31 @@
-# coding: utf-8
 # frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
-
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require "zabbix_manager/version"
+require_relative "lib/zabbix_manager/version"
 
 Gem::Specification.new do |spec|
-  spec.add_dependency "http"
-  spec.add_dependency "json"
-  spec.add_dependency "activesupport"
+  spec.add_dependency "activesupport", ">= 7.2"
+  spec.add_dependency "bigdecimal"
+  spec.add_dependency "json", ">= 2.0"
+  spec.add_dependency "logger", ">= 1.4"
+  spec.add_dependency "net-http"
 
   spec.name    = "zabbix_manager"
   spec.version = ZabbixManager::VERSION
   spec.authors = ["WENWU YAN"]
   spec.email   = ["careline@foxmail.com"]
 
-  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.summary     = "Ruby client and monitoring workflows for the Zabbix 4.0 through 7.x API"
+  spec.description = "A reusable Zabbix API client with device and network-interface monitoring workflows."
+  spec.homepage    = "https://github.com/gatework/zabbix_manager/tree/master"
   spec.licenses    = "MIT"
 
   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.metadata["source_code_uri"] = "https://github.com/gatework/zabbix_manager"
+  spec.metadata["changelog_uri"]   = "https://github.com/gatework/zabbix_manager/blob/master/CHANGELOG.md"
 
   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"
+  spec.required_ruby_version = ">= 3.4"
 end

metadata

@@ -1,17 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: zabbix_manager
 version: !ruby/object:Gem::Version
-  version: 5.1.5
+  version: 6.0.0
 platform: ruby
 authors:
 - WENWU YAN
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: http
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -30,16 +43,30 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: net-http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,7 +79,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A Ruby interface to the Zabbix API
+description: A reusable Zabbix API client with device and network-interface monitoring
+  workflows.
 email:
 - careline@foxmail.com
 executables: []
@@ -63,49 +91,59 @@ files:
 - LICENSE
 - README.md
 - lib/zabbix_manager.rb
-- lib/zabbix_manager/basic/basic_alias.rb
-- lib/zabbix_manager/basic/basic_func.rb
-- lib/zabbix_manager/basic/basic_init.rb
-- lib/zabbix_manager/basic/basic_logic.rb
 - lib/zabbix_manager/classes/actions.rb
 - lib/zabbix_manager/classes/applications.rb
 - lib/zabbix_manager/classes/configurations.rb
-- lib/zabbix_manager/classes/drules.rb
+- lib/zabbix_manager/classes/discovery_rules.rb
 - lib/zabbix_manager/classes/errors.rb
 - lib/zabbix_manager/classes/events.rb
 - lib/zabbix_manager/classes/graphs.rb
-- lib/zabbix_manager/classes/hostgroups.rb
-- lib/zabbix_manager/classes/hostinterfaces.rb
+- lib/zabbix_manager/classes/host_groups.rb
+- lib/zabbix_manager/classes/host_interfaces.rb
 - lib/zabbix_manager/classes/hosts.rb
-- lib/zabbix_manager/classes/httptests.rb
+- lib/zabbix_manager/classes/http_tests.rb
 - lib/zabbix_manager/classes/items.rb
 - lib/zabbix_manager/classes/maintenance.rb
-- lib/zabbix_manager/classes/mediatypes.rb
+- lib/zabbix_manager/classes/media_types.rb
 - lib/zabbix_manager/classes/problems.rb
 - lib/zabbix_manager/classes/proxies.rb
+- lib/zabbix_manager/classes/proxy_groups.rb
 - lib/zabbix_manager/classes/roles.rb
 - lib/zabbix_manager/classes/screens.rb
 - lib/zabbix_manager/classes/scripts.rb
 - lib/zabbix_manager/classes/server.rb
 - lib/zabbix_manager/classes/templates.rb
 - lib/zabbix_manager/classes/triggers.rb
-- lib/zabbix_manager/classes/unusable.rb
-- lib/zabbix_manager/classes/usergroups.rb
-- lib/zabbix_manager/classes/usermacros.rb
+- lib/zabbix_manager/classes/user_groups.rb
+- lib/zabbix_manager/classes/user_macros.rb
 - lib/zabbix_manager/classes/users.rb
-- lib/zabbix_manager/classes/valuemaps.rb
+- lib/zabbix_manager/classes/value_maps.rb
 - lib/zabbix_manager/client.rb
+- lib/zabbix_manager/configuration.rb
+- lib/zabbix_manager/http_transport.rb
+- lib/zabbix_manager/log_sanitizer.rb
+- lib/zabbix_manager/monitoring.rb
+- lib/zabbix_manager/monitoring/device.rb
+- lib/zabbix_manager/monitoring/expressions.rb
+- lib/zabbix_manager/monitoring/line.rb
+- lib/zabbix_manager/monitoring/line_items.rb
+- lib/zabbix_manager/monitoring/line_lifecycle.rb
+- lib/zabbix_manager/monitoring/line_plan.rb
+- lib/zabbix_manager/monitoring/thresholds.rb
+- lib/zabbix_manager/monitoring/traffic_items.rb
+- lib/zabbix_manager/monitoring/validation.rb
+- lib/zabbix_manager/resource.rb
+- lib/zabbix_manager/traffic.rb
 - lib/zabbix_manager/version.rb
 - zabbix_manager.gemspec
-homepage: https://github.com/snmpd/zabbix_manager
+homepage: https://github.com/gatework/zabbix_manager/tree/master
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/snmpd/zabbix_manager
-  source_code_uri: https://github.com/snmpd/zabbix_manager
-  changelog_uri: https://github.com/snmpd/zabbix_manager
-post_install_message: 
+  homepage_uri: https://github.com/gatework/zabbix_manager/tree/master
+  source_code_uri: https://github.com/gatework/zabbix_manager
+  changelog_uri: https://github.com/gatework/zabbix_manager/blob/master/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -113,15 +151,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
-summary: Common code for Zabbix API clients
+summary: Ruby client and monitoring workflows for the Zabbix 4.0 through 7.x API
 test_files: []

data/lib/zabbix_manager/basic/basic_alias.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-class ZabbixManager
-  class Basic
-    # 获取 Zabbix 对象数据
-    def get(data)
-      get_full_data(data)
-    end
-
-    # 新增 Zabbix 对象
-    def add(data)
-      create(data)
-    end
-
-    # 删除 Zabbix 对象
-    def destroy(data)
-      delete(data)
-    end
-  end
-end

data/lib/zabbix_manager/basic/basic_func.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-class ZabbixManager
-  class Basic
-    # 在调试模式下将日志消息记录到 stdout
-    def log(message)
-      puts message if @client.options[:debug]
-    end
-
-    # 比较两个哈希是否相等
-    def hash_equals?(hash1, hash2)
-      normalized_hash1 = normalize_hash(hash1)
-      normalized_hash2 = normalize_hash(hash2)
-
-      merged_hash1 = normalized_hash1.merge(normalized_hash2)
-      merged_hash2 = normalized_hash2.merge(normalized_hash1)
-
-      merged_hash1 == merged_hash2
-    end
-
-    # 将所有哈希/数组键转换为符号
-    # &method(:symbolize_keys) 是 Ruby 中一种将方法转换为可传递给块或其他方法的 Proc 的方式
-    def symbolize_keys(object)
-      case object
-      when Array
-        object.map(&method(:symbolize_keys))
-      when Hash
-        object.transform_keys(&:to_sym).transform_values(&method(:symbolize_keys))
-      else
-        object
-      end
-    end
-
-    # 将所有哈希值规范化为字符串
-    def normalize_hash(hash)
-      result = hash.dup
-
-      # 移除用于日志记录的 TODO 注释。TemplateID 和 HostID 具有不同的 ID
-      result.delete(:hostid)
-
-      result.transform_keys!(&:to_sym)
-      result.transform_values! { |value| value.is_a?(Array) ? normalize_array(value) : value.to_s }
-
-      result
-    end
-
-    # 将所有数组值规范化为字符串
-    def normalize_array(array)
-      result = []
-
-      array.each do |e|
-        if e.is_a?(Array)
-          result.push(normalize_array(e))
-        elsif e.is_a?(Hash)
-          result.push(normalize_hash(e))
-        else
-          result.push(e.to_s)
-        end
-      end
-
-      result
-    end
-
-    # 解析包含 ID 键或布尔值的数据哈希
-    def parse_keys(data)
-      case data
-      when Hash
-        data.empty? ? false : data[keys][0].to_i
-      when TrueClass
-        true
-      when FalseClass
-        false
-      else
-        false
-      end
-    end
-
-    # 合并两个哈希为一个新的哈希
-    def merge_hashes(hash1, hash2)
-      new_hash = hash1.dup
-      new_hash.merge(hash2)
-    end
-  end
-end

data/lib/zabbix_manager/basic/basic_init.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-class ZabbixManager
-  class Basic
-    # 使用 ZabbixManager 客户端初始化一个新的 Basic 对象
-    def initialize(client)
-      @client = client
-    end
-
-    # 在派生类中应该重写此方法以提供特定的方法名
-    def method_name
-      raise ZbxError, "子类需要自行实现 method_name"
-    end
-
-    # 在派生类中应该重写此方法以提供特定的 ID 字段名
-    def identify
-      raise ZbxError, "子类需要自行实现 identify"
-    end
-
-    # 派生类可以重写此方法以提供特定的默认选项
-    def default_options
-      {}
-    end
-
-    # 根据 method_name + id 返回对象的 ID 字段名（identify）
-    def key
-      "#{method_name}id"
-    end
-
-    # 根据 key 返回对象的复数 ID 字段名（identify）
-    def keys
-      "#{key}s"
-    end
-  end
-end