zabbix_manager 5.0.4 → 5.0.7

data/lib/zabbix_manager/classes/usermacros.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Usermacros < Basic
     # The id field name used for identifying specific User macro objects via Zabbix API
     #
     # @return [String]
     def identify
-      'macro'
+      "macro"
     end
 
     # The method name used for interacting with User macros via Zabbix API
     #
     # @return [String]
     def method_name
-      'usermacro'
+      "usermacro"
     end
 
     # Get User macro object id from Zabbix API based on provided data
@@ -27,11 +29,11 @@ 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 = request(data, 'usermacro.get', 'hostmacroid')
+      result = request(data, "usermacro.get", "hostmacroid")
 
-      !result.empty? && result[0].key?('hostmacroid') ? result[0]['hostmacroid'].to_i : nil
+      !result.empty? && result[0].key?("hostmacroid") ? result[0]["hostmacroid"].to_i : nil
     end
 
     # Get Global macro object id from Zabbix API based on provided data
@@ -47,11 +49,11 @@ 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_global") if name.nil?
+      raise ManagerError, "#{identify} not supplied in call to get_id_global" if name.nil?
 
-      result = request(data, 'usermacro.get', 'globalmacroid')
+      result = request(data, "usermacro.get", "globalmacroid")
 
-      !result.empty? && result[0].key?('globalmacroid') ? result[0]['globalmacroid'].to_i : nil
+      !result.empty? && result[0].key?("globalmacroid") ? result[0]["globalmacroid"].to_i : nil
     end
 
     # Get full/extended User macro data from Zabbix API
@@ -63,7 +65,7 @@ class ZabbixManager
     def get_full_data(data)
       log "[DEBUG] Call get_full_data with parameters: #{data.inspect}"
 
-      request(data, 'usermacro.get', 'hostmacroid')
+      request(data, "usermacro.get", "hostmacroid")
     end
 
     # Get full/extended Global macro data from Zabbix API
@@ -75,7 +77,7 @@ class ZabbixManager
     def get_full_data_global(data)
       log "[DEBUG] Call get_full_data_global with parameters: #{data.inspect}"
 
-      request(data, 'usermacro.get', 'globalmacroid')
+      request(data, "usermacro.get", "globalmacroid")
     end
 
     # Create new User macro object using Zabbix API (with defaults)
@@ -86,7 +88,7 @@ class ZabbixManager
     # @return [Integer] The object id if a single object is created
     # @return [Boolean] True/False if multiple objects are created
     def create(data)
-      request(data, 'usermacro.create', 'hostmacroids')
+      request(data, "usermacro.create", "hostmacroids")
     end
 
     # Create new Global macro object using Zabbix API (with defaults)
@@ -97,7 +99,7 @@ class ZabbixManager
     # @return [Integer] The object id if a single object is created
     # @return [Boolean] True/False if multiple objects are created
     def create_global(data)
-      request(data, 'usermacro.createglobal', 'globalmacroids')
+      request(data, "usermacro.createglobal", "globalmacroids")
     end
 
     # Delete User macro object using Zabbix API
@@ -109,7 +111,7 @@ class ZabbixManager
     # @return [Boolean] True/False if multiple objects are deleted
     def delete(data)
       data_delete = [data]
-      request(data_delete, 'usermacro.delete', 'hostmacroids')
+      request(data_delete, "usermacro.delete", "hostmacroids")
     end
 
     # Delete Global macro object using Zabbix API
@@ -121,7 +123,7 @@ class ZabbixManager
     # @return [Boolean] True/False if multiple objects are deleted
     def delete_global(data)
       data_delete = [data]
-      request(data_delete, 'usermacro.deleteglobal', 'globalmacroids')
+      request(data_delete, "usermacro.deleteglobal", "globalmacroids")
     end
 
     # Update User macro object using Zabbix API
@@ -133,7 +135,7 @@ class ZabbixManager
     # @return [Integer] The object id if a single object is created
     # @return [Boolean] True/False if multiple objects are created
     def update(data)
-      request(data, 'usermacro.update', 'hostmacroids')
+      request(data, "usermacro.update", "hostmacroids")
     end
 
     # Update Global macro object using Zabbix API
@@ -145,7 +147,7 @@ class ZabbixManager
     # @return [Integer] The object id if a single object is created
     # @return [Boolean] True/False if multiple objects are created
     def update_global(data)
-      request(data, 'usermacro.updateglobal', 'globalmacroids')
+      request(data, "usermacro.updateglobal", "globalmacroids")
     end
 
     # Get or Create User macro object using Zabbix API
@@ -200,29 +202,28 @@ class ZabbixManager
       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 })
+    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
-          @client.api_request(method: method, params: { filter: data })
-        end
-      else
-        result = @client.api_request(method: method, params: data)
+          result = @client.api_request(method: method, params: data)
 
