zbxapi 0.1

data/libs/api_exceptions.rb

@@ -0,0 +1,125 @@
+#License:: LGPL 2.1   http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
+#Copyright:: Copyright (C) 2009,2010 Andrew Nelson nelsonab(at)red-tux(dot)net
+#
+#This library is free software; you can redistribute it and/or
+#modify it under the terms of the GNU Lesser General Public
+#License as published by the Free Software Foundation; either
+#version 2.1 of the License, or (at your option) any later version.
+#
+#This library is distributed in the hope that it will be useful,
+#but WITHOUT ANY WARRANTY; without even the implied warranty of
+#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#Lesser General Public License for more details.
+#
+#You should have received a copy of the GNU Lesser General Public
+#License along with this library; if not, write to the Free Software
+#Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+##########################################
+# Subversion information
+# $Id:  $
+# $Revision:  $
+##########################################
+
+#------------------------------------------------------------------------------
+#
+# Class ZbxAP_ParameterError
+#
+# Exception class for parameter errors for Argument Processor calls.
+#
+#------------------------------------------------------------------------------
+
+#setup our search path or libraries
+path=File.expand_path(File.dirname(__FILE__) + "/./")+"/"
+
+require path+'zdebug'
+require path+'exceptions'
+
+#------------------------------------------------------------------------------
+#
+# Class ZbxAPI_ExceptionBadAuth
+#
+# Exception class for bad authentication information
+#
+#------------------------------------------------------------------------------
+
+class ZbxAPI_ExceptionBadAuth < RuntimeError
+end
+
+#------------------------------------------------------------------------------
+#
+# Class ZbxAPI_ExceptionBadServerUrl
+#
+# Exception class for bad host url, also used for connection
+# refused errors
+#
+#------------------------------------------------------------------------------
+
+class ZbxAPI_ExceptionBadServerUrl < RuntimeError
+end
+
+#------------------------------------------------------------------------------
+#
+# Class ZbxAPI_ExceptionArgumentError
+#
+# Exception class for incorrect arguments to a method
+#
+#------------------------------------------------------------------------------
+
+class ZbxAPI_ExceptionArgumentError < RuntimeError
+end
+
+#------------------------------------------------------------------------------
+#
+# Class ZbxAPI_ParameterError
+#
+# Exception class for parameter errors for API calls.
+#
+#------------------------------------------------------------------------------
+
+class ZbxAPI_ParameterError < RuntimeError
+end
+
+#------------------------------------------------------------------------------
+#
+# Class ZbxAPI_ExceptionVersion
+#
+# Exception class for API version errors
+#
+#------------------------------------------------------------------------------
+
+class ZbxAPI_ExceptionVersion < RuntimeError
+end
+
+#------------------------------------------------------------------------------
+#
+# Class ZbxAPI_ExceptionLoginPermission
+#
+# Exception class for lack of API login permission
+#
+#------------------------------------------------------------------------------
+
+class ZbxAPI_ExceptionLoginPermission < ZError
+end
+
+#------------------------------------------------------------------------------
+#
+# Class ZbxAPI_ExceptionPermissionError
+#
+# Exception class for general API permissions errors
+#
+#------------------------------------------------------------------------------
+
+class ZbxAPI_ExceptionPermissionError < ZError
+end
+
+#------------------------------------------------------------------------------
+#
+# Class ZbxAPI_GeneralError
+#
+# Exception class for errors not encompassed in the above exceptions.
+#
+#------------------------------------------------------------------------------
+
+class ZbxAPI_GeneralError < ZError
+end

data/libs/exceptions.rb

