zabbixapi 3.1.0 → 3.2.1

data/lib/zabbixapi/classes/items.rb

@@ -1,14 +1,22 @@
 class ZabbixApi
   class Items < Basic
-
+    # The method name used for interacting with Items via Zabbix API
+    #
+    # @return [String]
     def method_name
-      "item"
+      'item'
     end
 
+    # The id field name used for identifying specific Item objects via Zabbix API
+    #
+    # @return [String]
     def indentify
-      "name"
+      'name'
     end
 
+    # The default options used when creating Item objects via Zabbix API
+    #
+    # @return [Hash]
     def default_options
       {
         :name => nil,
@@ -42,10 +50,16 @@ class ZabbixApi
         :publickey => '',
         :privatekey => '',
         :params => '',
-        :ipmi_sensor => ''
+        :ipmi_sensor => '',
       }
     end
 
+    # Get or Create Item object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name and hostid to properly identify 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 [Integer] Zabbix object id
     def get_or_create(data)
       log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
 
@@ -55,10 +69,15 @@ class ZabbixApi
       id
     end
 
+    # Create or update Item object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name and hostid to properly identify 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 [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)
     end
-
   end
 end

data/lib/zabbixapi/classes/maintenance.rb

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

data/lib/zabbixapi/classes/mediatypes.rb

@@ -1,27 +1,34 @@
 class ZabbixApi
   class Mediatypes < Basic
-
+    # The method name used for interacting with MediaTypes via Zabbix API
+    #
+    # @return [String]
     def method_name
-      "mediatype"
+      'mediatype'
     end
 
+    # The id field name used for identifying specific MediaType objects via Zabbix API
+    #
+    # @return [String]
     def indentify
-      "description"
+      'description'
     end
 
+    # The default options used when creating MediaType objects via Zabbix API
+    #
+    # @return [Hash]
     def default_options
       {
-        :description => "",  #Name
-        :type        => 0,   #0 - Email, 1 - External script, 2 - SMS, 3 - Jabber, 100 - EzTexting
-        :smtp_server => "",
-        :smtp_helo   => "",
-        :smtp_email  => "",  #Email address of Zabbix server
-        :exec_path   => "",  #Name of external script
-        :gsm_modem   => "",  #Serial device name of GSM modem
-        :username    => "",  #Jabber user name used by Zabbix server
-        :passwd      => ""   #Jabber password used by Zabbix server
+        :description => '',  # Name
+        :type        => 0,   # 0 - Email, 1 - External script, 2 - SMS, 3 - Jabber, 100 - EzTexting
+        :smtp_server => '',
+        :smtp_helo   => '',
+        :smtp_email  => '',  # Email address of Zabbix server
+        :exec_path   => '',  # Name of external script
+        :gsm_modem   => '',  # Serial device name of GSM modem
+        :username    => '',  # Jabber user name used by Zabbix server
+        :passwd      => ''   # Jabber password used by Zabbix server
       }
     end
-
   end
 end

data/lib/zabbixapi/classes/proxies.rb

@@ -1,27 +1,48 @@
 class ZabbixApi
   class Proxies < Basic
-
+    # The method name used for interacting with Proxies via Zabbix API
+    #
+    # @return [String]
     def method_name
-      "proxy"
+      'proxy'
     end
 
+    # The id field name used for identifying specific Proxy objects via Zabbix API
+    #
+    # @return [String]
     def indentify
-      "host"
+      'host'
     end
 
+    # Delete Proxy object using Zabbix API
+    #
+    # @param data [Array] Should include array of proxyid's
+    # @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 Proxy object id that was deleted
     def delete(data)
-      result = @client.api_request(:method => "proxy.delete", :params => data)
+      result = @client.api_request(:method => 'proxy.delete', :params => data)
       result.empty? ? nil : result['proxyids'][0].to_i
     end
 
+    # Check if a Proxy object is readable using Zabbix API
+    #
+    # @param data [Array] Should include array of proxyid's
+    # @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] Returns true if the given proxies are readable
     def isreadable(data)
-      result = @client.api_request(:method => "proxy.isreadable", :params => data)
+      @client.api_request(:method => 'proxy.isreadable', :params => data)
     end
 
+    # Check if a Proxy object is writable using Zabbix API
+    #
+    # @param data [Array] Should include array of proxyid's
+    # @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] Returns true if the given proxies are writable
     def iswritable(data)
-      result = @client.api_request(:method => "proxy.iswritable", :params => data)
+      @client.api_request(:method => 'proxy.iswritable', :params => data)
     end
-
   end
 end
-

data/lib/zabbixapi/classes/screens.rb

@@ -1,38 +1,55 @@
 class ZabbixApi
   class Screens < Basic
-
     # extracted from frontends/php/include/defines.inc.php
