zabbixapi 2.4.4 → 2.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d196f3e01ddbffa49332172c445ceb140d4f3c52
-  data.tar.gz: 340e897f40f1349a9c0da756e1b25c584061c96a
+  metadata.gz: 25ba28c4faff22b396e0e768792448a75ca4e637
+  data.tar.gz: 788a52dbb357ab631f7a2029a6485c41d0d49ca1
 SHA512:
-  metadata.gz: 7e8650a501039e28ca6e45a8bcf61ce81fd368b1a622c84c95e83240d25fec3d52e890e5d5c1b33f9039f103c374d3e4765bd3a998f0851e0bfe278a6381fe3a
-  data.tar.gz: ab4dc190196e5584faf2c54b8f55b5873608f0484eff14f3a0db159b4339de79d25456330734e2b90c5bb65095528dd327bd4264eb6fdb326d967e20c5786bce
+  metadata.gz: 78dd6e98b5a32bb724259b3e34c29e509cbba0fcb5c9decbdc8a9aeca25adf1f3a3692d661de57ce76c3be2c3d4607624d3addf346c123a911a9a8c4b3b629df
+  data.tar.gz: 0b5ff259f158b439285c080de706336847e52c554e3dd4f4a214fc02ce877b178717c81e99b038fcd64b1bb589698b82698c447f18060af5abf58a45d47f0b1e

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.4.5
+
+[PR #33](https://github.com/express42/zabbixapi/issues/33) Typed exceptions
+
 ## 2.4.4
 
 [Issue #32](https://github.com/express42/zabbixapi/issues/32): Force update of objects in zabbix

data/README.md

@@ -147,6 +147,25 @@ zbx.hosts.update(
 )
 #You can check host:
 puts zbx.hosts.get_full_data(:host => "hostname")
+
+# Zabbixapi checks that new object differ from one in zabbix. But if you
+# want to update nested arguments (like interfaces), you should use second argument. 
+# For example:
+
+zbx.hosts.update({
+  :hostid => zbx.hosts.get_id(:host => "hostname"),
+  :interfaces => [
+    {
+      :type => 1,
+      :main => 1,
+      :ip => '10.0.0.1',
+      :dns => 'server.example.org',
+      :port => 10050,
+      :useip => 0
+    }
+  ]}, true)
+
+
 ```
 
 

data/lib/zabbixapi.rb

@@ -105,5 +105,3 @@ class ZabbixApi
   end
 
 end
-
-

data/lib/zabbixapi/basic/basic_alias.rb

@@ -14,7 +14,6 @@ class ZabbixApi
     end
 
     def method_name
-      
     end
 
   end

data/lib/zabbixapi/basic/basic_init.rb

@@ -6,7 +6,7 @@ class ZabbixApi
     end
 
     def method_name
-      raise "Can't call method_name here"
+      raise ApiError.new("Can't call method_name here")
     end
 
     def default_options
@@ -22,7 +22,7 @@ class ZabbixApi
     end
 
     def indentify
-      raise "Can't call indentify here"
+      raise ApiError.new("Can't call indentify here")
     end
 
   end

data/lib/zabbixapi/classes/errors.rb

@@ -1,6 +1,21 @@
 class ZabbixApi
 
   class BaseError < RuntimeError
+    attr_accessor :response, :error, :error_message
+
+    def initialize(message, response = nil)
+      super(message)
+      @response = response
+
+      set_error! if @response
+    end
+
+    private
+
+    def set_error!
+      @error         = @response["error"] rescue nil
+      @error_message = "#{@error['message']}: #{@error['data']}" rescue nil
+    end
   end
 
   class ApiError < BaseError
@@ -9,7 +24,4 @@ class ZabbixApi
   class HttpError < BaseError
   end
 
-  class SocketError < BaseError
-  end
-
-end
+end

data/lib/zabbixapi/classes/mediatypes.rb

@@ -9,17 +9,17 @@ class ZabbixApi
       "description"
     end
 
-    def default_options 
+    def default_options
       {
         :description => "",  #Name
-        :type => 0,          #0 - Email, 1 - External script, 2 - SMS, 3 - Jabber, 100 - EzTexting
-        :smtp_server => "", 
+        :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
+        :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
 

data/lib/zabbixapi/classes/proxies.rb

@@ -17,7 +17,7 @@ class ZabbixApi
     def isreadable(data)
       result = @client.api_request(:method => "proxy.isreadable", :params => data)
     end
-    
+
     def iswritable(data)
       result = @client.api_request(:method => "proxy.iswritable", :params => data)
     end

data/lib/zabbixapi/classes/templates.rb

@@ -21,8 +21,8 @@ class ZabbixApi
       result.empty? ? nil : result['templateids'][0].to_i
     end
 
-    # Return templateids linked with host 
-    # 
+    # Return templateids linked with host
+    #
     # * *Args*    :
     #   - +data+ -> Hash with :hostids => [hostid]
     # * *Returns* :
@@ -36,7 +36,7 @@ class ZabbixApi
     end
 
     # Return templateid
-    # 
+    #
     # * *Args*    :
     #   - +data+ -> Hash with :host => "Template_Name" and :groups => array with hostgroup ids
     # * *Returns* :
@@ -46,17 +46,17 @@ class ZabbixApi
         templateid = create(data)
       end
       templateid
-    end   
+    end
 
     # Analog Zabbix api call massUpdate
-    # 
+    #
     # * *Args*    :
     #   - +data+ -> Hash with :hosts_id => [hostid1, hostid2 ...], and :templates_id => [templateid1, templateid2 ...]
     # * *Returns* :
     #   - True or False
     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} }
@@ -65,15 +65,15 @@ class ZabbixApi
       result.empty? ? false : true
     end
 
-    # Analog Zabbix api call massAdd 
-    # 
+    # Analog Zabbix api call massAdd
+    #
     # * *Args*    :
     #   - +data+ -> Hash with :hosts_id => [hostid1, hostid2 ...], and :templates_id => [templateid1, templateid2 ...]
     # * *Returns* :
     #   - True or False
     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} }

data/lib/zabbixapi/classes/usergroups.rb

@@ -14,7 +14,7 @@ class ZabbixApi
     end
 
     # Return usrgrpid
-    # 
+    #
     # * *Args*    :
     #   - +data+ -> Hash with :name => "UserGroup"
     # * *Returns* :
@@ -28,15 +28,15 @@ class ZabbixApi
     end
 
     # Set permission for usrgrp on some hostgroup
-    # 
+    #
     # * *Args*    :
     #   - +data+ -> Hash with :usrgrpids => id, :hostgroupids => [], :permission => 2,3 (read and read write)
     # * *Returns* :
     #   - Integer
     def set_perms(data)
-      permission = data[:permission] || 2 
+      permission = data[:permission] || 2
       result = @client.api_request(
-        :method => "usergroup.massAdd", 
+        :method => "usergroup.massAdd",
         :params => {
           :usrgrpids => [data[:usrgrpid]],
           :rights => data[:hostgroupids].map { |t| {:permission => permission, :id => t} }
@@ -46,14 +46,14 @@ class ZabbixApi
     end
 
     # Update usergroup, add user
-    # 
+    #
     # * *Args*    :
     #   - +data+ -> Hash with :usrgrpids => id, :userids => []
     # * *Returns* :
     #   - Integer
     def add_user(data)
       result = @client.api_request(
-        :method => "usergroup.massAdd", 
+        :method => "usergroup.massAdd",
         :params => {
           :usrgrpids => data[:usrgrpids],
           :userids => data[:userids]
@@ -63,14 +63,14 @@ class ZabbixApi
     end
 
     # Update usergroup, modify users
-    # 
+    #
     # * *Args*    :
     #   - +data+ -> Hash with :usrgrpids => id, :userids => []
     # * *Returns* :
     #   - Integer
     def update_users(data)
       result = @client.api_request(
-        :method => "usergroup.massUpdate", 
+        :method => "usergroup.massUpdate",
         :params => {
           :usrgrpids => data[:usrgrpids],
           :userids => data[:userids]

data/lib/zabbixapi/classes/users.rb

@@ -9,7 +9,7 @@ class ZabbixApi
       "userids"
     end
 
-    def key 
+    def key
       "userid"
     end
 

data/lib/zabbixapi/client.rb

@@ -19,8 +19,8 @@ class ZabbixApi
       api_request(
         :method => 'user.login',
         :params => {
-          :user      => @options[:user],
-          :password  => @options[:password],
+          :user     => @options[:user],
+          :password => @options[:password],
         }
       )
     end
@@ -34,7 +34,7 @@ class ZabbixApi
         @proxy_user, @proxy_pass = @proxy_uri.userinfo.split(/:/) if @proxy_uri.userinfo
       end
       unless api_version =~ /2\.4\.\d+/
-        raise "Zabbix API version: #{api_version} is not support by this version of zabbixapi"
+        raise ApiError.new("Zabbix API version: #{api_version} is not support by this version of zabbixapi")
       end
       @auth_hash = auth
     end
@@ -55,7 +55,7 @@ class ZabbixApi
     def http_request(body)
       uri = URI.parse(@options[:url])
       # set the time out the default (60) or to what the user passed
-      @options[:timeout] == nil ? timeout = 60 : timeout = @options[:timeout] 
+      @options[:timeout] == nil ? timeout = 60 : timeout = @options[:timeout]
       puts "[DEBUG] Timeout for request set to #{timeout} seconds" if @options[:debug]
 
       unless @proxy_uri.nil?
@@ -79,7 +79,7 @@ class ZabbixApi
       request.add_field('Content-Type', 'application/json-rpc')
       request.body = body
       response = http.request(request)
-      raise "HTTP Error: #{response.code} on #{@options[:url]}" unless response.code == "200"
+      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
@@ -87,7 +87,7 @@ class ZabbixApi
     def _request(body)
       puts "[DEBUG] Send request: #{body}" if @options[:debug]
       result = JSON.parse(http_request(body))
-      raise "Server answer API error:\n #{JSON.pretty_unparse(result['error'])}\n on request:\n #{JSON.pretty_unparse(JSON.parse(body))}" if result['error']
+      raise ApiError.new("Server answer API error\n #{JSON.pretty_unparse(result['error'])}\n on request:\n #{JSON.pretty_unparse(JSON.parse(body))}", result) if result['error']
       result['result']
     end
 
@@ -97,4 +97,3 @@ class ZabbixApi
 
   end
 end
-

data/lib/zabbixapi/version.rb

@@ -1,3 +1,3 @@
 class ZabbixApi
-  VERSION = "2.4.4"
+  VERSION = "2.4.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zabbixapi
 version: !ruby/object:Gem::Version
-  version: 2.4.4
+  version: 2.4.5
 platform: ruby
 authors:
 - Vasiliev D.V.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-23 00:00:00.000000000 Z
+date: 2015-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json