@@ -0,0 +1,122 @@
+#License:: LGPL 2.1   http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
+#Copyright:: Copyright (C) 2009,2010 Andrew Nelson nelsonab(at)red-tux(dot)net
+#
+#This library is free software; you can redistribute it and/or
+#modify it under the terms of the GNU Lesser General Public
+#License as published by the Free Software Foundation; either
+#version 2.1 of the License, or (at your option) any later version.
+#
+#This library is distributed in the hope that it will be useful,
+#but WITHOUT ANY WARRANTY; without even the implied warranty of
+#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#Lesser General Public License for more details.
+#
+#You should have received a copy of the GNU Lesser General Public
+#License along with this library; if not, write to the Free Software
+#Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+##########################################
+# Subversion information
+# $Id: exceptions.rb 254 2010-12-27 19:45:42Z nelsonab $
+# $Revision: 254 $
+##########################################
+
+#setup our search path or libraries
+path=File.expand_path(File.dirname(__FILE__) + "/./")+"/"
+
+require path+'zdebug'
+
+#------------------------------------------------------------------------------
+#
+# Class ZError
+#
+# This is the superclass for all Zabcon and ZabbixAPI exceptions.
+#
+#------------------------------------------------------------------------------
+class ZError < RuntimeError
+
+  include ZDebug
+
+  attr_reader :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]
+    @message=message
+    @local_msg="Error"
+    @retry = params[:retry]
+    super(message)
+  end
+
+  def show_message
+    puts "** #{self.class}"
+    if @message.nil? && @help_func.nil?
+      puts "** #{@local_msg}"
+      puts
+    else
+      if !@message.nil?
+        @message.each_line {|line|
+          puts "** #{line}"
+        }
+        puts
+        puts "---" if !@help_func.nil?
+      end
+      @help_func.call if !@help_func.nil?
+    end
+  end
+
+  #show the backtrace, if override is true it will be shown even if there is a help function
+  def show_backtrace(override=false)
+    if @help_func.nil? || override
+      puts "Backtrace:"
+      puts backtrace.join("\n")
+    end
+  end
+  def retry?
+    #the following may be worthy of a sig on "The Daily WTF", but this guarantees a boolean gets returned.
+    #@retry is not guaranteed to be a boolean.
+    if @retry
+      return true
+    else
+      return false
+    end
+  end
+end
+
+class ParameterError < ZError
+  def initialize(message=nil, params=nil)
+    super(message, params)
+    @local_msg="Parameter Error"
+  end
+end
+
+#----------------------------------------------------------
+
+class ParameterError_Invalid < ZError
+  def initialize(message=nil, params=nil)
+    super(message, params)
+    @local_msg="Invalid Parameters"
+  end
+end
+
+class ParameterError_Missing < ZError
+  def initialize(message=nil, params=nil)
+    super(message, params)
+    @local_msg="Missing required parameters"
+  end
+end
+
+#----------------------------------------------------------
+
+class ParseError < ZError
+  def initialize(message=nil, params=nil)
+    super(message, params)
+    @local_msg="Parse Error"
+  end
+end

data/libs/zdebug.rb