-    #SCREEN_RESOURCE_GRAPH => 0,
-    #SCREEN_RESOURCE_SIMPLE_GRAPH => 1,
-    #SCREEN_RESOURCE_MAP => 2,
-    #SCREEN_RESOURCE_PLAIN_TEXT => 3,
-    #SCREEN_RESOURCE_HOSTS_INFO => 4,
-    #SCREEN_RESOURCE_TRIGGERS_INFO => 5,
-    #SCREEN_RESOURCE_SERVER_INFO => 6,
-    #SCREEN_RESOURCE_CLOCK => 7,
-    #SCREEN_RESOURCE_SCREEN => 8,
-    #SCREEN_RESOURCE_TRIGGERS_OVERVIEW => 9,
-    #SCREEN_RESOURCE_DATA_OVERVIEW => 10,
-    #SCREEN_RESOURCE_URL => 11,
-    #SCREEN_RESOURCE_ACTIONS => 12,
-    #SCREEN_RESOURCE_EVENTS => 13,
-    #SCREEN_RESOURCE_HOSTGROUP_TRIGGERS => 14,
-    #SCREEN_RESOURCE_SYSTEM_STATUS => 15,
-    #SCREEN_RESOURCE_HOST_TRIGGERS => 16
+    # SCREEN_RESOURCE_GRAPH => 0,
+    # SCREEN_RESOURCE_SIMPLE_GRAPH => 1,
+    # SCREEN_RESOURCE_MAP => 2,
+    # SCREEN_RESOURCE_PLAIN_TEXT => 3,
+    # SCREEN_RESOURCE_HOSTS_INFO => 4,
+    # SCREEN_RESOURCE_TRIGGERS_INFO => 5,
+    # SCREEN_RESOURCE_SERVER_INFO => 6,
+    # SCREEN_RESOURCE_CLOCK => 7,
+    # SCREEN_RESOURCE_SCREEN => 8,
+    # SCREEN_RESOURCE_TRIGGERS_OVERVIEW => 9,
+    # SCREEN_RESOURCE_DATA_OVERVIEW => 10,
+    # SCREEN_RESOURCE_URL => 11,
+    # SCREEN_RESOURCE_ACTIONS => 12,
+    # SCREEN_RESOURCE_EVENTS => 13,
+    # SCREEN_RESOURCE_HOSTGROUP_TRIGGERS => 14,
+    # SCREEN_RESOURCE_SYSTEM_STATUS => 15,
+    # SCREEN_RESOURCE_HOST_TRIGGERS => 16
 
+    # The method name used for interacting with Screens via Zabbix API
+    #
+    # @return [String]
     def method_name
-      "screen"
+      'screen'
     end
 
+    # The id field name used for identifying specific Screen objects via Zabbix API
+    #
+    # @return [String]
     def indentify
-      "name"
+      'name'
     end
 
+    # Delete Screen object using Zabbix API
+    #
+    # @param data [String, Array] Should include id's of the screens 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] Zabbix object id
     def delete(data)
-      result = @client.api_request(:method => "screen.delete", :params => [data])
+      result = @client.api_request(:method => 'screen.delete', :params => [data])
       result.empty? ? nil : result['screenids'][0].to_i
     end
 
+    # Get or Create Screen object for Host using Zabbix API
+    #
+    # @param data [Hash] Needs to include screen_name and graphids to properly identify Screens 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_for_host(data)
       screen_name = data[:screen_name]
       graphids = data[:graphids]
@@ -44,7 +61,7 @@ class ZabbixApi
       colspan = data[:colspan] || 1
       height = data[:height] || 320 # default 320
       width = data[:width] || 200 # default 200
-      vsize = data[:vsize] || [1, (graphids.size/hsize).to_i].max
+      vsize = data[:vsize] || [1, (graphids.size / hsize).to_i].max
       screenid = get_id(:name => screen_name)
 
       unless screenid
@@ -54,13 +71,13 @@ class ZabbixApi
             :resourcetype => 0,
             :resourceid => graphid,
             :x => (index % hsize).to_i,
-            :y => (index % graphids.size/hsize).to_i,
+            :y => (index % graphids.size / hsize).to_i,
             :valign => valign,
             :halign => halign,
             :rowspan => rowspan,
             :colspan => colspan,
             :height => height,
