zabbixapi 0.1.4 → 0.1.5a1

data/lib/zabbixapi/usermacro.rb

@@ -0,0 +1,74 @@
+module Zabbix
+
+  class ZabbixApi
+    def add_macro(host_id, macro_name, macro_value)
+
+      message = {
+        'method' => 'Usermacro.create',
+        'params' => {
+          'hostid' => host_id,
+          'macro' => macro_name,
+          'value'=> macro_value
+        }
+      }
+
+      response = send_request(message)
+
+      if hostmacroids = response['hostmacroids'] then
+        result = hostmacroids
+      else
+        result = nil
+      end
+
+      return result
+    end
+
+    def get_macro(host_id, macro_name)
+    
+      message = {
+        'method' => 'Usermacro.get',
+        'params' => {
+          'hostids' => host_id,
+          'macros' => macro_name,
+          'extendoutput' => '1'
+        }
+      }
+
+      response = send_request(message)
+
+      unless response.empty? then
+        if hostmacroid =  response[0]['hostmacroid'] then
+          macro_id = hostmacroid
+          macro_value = response[0]['value']
+
+          result = {
+            'id' => macro_id,
+            'value'=> macro_value
+          }
+        else
+          result = nil
+        end
+      else
+        result = nil
+      end
+
+      return result
+    end
+
+    def set_macro_value(host_id, macro_name, macro_value)
+      
+      message = {
+        'method' => 'usermacro.updateValue',
+        'params' => {
+          'hostid' => host_id,
+          'macro' => macro_name,
+          'value' => macro_value
+        }
+      }
+
+      response = send_request(message)
+
+      return true
+    end
+  end
+end

data/lib/zabbixapi.rb

@@ -1,10 +1,10 @@
-require 'base'
-require 'graph'
-require 'group'
-require 'host'
-require 'item'
-require 'screen'
-require 'template'
-require 'trigger'
-require 'usermacro'
-require 'application'
+require 'zabbixapi/application'
+require 'zabbixapi/base'
+require 'zabbixapi/graph'
+require 'zabbixapi/group'
+require 'zabbixapi/host'
+require 'zabbixapi/item'
+require 'zabbixapi/screen'
+require 'zabbixapi/template'
+require 'zabbixapi/trigger'
+require 'zabbixapi/usermacro'

data/spec/item.rb

@@ -0,0 +1,60 @@
+require 'zabbixapi'
+require 'json'
+
+require 'webmock/rspec'
+include WebMock::API
+
+# settings
+api_url = 'http://zabbix.local/api_jsonrpc.php'
+api_login = 'admin'
+api_password = 'zabbix'
+
+# 01. Add item
+auth_response = '{"jsonrpc":"2.0","result":"a82039d56baba1f92311aa917af9939b","id":83254}'
+add_item_response = '{"jsonrpc":"2.0","result":{"itemids":["19541"]},"id":80163}'
+item_options = {
+  'description' => "Description",
+  'key_' => "key[,avg1]",
+  'hostid' => '10160',
+  'applications' => [ 393 ],
+  'history' => 7,
+  'trends' => 30, 
+  'delay' => 60, 
+  'value_type' => 0
+}
+
+stub_request(:post, api_url).with(:body => /"method":"user\.authenticate"/).to_return(:body => auth_response)
+stub_request(:post, api_url).with(:body => /"method":"item\.create"/).to_return(:body => add_item_response)
+
+describe Zabbix::ZabbixApi, "add_item" do
+  it "Create item" do
+    zbx = Zabbix::ZabbixApi.new(api_url, api_login, api_password)
+    result = zbx.add_item(item_options)
+    result.should eq("19541")
+  end
+end
+
+# 02. Delete item
+auth_response = '{"jsonrpc":"2.0","result":"a82039d56baba1f92311aa917af9939b","id":83254}'
+delete_item_response = ''
+item_options = {
+  'description' => "Description",
+  'key_' => "key[,avg1]",
+  'hostid' => '10160',
+  'applications' => [ 393 ],
+  'history' => 7,
+  'trends' => 30, 
+  'delay' => 60, 
+  'value_type' => 0
+}
+
+stub_request(:post, api_url).with(:body => /"method":"user\.authenticate"/).to_return(:body => auth_response)
+stub_request(:post, api_url).with(:body => /"method":"item\.create"/).to_return(:body => add_item_response)
+
+describe Zabbix::ZabbixApi, "add_item" do
+  it "Create item" do
+    zbx = Zabbix::ZabbixApi.new(api_url, api_login, api_password)
+    result = zbx.add_item(item_options)
+    result.should eq("19541")
+  end
+end

data/zabbixapi.gemspec

@@ -1,10 +1,10 @@
-require 'rubygems'
+# -*- encoding: utf-8 -*-
+
 require 'rake'
-require 'echoe'
 
 Gem::Specification.new do |spec|
 
-  spec.version = '0.1.4'
+  spec.version = '0.1.5a1'
   spec.name = 'zabbixapi'
   spec.summary = 'Ruby module for work with zabbix api.'
 
