zabbixapi 0.6.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: 635adc2b44f68bdca298f1fa7a72839901528f0e
-  data.tar.gz: f257c9c6f322b313de54fb9b4893ddc37f217488
+  metadata.gz: acfb3f390844a6875bacfda608080b148a3872a2
+  data.tar.gz: 5c6a2e839a324b6de537b9e93d68db825a4e818f
 SHA512:
-  metadata.gz: 4e893b3fc1a1cee7cc81d9e44e2f1af92f4a5f96cf0f3f2a62d3cdb007bae119b7988078dace1818a6d73cf64087ba7b216c52905d838dbf61d5b586b40d3c5f
-  data.tar.gz: 3f1cc8fe7bfa1dc99d779c44d536fde3aa3e84dff2a666266f463c7b1f415e78f53ee75e6bcb0690f9690e5b4303b93e42c8a038b4f515e8d80b23f459e1cc72
+  metadata.gz: d47ef057a22a1268ea94f67c98381bff223037e8ff8f84fc48323c42bd96a5f5248bfd1396497a3ece93920acf25718f1d159fdda1e343b57d20d797a1781f76
+  data.tar.gz: 2af73a1a183dee4576ed0a213993579d454646b77db072deb77c69b06389c10661c9360b4ab3cd266d42abc510d2f67e2778a07600b59246a2e61747f01528f5

data/.travis.yml

@@ -1,9 +1,14 @@
-language: 
+language:
   - ruby
-rvm: 
+rvm:
   - 1.9.3
+  - 2.0.0
+  - 2.1.1
 before_script:
-  - sudo apt-get update; sudo apt-get install mysql-server zabbix-server-mysql zabbix-frontend-php
-  - mysql -u root -e "use zabbix; insert into users_groups(usrgrpid, userid) values(10,1);"
-  - echo "$(curl -fsSL https://gist.github.com/vadv/8f0df0d1824ea25a3827/raw/29b9fdd258d5cfcc89a505c166231359ad70d326/zabbix.php)" | sudo tee /usr/share/zabbix/conf/zabbix.conf.php
-script: "bundle exec rspec spec/run.rb" 
+  - wget -qO - http://obs.express42.com/project_root:/zabbix2.0/precise/Release.key | sudo apt-key add -
+  - echo "deb http://obs.express42.com/project_root:/zabbix2.0/precise/ ./" | sudo tee /etc/apt/sources.list.d/zabbix.list
+  - sudo apt-get update
+  - sudo apt-get install libiodbc2
+  - sudo apt-get install zabbix-server-pgsql zabbix-frontend-php
+  - echo "$(curl -fsSL https://gist.githubusercontent.com/evtuhovich/9544441/raw/d661863063b76cc8e2599bc44d8595b1f86ece38/zabbix)" | sudo tee /etc/zabbix/web/zabbix.conf.php
+script: "ZABBIX_HOST_URL=http://localhost/zabbix/api_jsonrpc.php bundle exec rspec spec/*"

data/README.md

@@ -2,19 +2,31 @@
 
 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)
