zabbixapi_mgx 5.0.0.pre.alpha1

data/lib/zabbixapi/classes/usermacros.rb

@@ -0,0 +1,228 @@
+class ZabbixApi
+  class Usermacros < Basic
+    # The id field name used for identifying specific User macro objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'macro'
+    end
+
+    # The method name used for interacting with User macros via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'usermacro'
+    end
+
+    # Get User macro object id from Zabbix API based on provided data
+    #
+    # @param data [Hash] Needs to include macro to properly identify user macros via Zabbix API
+    # @raise [ApiError] 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_id(data)
+      log "[DEBUG] Call 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 ApiError.new("#{identify} not supplied in call to get_id") if name.nil?
+
+      result = request(data, 'usermacro.get', 'hostmacroid')
+
+      !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
+    #
+    # @param data [Hash] Needs to include macro to properly identify global macros via Zabbix API
+    # @raise [ApiError] 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_id_global(data)
+      log "[DEBUG] Call get_id_global 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 ApiError.new("#{identify} not supplied in call to get_id_global") if name.nil?
+
+      result = request(data, 'usermacro.get', 'globalmacroid')
+
+      !result.empty? && result[0].key?('globalmacroid') ? result[0]['globalmacroid'].to_i : nil
+    end
+
+    # Get full/extended User macro data from Zabbix API
+    #
+    # @param data [Hash] Should include object's id field name (identify) and id value
+    # @raise [ApiError] 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}"
+
+      request(data, 'usermacro.get', 'hostmacroid')
+    end
+
+    # Get full/extended Global macro data from Zabbix API
+    #
+    # @param data [Hash] Should include object's id field name (identify) and id value
+    # @raise [ApiError] 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_global(data)
+      log "[DEBUG] Call get_full_data_global with parameters: #{data.inspect}"
+
+      request(data, 'usermacro.get', 'globalmacroid')
+    end
+
+    # Create new User macro object using Zabbix API (with defaults)
+    #
+    # @param data [Hash] Needs to include hostid, macro, and value to create User macro via Zabbix API
+    # @raise [ApiError] 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)
+      request(data, 'usermacro.create', 'hostmacroids')
+    end
+
+    # Create new Global macro object using Zabbix API (with defaults)
+    #
+    # @param data [Hash] Needs to include hostid, macro, and value to create Global macro via Zabbix API
+    # @raise [ApiError] 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_global(data)
+      request(data, 'usermacro.createglobal', 'globalmacroids')
+    end
+
+    # Delete User macro object using Zabbix API
+    #
+    # @param data [Hash] Should include hostmacroid's of User macros to delete
+    # @raise [ApiError] 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)
+      data_delete = [data]
+      request(data_delete, 'usermacro.delete', 'hostmacroids')
+    end
+
+    # Delete Global macro object using Zabbix API
+    #
+    # @param data [Hash] Should include hostmacroid's of Global macros to delete
+    # @raise [ApiError] 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_global(data)
+      data_delete = [data]
+      request(data_delete, 'usermacro.deleteglobal', 'globalmacroids')
+    end
+
+    # Update User macro object using Zabbix API
+    #
+    # @param data [Hash] Should include object's id field name (identify), id value, and fields to update
+    # @param force [Boolean] Whether to force an object update even if provided data matches Zabbix
+    # @raise [ApiError] 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)
+      request(data, 'usermacro.update', 'hostmacroids')
+    end
+
+    # Update Global macro object using Zabbix API
+    #
+    # @param data [Hash] Should include object's id field name (identify), id value, and fields to update
+    # @param force [Boolean] Whether to force an object update even if provided data matches Zabbix
+    # @raise [ApiError] 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_global(data)
+      request(data, 'usermacro.updateglobal', 'globalmacroids')
+    end
+
+    # Get or Create User macro object using Zabbix API
+    #
+    # @param data [Hash] Needs to include macro and hostid to properly identify User macros via Zabbix API
+    # @raise [ApiError] 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 get_or_create(data)
+      log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
+
+      unless (id = get_id(macro: data[:macro], hostid: data[:hostid]))
+        id = create(data)
+      end
+      id
+    end
+
+    # Get or Create Global macro object using Zabbix API
+    #
+    # @param data [Hash] Needs to include macro and hostid to properly identify Global macros via Zabbix API
+    # @raise [ApiError] 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 get_or_create_global(data)
+      log "[DEBUG] Call get_or_create_global with parameters: #{data.inspect}"
+
+      unless (id = get_id_global(macro: data[:macro], hostid: data[:hostid]))
+        id = create_global(data)
+      end
+      id
+    end
+
+    # Create or update User macro object using Zabbix API
+    #
+    # @param data [Hash] Needs to include macro and hostid to properly identify User macros via Zabbix API
+    # @raise [ApiError] 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 create_or_update(data)
+      hostmacroid = get_id(macro: data[:macro], hostid: data[:hostid])
+      hostmacroid ? update(data.merge(hostmacroid: hostmacroid)) : create(data)
+    end
+
+    # Create or update Global macro object using Zabbix API
+    #
+    # @param data [Hash] Needs to include macro and hostid to properly identify Global macros via Zabbix API
+    # @raise [ApiError] 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 create_or_update_global(data)
+      globalmacroid = get_id_global(macro: data[:macro], hostid: data[:hostid])
+      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 [ApiError] 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
+        result = @client.api_request(method: method, params: data)
+
+        result.key?(result_key) && !result[result_key].empty? ? result[result_key][0].to_i : nil
+      end
+    end
+  end
+end

