zabbixapi 0.1.6.4 → 0.1.7

data/lib/zabbixapi/base.rb

@@ -23,7 +23,7 @@ module Zabbix
 
   class ZabbixApi
 
-    attr_accessor :debug
+    attr_accessor :debug, :basic_auth
 
     def initialize (api_url, api_user, api_password)
       @api_url = api_url
@@ -31,6 +31,7 @@ module Zabbix
       @api_password = api_password
 
       @debug = false # Disable debug by default
+      @basic_auth = false #Disable basic_auth by default
     end
 
     def do_request(message)
@@ -54,6 +55,10 @@ module Zabbix
       request.add_field('Content-Type', 'application/json-rpc')
       request.body=(message_json)
 
+      if @basic_auth
+        request.basic_auth @api_user, @api_password
+      end
+
       begin
         puts "[ZBXAPI] : #{Time.now()} : INFO : Do request. Body => #{request.body}" if @debug
         response = http.request(request)

data/lib/zabbixapi/host.rb

@@ -8,8 +8,8 @@ module Zabbix
           'method' => 'host.update',
           'params' => host
       }
-      responce = send_request(message)
-      responce.empty? ?  nil :  response['hostids'][0].to_i 
+      response = send_request(message)
+      response.empty? ?  nil :  response['hostids'][0].to_i 
     end
 
     def add_host(host_options)
@@ -50,7 +50,7 @@ module Zabbix
           }
       }
       response = send_request(message)
-      response.empty? ?  nil : response[0]['hostid'].to_i
+      response.empty? ? nil : response[0]['hostid'].to_i
     end
 
     def delete_host(hostname)

data/lib/zabbixapi/maintenance.rb

@@ -0,0 +1,78 @@
+module Zabbix
+  class ZabbixApi
+
+    def create_maintenance(host_id, maintenance_options)
+    	
+    	time_now = Time.now.to_i 
+    	
+      maintenance_default = {
+        'hostids'						=> [host_id],
+        'groupids'					=> [],
+		    'name'							=> '',
+		    'maintenance_type'	=> '0', # 0 = with data collection, 1 = without
+		    'description'				=> '',
+		    'active_since'			=> '',
+		    'active_till'				=> ''
+      }
+      message = {
+        'method' => 'maintenance.create',
+        'params' => merge_opt(maintenance_default, maintenance_options)
+      }
+      response = send_request(message)
+      response.empty? ?  nil : response['maintenanceids'][0].to_i 
+    end
+
+    def get_maintenance_id(host_id)
+      message = {
+          'method' => 'maintenance.get',
+          'params' => {
+              'hostids' => [host_id]
+          }
+      }
+      response = send_request(message)
+      response.empty? ? nil : response[0]['maintenanceid'].to_i
+    end
+    
+    def maintenance_exists?(maintenance_id)
+    	# seems like .nodeids and .maintenance are ignored
+    	# mmethner: .maintenanceid is the only settings which not always returns true
+      message = {
+        'method' => 'maintenance.exists',
+        'params' => {
+	        'nodeids'				=> [],
+	        'maintenance'		=> '',
+			    'maintenanceid'	=> maintenance_id,
+	      }
+      }
+      response = send_request(message)
+      response
+    end
+
+    def update_maintenance(maintenance_id, maintenance_options)
+      
+      maintenance_options["maintenanceid"] = maintenance_id
+      message = {
+        'method' => 'maintenance.update',
+        'params' => maintenance_options
+      }
+      response = send_request(message)
+      
+      # the zabbix api returns boolean
+      # even the official zabbix api documentation specifies an array
+      response
+    end
+    
+    def delete_maintenance(maintenance_id)
+      message = {
+        'method' => 'maintenance.delete',
+        'params' => [maintenance_id]
+      }
+      response = send_request(message)
+      
+      # the zabbix api returns boolean
+      # even the official zabbix api documentation specifies an array
+      response
+    end
+    
+  end
+end

data/spec/localhost.rb

@@ -10,7 +10,7 @@ api_password = 'zabbix'
 zbx = Zabbix::ZabbixApi.new(api_url, api_login, api_password)
 #zbx.debug = true
 