@@ -16,6 +16,5 @@ Gem::Specification.new do |spec|
   spec.has_rdoc = true
   spec.extra_rdoc_files  = 'README.rdoc'
 
-
-  spec.files = FileList["lib/*.rb", "bin/*", "spec/*", 'zabbixapi.gemspec', 'README.rdoc'].to_a
+  spec.files = FileList["lib/*.rb", "lib/zabbixapi/*.rb", "bin/*", "spec/*", 'zabbixapi.gemspec', 'README.rdoc', "examples/*"].to_a
 end

metadata

@@ -1,76 +1,66 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: zabbixapi
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 4
-  version: 0.1.4
+version: !ruby/object:Gem::Version
+  version: 0.1.5a1
+  prerelease: 5
 platform: ruby
-authors: 
+authors:
 - Eduard Snesarev
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-03-28 00:00:00 +04:00
-default_executable: 
+date: 2012-06-18 00:00:00.000000000Z
 dependencies: []
-
-description: "Ruby module for work with zabbix api. "
+description: ! 'Ruby module for work with zabbix api. '
 email: verm666@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
-files: 
-- lib/application.rb
-- lib/base.rb
-- lib/graph.rb
-- lib/group.rb
-- lib/host.rb
-- lib/item.rb
-- lib/screen.rb
-- lib/template.rb
-- lib/trigger.rb
-- lib/usermacro.rb
+files:
 - lib/zabbixapi.rb
+- lib/zabbixapi/application.rb
+- lib/zabbixapi/base.rb
+- lib/zabbixapi/graph.rb
+- lib/zabbixapi/group.rb
+- lib/zabbixapi/host.rb
+- lib/zabbixapi/item.rb
+- lib/zabbixapi/screen.rb
+- lib/zabbixapi/template.rb
+- lib/zabbixapi/trigger.rb
+- lib/zabbixapi/usermacro.rb
+- spec/item.rb
 - zabbixapi.gemspec
 - README.rdoc
-has_rdoc: true
+- examples/config.yml
+- examples/zabbix_availability
+- examples/zabbix_disk_io
+- examples/zabbix_filesystem
+- examples/zabbix_la
+- examples/zabbix_memory
+- examples/zabbix_net
 homepage: http://github.com/verm666/RubyZabbixApi
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Ruby module for work with zabbix api.
 test_files: []
-

data/lib/base.rb

@@ -1,126 +0,0 @@
-#!/usr/bin/ruby
-
-require 'json'
-require 'net/http'
-require 'net/https'
-
-module Zabbix
-
-	class JsonMessage < RuntimeError
-	end
-
-	class ResponceCodeError < RuntimeError
-	end
-
-	class ResponceBodyHash < RuntimeError
-	end
-
-	class InvalidAnswerId < RuntimeError
-	end
-
-	class Error < RuntimeError
-	end
-
-	class ZabbixApi
-
-	def initialize ( api_url, api_user, api_password )
-		@api_url = api_url
-		@api_user = api_user
-		@api_password = api_password
-	end
-
-	def do_request(message)
-
-		id = rand 100_000
-
-		message['id'] = id
-		message['jsonrpc'] = '2.0'
-
-		message_json = JSON.generate(message)
-
-#		puts message.inspect
-
-		uri = URI.parse(@api_url)
-		http = Net::HTTP.new(uri.host, uri.port)
-
-		if ( uri.scheme == "https" ) then
-			http.use_ssl = true
-			http.verify_mode = OpenSSL::SSL::VERIFY_NONE	
-		end
-
-		request = Net::HTTP::Post.new(uri.request_uri)
-		request.add_field('Content-Type', 'application/json-rpc')
-		request.body=(message_json)
-
-		# TODO сделать проверку невозможности подключения.
-		responce = http.request(request)
-
-		if ( responce.code != "200" ) then
-			raise Zabbix::ResponceCodeError.new("Responce code from [" + @api_url + "] is " + responce.code)
-		end
-
-		responce_body_hash = JSON.parse(responce.body)
-
-		#if not ( responce_body_hash['id'] == id ) then
-		#	raise Zabbix::InvalidAnswerId.new("Wrong ID in zabbix answer")
-		#end
-
-
-		# Check errors in zabbix answer. If error exist - raise exception Zabbix::Error
-
- #               puts responce_body_hash.inspect
-
-		if ( error = responce_body_hash['error'] ) then
-			error_message = error['message']
-			error_data = error['data']
-			error_code = error['code']
-
-			e_message = "Code: [" + error_code.to_s + "]. Message: [" + error_message +\
-						"]. Data: [" + error_data + "]."
-
-			raise Zabbix::Error.new(e_message)
-		end
-
-		result = responce_body_hash['result']
-
-		return result
-	end
-
-	def send_request(message)
-		message['auth'] = auth()
-		do_request(message)
-	end
-
-	def auth()
-
-		auth_message = {
-			'auth' =>	nil,
-			'method' =>	'user.authenticate',
-			'params' =>	{
-				'user' => @api_user,
-				'password' => @api_password,
-				'0' => '0'
-			}
-		}
-
-		auth_id = do_request(auth_message)
-
-		return auth_id
-	end
-
-	def merge_opt(a, b)
-		
-		c = {}
-
-		b.each_pair do |key, value|
-			
-			if ( a.has_key?(key) ) then
-				c[key] = value
-			end
-
-		end
-
-		return a.merge(c)
-	end
-end
-end