data/lib/zabbixapi/classes/users.rb

@@ -0,0 +1,64 @@
+class ZabbixApi
+  class Users < Basic
+    # The method name used for interacting with Users via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'user'
+    end
+
+    # The keys field name used for User objects via Zabbix API
+    #
+    # @return [String]
+    def keys
+      'userids'
+    end
+
+    # The key field name used for User objects via Zabbix API
+    #
+    # @return [String]
+    def key
+      'userid'
+    end
+
+    # The id field name used for identifying specific User objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'alias'
+    end
+
+    def medias_helper(data, action)
+      result = @client.api_request(
+        method: "user.#{action}",
+        params: data[:userids].map do |t|
+          {
+            userid: t,
+            user_medias: data[:media],
+          }
+        end,
+      )
+      result ? result['userids'][0].to_i : nil
+    end
+
+    # Add media to users using Zabbix API
+    #
+    # @param data [Hash] Needs to include userids and media to mass add media to users
+    # @raise [ApiError] 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 (media)
+    def add_medias(data)
+      medias_helper(data, 'update')
+    end
+
+    # Update media for users using Zabbix API
+    #
+    # @param data [Hash] Needs to include userids and media to mass update media for users
+    # @raise [ApiError] 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 (user)
+    def update_medias(data)
+      medias_helper(data, 'update')
+    end
+  end
+end

data/lib/zabbixapi/classes/valuemaps.rb

@@ -0,0 +1,50 @@
+class ZabbixApi
+  class ValueMaps < Basic
+    # The method name used for interacting with ValueMaps via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'valuemap'
+    end
+
+    # The key field name used for ValueMap objects via Zabbix API
+    #
+    # @return [String]
+    def key
+      'valuemapid'
+    end
+
+    # The id field name used for identifying specific ValueMap objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+
+    # Get or Create ValueMap object using Zabbix API
+    #
+    # @param data [Hash] Needs to include valuemapids [List] to properly identify ValueMaps via Zabbix API
+    # @raise [ApiError] 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 get_or_create(data)
+      log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
+
+      unless (id = get_id(valuemapids: data[:valuemapids]))
+        id = create(data)
+      end
+      id
+    end
+
+    # Create or update Item object using Zabbix API
+    #
+    # @param data [Hash] Needs to include valuemapids to properly identify ValueMaps via Zabbix API
+    # @raise [ApiError] 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 create_or_update(data)
+      valuemapid = get_id(name: data[:name])
+      valuemapid ? update(data.merge(valuemapids: [:valuemapid])) : create(data)
+    end
+  end
+end

data/lib/zabbixapi/client.rb

@@ -0,0 +1,167 @@
+require 'net/http'
+require 'json'
+require 'openssl'
+
+class ZabbixApi
+  class Client
+    # @param (see ZabbixApi::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
+
+    # ZabbixApi::Basic.log does not like @client.options[:debug]
+    #
+    # @return [boolean]
+    def debug?
+      return ! @options || @options[:debug]
+    end
+
+    # Log out from the Zabbix Server
+    #
+    # @return [Boolean]
+    #
+    def logout
+      api_request(
+	 :method => 'user.logout',
+	 :params => []
+      )
+    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 [ZabbixApi::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 ZabbixApi::ApiError.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 ApiError.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)
+      _request message_json(body)
+    end
+  end
+end

data/lib/zabbixapi/version.rb

@@ -0,0 +1,3 @@
+class ZabbixApi
+  VERSION = '5.0.0-alpha1'.freeze
+end