zabbixapi 3.1.0 → 3.2.1

data/lib/zabbixapi/classes/actions.rb

@@ -1,13 +1,17 @@
 class ZabbixApi
   class Actions < Basic
-
+    # The method name used for interacting with Actions via Zabbix API
+    #
+    # @return [String]
     def method_name
-      "action"
+      'action'
     end
 
+    # The id field name used for identifying specific Action objects via Zabbix API
+    #
+    # @return [String]
     def indentify
-      "name"
+      'name'
     end
-
   end
 end

data/lib/zabbixapi/classes/applications.rb

@@ -1,16 +1,25 @@
 class ZabbixApi
   class Applications < Basic
-
-    API_PARAMETERS = %w(applicationids groupids hostids inherited itemids templated templateids selectItems)
-
+    # The method name used for interacting with Applications via Zabbix API
+    #
+    # @return [String]
     def method_name
-      "application"
+      'application'
     end
 
+    # The id field name used for identifying specific Application objects via Zabbix API
+    #
+    # @return [String]
     def indentify
-      "name"
+      'name'
     end
 
+    # Get or Create Application object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name and hostid to properly identify Applications 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}"
 
@@ -20,10 +29,15 @@ class ZabbixApi
       id
     end
 
+    # Create or update Application object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name and hostid to properly identify Applications 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)
       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

@@ -1,36 +1,42 @@
 class ZabbixApi
   class Configurations < Basic
-
+    # @return [Boolean]
     def array_flag
       true
     end
 
+    # The method name used for interacting with Configurations via Zabbix API
+    #
+    # @return [String]
     def method_name
-      "configuration"
+      'configuration'
     end
 
+    # The id field name used for identifying specific Configuration objects via Zabbix API
+    #
+    # @return [String]
     def indentify
-      "host"
+      'host'
     end
 
-    # Export configuration data as a serialized string
-    # * *Args*    :
-    # see available parameters: https://www.zabbix.com/documentation/2.2/manual/api/reference/configuration/export
-    # * *Returns* :
-    #   - String
+    # Export configuration data using Zabbix API
+    #
+    # @param data [Hash]
+    # @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 export(data)
-      @client.api_request(:method => "configuration.export", :params => data)
+      @client.api_request(:method => 'configuration.export', :params => data)
     end
 
-    # Import configurations data from a serialized string
-    # * *Args*    :
-    # see available parameters: https://www.zabbix.com/documentation/2.2/manual/api/reference/configuration/import
-    # * *Returns* :
-    #   - Boolean
+    # Import configuration data using Zabbix API
+    #
+    # @param data [Hash]
+    # @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 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/errors.rb

@@ -1,5 +1,4 @@
 class ZabbixApi
-
   class BaseError < RuntimeError
     attr_accessor :response, :error, :error_message
 
@@ -10,10 +9,10 @@ class ZabbixApi
       set_error! if @response
     end
 
-    private
+  private
 
     def set_error!
-      @error         = @response["error"] rescue nil
+      @error = @response['error'] rescue nil
       @error_message = "#{@error['message']}: #{@error['data']}" rescue nil
     end
   end
@@ -23,5 +22,4 @@ class ZabbixApi
 
   class HttpError < BaseError
   end
-
 end

data/lib/zabbixapi/classes/graphs.rb

@@ -1,14 +1,25 @@
 class ZabbixApi
   class Graphs < Basic
-
+    # The method name used for interacting with Graphs via Zabbix API
+    #
+    # @return [String]
     def method_name
-      "graph"
+      'graph'
     end
 
+    # The id field name used for identifying specific Graph objects via Zabbix API
+    #
+    # @return [String]
     def indentify
-      "name"
+      'name'
     end
 
+    # Get full/extended Graph data from Zabbix API
+    #
+    # @param data [Hash] Should include object's id field name (indentify) 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}"
 
@@ -16,47 +27,87 @@ class ZabbixApi
         :method => "#{method_name}.get",
         :params => {
           :search => {
-            indentify.to_sym => data[indentify.to_sym]
+            indentify.to_sym => data[indentify.to_sym],
           },
-          :output => "extend"
+          :output => 'extend',
         }
       )
     end
 
+    # Get Graph ids for Host from Zabbix API
+    #
+    # @param data [Hash] Should include host value to query for matching graphs
+    # @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 [Array] Returns array of Graph ids
     def get_ids_by_host(data)
       ids = []
-      graphs = Hash.new
-      result = @client.api_request(:method => "graph.get", :params => {:filter => {:host => data[:host]}, :output => "extend"})
+      graphs = {}
+
+      result = @client.api_request(
+        :method => 'graph.get',
+        :params => {
+          :filter => {
+            :host => data[:host],
+          },
+          :output => 'extend',
+        }
+      )
+
       result.each do |graph|
         num  = graph['graphid']
         name = graph['name']
         graphs[name] = num
         filter = data[:filter]
 
-        unless filter.nil?
-          if /#{filter}/ =~ name
-            ids.push(graphs[name])
-          end
-        else
-            ids.push(graphs[name])
+        if filter.nil?
+          ids.push(graphs[name])
+        elsif /#{filter}/ =~ name
+          ids.push(graphs[name])
         end
       end
