zabbix_manager 5.0.1 → 5.0.2

data/lib/zabbix_manager/client.rb

@@ -0,0 +1,158 @@
+require 'net/http'
+require 'json'
+require 'openssl'
+
+class ZabbixManager
+  class Client
+    # @param (see ZabbixManager::Client#initialize)
+    # @return [Hash]
+    attr_reader :options
+
+    # @return [Integer]
+    def id
+      rand(100_000)
+    end
+
+    # Returns the API version from the Zabbix Server
+    #
+    # @return [String]
+    def api_version
+      @api_version ||= api_request(method: 'apiinfo.version', params: {})
+      @api_version
+    end
+
+    # Log in to the Zabbix Server and generate an auth token using the API
+    #
+    # @return [Hash]
+    def auth
+      api_request(
+        method: 'user.login',
+        params: {
+          user:     @options[:user],
+          password: @options[:password]
+        }
+      )
+    end
+
+    # ZabbixManager::Basic.log does not like @client.options[:debug]
+    #
+    # @return [boolean]
+    def debug?
+      return !@options || @options[:debug]
+    end
+
+    # 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] :user
+    # @option opts [String] :password
+    # @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)
+    #
+    # @return [ZabbixManager::Client]
+    def initialize(options = {})
+      @options = options
+      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
+      unless api_version =~ %r{^5.[0|2]\.\d+$}
+        message = "Zabbix API version: #{api_version} is not supported by this version of zabbixapi"
+        if @options[:ignore_version]
+          puts "[WARNING] #{message}" if @options[:debug]
+        else
+          raise ZabbixManager::ManagerError.new(message)
+        end
+      end
+
+      @auth_hash = auth
+    end
+
+    # Convert message body to JSON string for the Zabbix API
+    #
+    # @param body [Hash]
+    # @return [String]
+    def message_json(body)
+      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'
+
+      JSON.generate(message)
+    end
+
+    # @param body [String]
+    # @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]
+
+      http =
+        if @proxy_uri
+          Net::HTTP.Proxy(@proxy_host, @proxy_port, @proxy_user, @proxy_pass).new(uri.host, uri.port)
+        else
+          Net::HTTP.new(uri.host, uri.port)
+        end
+
+      if uri.scheme == 'https'
+        http.use_ssl     = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      http.open_timeout = timeout
+      http.read_timeout = timeout
+
+      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.body = body
+
+      response = http.request(request)
+
+      raise HttpError.new("HTTP Error: #{response.code} on #{@options[:url]}", response) unless response.code == '200'
+
+      puts "[DEBUG] Get 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']
+
+      result['result']
+    end
+
+    def pretty_body(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')
+
+      JSON.pretty_unparse(parsed_body)
+    end
+
+    # Execute Zabbix API requests and return response
+    #
+    # @param body [Hash]
+    # @return [Hash, String]
+    def api_request(body)
+      # ap body
+      _request message_json(body)
+    end
+  end
+end

data/lib/zabbix_manager/version.rb

@@ -1,3 +1,3 @@
 class ZabbixManager
-  VERSION = '5.0.1'.freeze
+  VERSION = '5.0.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zabbix_manager
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.0.2
 platform: ruby
 authors:
 - WENWU YAN
@@ -9,7 +9,49 @@ autorequire:
 bindir: exe
 cert_chain: []
 date: 2021-12-18 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Write a longer description or delete this line.
 email:
 - careline@foxmail.com
@@ -27,7 +69,40 @@ files:
 - bin/console
 - bin/setup
 - lib/zabbix_manager.rb
+- lib/zabbix_manager/basic/basic_alias.rb
+- lib/zabbix_manager/basic/basic_extend.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/errors.rb
+- lib/zabbix_manager/classes/events.rb
+- lib/zabbix_manager/classes/graphs.rb
+- lib/zabbix_manager/classes/hostgroups.rb
+- lib/zabbix_manager/classes/hosts.rb
+- lib/zabbix_manager/classes/httptests.rb
+- lib/zabbix_manager/classes/items.rb
+- lib/zabbix_manager/classes/maintenance.rb
+- lib/zabbix_manager/classes/mediatypes.rb
+- lib/zabbix_manager/classes/problems.rb
+- lib/zabbix_manager/classes/proxies.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/users.rb
+- lib/zabbix_manager/classes/valuemaps.rb
+- lib/zabbix_manager/client.rb
 - lib/zabbix_manager/version.rb
+- zabbix_manager-5.0.1.gem
 homepage: https://github.com/snmpd/zabbix_manager
 licenses:
 - MIT