zabbixapi 0.5.0b2 → 0.5.0b3

data/README.md

@@ -3,6 +3,7 @@
 Simple and lightweight ruby module for work with zabbix api 
 
 [![Build Status](https://travis-ci.org/vadv/zabbixapi.png)](https://travis-ci.org/vadv/zabbixapi)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/vadv/zabbixapi)
 
 #####Now worked with zabbix 
 * 1.8.2 (api version 1.2)
@@ -236,7 +237,7 @@ zbx.usergroups.set_perm(
 ```ruby
 zbx.mediatypes.create_or_update(
   :description => "mediatype",
-  :type => 0,
+  :type => 0, # 0 - Email, 1 - External script, 2 - SMS, 3 - Jabber, 100 - EzTexting, 
   :smtp_server => "127.0.0.1",
   :smtp_email => "zabbix@test.com"
 )
@@ -247,7 +248,7 @@ zbx.users.add_medias(
       :mediatypeid => zbx.mediatypes.get_id(:description => "mediatype"), 
       :sendto => "test@test", 
       :active => 0, 
-      :period => "1-7,00:00-24:00",
+      :period => "1-7,00:00-24:00", # 1-7 days and 00:00-24:00 hours
       :severity => "56"
     }
   ]

data/lib/zabbixapi.rb

@@ -1,5 +1,6 @@
-require "zabbixapi/version"
+require "zabbixapi/basic"
 require "zabbixapi/client"
+require "zabbixapi/version"
 require "zabbixapi/server"
 require "zabbixapi/applications"
 require "zabbixapi/templates"
@@ -16,45 +17,65 @@ require "zabbixapi/mediatypes"
 class ZabbixApi
 
   attr :client
-  attr :server
-  attr :users
-  attr :items
-  attr :applications
-  attr :templates
-  attr :hostgroups
-  attr :hosts
-  attr :triggers
-  attr :graphs
-  attr :screens
-  attr :usergroups
-  attr :mediatypes
 
   def self.connect(options = {})
     new(options)
   end
 
-  def self.current
-    @current ||= ZabbixApi.new
-  end
-
   def query(data)
     @client.api_request(:method => data[:method], :params => data[:params])
   end
 
   def initialize(options = {})
     @client = Client.new(options)
-    @server = Server.new(options)
-    @users   = Users.new(options)
-    @items   = Items.new(options)
-    @hosts   = Hosts.new(options)
-    @applications = Applications.new(options)
-    @templates    = Templates.new(options)
-    @hostgroups   = HostGroups.new(options)
-    @triggers = Triggers.new(options)
-    @graphs = Graphs.new(options)
-    @screens = Screens.new(options)
-    @usergroups = Usergroups.new(options)
-    @mediatypes = Mediatypes.new(options)
+  end
+
+  def server
+    @server ||= Server.new(@client)
+  end
+
+  def users
+    @users ||= Users.new(@client)
+  end
+
+  def items
+    @items ||= Items.new(@client)
+  end
+
+  def hosts
+    @hosts ||= Hosts.new(@client)
+  end
+
+  def applications
+    @applications ||= Applications.new(@client)
+  end
+
+  def templates
+    @templates ||= Templates.new(@client)
+  end
+
+  def hostgroups
+    @hostgroups ||= HostGroups.new(@client)
+  end
+
+  def triggers
+    @triggers ||= Triggers.new(@client)
+  end
+
+  def graphs
+    @graphs ||= Graphs.new(@client)
+  end
+
+  def screens
+    @screens ||= Screens.new(@client)
+  end
+
+  def usergroups
+    @usergroups ||= Usergroups.new(@client)
+  end
+
+  def mediatypes
+    @mediatypes ||= Mediatypes.new(@client)
   end
 
 end

data/lib/zabbixapi/applications.rb

@@ -1,46 +1,25 @@
 class ZabbixApi
-  class Applications
+  class Applications < Basic
 
-    def initialize(options = {})
-      @client = Client.new(options)
-      @options = options
+    def api_method_name
+      "application"
     end
 
-    def create(data)
-      result = @client.api_request(:method => "application.create", :params => [data])
-      result.empty? ? nil : result['applicationids'][0].to_i
+    def api_identify
+      "name"
     end
 
-    def add(data)
-      create(data)
+    def create(data)
+      create_array(data)
     end
 
     def delete(data)
-      result = @client.api_request(:method => "application.delete", :params => [data])
-      result.empty? ? nil : result['applicationids'][0].to_i
-    end
-
-    def get_or_create(data)
-      unless appid = get_id(data)
-        appid = create(data)
-      end
-      appid
-    end
-
-    def destroy(data)
-      delete(data)
+      delete_array(data)
     end
 
     def get_full_data(data)
-      @client.api_request(:method => "application.get", :params => {:filter => data, :output => "extend"})
-    end
-
-    def get_id(data)
-      result = get_full_data(data)
-      applicationid = nil
-      result.each { |app| applicationid = app['applicationid'].to_i if app['name'] == data[:name] }
-      applicationid
+      get_full_data_filter(data)
     end
 
   end
-end
+end

data/lib/zabbixapi/basic.rb

@@ -0,0 +1,109 @@
+class ZabbixApi
+  class Basic
+
+    def initialize(client)
+      @client = client
+    end
+
+####### Synonyms #########
+    def add(data)
+      create(data)
+    end
+
+    def destroy(data)
+      delete(data)
+    end
+
+    def dump(data)
+      get_full_data(data)
+    end
+
+##########################
+
+####### Methods ##########
+    def create_array(data)
+      result = @client.api_request(:method => "#{api_method_name}.create", :params => [data])
+      result.empty? ? nil : result[api_keys][0].to_i
+    end
+
+    def create(data)
+      result = @client.api_request(:method => "#{api_method_name}.create", :params => data)
+      result.empty? ? nil : result[api_keys][0].to_i
+    end
+
+    def delete_array(data)
+      result = @client.api_request(:method => "#{api_method_name}.delete", :params => [data])
+      result.empty? ? nil : result[api_keys][0].to_i
+    end
+
+    def delete_array_sym(data)
+      result = @client.api_request(:method => "#{api_method_name}.delete", :params => [api_key.to_sym => data])
+      result.empty? ? nil : result[api_keys][0].to_i
+    end    
+
+    def delete(data)
+      result = @client.api_request(:method => "#{api_method_name}.delete", :params => data)
+      result.empty? ? nil : result[api_keys][0].to_i
+    end
+
+    def update(data)
+      result = @client.api_request(:method => "#{api_method_name}.update", :params => data)
+      result.empty? ? nil : result[api_keys][0].to_i
+    end
+
+    def get_full_data_filter(data)
+      @client.api_request(:method => "#{api_method_name}.get", :params => {:filter => data, :output => "extend"})
+    end
+
+    def get_full_data_filter_array(data)
+      @client.api_request(:method => "#{api_method_name}.get", :params => {:filter => [data[api_identify.to_sym]], :output => "extend"})
+    end
+
+    def get_id(data)
+      result = get_full_data(data)
+      id = nil
+      result.each { |tmpl| id = tmpl[api_key].to_i if tmpl[api_identify] == data[api_identify.to_sym] }
+      id
+    end
+
+    def get_or_create(data)
+      id = get_id(data)
+      if id.nil?
+        id = create(data)
+      end
+      id
+    end
+
+    def create_or_update(data)
+      id = get_id(api_identify.to_sym => data[api_identify.to_sym], :templateid => data[:templateid])
+      id ? update(data.merge(api_key.to_sym => id)) : create(data)
+    end
+
+    def all
+      result = {}
+      @client.api_request(:method => "#{api_method_name}.get", :params => {:output => "extend"}).each do |tmpl|
+        result[tmpl[api_identify]] = tmpl[api_key]
+      end
+      result      
+    end
+
+##########################
+
+    def api_method_name
+      raise "Can't call here api_method_name"
+    end
+
+    def api_identify
+      raise "Can't call here api_identify"
+    end
+
+    def api_keys
+      api_key + "s"
+    end
+
+    def api_key
+      api_method_name + "id"
+    end
+
+  end
+end

data/lib/zabbixapi/client.rb

@@ -46,10 +46,10 @@ class ZabbixApi
 
     def http_request(body)
       uri = URI.parse(@options[:url])
-      unless @proxy_uri.nil? 
-        http = Net::HTTP.new(uri.host, uri.port)
-      else
+      if @proxy_uri.nil?
         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
       request = Net::HTTP::Post.new(uri.request_uri)
       request.add_field('Content-Type', 'application/json-rpc')

data/lib/zabbixapi/graphs.rb

@@ -1,18 +1,17 @@
 class ZabbixApi
-  class Graphs
+  class Graphs < Basic
 
-    def initialize(options = {})
-      @client = Client.new(options)
-      @options = options
+
+    def api_method_name
+      "graph"
     end
 
-    def create(data)
-      result = @client.api_request(:method => "graph.create", :params => [data])
-      result.empty? ? nil : result['graphids'][0].to_i
+    def api_identify
+      "name"
     end
 
-    def add(data)
-      create(data)
+    def create(data)
+      create_array(data)
     end
 
     def delete(data)
@@ -25,12 +24,8 @@ class ZabbixApi
       end
     end
 
-    def destroy(data)
-      delete(data)
-    end
-
     def get_full_data(data)
-      @client.api_request(:method => "graph.get", :params => {:search => {:name => data}, :output => "extend"})
+      get_full_data_filter()
     end
 
     def get_ids_by_host(data)

data/lib/zabbixapi/hostgroups.rb

@@ -1,62 +1,28 @@
 class ZabbixApi
-  class HostGroups
+  class HostGroups < Basic
 
-    def initialize(options = {})
-      @client = Client.new(options)
-      @options = options
+    def api_method_name
+      "hostgroup"
     end
 
-    def create(data)
-      result = @client.api_request(:method => "hostgroup.create", :params => [data])
-      result.empty? ? nil : result['groupids'][0].to_i
+    def api_identify
+      "name"
     end
 
-    def add(data)
-      create(data)
+    def api_key
+      "groupid"
     end
 
-    def delete(data)
-      result = @client.api_request(:method => "hostgroup.delete", :params => [:groupid => data])
-      result.empty? ? nil : result['groupids'][0].to_i
-    end
-
-    def destroy(data)
-      delete(data)
+    def create(data)
+      create_array(data)
     end
 
-    def get_or_create(data)
-      unless hostgroupid = get_id(data)
-        hostgroupid = update(data)
-      end
-      hostgroupid
+    def delete(data)
+      delete_array_sym(data)
     end
 
     def get_full_data(data)
-      case @client.api_version 
-        when "1.2"
-          @client.api_request(:method => "hostgroup.get", :params => {:filter => data, :output => "extend"})
-        else
-          @client.api_request(:method => "hostgroup.get", :params => {:filter => data, :output => "extend"})
-      end
-    end
-
-    # Return all hostgroups
-    # 
-    # * *Returns* :
-    #   - Hash with {"Hostgroup1" => "id1", "Hostgroup2" => "id2"}
-    def all
-      result = {}
-      @client.api_request(:method => "hostgroup.get", :params => {:output => "extend"}).each do |hostgrp|
-        result[hostgrp['name']] = hostgrp['groupid']
-      end
-      result
-    end
-
-    def get_id(data)
-      result = get_full_data(data)
-      hostgroupid = nil
-      result.each { |hgroup| hostgroupid = hgroup['groupid'].to_i if hgroup['name'] == data[:name] }
-      hostgroupid
+      get_full_data_filter(data)
     end
 
   end

data/lib/zabbixapi/hosts.rb

@@ -1,9 +1,16 @@
 class ZabbixApi
-  class Hosts
+  class Hosts < Basic
 
-    def initialize(options = {})
-      @client = Client.new(options)
-      @options = options
+    def api_method_name
+      "host"
+    end
+
+    def api_identify
+      "host"
+    end
+
+    def initialize(client)
+      @client = client
       @host_default_options = {
         :host => nil,
         :port => 10050,
@@ -33,10 +40,6 @@ class ZabbixApi
       result.empty? ? nil : result['hostids'][0].to_i
     end
 
-    def add(data)
-      create(data)
-    end
-
     def unlink_templates(data)
       result = @client.api_request(
         :method => "host.massRemove", 
@@ -54,33 +57,12 @@ class ZabbixApi
     end
 
     def delete(data)
-      result = @client.api_request(:method => "host.delete", :params => [:hostid => data])
-      result.empty? ? nil : result['hostids'][0].to_i
+      delete_array_sym(data)
     end
 
-    def destroy(data)
-      delete(data)
-    end
-
-    def update(data)
-      result = @client.api_request(:method => "host.update", :params => data)
-      result.empty? ? nil : result['hostids'][0].to_i
-    end
 
     def get_full_data(data)
-      @client.api_request(:method => "host.get", :params => {:filter => data, :output => "extend"})
-    end
-
-    def create_or_update(data)
-      hostid = get_id(:host => data[:host])
-      hostid ? update(data.merge(:hostid => hostid)) : create(data)
-    end
-
-    def get_id(data)
-      result = get_full_data(data)
-      hostid = nil
-      result.each { |host| hostid = host['hostid'].to_i if host['host'] == data[:host] }
-      hostid
+      get_full_data_filter(data)
     end
 
   end