zabbixapi 4.0.0 → 5.0.0.pre.alpha1

data/lib/zabbixapi/classes/actions.rb

@@ -10,8 +10,32 @@ class ZabbixApi
     # The id field name used for identifying specific Action objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
+
+    # Get full/extended Action object data from 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}"
+
+      @client.api_request(
+        method: "#{method_name}.get",
+        params: {
+          filter: {
+            identify.to_sym => data[identify.to_sym]
+          },
+          output: 'extend',
+          selectOperations: "extend",
+          selectRecoveryOperations: "extend",
+          selectAcknowledgeOperations: "extend",
+          selectFilter: "extend",
+        }
+      )
+    end
   end
 end

data/lib/zabbixapi/classes/applications.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # The id field name used for identifying specific Application objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
 
@@ -23,7 +23,7 @@ class ZabbixApi
     def get_or_create(data)
       log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
 
-      unless (id = get_id(:name => data[:name], :hostid => data[:hostid]))
+      unless (id = get_id(name: data[:name], hostid: data[:hostid]))
         id = create(data)
       end
       id
@@ -36,8 +36,8 @@ class ZabbixApi
     # @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)
-      applicationid = get_id(:name => data[:name], :hostid => data[:hostid])
-      applicationid ? update(data.merge(:applicationid => applicationid)) : create(data)
+      applicationid = get_id(name: data[:name], hostid: data[:hostid])
+      applicationid ? update(data.merge(applicationid: applicationid)) : create(data)
     end
   end
 end

data/lib/zabbixapi/classes/configurations.rb

@@ -15,7 +15,7 @@ class ZabbixApi
     # The id field name used for identifying specific Configuration objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'host'
     end
 
@@ -26,7 +26,7 @@ class ZabbixApi
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Hash]
     def export(data)
-      @client.api_request(:method => 'configuration.export', :params => data)
+      @client.api_request(method: 'configuration.export', params: data)
     end
 
     # Import configuration data using Zabbix API
@@ -36,7 +36,7 @@ class ZabbixApi
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Hash]
     def import(data)
-      @client.api_request(:method => 'configuration.import', :params => data)
+      @client.api_request(method: 'configuration.import', params: data)
     end
   end
 end

data/lib/zabbixapi/classes/drules.rb

@@ -0,0 +1,55 @@
+class ZabbixApi
+  class Drules < Basic
+    # The method name used for interacting with Drules via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'drule'
+    end
+
+    # The id field name used for identifying specific Drule objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+
+    # The default options used when creating Drule objects via Zabbix API
+    #
+    # @return [Hash]
+    def default_options
+      {
+        name: nil,
+        iprange: nil,
+        delay: 3600,
+        status: 0,
+      }
+    end
+
+    # Get or Create Drule object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name to properly identify Drule 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(name: data[:name]))
+        id = create(data)
+      end
+      id
+    end
+
+    # Create or update Drule object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name to properly identify Drules 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)
+      druleid = get_id(name: data[:name])
+      druleid ? update(data.merge(druleid: druleid)) : create(data)
+    end
+  end
+end

data/lib/zabbixapi/classes/errors.rb

@@ -12,8 +12,11 @@ class ZabbixApi
   private
 
     def set_error!
-      @error = @response['error'] rescue nil
-      @error_message = "#{@error['message']}: #{@error['data']}" rescue nil
+      @error = @response['error']
+      @error_message = "#{@error['message']}: #{@error['data']}"
+    rescue StandardError
+      @error = nil
+      @error_message = nil
     end
   end
 

data/lib/zabbixapi/classes/events.rb

@@ -0,0 +1,17 @@
+class ZabbixApi
+  class Events < Basic
+    # The method name used for interacting with Events via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'event'
+    end
+
+    # The id field name used for identifying specific Event objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+  end
+end

data/lib/zabbixapi/classes/graphs.rb

@@ -10,26 +10,26 @@ class ZabbixApi
     # The id field name used for identifying specific Graph objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
 
     # Get full/extended Graph data from Zabbix API
     #