-            :width => width
+            :width => width,
           }
         end
         screenid = create(
@@ -72,6 +89,5 @@ class ZabbixApi
       end
       screenid
     end
-
   end
 end

data/lib/zabbixapi/classes/server.rb

@@ -1,12 +1,16 @@
 class ZabbixApi
   class Server
+    # @return [String]
+    attr_reader :version
 
-    attr :version
-
+    # Initializes a new Server object with ZabbixApi Client and fetches Zabbix Server API version
+    #
+    # @param client [ZabbixApi::Client]
+    # @return [ZabbixApi::Client]
+    # @return [String] Zabbix API version number
     def initialize(client)
       @client = client
-      @version = @client.api_request(:method => "apiinfo.version", :params => {})
+      @version = @client.api_request(:method => 'apiinfo.version', :params => {})
     end
-
   end
 end

data/lib/zabbixapi/classes/templates.rb

@@ -1,46 +1,50 @@
 class ZabbixApi
   class Templates < Basic
-
+    # The method name used for interacting with Templates via Zabbix API
+    #
+    # @return [String]
     def method_name
-      "template"
+      'template'
     end
 
+    # The id field name used for identifying specific Template objects via Zabbix API
+    #
+    # @return [String]
     def indentify
-      "host"
+      'host'
     end
 
-
-    # Delete template
+    # Delete Template object using Zabbix API
     #
-    # * *Args*    :
-    #   - +data+ -> Hash with :host => "Template_Name"
-    # * *Returns* :
-    #   - Nil or Integer
+    # @param data [Array] Should include array of templateid's
+    # @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 Template object id that was deleted
     def delete(data)
-      result = @client.api_request(:method => "template.delete", :params => [data])
+      result = @client.api_request(:method => 'template.delete', :params => [data])
       result.empty? ? nil : result['templateids'][0].to_i
     end
 
-    # Return templateids linked with host
+    # Get Template ids for Host from Zabbix API
     #
-    # * *Args*    :
-    #   - +data+ -> Hash with :hostids => [hostid]
-    # * *Returns* :
-    #   - Array with templateids
+    # @param data [Hash] Should include host value to query for matching templates
+    # @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 Template ids
     def get_ids_by_host(data)
       result = []
-      @client.api_request(:method => "template.get", :params => data).each do |tmpl|
+      @client.api_request(:method => 'template.get', :params => data).each do |tmpl|
         result << tmpl['templateid']
       end
       result
     end
 
-    # Return templateid
+    # Get or Create Template object using Zabbix API
     #
-    # * *Args*    :
-    #   - +data+ -> Hash with :host => "Template_Name" and :groups => array with hostgroup ids
-    # * *Returns* :
-    #   - Integer
+    # @param data [Hash] Needs to include host to properly identify Templates 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)
       unless (templateid = get_id(:host => data[:host]))
         templateid = create(data)
@@ -48,58 +52,57 @@ class ZabbixApi
       templateid
     end
 
-    # Analog Zabbix api call massUpdate
+    # Mass update Templates for Hosts using Zabbix API
     #
-    # * *Args*    :
-    #   - +data+ -> Hash with :hosts_id => [hostid1, hostid2 ...], and :templates_id => [templateid1, templateid2 ...]
-    # * *Returns* :
-    #   - True or False
+    # @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 mass_update(data)
       result = @client.api_request(
-        :method => "template.massUpdate",
+        :method => 'template.massUpdate',
         :params => {
           :hosts => data[:hosts_id].map { |t| {:hostid => t} },
-          :templates => data[:templates_id].map { |t| {:templateid => t} }
+          :templates => data[:templates_id].map { |t| {:templateid => t} },
         }
       )
       result.empty? ? false : true
     end
 
-    # Analog Zabbix api call massAdd
+    # Mass add Templates to Hosts using Zabbix API
     #
-    # * *Args*    :
-    #   - +data+ -> Hash with :hosts_id => [hostid1, hostid2 ...], and :templates_id => [templateid1, templateid2 ...]
-    # * *Returns* :
-    #   - True or False
+    # @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 mass_add(data)
       result = @client.api_request(
-        :method => "template.massAdd",
+        :method => 'template.massAdd',
         :params => {
           :hosts => data[:hosts_id].map { |t| {:hostid => t} },
-          :templates => data[:templates_id].map { |t| {:templateid => t} }
+          :templates => data[:templates_id].map { |t| {:templateid => t} },
         }
       )
       result.empty? ? false : true
     end
 
-    # Analog Zabbix api call massRemove
+    # Mass remove Templates to Hosts using Zabbix API
     #
-    # * *Args*    :
-    #   - +data+ -> Hash with :hosts_id => [hostid1, hostid2 ...], and :templates_id => [templateid1, templateid2 ...]
-    # * *Returns* :
-    #   - True or False
+    # @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 mass_remove(data)
       result = @client.api_request(
-        :method => "template.massRemove",
+        :method => 'template.massRemove',
         :params => {
           :hostids => data[:hosts_id],
           :templateids => data[:templates_id],
           :groupids => data[:group_id],
-          :force => 1
+          :force => 1,
         }
       )
       result.empty? ? false : true
     end
-
   end
 end