data/lib/group.rb

@@ -1,78 +0,0 @@
-module Zabbix
-
-	class ZabbixApi
-		def get_group_id(pattern)
-			
-			message = {
-				'method' => 'hostgroup.get',
-				'params' => {
-					'filter' => {
-						'name' => pattern
-					}
-				}
-			}
-
-			responce = send_request(message)
-
-			if not ( responce.empty? ) then
-				result = responce[0]['groupid']
-			else
-				result = nil
-			end
-
-			return result
-		end
-
-		def group_exist?(pattern)
-		
-			group_id = get_groups_id(pattern)
-
-			if ( group_id ) then
-				return true
-			else
-				return false
-			end
-		end
-
-		def add_group(groupname)
-			
-			message = {
-				'method' => 'hostgroup.create',
-				'params' => {
-					'name' => groupname 
-				}
-			}
-
-			responce = send_request(message)
-
-			if ( responce ) then
-				result = responce['groupids'] 
-			else
-				result = nil
-			end
-
-			return result
-		end
-
-		def add_host_to_group(host_id, group_id)
-			
-			message = {
-				'method' => 'hostgroup.massAdd',
-				'params' => {
-					'groups' => [ group_id ],
-					'hosts' => [ host_id ]
-				}
-			}
-
-			responce = send_request(message)
-
-			if not ( responce.empty? ) then
-				result = true
-			else
-				result = false
-			end
-			
-			return result
-		end
-	end
-end

data/lib/host.rb

@@ -1,98 +0,0 @@
-module Zabbix
-
-  # Examples:
-  # * Create host in zabbix
-  #   
-  #    zbx = Zabbix::ZabbixApi.new(url, user, password)
-  #    host_options => {
-  #      host => 'host.example.org',
-  #      ip => '127.0.0.1',
-  #      groups => [10001, 10002],
-  #    }
-  #    host_id = zbx.add_host(host_options)
-    
-    # Method for creation host in zabbix.
-    # * Input parameter - hash <tt>host_options</tt>. Available keys in hash:
-    #   - host - hostname. Type: string. Default: nil;
-    #   - port - zabbix agent pont. Type: int. Default: 10050;
-    #   - status - host status. Type: int. Possible values: 0 - monitored, 1 - not monitored. Default: 0; 
-    #   - useip - use ip or dns name for monitoring host. Possible values: 0 - don't use ip (use dns name), 1 - use ip (don't use dns name);
-    #   - ip - host's ip address. Used for monitoring host if useip set to 1. Default: '0.0.0.0';
-    #   - proxy_hostid - host_id of zabbix proxy (if necessary). See <tt>get_host_id</tt>. Default: 0 (don't use proxy server);
-    #   - groups - array of groups that belong host. Default: []. 
-    #   - useipmi - Use or not ipmi. Default: 0 (don't use ipmi);
-    #   - ipmi_ip - Default: '';
-    #   - ipmi_port - Default: 623;
-    #   - ipmi_authtype - Default: 0;
-    #   - ipmi_privilege - Default: 0;
-    #   - ipmi_username - Default: '';
-    #   - ipmi_password - Default: '';
-    class ZabbixApi
-    def add_host(host_options)
-
-      host_default = {
-        'host' => nil,
-        'port' => 10050,
-        'status' => 0,
-        'useip' => 0,
-        'dns' => '',
-        'ip' => '0.0.0.0',
-        'proxy_hostid' => 0,
-        'groups' => [],
-        'useipmi' => 0,
-        'ipmi_ip' => '',
-        'ipmi_port' => 623,
-        'ipmi_authtype' => 0,
-        'ipmi_privilege' => 0,
-        'ipmi_username' => '',
-        'ipmi_password' => ''
-      }
-
-      host_options['groups'].map! { |group_id| {'groupid' => group_id} }
-
-      host = merge_opt(host_default, host_options)
-
-      message = {
-        'method' => 'host.create',
-        'params' => host
-      }
-
-      responce = send_request(message)
-
-      if not ( responce.empty? ) then
-        result = responce['hostids'][0].to_i
-      else
-        result = nil
-      end
-
-      return result
-    end
-
-    # Method for retrieving host id from zabbix by hostname.
-    # * Non optional input parameters:
-    #   - hostname - Type: String.
-    # * Return:
-    #   - host_id - Return finded host_id for passed hostname. If host not found in zabbix - return nil
-    def get_host_id(hostname)
-  
-      message = {
-        'method' => 'host.get',
-        'params' => {
-          'filter' => {
-            'host' => hostname
-          }
-        }
-      }
-
-      responce = send_request(message)
-
-      if not ( responce.empty? ) then
-        result = responce[0]['hostid'].to_i
-      else
-        result = nil
-      end
-
-      return result
-    end
-end
-  end