zbxapi 0.1.1 → 0.1.291

data/libs/api_exceptions.rb

@@ -97,6 +97,10 @@ end
 #------------------------------------------------------------------------------
 
 class ZbxAPI_ExceptionLoginPermission < ZError
+  def initialize(message=nil, params=nil)
+    super(message, params)
+    @local_msg="This is also a general Zabbix API error number (Your error may not be a login error).\nTell the Zabbix devs to honor section 5.1 of the JSON-RPC 2.0 Spec."
+  end
 end
 
 #------------------------------------------------------------------------------

data/libs/exceptions.rb

@@ -34,14 +34,12 @@ class ZError < RuntimeError
 
   include ZDebug
 
-  attr_reader :help_func, :message, :retry
+  attr_accessor :help_func, :message, :retry
 
   # list of valid params
   # :help_func, the help function with more information for the exception
   # : retry, is the exception eligable for retry?
   def initialize(message=nil, params=nil)
-    debug(2,self.class,"Exception raised")
-    debug(2,params,"params")
     raise "Exception not called correctly" if params.class!=Hash if !params.nil?
     params={} if params.nil?
     @help_func=params[:help_func]
@@ -117,3 +115,7 @@ class ParseError < ZError
     @local_msg="Parse Error"
   end
 end
+
+class ReturnError < ZError
+
+end

data/libs/zdebug.rb

@@ -17,8 +17,8 @@
 
 ##########################################
 # Subversion information
-# $Id: zdebug.rb 222 2010-10-07 14:25:08Z nelsonab $
-# $Revision: 222 $
+# $Id: zdebug.rb 281 2011-04-06 18:10:16Z nelsonab $
+# $Revision: 281 $
 ##########################################
 
 module ZDebug

data/zbxapi.rb

@@ -19,11 +19,13 @@
 #--
 ##########################################
 # Subversion information
-# $Id: zbxapi.rb 268 2011-01-02 18:52:37Z nelsonab $
-# $Revision: 268 $
+# $Id: zbxapi.rb 290 2011-07-08 04:58:15Z nelsonab $
+# $Revision: 290 $
 ##########################################
 #++
 
+#TODO Create class to capture resultant data
+
 #setup our search path or libraries
 $: << File.expand_path(File.join(File.dirname(__FILE__), '.'))
 
@@ -35,6 +37,16 @@ require 'net/https'
 require 'rubygems'
 require 'json'
 
+require "api_classes/application"
+require "api_classes/history"
+require "api_classes/host"
+require "api_classes/host_group"
+require "api_classes/item"
+require "api_classes/sysmap"
+require "api_classes/trigger"
+require "api_classes/user"
+require "api_classes/user_group"
+
 
 
 #------------------------------------------------------------------------------
@@ -267,6 +279,7 @@ class ZabbixAPI
 
       # check return code and throw exception for error checking
       resp = JSON.parse(response.body) #parse the JSON Object so we can use it
+      raise
       if !resp["error"].nil?
         errcode=resp["error"]["code"].to_i
         case errcode
@@ -299,605 +312,6 @@ class ZabbixAPI
   end
 end
 