-        result.key?(result_key) && !result[result_key].empty? ? result[result_key][0].to_i : nil
+          result.key?(result_key) && !result[result_key].empty? ? result[result_key][0].to_i : nil
+        end
       end
-    end
   end
 end

data/lib/zabbix_manager/classes/users.rb

@@ -1,31 +1,33 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Users < Basic
     # The method name used for interacting with Users via Zabbix API
     #
     # @return [String]
     def method_name
-      'user'
+      "user"
     end
 
     # The keys field name used for User objects via Zabbix API
     #
     # @return [String]
     def keys
-      'userids'
+      "userids"
     end
 
     # The key field name used for User objects via Zabbix API
     #
     # @return [String]
     def key
-      'userid'
+      "userid"
     end
 
     # The id field name used for identifying specific User objects via Zabbix API
     #
     # @return [String]
     def identify
-      'alias'
+      "alias"
     end
 
     def medias_helper(data, action)
@@ -34,11 +36,11 @@ class ZabbixManager
         params: data[:userids].map do |t|
           {
             userid: t,
-            user_medias: data[:media],
+            user_medias: data[:media]
           }
-        end,
+        end
       )
-      result ? result['userids'][0].to_i : nil
+      result ? result["userids"][0].to_i : nil
     end
 
     # Add media to users using Zabbix API
@@ -48,7 +50,7 @@ class ZabbixManager
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Integer] Zabbix object id (media)
     def add_medias(data)
-      medias_helper(data, 'update')
+      medias_helper(data, "update")
     end
 
     # Update media for users using Zabbix API
@@ -58,7 +60,7 @@ class ZabbixManager
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Integer] Zabbix object id (user)
     def update_medias(data)
-      medias_helper(data, 'update')
+      medias_helper(data, "update")
     end
   end
 end

data/lib/zabbix_manager/classes/valuemaps.rb

@@ -1,24 +1,26 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class ValueMaps < Basic
     # The method name used for interacting with ValueMaps via Zabbix API
     #
     # @return [String]
     def method_name
-      'valuemap'
+      "valuemap"
     end
 
     # The key field name used for ValueMap objects via Zabbix API
     #
     # @return [String]
     def key
-      'valuemapid'
+      "valuemapid"
     end
 
     # The id field name used for identifying specific ValueMap objects via Zabbix API
     #
     # @return [String]
     def identify
-      'name'
+      "name"
     end
 
     # Get or Create ValueMap object using Zabbix API

data/lib/zabbix_manager/client.rb

@@ -1,6 +1,8 @@
-require 'net/http'
-require 'json'
-require 'openssl'
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "openssl"
 
 class ZabbixManager
   class Client
@@ -10,14 +12,14 @@ class ZabbixManager
 
     # @return [Integer]
     def id
-      rand(800_000)
+      rand 10_000
     end
 
     # Returns the API version from the Zabbix Server
     #
     # @return [String, Hash]
     def api_version
-      api_request(method: 'apiinfo.version', params: {})
+      api_request(method: "apiinfo.version", params: {})
     end
 
     # Log in to the Zabbix Server and generate an auth token using the API
@@ -25,9 +27,9 @@ class ZabbixManager
     # @return [Hash, String]
     def auth
       api_request(
-        method: 'user.login',
+        method: "user.login",
         params: {
-          user:     @options[:user],
+          user: @options[:user],
           password: @options[:password]
         }
       )
@@ -43,7 +45,7 @@ class ZabbixManager
     # Initializes a new Client object
     #
     # @param options [Hash]
-    # @option opts [String] :url The url of zabbixapi(example: 'http://localhost/zabbix/api_jsonrpc.php')
+    # @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] :http_user A user for basic auth.(optional)
@@ -53,23 +55,24 @@ class ZabbixManager
     # @return [ZabbixManager::Client]
     def initialize(options = {})
       @options = options
-      if !ENV['http_proxy'].nil? && options[:no_proxy] != true
-        @proxy_uri               = URI.parse(ENV['http_proxy'])
+      if !ENV["http_proxy"].nil? && options[:no_proxy] != true
+        @proxy_uri               = URI.parse(ENV["http_proxy"])
         @proxy_host              = @proxy_uri.host
         @proxy_port              = @proxy_uri.port
         @proxy_user, @proxy_pass = @proxy_uri.userinfo&.split(/:/) if @proxy_uri.userinfo
       end
 
-      if api_version.match? /^7\.\d+\.\d+$/
-        message = "Zabbix API version: #{api_version} is not supported by this version of zabbixapi"
+      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]
         else
-          raise ZabbixManager::ManagerError.new(message)
+          raise ZabbixManager::ManagerError, message
         end
       end
 
       @auth_hash = auth
+      puts "[DEBUG] Auth token: #{@auth_hash}" if @options[:debug]
     end
 
     # Convert message body to JSON string for the Zabbix API