+
       ids
     end
 
+    # Get Graph Item object using Zabbix API
+    #
+    # @param data [Hash] Needs to include graphids to properly identify Graph Items 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 [Hash]
     def get_items(data)
-      @client.api_request(:method => "graphitem.get", :params => { :graphids => [data], :output => "extend" } )
+      @client.api_request(
+        :method => 'graphitem.get',
+        :params => {
+          :graphids => [data],
+          :output => 'extend',
+        }
+      )
     end
 
+    # Get or Create Graph object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name and templateid to properly identify Graphs 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], :templateid => data[:templateid]))
         id = create(data)
       end
+
       id
     end
 
+    # Create or update Graph object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name and templateid to properly identify Graphs 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)
       graphid = get_id(:name => data[:name], :templateid => data[:templateid])
       graphid ? _update(data.merge(:graphid => graphid)) : create(data)
@@ -66,6 +117,5 @@ class ZabbixApi
       data.delete(:name)
       update(data)
     end
-
   end
 end

data/lib/zabbixapi/classes/hostgroups.rb

@@ -1,16 +1,24 @@
 class ZabbixApi
   class HostGroups < Basic
-
+    # The method name used for interacting with HostGroups via Zabbix API
+    #
+    # @return [String]
     def method_name
-      "hostgroup"
+      'hostgroup'
     end
 
+    # The id field name used for identifying specific HostGroup objects via Zabbix API
+    #
+    # @return [String]
     def indentify
-      "name"
+      'name'
     end
 
+    # The key field name used for HostGroup objects via Zabbix API
+    #
+    # @return [String]
     def key
-      "groupid"
+      'groupid'
     end
   end
 end

data/lib/zabbixapi/classes/hosts.rb

@@ -1,29 +1,43 @@
 class ZabbixApi
   class Hosts < Basic
-
+    # The method name used for interacting with Hosts via Zabbix API
+    #
+    # @return [String]
     def method_name
-      "host"
+      'host'
     end
 
+    # The id field name used for identifying specific Host objects via Zabbix API
+    #
+    # @return [String]
     def indentify
-      "host"
+      'host'
     end
 
+    # Dump Host object data by key from Zabbix API
+    #
+    # @param data [Hash] Should include desired object's key and 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 dump_by_id(data)
       log "[DEBUG] Call dump_by_id with parametrs: #{data.inspect}"
 
       @client.api_request(
-        :method => "host.get",
+        :method => 'host.get',
         :params => {
           :filter => {
-            key.to_sym => data[key.to_sym]
+            key.to_sym => data[key.to_sym],
           },
-          :output => "extend",
-          :selectGroups => "shorten"
+          :output => 'extend',
+          :selectGroups => 'shorten',
         }
       )
     end
 
+    # The default options used when creating Host objects via Zabbix API
+    #
+    # @return [Hash]
     def default_options
       {
         :host => nil,
@@ -31,21 +45,33 @@ class ZabbixApi
         :status => 0,
         :available => 1,
         :groups => [],
-        :proxy_hostid => nil
+        :proxy_hostid => nil,
       }
     end
 
+    # Unlink/Remove Templates from Hosts using Zabbix API
+    #
+    # @param data [Hash] Should include hosts_id array and templates_id array
+    # @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 [Boolean]
     def unlink_templates(data)
       result = @client.api_request(
-        :method => "host.massRemove",
+        :method => 'host.massRemove',
         :params => {
           :hostids => data[:hosts_id],
-          :templates => data[:templates_id]
+          :templates => data[:templates_id],
         }
       )
       result.empty? ? false : true
     end
 
+    # Create or update Host object using Zabbix API
+    #
+    # @param data [Hash] Needs to include host to properly identify Hosts 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)
       hostid = get_id(:host => data[:host])
       hostid ? update(data.merge(:hostid => hostid)) : create(data)

data/lib/zabbixapi/classes/httptests.rb

@@ -1,22 +1,36 @@
 class ZabbixApi
   class HttpTests < Basic
-
+    # The method name used for interacting with HttpTests via Zabbix API
+    #
+    # @return [String]
     def method_name
-      "httptest"
+      'httptest'
     end
 
+    # The id field name used for identifying specific HttpTest objects via Zabbix API
+    #
+    # @return [String]
     def indentify
-      "name"
+      'name'
     end
 
+    # The default options used when creating HttpTest objects via Zabbix API
+    #
+    # @return [Hash]
     def default_options
       {
         :hostid => nil,
         :name => nil,
-        :steps => []
+        :steps => [],
       }
     end
 
+    # Get or Create HttpTest object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name and hostid to properly identify HttpTests 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}"
 
@@ -26,6 +40,12 @@ class ZabbixApi
       id
     end
 
+    # Create or update HttpTest object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name and hostid to properly identify HttpTests 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)
       httptestid = get_id(:name => data[:name], :hostid => data[:hostid])
       httptestid ? update(data.merge(:httptestid => httptestid)) : create(data)