-describe Zabbix::ZabbixApi, "create_group" do
+describe Zabbix::ZabbixApi, "test_api" do
 
   # 01. Create group
   it "Create some group" do
@@ -104,3 +104,9 @@ describe Zabbix::ZabbixApi, "create_group" do
   end
 
 end
+
+describe Zabbix::ZabbixApi, "test_examples" do
+  it "Test all examples" do
+    system("examples/populate_new_zabbix.sh development")
+  end
+end

data/zabbixapi.gemspec

@@ -4,12 +4,12 @@ require 'rake'
 
 Gem::Specification.new do |spec|
 
-  spec.version = '0.1.6.4'
+  spec.version = '0.1.7'
   spec.name = 'zabbixapi'
   spec.summary = 'Ruby module for work with zabbix api.'
 
   spec.email = 'vadv.mkn@gmail.com'
-  spec.author = 'Eduard Snesarev and Dmitry Vasiliev'
+  spec.author = 'Eduard Snesarev and Dmitry Vasiliev, mathiasmethner@googlemail.com'
   spec.homepage = 'https://github.com/vadv/zabbixapi/wiki'
   spec.description = 'Ruby module for work with zabbix api v1.8.'
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: zabbixapi
 version: !ruby/object:Gem::Version
-  version: 0.1.6.4
+  version: 0.1.7
   prerelease: 
 platform: ruby
 authors:
-- Eduard Snesarev and Dmitry Vasiliev
+- Eduard Snesarev and Dmitry Vasiliev, mathiasmethner@googlemail.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-15 00:00:00.000000000 Z
+date: 2012-11-02 00:00:00.000000000 Z
 dependencies: []
 description: Ruby module for work with zabbix api v1.8.
 email: vadv.mkn@gmail.com
@@ -25,6 +25,7 @@ files:
 - lib/zabbixapi/group.rb
 - lib/zabbixapi/host.rb
 - lib/zabbixapi/item.rb
+- lib/zabbixapi/maintenance.rb
 - lib/zabbixapi/mediatype.rb
 - lib/zabbixapi/screen.rb
 - lib/zabbixapi/template.rb
@@ -32,16 +33,40 @@ files:
 - lib/zabbixapi/user.rb
 - lib/zabbixapi/usermacro.rb
 - spec/localhost.rb
-- spec/request.rb
 - zabbixapi.gemspec
 - README.rdoc
+- examples/basic_auth.rb
 - examples/config.yml
+- examples/maintenance-example.rb
+- examples/populate_new_zabbix.sh
 - examples/zabbix_availability
+- examples/zabbix_clear_default
+- examples/zabbix_cpufan-sersor
+- examples/zabbix_cputemp-sersor
 - examples/zabbix_disk_io
 - examples/zabbix_filesystem
+- examples/zabbix_group
+- examples/zabbix_hlsp
+- examples/zabbix_host
+- examples/zabbix_iops
+- examples/zabbix_ipmi-cpufan-sersor
+- examples/zabbix_ipmi_systemp
 - examples/zabbix_la
+- examples/zabbix_mailer
+- examples/zabbix_mdadm
+- examples/zabbix_megaraid
 - examples/zabbix_memory
+- examples/zabbix_named
 - examples/zabbix_net
+- examples/zabbix_nginx
+- examples/zabbix_nginx_500
+- examples/zabbix_ntp
+- examples/zabbix_nv-gputemp
+- examples/zabbix_pgsql
+- examples/zabbix_server_process
+- examples/zabbix_smart_blade
+- examples/zabbix_ssh
+- examples/zabbix_varnish
 homepage: https://github.com/vadv/zabbixapi/wiki
 licenses: []
 post_install_message: 
@@ -67,3 +92,4 @@ signing_key:
 specification_version: 3
 summary: Ruby module for work with zabbix api.
 test_files: []
+has_rdoc: true

data/spec/request.rb

