zabbix_manager 5.0.5 → 5.0.8

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.5'.freeze
+  VERSION = "5.0.8"
 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 ZabbixApi, 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zabbix_manager
 version: !ruby/object:Gem::Version
-  version: 5.0.5
+  version: 5.0.8
 platform: ruby
 authors:
 - WENWU YAN
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2022-03-08 00:00:00.000000000 Z
+date: 2022-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -42,33 +42,157 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.9
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.27
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.27
+- !ruby/object:Gem::Dependency
+  name: yardstick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.13.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: Write a longer description or delete this line.
+        version: 2.13.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+description: Most codes borrowed from ZabbixApi, But changed some logic for everyday
+  jobs.
 email:
 - careline@foxmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".idea/workspace.xml"
-- ".rubocop.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/zabbix_manager.rb
 - lib/zabbix_manager/basic/basic_alias.rb
 - lib/zabbix_manager/basic/basic_extend.rb
@@ -103,8 +227,7 @@ files:
 - lib/zabbix_manager/classes/valuemaps.rb
 - lib/zabbix_manager/client.rb
 - lib/zabbix_manager/version.rb
-- zabbix_manager-5.0.1.gem
-- zabbix_manager-5.0.2.gem
+- zabbix_manager.gemspec
 homepage: https://github.com/snmpd/zabbix_manager
 licenses:
 - MIT
@@ -121,7 +244,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -131,5 +254,6 @@ requirements: []
 rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one.
+summary: Simple and lightweight ruby module for working with the Zabbix API, support
+  4.0 5.0 6.0
 test_files: []

data/.idea/workspace.xml

@@ -1,69 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="AutoImportSettings">
-    <option name="autoReloadType" value="SELECTIVE" />
-  </component>
-  <component name="ChangeListManager">
-    <list default="true" id="9f25f96c-828f-4aea-8886-dcbae369ba60" name="变更" comment="">
-      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/lib/zabbix_manager/version.rb" beforeDir="false" afterPath="$PROJECT_DIR$/lib/zabbix_manager/version.rb" afterDir="false" />
-    </list>
-    <option name="SHOW_DIALOG" value="false" />
-    <option name="HIGHLIGHT_CONFLICTS" value="true" />
-    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
-    <option name="LAST_RESOLUTION" value="IGNORE" />
-  </component>
-  <component name="Git.Settings">
-    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
-  </component>
-  <component name="JsBowerSettings">
-    <bower-package value="" />
-    <bower.json value="" />
-  </component>
-  <component name="ProjectId" id="265x23SpJKPxcHuoXgA68nnhQDg" />
-  <component name="ProjectViewState">
-    <option name="hideEmptyMiddlePackages" value="true" />
-    <option name="showLibraryContents" value="true" />
-  </component>
-  <component name="PropertiesComponent">
-    <property name="RunOnceActivity.OpenProjectViewOnStart" value="true" />
-    <property name="RunOnceActivity.ShowReadmeOnStart" value="true" />
-    <property name="WebServerToolWindowFactoryState" value="false" />
-    <property name="last_opened_file_path" value="$PROJECT_DIR$" />
-    <property name="node.js.detected.package.eslint" value="true" />
-    <property name="node.js.selected.package.eslint" value="(autodetect)" />
-    <property name="node.js.selected.package.tslint" value="(autodetect)" />
-    <property name="nodejs_interpreter_path" value="node" />
-    <property name="nodejs_package_manager_path" value="yarn" />
-    <property name="settings.editor.selected.configurable" value="org.jetbrains.plugins.ruby.settings.RubyActiveModuleSdkConfigurable" />
-    <property name="vue.rearranger.settings.migration" value="true" />
-  </component>
-  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="应用程序级" UseSingleDictionary="true" transferred="true" />
-  <component name="SpringUtil" SPRING_PRE_LOADER_OPTION="true" RAKE_SPRING_PRE_LOADER_OPTION="true" RAILS_SPRING_PRE_LOADER_OPTION="true" />
-  <component name="TaskManager">
-    <task active="true" id="Default" summary="默认任务">
-      <changelist id="9f25f96c-828f-4aea-8886-dcbae369ba60" name="变更" comment="" />
-      <created>1646727041577</created>
-      <option name="number" value="Default" />
-      <option name="presentableId" value="Default" />
-      <updated>1646727041577</updated>
-      <workItem from="1646727043249" duration="3509000" />
-      <workItem from="1646732978147" duration="8000" />
-    </task>
-    <servers />
-  </component>
-  <component name="TypeScriptGeneratedFilesManager">
-    <option name="version" value="3" />
-  </component>
-  <component name="Vcs.Log.Tabs.Properties">
-    <option name="TAB_STATES">
-      <map>
-        <entry key="MAIN">
-          <value>
-            <State />
-          </value>
-        </entry>
-      </map>
-    </option>
-  </component>
-</project>

data/.rubocop.yml

@@ -1,13 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.4
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120