@@ -77,16 +80,17 @@ class ZabbixManager
     # @param body [Hash]
     # @return [String]
     def message_json(body)
-      message        = {
-        method:  body[:method],
-        params:  body[:params],
-        id:      id,
-        jsonrpc: '2.0'
+      message = {
+        method: body[:method],
+        params: body[:params],
+        id: id,
+        jsonrpc: "2.0"
       }
 
-      message[:auth] = @auth_hash unless body[:method] == 'apiinfo.version' || body[:method] == 'user.login'
+      # 除登录认证和获取版本后之外，都需要携带TOKEN查询
+      message[:auth] = @auth_hash unless body[:method] == "apiinfo.version" || body[:method] == "user.login"
 
-      JSON.generate(message)
+      JSON(message)
     end
 
     # @param body [String]
@@ -105,7 +109,7 @@ class ZabbixManager
           Net::HTTP.new(uri.host, uri.port)
         end
 
-      if uri.scheme == 'https'
+      if uri.scheme == "https"
         http.use_ssl     = true
         http.verify_mode = OpenSSL::SSL::VERIFY_NONE
       end
@@ -115,33 +119,39 @@ class ZabbixManager
 
       request = Net::HTTP::Post.new(uri.request_uri)
       request.basic_auth @options[:http_user], @options[:http_password] if @options[:http_user]
-      request.add_field('Content-Type', 'application/json-rpc')
+      request.add_field("Content-Type", "application/json-rpc")
       request.body = body
+      puts "[DEBUG] HTTP request params: #{request.body}" if @options[:debug]
 
       response = http.request(request)
+      raise HttpError.new("HTTP Error: #{response.code} on #{@options[:url]}", response) unless response.code == "200"
 
-      raise HttpError.new("HTTP Error: #{response.code} on #{@options[:url]}", response) unless response.code == '200'
-
-      puts "[DEBUG] Get answer: #{response.body}" if @options[:debug]
+      puts "[DEBUG] HTTP response answer: #{response.body}" if @options[:debug]
       response.body
     end
 
     # @param body [String]
     # @return [Hash, String]
     def _request(body)
-      puts "[DEBUG] Send request: #{body}" if @options[:debug]
       result = JSON.parse(http_request(body))
       # 异常信息抛出
-      raise ManagerError.new("Server answer API error\n #{JSON.pretty_unparse(result['error'])}\n on request:\n #{pretty_body(body)}", result) if result['error']
+      if result["error"]
+        raise ManagerError.new(
+          "Server answer API error\n #{JSON.pretty_unparse(result["error"])}\n on request:\n #{pretty_body(body)}", result
+        )
+      end
 
-      result['result']
+      result["result"]
     end
 
     def pretty_body(body)
-      parsed_body                       = JSON.parse(body)
+      parsed_body = JSON.parse(body)
 
       # If password is in body hide it
-      parsed_body['params']['password'] = '***' if parsed_body['params'].is_a?(Hash) && parsed_body['params'].key?('password')
+      if parsed_body["params"].is_a?(Hash) && parsed_body["params"].key?("password")
+        parsed_body["params"]["password"] =
+          "***"
+      end
 
       JSON.pretty_unparse(parsed_body)
     end

data/lib/zabbix_manager/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ZabbixManager
-  VERSION = '5.0.4'.freeze
+  VERSION = "5.0.7"
 end

data/lib/zabbix_manager.rb

@@ -1,37 +1,39 @@
-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'
+# 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"
 
 class ZabbixManager
   # @return [ZabbixManager::Client]
@@ -192,4 +194,3 @@ class ZabbixManager
     @drules ||= Drules.new(@client)
   end
 end
-

data/zabbix_manager.gemspec

@@ -0,0 +1,43 @@
+# 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"
+
+Gem::Specification.new do |spec|
+  spec.add_dependency "http", "~> 4.0"
+  spec.add_dependency "json", "~> 2.0"
+  spec.add_development_dependency "bundler", "~> 2.3", ">= 2.3.9"
+
+  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_development_dependency "rubocop", "~> 1.25", ">= 1.25.1"
+  spec.add_development_dependency "rubocop-minitest", "~> 0.18.0"
+  spec.add_development_dependency "rubocop-performance", "~> 1.13"
+  spec.add_development_dependency "rubocop-rails", "~> 2.13", ">= 2.13.2"
+  spec.add_development_dependency "rubocop-packaging", "~> 0.5.1"
+
+  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 zabbix_manager, But changed some logic for everyday jobs."
+  spec.homepage    = "https://github.com/snmpd/zabbix_manager"
+  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.files                 = %w[CHANGELOG.md LICENSE.txt README.md zabbix_manager.gemspec] + Dir["lib/**/*.rb"]
+  spec.require_paths         = "lib"
+  spec.required_ruby_version = ">= 2.7.0"
+end