@@ -0,0 +1,163 @@
+#License:: LGPL 2.1   http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
+#Copyright:: Copyright (C) 2009,2010 Andrew Nelson nelsonab(at)red-tux(dot)net
+#
+#This library is free software; you can redistribute it and/or
+#modify it under the terms of the GNU Lesser General Public
+#License as published by the Free Software Foundation; either
+#version 2.1 of the License, or (at your option) any later version.
+#
+#This library is distributed in the hope that it will be useful,
+#but WITHOUT ANY WARRANTY; without even the implied warranty of
+#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#Lesser General Public License for more details.
+#
+#You should have received a copy of the GNU Lesser General Public
+#License along with this library; if not, write to the Free Software
+#Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+##########################################
+# Subversion information
+# $Id: zdebug.rb 222 2010-10-07 14:25:08Z nelsonab $
+# $Revision: 222 $
+##########################################
+
+module ZDebug
+
+  # Either set_debug_level or set_facility_debug_level must be called before
+  # the debug functions can be used.
+  def set_debug_level(level)   # sets the current debug level for printing messages
+    @@debug_level=level
+
+    # Create faciltiy_level if it's not created already
+    @@facility_level= {} if !defined?(@@facility_level)
+  end
+
+  # facility is a symbol, level is an integer
+  def set_facility_debug_level(facility,level)
+    # Create faciltiy_level if it's not created already
+    @@facility_level= {} if !defined?(@@facility_level)
+
+    @@facility_level[facility]=level
+
+    # Create debug level if it's not already created
+    @@debug_level=0 if !defined?(@@debug_level)
+  end
+
+  def debug_level
+    @@debug_level
+  end
+
+  # level - level to show message (Integer)
+  # variable - variable to show (Object)
+  # message - message to be prepended before variable  (String)
+  # overload - do show or error if debug_level is not set
+  def debug(level,variable="",message=nil,truncate=nil,overload=false)
+    return if overload
+    raise "Call set_debug before using debug" if !defined?(@@debug_level)
+    if level<=@@debug_level
+      #parse the caller array to determine who called us, what line, and what file
+      caller[0]=~/(.*):(\d+):.*`(.*?)'/
+
+      #sometimes the debug function gets called from within an exception block, in which cases the backtrace is not
+      #available.
+      file_tmp=$1.nil? ? "n/a" : $1
+      debug_line=$2.nil? ? "" : $2
+      debug_func=$3.nil? ? "" : $3
+      tmp_split=file_tmp.split("/")
+
+      if (len=tmp_split.length)>2
+        debug_file=".../#{tmp_split[len-2]}/#{tmp_split[len-1]}"
+      else
+        debug_file=file_tmp
+      end
+
+      strval=""
+      if variable.nil?
+        strval="nil"
+      elsif variable.class==String
+        strval=variable
+        if !truncate.nil?
+          if truncate<strval.length then
+            o_strval=strval
+            strval=o_strval[0..(truncate/2)]
+            strval+= "  .....  "
+            strval+=o_strval[(o_strval.length-(truncate/2))..o_strval.length]
+          end
+        end
+      else
+        strval=variable.inspect
+        if !truncate.nil?
+          if truncate<strval.length then
+            o_strval=strval
+            strval=o_strval[0..(truncate/2)]
+            strval+= "  .....  "
+            strval+=o_strval[(o_strval.length-(truncate/2))..o_strval.length]
+          end
+        end
+      end
+
+      if !message.nil?
+        strval = message + ": " + strval
+      end
+      puts "D#{level} #{debug_file}:#{debug_func}:#{debug_line} #{strval}"
+    end
+  end
+
+  # Debug_facility is a copy of the above function in an effort to shorten
+  # code path.
+  # facility - symbol denoting logging facility
+  # level - level to show message (Integer)
+  # variable - variable to show (Object)
+  # message - message to be prepended before variable  (String)
+  def debug_facility(facility,level,variable="",message=nil,truncate=nil)
+    facility_level=@@facility_level[facility]
+    raise "Call set_debug before using debug" if !defined?(@@debug_level)
+    raise "Unknown facility type: #{facility.to_s}" if facility_level.nil?
+    if level<=facility_level
+      #parse the caller array to determine who called us, what line, and what file
+      caller[0]=~/(.*):(\d+):.*`(.*?)'/
+
+      file_tmp=$1
+      debug_line=$2
+      debug_func=$3
+      tmp_split=file_tmp.split("/")
+
+      if (len=tmp_split.length)>2
+        debug_file=".../#{tmp_split[len-2]}/#{tmp_split[len-1]}"
+      else
+        debug_file=file_tmp
+      end
+
+      strval=""
+      if variable.nil?
+        strval="nil"
+      elsif variable.class==String
+        strval=variable
+        if !truncate.nil?
+          if truncate<strval.length then
+            o_strval=strval
+            strval=o_strval[0..(truncate/2)]
+            strval+= "  .....  "
+            strval+=o_strval[(o_strval.length-(truncate/2))..o_strval.length]
+          end
+        end
+      else
+        strval=variable.inspect
+        if !truncate.nil?
+          if truncate<strval.length then
+            o_strval=strval
+            strval=o_strval[0..(truncate/2)]
+            strval+= "  .....  "
+            strval+=o_strval[(o_strval.length-(truncate/2))..o_strval.length]
+          end
+        end
+      end
+
+      if !message.nil?
+        strval = message + ": " + strval
+      end
+      puts "D#{level}(#{facility.to_s}) #{debug_file}:#{debug_func}:#{debug_line} #{strval}"
+    end
+  end
+
+end  # end Debug module