-    # @param data [Hash] Should include object's id field name (indentify) and id value
+    # @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 parametrs: #{data.inspect}"
+      log "[DEBUG] Call get_full_data with parameters: #{data.inspect}"
 
       @client.api_request(
-        :method => "#{method_name}.get",
-        :params => {
-          :search => {
-            indentify.to_sym => data[indentify.to_sym],
+        method: "#{method_name}.get",
+        params: {
+          search: {
+            identify.to_sym => data[identify.to_sym]
           },
-          :output => 'extend',
+          output: 'extend'
         }
       )
     end
@@ -41,33 +41,23 @@ class ZabbixApi
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Array] Returns array of Graph ids
     def get_ids_by_host(data)
-      ids = []
-      graphs = {}
-
       result = @client.api_request(
-        :method => 'graph.get',
-        :params => {
-          :filter => {
-            :host => data[:host],
+        method: 'graph.get',
+        params: {
+          filter: {
+            host: data[:host]
           },
-          :output => 'extend',
+          output: 'extend'
         }
       )
 
-      result.each do |graph|
+      result.map do |graph|
         num  = graph['graphid']
         name = graph['name']
-        graphs[name] = num
         filter = data[:filter]
 
-        if filter.nil?
-          ids.push(graphs[name])
-        elsif /#{filter}/ =~ name
-          ids.push(graphs[name])
-        end
-      end
-
-      ids
+        num if filter.nil? || /#{filter}/ =~ name
+      end.compact
     end
 
     # Get Graph Item object using Zabbix API
@@ -78,10 +68,10 @@ class ZabbixApi
     # @return [Hash]
     def get_items(data)
       @client.api_request(
-        :method => 'graphitem.get',
-        :params => {
-          :graphids => [data],
-          :output => 'extend',
+        method: 'graphitem.get',
+        params: {
+          graphids: [data],
+          output: 'extend'
         }
       )
     end
@@ -95,7 +85,7 @@ class ZabbixApi
     def get_or_create(data)
       log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
 
-      unless (id = get_id(:name => data[:name], :templateid => data[:templateid]))
+      unless (id = get_id(name: data[:name], templateid: data[:templateid]))
         id = create(data)
       end
 
@@ -109,8 +99,8 @@ class ZabbixApi
     # @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)
-      graphid = get_id(:name => data[:name], :templateid => data[:templateid])
-      graphid ? _update(data.merge(:graphid => graphid)) : create(data)
+      graphid = get_id(name: data[:name], templateid: data[:templateid])
+      graphid ? _update(data.merge(graphid: graphid)) : create(data)
     end
 
     def _update(data)

data/lib/zabbixapi/classes/hostgroups.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # The id field name used for identifying specific HostGroup objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
 

data/lib/zabbixapi/classes/hosts.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # The id field name used for identifying specific Host objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'host'
     end
 
@@ -21,16 +21,16 @@ class ZabbixApi
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Hash]
     def dump_by_id(data)
-      log "[DEBUG] Call dump_by_id with parametrs: #{data.inspect}"
+      log "[DEBUG] Call dump_by_id with parameters: #{data.inspect}"
 
       @client.api_request(
-        :method => 'host.get',
-        :params => {
-          :filter => {
-            key.to_sym => data[key.to_sym],
+        method: 'host.get',
+        params: {
+          filter: {
+            key.to_sym => data[key.to_sym]
           },
-          :output => 'extend',
-          :selectGroups => 'shorten',
+          output: 'extend',
+          selectGroups: 'shorten'
         }
       )
     end
@@ -40,12 +40,12 @@ class ZabbixApi
     # @return [Hash]
     def default_options
       {
-        :host => nil,
-        :interfaces => [],
-        :status => 0,
-        :available => 1,
-        :groups => [],
-        :proxy_hostid => nil,
+        host: nil,
+        interfaces: [],
+        status: 0,
+        available: 1,
+        groups: [],
+        proxy_hostid: nil
       }
     end
 
@@ -57,10 +57,10 @@ class ZabbixApi
     # @return [Boolean]
     def unlink_templates(data)
       result = @client.api_request(
-        :method => 'host.massRemove',
-        :params => {
-          :hostids => data[:hosts_id],
-          :templates => data[:templates_id],
+        method: 'host.massRemove',
+        params: {
+          hostids: data[:hosts_id],
+          templates: data[:templates_id]
         }
       )
       result.empty? ? false : true
@@ -73,8 +73,8 @@ class ZabbixApi
     # @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)
-      hostid = get_id(:host => data[:host])
-      hostid ? update(data.merge(:hostid => hostid)) : create(data)
+      hostid = get_id(host: data[:host])
+      hostid ? update(data.merge(hostid: hostid)) : create(data)
     end
   end
 end

data/lib/zabbixapi/classes/httptests.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # The id field name used for identifying specific HttpTest objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
 
@@ -19,9 +19,9 @@ class ZabbixApi
     # @return [Hash]
     def default_options
       {
-        :hostid => nil,
-        :name => nil,
-        :steps => [],
+        hostid: nil,
+        name: nil,
+        steps: []
       }
     end
 
@@ -34,7 +34,7 @@ class ZabbixApi
     def get_or_create(data)
       log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
 
-      unless (id = get_id(:name => data[:name], :hostid => data[:hostid]))
+      unless (id = get_id(name: data[:name], hostid: data[:hostid]))
         id = create(data)
       end
       id
@@ -47,8 +47,8 @@ class ZabbixApi
     # @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)
-      httptestid = get_id(:name => data[:name], :hostid => data[:hostid])
-      httptestid ? update(data.merge(:httptestid => httptestid)) : create(data)
+      httptestid = get_id(name: data[:name], hostid: data[:hostid])
+      httptestid ? update(data.merge(httptestid: httptestid)) : create(data)
     end
   end
 end

data/lib/zabbixapi/classes/items.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # The id field name used for identifying specific Item objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
 
@@ -19,38 +19,38 @@ class ZabbixApi
     # @return [Hash]
     def default_options
       {
-        :name => nil,
-        :key_ => nil,
-        :hostid => nil,
-        :delay => 60,
-        :history => 60,
-        :status => 0,
-        :type => 7,
-        :snmp_community => '',
-        :snmp_oid => '',
-        :value_type => 3,
-        :data_type => 0,
-        :trapper_hosts => 'localhost',
-        :snmp_port => 161,
-        :units => '',
-        :multiplier => 0,
-        :delta => 0,
-        :snmpv3_securityname => '',
-        :snmpv3_securitylevel => 0,
-        :snmpv3_authpassphrase => '',
-        :snmpv3_privpassphrase => '',
-        :formula => 0,
-        :trends => 365,
-        :logtimefmt => '',
-        :valuemapid => 0,
-        :delay_flex => '',
-        :authtype => 0,
-        :username => '',
-        :password => '',
-        :publickey => '',
-        :privatekey => '',
-        :params => '',
-        :ipmi_sensor => '',
+        name: nil,
+        key_: nil,
+        hostid: nil,
+        delay: 60,
+        history: 3600,
+        status: 0,
+        type: 7,
+        snmp_community: '',
+        snmp_oid: '',
+        value_type: 3,
+        data_type: 0,
+        trapper_hosts: 'localhost',
+        snmp_port: 161,
+        units: '',
+        multiplier: 0,
+        delta: 0,
+        snmpv3_securityname: '',
+        snmpv3_securitylevel: 0,
+        snmpv3_authpassphrase: '',
+        snmpv3_privpassphrase: '',
+        formula: 0,
+        trends: 86400,
+        logtimefmt: '',
+        valuemapid: 0,
+        delay_flex: '',
+        authtype: 0,
+        username: '',
+        password: '',
+        publickey: '',
+        privatekey: '',
+        params: '',
+        ipmi_sensor: ''
       }
     end
 
@@ -63,7 +63,7 @@ class ZabbixApi
     def get_or_create(data)
       log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
 
-      unless (id = get_id(:name => data[:name], :hostid => data[:hostid]))
+      unless (id = get_id(name: data[:name], hostid: data[:hostid]))
         id = create(data)
       end
       id
@@ -76,8 +76,8 @@ class ZabbixApi
     # @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)
-      itemid = get_id(:name => data[:name], :hostid => data[:hostid])
-      itemid ? update(data.merge(:itemid => itemid)) : create(data)
+      itemid = get_id(name: data[:name], hostid: data[:hostid])
+      itemid ? update(data.merge(itemid: itemid)) : create(data)
     end
   end
 end