@@ -1,130 +0,0 @@
-require 'zabbixapi'
-require 'json'
-require 'servers/server18'
-
-# settings
-api_url = 'http://somehost'
-api_login = ''
-api_password = ''
-
-
-zbx = Zabbix::ZabbixApi.new(api_url, api_login, api_password)
-#zbx.debug = true
-
-describe Zabbix::ZabbixApi do
-
-  before :each do
-    # stub auth tocken
-    Zabbix::ZabbixApi.any_instance.stub(:auth).and_return "a9a1f569d10d6339f23c4d122a7f5c46" 
-    # stub resquest
-    @request = mock
-    Net::HTTP.any_instance.stub(:request).and_return @request
-    @request.stub(:code).and_return "200"
-  end
-
-  # 01. Create group
-  it "Create some group" do
-    @request.stub(:body).and_return Server18.hostgroup_create
-    result = zbx.add_group('some_group')
-    result.should equal(107819)
-  end
-
-  # 02. Get group_id
-  it "Get group_id" do
-    @request.stub(:body).and_return Server18.hostgroup_get
-    result = zbx.get_group_id('some_group')
-    result.should equal(100100000000002)
-  end
-
-  # 03. Get unknown group_id
-  it "Get unknown group" do
-    @request.stub(:body).and_return Server18.hostgroup_get_error
-    result = zbx.get_group_id('___some_group')
-    result.should be_nil
-  end
-
-  # 04. Create host
-  host_options = { 
-    "ip"     => '127.0.0.1',
-    "dns"    => 'my.example.com',
-    "host"   => 'my.example.com',
-    "useip"  => 1,
-    "groups" => [1]
-  }
-  it "Create host" do
-    @request.stub(:body).and_return Server18.host_create
-    result = zbx.add_host(host_options)
-    result.should equal(107819)
-  end
-
-  # 05. Get host
-  it "Get host by name" do
-    @request.stub(:body).and_return Server18.host_get
-    result = zbx.get_host_id('my.example.com')
-    result.should equal(100100000010017)
-  end
-
-  # 06. Get unknown host
-  it "Get unknown host by name" do
-    @request.stub(:body).and_return Server18.host_get_error
-    result = zbx.get_host_id('___my.example.com')
-    result.should be_nil
-  end
-
-  # 07. Delete host
-  it "Delete host" do
-    @request.stub(:body).and_return Server18.host_delete
-    result = zbx.delete_host('my.example.com')
-    result.should be_kind_of(Integer)
-  end
-
-  # 08. Delete unknown host
-  it "Delete unknown host" do
-    @request.stub(:body).and_return Server18.host_delete_error
-    result = zbx.delete_host('__my.example.com')
-    result.should be_nil
-  end
-
-  # 09. Delete group
-  it "Delete some group" do
-    @request.stub(:body).and_return Server18.hostgroup_delete
-    result = zbx.delete_group('some_group')
-    result.should be_kind_of(Integer)
-  end
-
-  # 10. Delete unknown group
-  it "Delete unknown group" do
-    @request.stub(:body).and_return Server18.hostgroup_delete_error
-    result = zbx.delete_group('___some_group')
-    result.should be_nil
-  end
-
-  # 11. Mediatype create
-  mediatype_options = { 
-    'type' => '0', #email
-    'description' => 'example_mediatype',
-    'smtp_server' => 'test.company.com',
-    'smtp_helo'   => 'test.company.com',
-    'smtp_email'  => 'test@test.company.com',
-  }
-  it "Create mediatype" do
-    @request.stub(:body).and_return Server18.mediatype_create
-    result = zbx.add_mediatype(mediatype_options)
-    result.should equal(100100000214797)
-  end
-
-  # 12. Mediatype unknown delete
-  it "Delete unknown mediatype" do
-    @request.stub(:body).and_return Server18.mediatype_delete_error
-    result = zbx.delete_mediatype('__example_mediatype')
-    result.should be_nil
-  end
-
-  # 13. Mediatype delete
-  it "Delete mediatype" do
-    @request.stub(:body).and_return Server18.mediatype_delete    
-    result = zbx.delete_mediatype('example_mediatype')
-    result.should be_kind_of(Integer)
-  end
-
-end