+[![Build Status](https://travis-ci.org/express42/zabbixapi.png)](https://travis-ci.org/express42/zabbixapi)
 
 #####Now worked with zabbix
-* 1.8.2 (api version 1.2)
-* 1.8.9 (api version 1.3)
-* 2.0.x (api version 1.4 -> 2.0.6) [unstable]
+* 1.8.2 (api version 1.2) /zabbixapi 0.6.x
+* 1.8.9 (api version 1.3) /zabbixapi 0.6.x
+* 2.0.x (api version 1.4 -> 2.0.10) /zabbixapi 2.0.x
+
+## Version policy
+
+Zabbixapi has next version policy:
+* for zabbix 1.8.9 and below you should use zabbixapi 0.6.x
+* for zabbix 2.0.x you should use zabbixapi 2.0.y
+* for zabbix 2.2.x you should use zabbixapi 2.2.y (coming soon)
+
+The PATCH (third digit) version of zabbixapi should not correspond to PATCH version of zabbix, for example
+zabbixapi-2.0.x should works with all version of zabbix 2.0.y
+
+We support only two last versions of zabbix (2.0 and 2.2), so you should consider zabbixapi 0.6.x depricated.
 
 ## Installation
 ```
 gem install zabbixapi
 ```
 
-## Get Start
+## Getting Started
 
 ### Connect
 ```ruby
@@ -30,8 +42,8 @@ zbx = ZabbixApi.connect(
   :url => 'http://localhost/zabbix/api_jsonrpc.php',
   :user => 'Admin',
   :password => 'zabbix',
-  :http_password => 'bla-bla',
-  :http_user => 'bla-bla'
+  :http_password => 'foo',
+  :http_user => 'bar'
 )
 ```
 ### Create Hostgroup
@@ -83,23 +95,7 @@ zbx.items.update(
 puts zbx.items.get_full_data(:description => "item")
 ```
 
-### Create host (1.8)
-```ruby
-zbx.hosts.add(
-  :host => "hostname",
-  :usedns => 1,
-  :groups => [ :groupid => zbx.hostgroups.get_id(:name => "hostgroup") ]
-)
-#or use:
-zbx.hosts.create_or_update(
-  :host => host,
-  :usedns => 0,
-  :ip => "10.20.48.89",
-  :groups => [:groupid => zbx.hostgroups.get_id(:name => hostgroup)]
-)
-```
-
-### Create host (2.0 and later)
+### Create host
 ```ruby
 zbx.hosts.create(
   :host => host.fqdn,
@@ -370,4 +366,4 @@ zbx.query(
 ## Zabbix documentation
 
 * [Zabbix Project Homepage](http://zabbix.com/)
-* [Zabbix Api docs](http://www.zabbix.com/documentation/1.8/api)
+* [Zabbix Api docs](https://www.zabbix.com/documentation/2.0/manual/appendix/api/api)

data/lib/zabbixapi.rb

@@ -1,6 +1,27 @@
 require "zabbixapi/version"
 require "zabbixapi/client"
 
+require "zabbixapi/basic/basic_alias"
+require "zabbixapi/basic/basic_func"
+require "zabbixapi/basic/basic_init"
+require "zabbixapi/basic/basic_logic"
+
+require "zabbixapi/classes/applications"
+require "zabbixapi/classes/errors"
+require "zabbixapi/classes/graphs"
+require "zabbixapi/classes/hostgroups"
+require "zabbixapi/classes/hosts"
+require "zabbixapi/classes/items"
+require "zabbixapi/classes/mediatypes"
+require "zabbixapi/classes/proxies"
+require "zabbixapi/classes/screens"
+require "zabbixapi/classes/server"
+require "zabbixapi/classes/templates"
+require "zabbixapi/classes/triggers"
+require "zabbixapi/classes/unusable"
+require "zabbixapi/classes/usergroups"
+require "zabbixapi/classes/usermacros"
+require "zabbixapi/classes/users"
 
 class ZabbixApi
 
@@ -20,17 +41,9 @@ class ZabbixApi
 
   def initialize(options = {})
     @client = Client.new(options)
-    case @client.api_version
-      when "1.3", "1.2"
-        apidir = "1.8"
-      when "1.4", "2.0.4", "2.0.5", "2.0.6", "2.0.7", "2.0.8", "2.0.9"
-        apidir = "2.0"
-      else
-        apidir = "2.0"
-        puts "[DEBUG] Unknown API version: #{@client.api_version}. Continuing with #{apidir} apidir" if @client.options[:debug]
+    unless @client.api_version == "1.4" || @client.api_version =~ /2\.0\.\d+/
+      raise "Zabbix API version: #{@client.api_version} is not support by this version of zabbixapi"
     end
-    Dir["#{File.dirname(__FILE__)}/zabbixapi/#{apidir}/basic/*.rb"].each { |f| load(f) }
-    Dir["#{File.dirname(__FILE__)}/zabbixapi/#{apidir}/classes/*.rb"].each { |f| load(f) }
   end
 
   def server

data/lib/zabbixapi/{1.8/basic → basic}/basic_func.rb

@@ -46,9 +46,9 @@ class ZabbixApi
       end
     end
 
-    def merge_params(params)
-      result = JSON.generate(default_options).to_s + "," + JSON.generate(params).to_s
-      JSON.parse(result.gsub('},{', ','))
+    def merge_params(a, b)
+      new = a.dup
+      new.merge(b)
     end
 
   end

data/lib/zabbixapi/{2.0/basic → basic}/basic_logic.rb

@@ -4,7 +4,7 @@ class ZabbixApi
     def create(data)
       log "[DEBUG] Call create with parametrs: #{data.inspect}"
 
-      data_with_default = default_options.empty? ? data : merge_params(data)
+      data_with_default = default_options.empty? ? data : merge_params(default_options, data)
       data_create = array_flag ? [data_with_default] : data_with_default
       result = @client.api_request(:method => "#{method_name}.create", :params => data_create)
       parse_keys result
@@ -25,9 +25,9 @@ class ZabbixApi
       id ? update(data.merge(key.to_sym => id.to_s)) : create(data)
     end
 
-    def update(data)     
+    def update(data)
       log "[DEBUG] Call update with parametrs: #{data.inspect}"
-      
+
       dump = {}
       item_id = data[key.to_sym].to_i
       dump_by_id(key.to_sym => data[key.to_sym]).each do |item|

data/lib/zabbixapi/{2.0/classes → classes}/hosts.rb

@@ -40,5 +40,9 @@ class ZabbixApi
       hostid ? update(data.merge(:hostid => hostid)) : create(data)
     end
 
+    # to make delete call idempotent for all resources
+    def delete(hostid)
+      super(:hostid => hostid)
+    end
   end
 end

data/lib/zabbixapi/{2.0/classes → classes}/items.rb

@@ -50,5 +50,13 @@ class ZabbixApi
       }
     end
 
+    def delete(data)
+      log "[DEBUG] Call delete with parametrs: #{data.inspect}"
+
+      data_delete = array_flag ? [data] : [key.to_sym => data]
+      result = @client.api_request(:method => "#{method_name}.delete", :params => data_delete)
+      result['itemids'].keys[0].to_i
+    end
+
   end
 end

data/lib/zabbixapi/{2.0/classes → classes}/screens.rb

@@ -29,25 +29,7 @@ class ZabbixApi
     end
 
     def delete(data)
-      screen_name = data[:screen_name]
-      screen_id   = data[:screen_id]
-
-      unless screen_name.nil?
-        unless screen_name.instance_of?(Array)
-          screen_id = get_id(:name => screen_name)
-        else
-          screen_id = []
-          screen_name.each do |name|
-            screen_id << get_id(:name => name)
-          end
-        end
-      end
-
-      unless screen_id.instance_of?(Array)
-        screen_id = [screen_id, screen_id]
-      end
-
-      result = @client.api_request(:method => "screen.delete", :params => screen_id)
+      result = @client.api_request(:method => "screen.delete", :params => [data])
       result.empty? ? nil : result['screenids'][0].to_i
     end
 

data/lib/zabbixapi/{2.0/classes → classes}/templates.rb

@@ -21,7 +21,7 @@ class ZabbixApi
     # * *Returns* :
     #   - Nil or Integer
     def delete(data)
-      result = @client.api_request(:method => "template.delete", :params => [:templateid => data])
+      result = @client.api_request(:method => "template.delete", :params => [data])
       result.empty? ? nil : result['templateids'][0].to_i
     end
 
@@ -87,14 +87,14 @@ class ZabbixApi
     end
 
     # Analog Zabbix api call massRemove
-    # 
+    #
     # * *Args*    :
     #   - +data+ -> Hash with :hosts_id => [hostid1, hostid2 ...], and :templates_id => [templateid1, templateid2 ...]
     # * *Returns* :
     #   - True or False
     def mass_remove(data)
       result = @client.api_request(
-        :method => "template.massRemove", 
+        :method => "template.massRemove",
         :params => {
           :hostids => data[:hosts_id],
           :templateids => data[:templates_id],
@@ -102,7 +102,7 @@ class ZabbixApi
           :force => 1
         }
       )
-      result.empty? ? false : true      
+      result.empty? ? false : true
     end
 
   end

data/lib/zabbixapi/{2.0/classes → classes}/usergroups.rb

@@ -17,18 +17,6 @@ class ZabbixApi
       "name"
     end
 
-    # Delete UserGroup
-    #
-    # * *Args*    :
-    #   - +data+ -> Array with usrgrpids
-    # * *Returns* :
-    #   - Nil or Integer
-    def delete(data)
-      result = @client.api_request(:method => "usergroup.delete", :params => data)
-      result ? result['usrgrpids'][0].to_i : nil
-    end
-
-
     # Return usrgrpid
     # 
     # * *Args*    :

data/lib/zabbixapi/{2.0/classes → classes}/users.rb

@@ -19,13 +19,13 @@ class ZabbixApi
 
     def add_medias(data)
       result = @client.api_request(
-        :method => "user.addMedia", 
+        :method => "user.addMedia",
         :params => {
           :users => data[:userids].map { |t| {:userid => t} },
           :medias => data[:media]
         }
       )
-      result ? result['userids'][0].to_i : nil
+      result ? result['mediaids'][0].to_i : nil
     end
 
   end

data/lib/zabbixapi/version.rb

@@ -1,3 +1,3 @@
 class ZabbixApi
-  VERSION = "0.6.6"
+  VERSION = "2.0.0"
 end

data/spec/application.rb

@@ -0,0 +1,74 @@
+#encoding: utf-8
+
+require 'spec_helper'
+
+describe 'application' do
+  before :all do
+    @hostgroup = gen_name 'hostgroup'
+    @hostgroupid = zbx.hostgroups.create(:name => @hostgroup)
+    @template = gen_name 'template'
+    @templateid = zbx.templates.create(
+      :host => @template,
+      :groups => [:groupid => @hostgroupid]
+    )
+  end
+
+  context 'when name not exists' do
+    before do
+      @application = gen_name 'application'
+    end
+
+    describe 'create' do
+      it "should return integer id" do
+        applicationid = zbx.applications.create(
+          :name => @application,
+          :hostid => @templateid
+        )
+        applicationid.should be_kind_of(Integer)
+      end
+    end
+
+    describe 'get_id' do
+      it "should return nil" do
+        expect(zbx.applications.get_id(:host => @application)).to be_kind_of(NilClass)
+      end
+    end
+  end
+
+  context 'when name exists' do
+    before :all do
+      @application = gen_name 'application'
+      @applicationid = zbx.applications.create(
+        :name => @application,
+        :hostid => @templateid
+      )
+    end
+
+    describe 'get_or_create' do
+      it "should return id of application" do
+        expect(zbx.applications.get_or_create(
+          :name => @application,
+          :hostid => @templateid
+        )).to eq @applicationid
+      end
+    end
+
+    describe 'get_full_data' do
+      it "should contains created application" do
+        expect(zbx.applications.get_full_data(:name => @application)[0]).to include("name" => @application)
+      end
+    end
+
+    describe 'get_id' do
+      it "should return id of application" do
+        expect(zbx.applications.get_id(:name => @application)).to eq @applicationid
+      end
+    end
+
+    describe "delete" do
+      it "should return id" do
+        zbx.applications.delete(@applicationid).should eq @applicationid
+      end
+    end
+  end
+end

data/spec/basic_func.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe ZabbixApi::Basic do
+end

data/spec/graph.rb

@@ -0,0 +1,135 @@
+#encoding: utf-8
+
+require 'spec_helper'
+
+describe 'graph' do
+  before :all do
+    @hostgroup = gen_name 'hostgroup'
+    @hostgroupid = zbx.hostgroups.create(:name => @hostgroup)
+    @template = gen_name 'template'
+    @templateid = zbx.templates.create(
+      :host => @template,
+      :groups => [:groupid => @hostgroupid]
+    )
+    @application = gen_name 'application'
+    @applicationid = zbx.applications.create(
+      :name => @application,
+      :hostid => @templateid
+    )
+    @item = gen_name 'item'
+    @itemid = zbx.items.create(
+      :name => @item,
+      :key_ => "proc.num[#{gen_name 'proc'}]",
+      :status => 0,
+      :hostid => @templateid,
+      :applications => [@applicationid]
+    )
+
+    @color = "123456"
+  end
+
+  def gitems
+    {
+      :itemid => @itemid,
+      :calc_fnc => "3",
+      :color => @color,
+      :type => "0",
+      :periods_cnt => "5"
+    }
+  end
+
+  def create_graph(graph, itemid)
+    zbx.graphs.create(
+      :gitems => [gitems],
+      :show_triggers => "0",
+      :name => graph,
+      :width => "900",
+      :height => "200"
+    )
+  end
+
+
+  context 'when name not exists' do
+    describe 'create' do
+      it "should return integer id" do
+        @graph = gen_name 'graph'
+        expect(create_graph(@graph, @itemid)).to be_kind_of(Integer)
+      end
+    end
+  end
+
+  context 'when name exists' do
+    before :all do
+      @graph = gen_name 'graph'
+      @graphid = create_graph(@graph, @itemid)
+    end
+
+    describe 'get_or_create' do
+      it "should return id of existing graph" do
+        zbx.graphs.get_or_create(
+          :gitems => [gitems],
+          :show_triggers => "0",
+          :name => @graph,
+          :width => "900",
+          :height => "200"
+        ).should eq @graphid
+      end
+    end
+
+    describe 'get_items' do
+      it "should return array" do
+        expect(zbx.graphs.get_items( @graphid )).to be_kind_of(Array)
+      end
+
+      it "should return array of size 1" do
+        expect(zbx.graphs.get_items( @graphid ).size).to eq 1
+      end
+
+      it "should include correct item" do
+        expect(zbx.graphs.get_items( @graphid )[0]).to include("color" => @color)
+      end
+    end
+
+    describe 'get_id' do
+      it "should return id" do
+        zbx.graphs.get_id( :name => @graph ).should eq @graphid
+      end
+    end
+
+    describe 'get_ids_by_host' do
+      it "should contains id of graph" do
+        graph_array = zbx.graphs.get_ids_by_host( :host => @host )
+        graph_array.should be_kind_of(Array)
+        graph_array.should include(@graphid.to_s)
+      end
+    end
+
+    describe 'update' do
+      it "should return id" do
+        zbx.graphs.update(
+          :graphid => @graphid,
+          :gitems => [gitems],
+          :ymax_type => 1
+        ).should eq @graphid
+      end
+    end
+
+    describe 'create_or_update' do
+      it "should return existing id" do
+        zbx.graphs.create_or_update(
+          :gitems => [gitems],
+          :show_triggers => "1",
+          :name => @graph,
+          :width => "900",
+          :height => "200"
+        ).should eq @graphid
+      end
+    end
+
+    describe 'delete' do
+      it "should return true" do
+        expect(zbx.graphs.delete(@graphid)).to eq @graphid
+      end
+    end
+  end
+end