-# Class: Zbx_API_Sub
-# Wrapper class to ensure all class calls goes to the parent object not the
-# currently instantiated object.
-# Also ensures class specific variable sanity for global functions
-class ZbxAPI_Sub < ZabbixAPI #:nodoc: all
-  attr_accessor :parent
-
-  def initialize(parent)
-    @parent=parent
-  end
-
-  def checkauth
-    @parent.checkauth
-  end
-
-  def checkversion(major,minor,options=nil)
-    @parent.checkversion(major,minor,options)
-  end
-
-  def do_request(req)
-    return @parent.do_request(req)
-  end
-
-  def json_obj(method, param)
-    return @parent.json_obj(method, param)
-  end
-
-  def debug(level,param="",message=nil)
-    @parent.debug(level,param,message)
-  end
-end
-
-# Class ZbxAPI_User
-#
-# Class encapsulating User functions
-#
-# API Function          Status
-# [get]                   Implemented, need error checking
-# [authenticate]          Will not implement here, belongs in ZabbixAPI main class
-# [checkauth]             Will not implement here, belongs in ZabbixAPI main class
-# [getid]                 Implemented
-# [create]               Implemented, need to test more to find fewest items
-#                        needed, input value testing needed
-# [update]
-#
-# [addmedia]
-#
-# [deletemedia]
-#
-# [updatemedia]
-# [delete]    Implemented, checking of input values needed
-#
-# All functions expect a hash of options to add.
-# If multiple users need to be manipulated it must be broken out into different calls
-
-class ZbxAPI_User < ZbxAPI_Sub
-  def get(options={})
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('user.get',options))
-    return obj['result']
-  end
-
-  def getid(username)
-    raise ZbxAPI_ExceptionArgumentError, "String argument expected" if username.class != String
-
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('user.getid',{'alias'=>username}))
-    return obj['result']
-  end
-
-  def create(options)
-    checkauth
-    checkversion(1,1)
-
-    #Check input parameters
-
-    raise ZbxAPI_ParameterError, "Missing 'name' argument", "User.create" if options["name"].nil?
-    raise ZbxAPI_ParameterError, "Missing 'alias' argument", "User.create" if options["alias"].nil?
-    raise ZbxAPI_ParameterError, "Missing 'passwd' argument", "User.create" if options["passwd"].nil?
-
-    obj=do_request(json_obj('user.create',options))
-    return obj['result']
-  end
-
-  # Alias function name for code written to work against 1.0 API
-  # may be removed in future versions
-  
-  def add(options)
-    puts "WARNING API Function User.add is deprecated and will be removed in the future without further warning"
-    create(options)
-  end
-
-  def delete(userid)
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('user.delete',[userid]))
-    return obj['result']
-  end
-
-  def update(options)
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('user.update',options))
-    return obj['result']
-  end
-
-  # addmedia expects a hash of the following variables
-  # userid, mediatypeid, sendto, severity, active, period
-  def addmedia(options)
-    debug(8, "User.addmedia Start")
-    checkauth
-    checkversion(1,1)
-
-#    p options
-
-    raise ZbxAPI_ParameterError, "Missing 'userid' argument", "User.addmedia" if options["userid"].nil?
-    raise ZbxAPI_ParameterError, "Missing 'mediatypeid' argument", "User.addmedia" if options["mediatypeid"].nil?
-    raise ZbxAPI_ParameterError, "Missing 'severity' argument", "User.addmedia" if options["severity"].nil?
-    raise ZbxAPI_ParameterError, "Missing 'active' argument", "User.addmedia" if options["active"].nil?
-    raise ZbxAPI_ParameterError, "Missing 'period' argument", "User.addmedia" if options["period"].nil?
-
-    args = {}
-    args["userid"]=options["userid"]
-    args["medias"]={}
-    args["medias"]["mediatypeid"]=options["mediatypeid"]
-    args["medias"]["sendto"]=options["sendto"]
-    args["medias"]["severity"]=options["severity"]
-    args["medias"]["active"]=options["active"]
-    args["medias"]["period"]=options["period"]
-
-#    p args
-
-    obj=do_request(json_obj('user.addMedia',args))
-    return obj['result']
-  end
-end
-
-#******************************************************************************
-#
-# Class ZbxAPI_Host
-#
-# Class encapsulating Host and template functions
-#
-# API Function          Status
-# get                   Basic function implemented
-# getid
-# create                Basic function implemented 20091020
-# update
-# massupdate
-# delete                Implimented
-#
-# template.create       implemented as host.create_template
-# template.get          implemented as host.get_template
-# template.delete       implemented as host.delete_template
-#
-#******************************************************************************
-
-class ZbxAPI_Host < ZbxAPI_Sub
-  def get(options={})
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('host.get',options))
-    obj['result']
-  end
-
-  def get_template(options={})
-    checkauth
-    checkversion(1,3)
-
-    obj=do_request(json_obj('template.get',options))
-    obj['result']
-  end
-
-  def create(options={})
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('host.create',options))
-    obj['result']
-  end
-
-  def create_template(options={})
-    checkauth
-    checkversion(1,3)
-
-    obj=do_request(json_obj('template.create',options))
-    obj['result']
-  end
-
-  # http://www.zabbix.com/documentation/1.8/api/objects/host#hostdelete
-  #Accepts a single host id or an array  of host id's to be deleted
-  def delete(ids)
-    checkauth
-    checkversion(1,3)
-
-    obj=do_request(json_obj('host.delete',delete_helper("hostid",ids)))
-    obj['result']
-  end
-
-  def delete_template(ids)
-    checkauth
-    checkversion(1,3)
-
-    obj=do_request(json_obj('template.delete',delete_helper("templateid",ids)))
-    obj['result']
-  end
-
-  private
-
-  def delete_helper(id_type,ids)
-    if ids.class==Fixnum
-      ids=[ids]
-    elsif ids.class==Array
-      ids=ids
-    else
-      raise ZbxAPI_ParameterError, "ids parameter must be number or array"
-    end
-
-    ids.map do |id|
-      {id_type=>id}
-    end
-  end
-
-end
-
-#******************************************************************************
-#
-# Class ZbxAPI_Item
-#
-# Class encapsulating Item functions
-#
-# API Function          Status
-# get                   Basic Function working
-# getid                 Function implemented
-# create                   Function implemented
-# update
-# delete                Function implemented  - need to add type checking to input
-#
-#******************************************************************************
-
-class ZbxAPI_Item < ZbxAPI_Sub
-  def get(options={})
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('item.get',options))
-    return obj['result']
-  end
-
-  def getid(options)
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('item.getid', options))
-    return obj['result']
-  end
-
-  def create(options)
-    debug(8,options)
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('item.create', options))
-    return obj['result']
-  end
-
-  # Alias function for code written against 1.0 API
-  def add(options)
-    puts "WARNING API Function Item.add is deprecated and will be removed in the future without further warning"
-    create(options)
-  end
-
-  def delete(ids)
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('item.delete', ids))
-    return obj['result']
-  end
-end
-
-#******************************************************************************
-#
-# Class ZbxAPI_UserGroup
-#
-# Class encapsulating User Group functions
-#
-# API Function          Status
-# get                   Basic function implemented
-# getid
-# create
-# update
-# updaterights
-# addrights
-# addusers
-# removeusers
-# delete
-#
-#******************************************************************************
-
-class ZbxAPI_UserGroup < ZbxAPI_Sub
-  def get(options={})
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('usergroup.get',options))
-    return obj['result']
-  end
-end
-
-#******************************************************************************
-#
-# Class ZbxAPI_HostGroup
-#
-# Class encapsulating User Group functions
-#
-# API Function          Status
-# get                   Basic function implemented
-# getid
-# create
-# update
-# delete
-# addhosts
-# removehost
-# addgroupstohost
-# updategroupstohost
-#
-#******************************************************************************
-
-class ZbxAPI_HostGroup < ZbxAPI_Sub
-  def create(options={})
-    debug(8, "HostGroup.create Start")
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('hostgroup.create',options))
-    return obj['result']
-  end
-
-  # alias function for code written against 1.0 API
-  def add(options={})
-    puts "WARNING API Function HostGroup.add is deprecated and will be removed in the future without further warning"
-    create(options)
-  end
-
-  def get(options={})
-    debug(8, "HostGroup.get Start")
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('hostgroup.get',options))
-    return obj['result']
-  end
-
-  def getId(name)
-    puts "WARNING API Function HostGroup.getId is deprecated and will be removed in the future without further warning"
-    getObjects(name)
-  end
-
-  def getObjects(name)
-    debug(8, "HostGroup.getId Start")
-    checkauth
-    checkversion(1,1)
-
-    begin
-      if name.class==String
-        do_request(json_obj('hostgroup.getObjects',{"name"=>name}))['result']
-      elsif name.class==Array
-        valid = name.map {|item| item.class==String ? nil : false}  # create a validation array of nils or false
-        valid.compact!  # remove nils
-        raise ZbxAPI_ParameterError, "Expected a string or an array of strings" if !valid.empty?
-
-        results=[]
-        name.each do |item|
-          response=do_request(json_obj('hostgroup.getObjects',{"name"=>item}))
-          response['result'].each {|result| results << result }  # Just in case the server returns an array
-        end
-        results
-      else
-        raise ZbxAPI_ParameterError, "Expected a string or an array of strings"
-      end
-    rescue ZbxAPI_GeneralError => e
-      if e.message["code"]==-32602
-        return 0
-      else
-        raise e
-      end
-    end
-  end
-end
-
-#******************************************************************************
-
-#
-# Class ZbxAPI_Application
-#
-# Class encapsulating application functions
-#
-# API Function          Status
-# get			Not implemented
-# getById		Implemented
-# getId			Not implemented
-# create	              Not implemented
-# update		Not implemented
-# delete		Not implemented
-#
-#******************************************************************************
-
-
-class ZbxAPI_Application < ZbxAPI_Sub
-  def get(options={})
-    debug(8, "Application.get Start")
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('application.get',options))
-    return obj['result']
-  end
-
-  def create(options={})
-    debug(8, "Application.create Start")
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('application.create',options))
-    return obj['result']
-  end
-
-  # Alias function for code written against 1.0 API
-  def add(options={})
-    puts "WARNING API Function Application.add is deprecated and will be removed in the future without further warning"
-    create(options)
-  end
-
-  def getid(options={})
-    debug(8, "Application.getid Start")
-    checkauth
-    checkversion(1,1)
-
-    begin
-      obj=do_request(json_obj('application.getid',options))
-    rescue ZbxAPI_GeneralError => e
-      if e.message["code"]==-32400
-        return 0
-      else
-        raise e
-      end
-    end
-    return obj['result']
-  end
-end
-
-#******************************************************************************
-#
-# Class ZbxAPI_Trigger
-#
-# Class encapsulating trigger functions
-#
-# get			Implemented
-# getById		Not implemented
-# getId			Not implemented
-# create	              Implemented
-# update		Not implemented
-# delete		Not implemented
-# addDependency		Not implemented
-#
-#******************************************************************************
-
-
-class ZbxAPI_Trigger < ZbxAPI_Sub
-  def get(options={})
-    debug(8, "Trigger.get Start")
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('trigger.get',options))
-    return obj['result']
-  end
-
-  # Function name changed to reflect 1.1 API changes
-  def create(options={})
-    debug(8, "Trigger.create Start")
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('trigger.create',options))
-    return obj['result']
-  end
-
-  # Alias function for code written against 1.0 api
-  def add(options={})
-    puts "WARNING API Function Trigger.add is deprecated and will be removed in the future without further warning"
-    create(options)
-  end
-end
-
-#******************************************************************************
-#
-# Class ZbxAPI_Sysmap
-#
-# Class encapsulating sysmap functions
-#
-# get			Not implemented
-# cr	eate		Basic implementation
-#
-#******************************************************************************
-
-class ZbxAPI_Sysmap < ZbxAPI_Sub
-  def create(options={})
-    debug(8, "Sysmap.create Start")
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('map.create',options))
-    return obj['result']
-  end
-
-  # Alias function for code written against 1.0 API
-  def add(options={})
-    puts "WARNING API Function Sysmap.add is deprecated and will be removed in the future without further warning"
-    create(options)
-  end
-
-  def addelement(options={})
-    debug(8, "Sysmap.addelement Start")
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('map.addelement',options))
-    return obj['result']
-  end
-
-  def addlink(options={})
-    debug(8, "Sysmap.addlink Start")
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('map.addlink',options))
-    return obj['result']
-  end
-
-  def getseid(options={})
-    debug(8, "Sysmap.getseid Start")
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('map.getseid',options))
-    return obj['result']
-  end
-
-  def addlinktrigger(options={})
-    debug(8, "Sysmap.addlinktrigger Start")
-    checkauth
-    checkversion(1,1)
-
-    obj=do_request(json_obj('map.addlinktrigger',options))
-    return obj['result']
-  end
-end
-
-#******************************************************************************
-#
-# Class ZbxAPI_History
-#
-# Class encapsulating history functions
-#
-# get
-#
-#******************************************************************************
-
-class ZbxAPI_History
-
-  def initialize(server)
-    @server=server
-  end
-
-  #Get the history for an item.
-  # itemids is a required option
-  # example: get({"itemids"=>12345})
-  def get(options)
-    @server.checkauth
-    @server.checkversion(1,3)
-
-    raise ZbxAPI_ParameterError, "Missing 'itemid'", "History.get" if options["itemids"].nil?
-
-    p obj=@server.raw_api("history.get",options)
-    return obj['result']
-  end
-
-end
-
-
 #******************************************************************************
 
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: zbxapi
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 605
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 291
+  version: 0.1.291
 platform: ruby
 authors: 
 - A. Nelson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-06 00:00:00 -04:00
+date: 2011-07-08 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency