zabbixapi 4.1.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 487cf74b4af955baf4a18b789b90185235a789a1
-  data.tar.gz: d19ee4e5b3bf2e5f514795bc83a69cde75d8c29c
+SHA256:
+  metadata.gz: 95ee423a594e68d486a453c3bf2136fe8d6977236f09a006014655d7ffcc1e1f
+  data.tar.gz: 9bc71cd00aa0e3b01fdbb01bd97d8d01684d033a1720a3f29a78a6a11ca5375f
 SHA512:
-  metadata.gz: bc2f217355f205c40eb991469834a45d84e7f89adf7f28a9b9233e64a085c06300fb13d49bb2c96064681ea3f44f986a84fa1952e86416b05b6547e1fcfd1480
-  data.tar.gz: acc66046eeb21fdccf0404d19c3eedef36bb31fdd49945e8eb3a6f7793e15c0f0d65f2c3128b9591af763b0157f9d0f29b1f06149d853c27798132a5899f9c51
+  metadata.gz: 79f32a38cd75e8dde77ece567476a102a2b764cd9aee0e280a2ee07b3fefe9256e2043be06a4ec2cd42fbaa36f3bc718b5e8332d08e437213ae97dff9b8b08bb
+  data.tar.gz: c81b84714aa19441c9bb0cc173dacc69d2141afa1ff92cf05724a59aa5d86bbce069186d412d1da68989ba14a4cd62b566b1900d6f65f9ea6c65cb0f5bd55e6a

data/README.md

@@ -22,7 +22,7 @@ Simple and lightweight ruby module for working with [Zabbix][Zabbix] via the [Za
 [examples]: https://github.com/express42/zabbixapi/tree/master/examples
 
 ## Version Policy
-We support only two last versions of zabbix (3.4 and 4.0), so you should consider all previous versions deprecated.
+We support only two last versions of zabbix (4.0 and 4.2), so you should consider all previous versions deprecated.
 
 * Zabbix 1.8.2 (api version 1.2) | zabbixapi 0.6.x | [branch zabbix1.8](https://github.com/express42/zabbixapi/tree/zabbix1.8)
 * Zabbix 1.8.9 (api version 1.3) | zabbixapi 0.6.x | [branch zabbix1.8](https://github.com/express42/zabbixapi/tree/zabbix1.8)

data/lib/zabbixapi.rb

@@ -52,7 +52,7 @@ class ZabbixApi
   # @param data [Hash]
   # @return [Hash]
   def query(data)
-    @client.api_request(:method => data[:method], :params => data[:params])
+    @client.api_request(method: data[:method], params: data[:params])
   end
 
   # Invalidate current authentication token

data/lib/zabbixapi/basic/basic_func.rb

@@ -9,14 +9,15 @@ class ZabbixApi
 
     # Compare two hashes for equality
     #
-    # @param a [Hash]
-    # @param b [Hash]
+    # @param first_hash [Hash]
+    # @param second_hash [Hash]
     # @return [Boolean]
-    def hash_equals?(a, b)
-      a_new = normalize_hash(a)
-      b_new = normalize_hash(b)
-      hash1 = a_new.merge(b_new)
-      hash2 = b_new.merge(a_new)
+    def hash_equals?(first_hash, second_hash)
+      normalized_first_hash = normalize_hash(first_hash)
+      normalized_second_hash = normalize_hash(second_hash)
+
+      hash1 = normalized_first_hash.merge(normalized_second_hash)
+      hash2 = normalized_second_hash.merge(normalized_first_hash)
       hash1 == hash2
     end
 
@@ -91,12 +92,12 @@ class ZabbixApi
 
     # Merge two hashes into a single new hash
     #
-    # @param a [Hash]
-    # @param b [Hash]
+    # @param first_hash [Hash]
+    # @param second_hash [Hash]
     # @return [Hash]
-    def merge_params(a, b)
-      new = a.dup
-      new.merge(b)
+    def merge_params(first_hash, second_hash)
+      new = first_hash.dup
+      new.merge(second_hash)
     end
   end
 end

data/lib/zabbixapi/basic/basic_logic.rb

@@ -12,7 +12,7 @@ class ZabbixApi
 
       data_with_default = default_options.empty? ? data : merge_params(default_options, data)
       data_create = [data_with_default]
-      result = @client.api_request(:method => "#{method_name}.create", :params => data_create)
+      result = @client.api_request(method: "#{method_name}.create", params: data_create)
       parse_keys result
     end
 
@@ -27,7 +27,7 @@ class ZabbixApi
       log "[DEBUG] Call delete with parameters: #{data.inspect}"
 
       data_delete = [data]
-      result = @client.api_request(:method => "#{method_name}.delete", :params => data_delete)
+      result = @client.api_request(method: "#{method_name}.delete", params: data_delete)
       parse_keys result
     end
 
@@ -64,7 +64,7 @@ class ZabbixApi
         data[key.to_sym].to_i
       else
         data_update = [data]
-        result = @client.api_request(:method => "#{method_name}.update", :params => data_update)
+        result = @client.api_request(method: "#{method_name}.update", params: data_update)
         parse_keys result
       end
     end
@@ -79,12 +79,12 @@ class ZabbixApi
       log "[DEBUG] Call get_full_data with parameters: #{data.inspect}"
 
       @client.api_request(
-        :method => "#{method_name}.get",
-        :params => {
-          :filter => {
-            indentify.to_sym => data[indentify.to_sym],
+        method: "#{method_name}.get",
+        params: {
+          filter: {
+            indentify.to_sym => data[indentify.to_sym]
           },
-          :output => 'extend',
+          output: 'extend'
         }
       )
     end
@@ -99,8 +99,8 @@ class ZabbixApi
       log "[DEBUG] Call get_raw with parameters: #{data.inspect}"
 
       @client.api_request(
-        :method => "#{method_name}.get",
-        :params => data
+        method: "#{method_name}.get",
+        params: data
       )
     end
 
@@ -114,12 +114,12 @@ class ZabbixApi
       log "[DEBUG] Call dump_by_id with parameters: #{data.inspect}"
 
       @client.api_request(
-        :method => "#{method_name}.get",
-        :params => {
-          :filter => {
-            key.to_sym => data[key.to_sym],
+        method: "#{method_name}.get",
+        params: {
+          filter: {
+            key.to_sym => data[key.to_sym]
           },
-          :output => 'extend',
+          output: 'extend'
         }
       )
     end
@@ -131,7 +131,7 @@ class ZabbixApi
     # @return [Array<Hash>] Array of matching objects
     def all
       result = {}
-      @client.api_request(:method => "#{method_name}.get", :params => {:output => 'extend'}).each do |item|
+      @client.api_request(method: "#{method_name}.get", params: { output: 'extend' }).each do |item|
         result[item[indentify]] = item[key]
       end
       result
@@ -150,11 +150,12 @@ class ZabbixApi
       # raise an error if indentify name was not supplied
       name = data[indentify.to_sym]
       raise ApiError.new("#{indentify} not supplied in call to get_id") if name.nil?
+
       result = @client.api_request(
-        :method => "#{method_name}.get",
-        :params => {
-          :filter => data,
-          :output => [key, indentify],
+        method: "#{method_name}.get",
+        params: {
+          filter: data,
+          output: [key, indentify]
         }
       )
       id = nil

data/lib/zabbixapi/classes/applications.rb

@@ -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

@@ -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/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/graphs.rb

@@ -24,12 +24,12 @@ class ZabbixApi
       log "[DEBUG] Call get_full_data with parametrs: #{data.inspect}"
 
       @client.api_request(
-        :method => "#{method_name}.get",
-        :params => {
-          :search => {
-            indentify.to_sym => data[indentify.to_sym],
+        method: "#{method_name}.get",
+        params: {
+          search: {
+            indentify.to_sym => data[indentify.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/hosts.rb

@@ -24,13 +24,13 @@ class ZabbixApi
       log "[DEBUG] Call dump_by_id with parametrs: #{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

@@ -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

@@ -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: 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: ''
       }
     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

data/lib/zabbixapi/classes/mediatypes.rb

@@ -19,15 +19,15 @@ class ZabbixApi
     # @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

data/lib/zabbixapi/classes/proxies.rb

@@ -21,7 +21,7 @@ class ZabbixApi
     # @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
 
@@ -32,7 +32,7 @@ class ZabbixApi
     # @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)
-      @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
@@ -42,7 +42,7 @@ class ZabbixApi
     # @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)
-      @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

@@ -40,7 +40,7 @@ class ZabbixApi
     # @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
 
@@ -62,29 +62,30 @@ class ZabbixApi
       height = data[:height] || 320 # default 320
       width = data[:width] || 200 # default 200
       vsize = data[:vsize] || [1, (graphids.size / hsize).to_i].max
-      screenid = get_id(:name => screen_name)
+      screenid = get_id(name: screen_name)
 
       unless screenid
         # Create screen
         graphids.each_with_index do |graphid, index|
           screenitems << {
-            :resourcetype => 0,
-            :resourceid => graphid,
-            :x => (index % hsize).to_i,
-            :y => (index % graphids.size / hsize).to_i,
-            :valign => valign,
-            :halign => halign,
-            :rowspan => rowspan,
-            :colspan => colspan,
-            :height => height,
-            :width => width,
+            resourcetype: 0,
+            resourceid: graphid,
+            x: (index % hsize).to_i,
+            y: (index % graphids.size / hsize).to_i,
+            valign: valign,
+            halign: halign,
+            rowspan: rowspan,
+            colspan: colspan,
+            height: height,
+            width: width
           }
         end
+
         screenid = create(
-          :name => screen_name,
-          :hsize => hsize,
-          :vsize => vsize,
-          :screenitems => screenitems
+          name: screen_name,
+          hsize: hsize,
+          vsize: vsize,
+          screenitems: screenitems
         )
       end
       screenid

data/lib/zabbixapi/classes/scripts.rb

@@ -1,27 +1,35 @@
 class ZabbixApi
   class Scripts < Basic
-
     def method_name
-      "script"
+      'script'
     end
 
+    # The id field name used for identifying specific Screen objects via Zabbix API
+    #
+    # @return [String]
     def indentify
-      "name"
+      'name'
     end
 
+    # Submits a request to the zabbix api
+    # data - A Hash containing the scriptid and hostid
+    #
+    # Example:
+    #   execute({ scriptid: '12', hostid: '32 })
+    #
+    # Returns nothing
     def execute(data)
       @client.api_request(
-        :method => "script.execute",
-        :params => {
-          :scriptid => data[:scriptid],
-          :hostid => data[:hostid]
+        method: 'script.execute',
+        params: {
+          scriptid: data[:scriptid],
+          hostid: data[:hostid]
         }
       )
     end
 
     def getscriptsbyhost(data)
-      @client.api_request(:method => "script.getscriptsbyhosts", :params => data)
+      @client.api_request(method: 'script.getscriptsbyhosts', params: data)
     end
-
   end
 end

data/lib/zabbixapi/classes/server.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # @return [String] Zabbix API version number
     def initialize(client)
       @client = client
-      @version = @client.api_request(:method => 'apiinfo.version', :params => {})
+      @api_version = @client.api_request(method: 'apiinfo.version', params: {})
     end
   end
 end

data/lib/zabbixapi/classes/templates.rb

@@ -21,7 +21,7 @@ class ZabbixApi
     # @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
 
@@ -32,11 +32,9 @@ class ZabbixApi
     # @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|
-        result << tmpl['templateid']
+      @client.api_request(method: 'template.get', params: data).map do |tmpl|
+        tmpl['templateid']
       end
-      result
     end
 
     # Get or Create Template object using Zabbix API
@@ -46,7 +44,7 @@ class ZabbixApi
     # @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]))
+      unless (templateid = get_id(host: data[:host]))
         templateid = create(data)
       end
       templateid
@@ -60,10 +58,10 @@ class ZabbixApi
     # @return [Boolean]
     def mass_update(data)
       result = @client.api_request(
-        :method => 'template.massUpdate',
-        :params => {
-          :hosts => data[:hosts_id].map { |t| {:hostid => t} },
-          :templates => data[:templates_id].map { |t| {:templateid => t} },
+        method: 'template.massUpdate',
+        params: {
+          hosts: data[:hosts_id].map { |t| { hostid: t } },
+          templates: data[:templates_id].map { |t| { templateid: t } }
         }
       )
       result.empty? ? false : true
@@ -77,10 +75,10 @@ class ZabbixApi
     # @return [Boolean]
     def mass_add(data)
       result = @client.api_request(
-        :method => 'template.massAdd',
-        :params => {
-          :hosts => data[:hosts_id].map { |t| {:hostid => t} },
-          :templates => data[:templates_id].map { |t| {:templateid => t} },
+        method: 'template.massAdd',
+        params: {
+          hosts: data[:hosts_id].map { |t| { hostid: t } },
+          templates: data[:templates_id].map { |t| { templateid: t } }
         }
       )
       result.empty? ? false : true
@@ -94,12 +92,12 @@ class ZabbixApi
     # @return [Boolean]
     def mass_remove(data)
       result = @client.api_request(
-        :method => 'template.massRemove',
-        :params => {
-          :hostids => data[:hosts_id],
-          :templateids => data[:templates_id],
-          :groupids => data[:group_id],
-          :force => 1,
+        method: 'template.massRemove',
+        params: {
+          hostids: data[:hosts_id],
+          templateids: data[:templates_id],
+          groupids: data[:group_id],
+          force: 1
         }
       )
       result.empty? ? false : true

data/lib/zabbixapi/classes/triggers.rb

@@ -24,14 +24,14 @@ class ZabbixApi
       log "[DEBUG] Call dump_by_id with parametrs: #{data.inspect}"
 
       @client.api_request(
-        :method => 'trigger.get',
-        :params => {
-          :filter => {
-            key.to_sym => data[key.to_sym],
+        method: 'trigger.get',
+        params: {
+          filter: {
+            key.to_sym => data[key.to_sym]
           },
-          :output => 'extend',
-          :select_items => 'extend',
-          :select_functions => 'extend',
+          output: 'extend',
+          select_items: 'extend',
+          select_functions: 'extend'
         }
       )
     end
@@ -68,7 +68,7 @@ class ZabbixApi
       else
         data[:expression] = old_expression
         # disable old trigger
-        log '[DEBUG] disable :' + @client.api_request(:method => "#{method_name}.update", :params => [{:triggerid => data[:triggerid], :status => '1'}]).inspect
+        log '[DEBUG] disable :' + @client.api_request(method: "#{method_name}.update", params: [{ triggerid: data[:triggerid], status: '1' }]).inspect
         # create new trigger
         data.delete(:triggerid)
         create(data)
@@ -84,7 +84,7 @@ class ZabbixApi
     def get_or_create(data)
       log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
 
-      unless (id = get_id(:description => data[:description], :hostid => data[:hostid]))
+      unless (id = get_id(description: data[:description], hostid: data[:hostid]))
         id = create(data)
       end
       id
@@ -97,8 +97,9 @@ 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)
-      triggerid = get_id(:description => data[:description], :hostid => data[:hostid])
-      triggerid ? update(data.merge(:triggerid => triggerid)) : create(data)
+      triggerid = get_id(description: data[:description], hostid: data[:hostid])
+
+      triggerid ? update(data.merge(triggerid: triggerid)) : create(data)
     end
   end
 end

data/lib/zabbixapi/classes/usergroups.rb

@@ -27,13 +27,13 @@ class ZabbixApi
     # @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 (usergroup)
-    def set_perms(data)
+    def permissions(data)
       permission = data[:permission] || 2
       result = @client.api_request(
-        :method => 'usergroup.massAdd',
-        :params => {
-          :usrgrpids => [data[:usrgrpid]],
-          :rights => data[:hostgroupids].map { |t| {:permission => permission, :id => t} },
+        method: 'usergroup.massAdd',
+        params: {
+          usrgrpids: [data[:usrgrpid]],
+          rights: data[:hostgroupids].map { |t| { permission: permission, id: t } }
         }
       )
       result ? result['usrgrpids'][0].to_i : nil
@@ -47,10 +47,10 @@ class ZabbixApi
     # @return [Integer] Zabbix object id (usergroup)
     def add_user(data)
       result = @client.api_request(
-        :method => 'usergroup.massAdd',
-        :params => {
-          :usrgrpids => data[:usrgrpids],
-          :userids => data[:userids],
+        method: 'usergroup.massAdd',
+        params: {
+          usrgrpids: data[:usrgrpids],
+          userids: data[:userids]
         }
       )
       result ? result['usrgrpids'][0].to_i : nil
@@ -64,10 +64,10 @@ class ZabbixApi
     # @return [Integer] Zabbix object id (usergroup)
     def update_users(data)
       result = @client.api_request(
-        :method => 'usergroup.massUpdate',
-        :params => {
-          :usrgrpids => data[:usrgrpids],
-          :userids => data[:userids],
+        method: 'usergroup.massUpdate',
+        params: {
+          usrgrpids: data[:usrgrpids],
+          userids: data[:userids]
         }
       )
       result ? result['usrgrpids'][0].to_i : nil

data/lib/zabbixapi/classes/usermacros.rb

@@ -47,7 +47,7 @@ class ZabbixApi
       data = symbolize_keys(data) if data.key?(indentify)
       # raise an error if indentify name was not supplied
       name = data[indentify.to_sym]
-      raise ApiError.new("#{indentify} not supplied in call to get_id") if name.nil?
+      raise ApiError.new("#{indentify} not supplied in call to get_id_global") if name.nil?
 
       result = request(data, 'usermacro.get', 'globalmacroid')
 
@@ -157,7 +157,7 @@ class ZabbixApi
     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]))
+      unless (id = get_id(macro: data[:macro], hostid: data[:hostid]))
         id = create(data)
       end
       id
@@ -172,7 +172,7 @@ class ZabbixApi
     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]))
+      unless (id = get_id_global(macro: data[:macro], hostid: data[:hostid]))
         id = create_global(data)
       end
       id
@@ -185,8 +185,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)
-      hostmacroid = get_id(:macro => data[:macro], :hostid => data[:hostid])
-      hostmacroid ? update(data.merge(:hostmacroid => hostmacroid)) : create(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
@@ -196,8 +196,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_global(data)
-      hostmacroid = get_id_global(:macro => data[:macro], :hostid => data[:hostid])
-      hostmacroid ? update_global(data.merge(:globalmacroid => globalmacroid)) : create_global(data)
+      globalmacroid = get_id_global(macro: data[:macro], hostid: data[:hostid])
+      globalmacroid ? update_global(data.merge(globalmacroid: globalmacroid)) : create_global(data)
     end
 
   private
@@ -214,12 +214,12 @@ class ZabbixApi
       # 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})
+          @client.api_request(method: method, params: { globalmacro: true, filter: data })
         else
-          @client.api_request(:method => method, :params => {:filter => data})
+          @client.api_request(method: method, params: { filter: data })
         end
       else
-        result = @client.api_request(:method => method, :params => data)
+        result = @client.api_request(method: method, params: data)
 
         result.key?(result_key) && !result[result_key].empty? ? result[result_key][0].to_i : nil
       end

data/lib/zabbixapi/classes/users.rb

@@ -28,6 +28,17 @@ class ZabbixApi
       'alias'
     end
 
+    def medias_helper(data, action)
+      result = @client.api_request(
+        method: "user.#{action}",
+        params: {
+          users: data[:userids].map { |t| { userid: t } },
+          medias: data[:media]
+        }
+      )
+      result ? result['mediaids'][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
@@ -35,14 +46,7 @@ class ZabbixApi
     # @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)
-      result = @client.api_request(
-        :method => 'user.addMedia',
-        :params => {
-          :users => data[:userids].map { |t| {:userid => t} },
-          :medias => data[:media],
-        }
-      )
-      result ? result['mediaids'][0].to_i : nil
+      medias_helper(data, 'addMedia')
     end
 
     # Update media for users using Zabbix API
@@ -52,14 +56,7 @@ class ZabbixApi
     # @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)
-      result = @client.api_request(
-        :method => 'user.updateMedia',
-        :params => {
-          :users => data[:userids].map { |t| {:userid => t} },
-          :medias => data[:media],
-        }
-      )
-      result ? result['userids'][0].to_i : nil
+      medias_helper(data, 'updateMedia')
     end
   end
 end

data/lib/zabbixapi/classes/valuemaps.rb

@@ -30,7 +30,7 @@ class ZabbixApi
     def get_or_create(data)
       log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
 
-      unless (id = get_id(:valuemapids => data[:valuemapids]))
+      unless (id = get_id(valuemapids: data[:valuemapids]))
         id = create(data)
       end
       id
@@ -43,8 +43,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)
-      valuemapid = get_id(:name => data[:name])
-      valuemapid ? update(data.merge(:valuemapids => [:valuemapid])) : create(data)
+      valuemapid = get_id(name: data[:name])
+      valuemapid ? update(data.merge(valuemapids: [:valuemapid])) : create(data)
     end
   end
 end

data/lib/zabbixapi/client.rb

@@ -1,5 +1,6 @@
 require 'net/http'
 require 'json'
+require 'openssl'
 
 class ZabbixApi
   class Client
@@ -16,7 +17,7 @@ class ZabbixApi
     #
     # @return [String]
     def api_version
-      @version ||= api_request(:method => 'apiinfo.version', :params => {})
+      @api_version ||= api_request(method: 'apiinfo.version', params: {})
     end
 
     # Log in to the Zabbix Server and generate an auth token using the API
@@ -24,24 +25,14 @@ class ZabbixApi
     # @return [Hash]
     def auth
       api_request(
-        :method => 'user.login',
-        :params => {
-          :user     => @options[:user],
-          :password => @options[:password],
+        method: 'user.login',
+        params: {
+          user: @options[:user],
+          password: @options[:password]
         }
       )
     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]
@@ -61,9 +52,10 @@ class ZabbixApi
         @proxy_port = @proxy_uri.port
         @proxy_user, @proxy_pass = @proxy_uri.userinfo.split(/:/) if @proxy_uri.userinfo
       end
-      unless api_version =~ /(2\.4|3\.[024]|4\.0)\.\d+/
-        raise ApiError.new("Zabbix API version: #{api_version} is not support by this version of zabbixapi")
+      unless api_version =~ %r{^4.[0|2]\.\d+$}
+        log "[WARN] Zabbix API version: #{api_version} is not supported by this version of zabbixapi"
       end
+
       @auth_hash = auth
     end
 
@@ -73,10 +65,10 @@ class ZabbixApi
     # @return [String]
     def message_json(body)
       message = {
-        :method  => body[:method],
-        :params  => body[:params],
-        :id      => id,
-        :jsonrpc => '2.0',
+        method: body[:method],
+        params: body[:params],
+        id: id,
+        jsonrpc: '2.0'
       }
 
       message[:auth] = @auth_hash unless body[:method] == 'apiinfo.version' || body[:method] == 'user.login'
@@ -93,11 +85,12 @@ class ZabbixApi
       timeout = @options[:timeout].nil? ? 60 : @options[:timeout]
       puts "[DEBUG] Timeout for request set to #{timeout} seconds" if @options[:debug]
 
-      if @proxy_uri
-        http = Net::HTTP.Proxy(@proxy_host, @proxy_port, @proxy_user, @proxy_pass).new(uri.host, uri.port)
-      else
-        http = Net::HTTP.new(uri.host, uri.port)
-      end
+      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
@@ -111,6 +104,7 @@ class ZabbixApi
       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'
@@ -125,6 +119,7 @@ class ZabbixApi
       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
 

data/lib/zabbixapi/version.rb

@@ -1,3 +1,3 @@
 class ZabbixApi
-  VERSION = '4.1.0'.freeze
+  VERSION = '4.1.1'.freeze
 end

data/zabbixapi.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.rubyforge_project = 'zabbixapi'
 
-  spec.files         = ['.yardopts', 'CHANGELOG.md', 'LICENSE.md', 'README.md', 'zabbixapi.gemspec'] + Dir['lib/**/*.rb']
+  spec.files         = ['CHANGELOG.md', 'LICENSE.md', 'README.md', 'zabbixapi.gemspec'] + Dir['lib/**/*.rb']
   spec.require_paths = 'lib'
   spec.required_ruby_version = '>= 2.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zabbixapi
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.1.1
 platform: ruby
 authors:
 - Vasiliev D.V.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-25 00:00:00.000000000 Z
+date: 2019-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -61,7 +61,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".yardopts"
 - CHANGELOG.md
 - LICENSE.md
 - README.md
@@ -115,8 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: zabbixapi
-rubygems_version: 2.4.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Simple and lightweight ruby module for working with the Zabbix API

data/.yardopts

@@ -1,9 +0,0 @@
---no-private
---protected
---tag authentication:"Authentication"
---markup markdown
--
-CHANGELOG.md
-LICENSE.md
-README.md
-examples/*.md