zbxapi 0.1.398 → 0.2.415

data/api_classes/api_dsl.rb

@@ -0,0 +1,308 @@
+# Title:: Zabbix API Ruby Library
+# 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: api_dsl.rb 409 2012-09-11 23:39:58Z nelsonab $
+# $Revision: 409 $
+##########################################
+#++
+
+require "zbxapi/zdebug"
+require "zbxapi/exceptions"
+
+class ZabbixAPI_Method
+  include ZDebug
+
+  class InvalidArity<RuntimeError
+  end
+
+  class AlreadyUsedError<RuntimeError
+  end
+
+  class InvalidMethodError<ZError
+  end
+
+  def initialize(apiclass,apimethod)
+    @apiclass=apiclass
+    @apimethod=apimethod
+    @login_required=true
+    @arg_processors={}  # {version=>block}
+    @validparams={} # {version=>[valid parameters]}
+    @requiredparams={}  # {version=>[required parameters]}
+    @default=:default   # Which is the default version to use
+    @method_names={}
+    @method_names["0"]="#{@apiclass}.#{@apimethod}".downcase
+    @deprecated=nil
+    @invalidated=nil
+  end
+
+  def login_not_required
+    @login_required=false
+  end
+
+  #Deprecate this function starting at API version ver
+  #If msg is nil the following will be printed:
+  #"#{method} is deprecated for API versions #{ver} and higher"
+  # Where method is the current method name for the API
+  def deprecate(ver,msg=nil)
+    #Deprecate can only be called once
+    raise AlreadyUsedError.new("Deprecate can only be used once per method") if @deprecated
+    @deprecated={ver=>(msg || "") }
+  end
+
+  #Invalidate this function starting at API version ver
+  #This will raise the ZabbixAPI_Method::InvalidMethod exception
+  #If msg is nil the following string will be used in the exception:
+  #"#{method} is invalid for API versions #{ver} and higher"
+  # Where method is the current method name for the API
+  def invalidate(ver,msg=nil)
+    #Invalidate can only be called once
+    raise AlreadyUsedError.new("Invalidate can only be used once per method") if @deprecated
+    @invalidated={ver=>(msg || "") }
+  end
+
+  #Allows for the override of the API method to be called
+  #The default method is version 0 which can be overridden
+  def method_override(ver,name)
+    @method_names[ver]=name
+  end
+
+  #add_arg_processor
+  #Creates an argument processor suitable for versions starting at ver
+  #ver is a string denoting the starting version number this argument processor should be used on
+  #This method also needs a block to be passed.  The block
+  def add_arg_processor(ver,&block)
+    raise InvalidArity.new("Argument processor must accept one parameter") if block.arity !=1
+    @arg_processors[ver]=block
+    @default=ver
+  end
+
+  def get_arg_processor(ver)
+    ver=get_version(ver,@arg_processors)
+    return nil if ver.nil?
+    @arg_processors[ver]
+  end
+
+  #calls the argument processor appropriate for ver
+  #If no argument processor found, params are returned unchanged
+  def call_arg_processor(ver,params={})
+    processor=get_arg_processor(ver)
+    if processor.nil?
+      params
+    else
+      processor.call(params)
+    end
+  end
+
+  def add_valid_params(ver,params)
+    @validparams[ver]=params
+  end
+
+  def add_required_params(ver,params)
+    @requiredparams[ver]=params
+  end
+
+  def get_valid_params(ver)
+    ver=get_version(ver,@validparams)
+    return nil if ver.nil?
+    @validparams[ver]
+  end
+
+  def get_required_params(ver)
+    ver=get_version(ver,@requiredparams)
+    return nil if ver.nil?
+    @requiredparams[ver]
+  end
+
+  def params_good?(server_version, params)
+    debug(8,:msg=>"Server Version", :var=>server_version)
+    var=params.is_a?(Hash) ? params.keys : params
+    debug(8,:msg=>"Param keys", :var=>var)
+
+    valid_params=get_valid_params(server_version)
+
+    if valid_params  #continue to see if there's a required param
+      raise ArgumentError.new("Named Arguments (Hash) expected for #{@apiclass}.#{@apimethod},"\
+                              " '#{params.class}' received: #{params.inspect}") if !params.is_a?(Hash)
+      args=params.keys
+
+      invalid_args=args-valid_params
+      debug(9,:msg=>"Invalid args",:var=>invalid_args)
+      raise ZbxAPI_ParameterError.new("Invalid parameters #{invalid_args.inspect}") if !invalid_args.empty?
+    end
+
+    required_params=get_required_params(server_version)
+#    ver=get_version(server_version,@requiredparams)
+
+    return true if required_params.nil?
+    required_args=required_params.reject { |i| i.class==Array }
+    required_or_args=required_params.reject { |i| i.class!=Array }
+
+    missing_args=[]
+    missing_args=required_args-args
+
+    required_or_args.delete_if do |i|
+      count=i.length
+      missing_args<<i if (i-args).count==count
+    end
+
+    debug(9,:msg=>"Required Params",:var=>required_params)
+    debug(9,:msg=>"Missing params",:var=>missing_args)
+
+    if !missing_args.empty?
+      msg=missing_args.map do |i|
+        if i.class==Array
+          "(#{i.join(" | ")})"
+        else
+          i
+        end
+      end.join(", ")
+      raise ZbxAPI_ParameterError.new("Missing required arguments: #{msg}")
+    end
+    true
+  end
+
+  #This is the function that does the actual APIcall.
+  def do(server,params={})
+    debug(7,:msg=>"Method Name",:var=>@method_names[@method_names.keys.sort.first])
+    debug(7,:msg=>"Server",:var=>server)
+    debug(7,:msg=>"Params",:var=>params)
+
+    ver=get_version(server.API_version,@method_names)
+    name=@method_names[ver]
+
+    debug(8,:msg=>"Method Name used",:var=>name)
+
+    if @invalidated
+      ver=get_version(server.API_version,@invalidated)
+      if ver
+        msg=@invalidated.values.first.empty? ?
+          "#{name} is invalid for api versions #{@invalidated.keys.first} and higher" : @invalidated.values.first
+        raise InvalidMethodError.new(msg)
+      end
+    end
+
+    if @deprecated
+      ver=get_version(server.API_version,@deprecated)
+      if ver
+        msg=@deprecated.values.first.empty? ?
+          "#{name} is deprecated for api versions #{@deprecated.keys.first} and higher" : @deprecated.values.first
+        warn("Warning: #{msg}")
+      end
+    end
+
+    debug(8,:msg=>"Params before arg processor",:var=>params)
+    params=call_arg_processor(server.API_version,params)
+    debug(7,:msg=>"Params after arg processor",:var=>params)
+    params_good?(server.API_version,params)
+    server.api_call(name,params)
+  end
+
+  #returns the version number closest to server which is less than
+  #or equal to server
+  #If no versions exist in hash, nil is returned
+  def get_version(server,hash)
+    return nil if hash.nil?
+    server=server.split(".").map{|i| i.to_i }
+    hash=hash.keys.map{|i| i.split(".").map {|a| a.to_i} }
+
+    equality=0
+    hash.sort! {|x,y| x<=>y }
+    version=nil
+    hash.each {|i|
+      version=i if (server<=>i)>=0
+    }
+    version.join(".") if !version.nil?
+  end
+
+
+end
+
+class ZabbixAPI_Base
+  def initialize(server)
+    @server=server
+  end
+
+  def api_methods
+    self.class.api_methods.keys
+  end
+
+  def api_aliases
+    self.class.api_aliases
+  end
+
+  def valid_params(sym,ver=nil)
+    api_method=self.class.api_methods[sym]
+    return nil if api_method.nil?
+    api_method.valid_params(ver)
+  end
+
+  def self.method_missing(sym,&block)
+    add(sym,&block)
+  end
+
+  def self.action(sym, &block)
+    add(sym,&block)
+  end
+
+  def self.actions(*sym)
+    sym.each {|s| add(s)}
+  end
+
+  def self.api_methods
+    @api_methods
+  end
+
+  def self.api_aliases
+    @api_aliases={} if @api_aliases.nil?
+    @api_aliases
+  end
+
+  def self.alias(from,to)
+    @api_aliases={} if @api_aliases.nil?
+    @api_aliases[from]=to
+
+    @api_methods[to]=@api_methods[from]
+
+    define_method(to) do |params|
+      self.class.api_methods[to].do(@server,params)
+    end
+  end
+
+  def self.add(sym,&block)
+    @api_methods={} if @api_methods.nil?
+    @api_methods[sym]=ZabbixAPI_Method.new(self.to_s,sym.to_s)
+    @api_methods[sym].instance_eval(&block) if !block.nil?
+
+    #Create a method definition for the parameter in question.
+    #params is not treated as an array, the splat operator
+    #is there to allow for no parameters to be passed
+    define_method(sym) do |*params|
+      #The splat operator ensures we get an array, but we need
+      #to test to ensure we receive one hash parameter
+      if (params.length>1)
+        raise ArgumentError.new("Hash or one argument expected for #{self.class}.#{sym.to_s}, received: #{params.inspect}")
+      end
+      self.class.api_methods[sym].do(@server,params.first)
+    end
+  end
+end
+
+

data/api_classes/{history.rb → dsl_event.rb}

@@ -19,41 +19,16 @@
 #--
 ##########################################
 # Subversion information
-# $Id: zbxapi.rb 281 2011-04-06 18:10:16Z nelsonab $
-# $Revision: 281 $
+# $Id: dsl_event.rb 340 2011-10-14 23:22:06Z nelsonab $
+# $Revision: 340 $
 ##########################################
 #++
 
-require "api_classes/subclass_base"
-
-
-#******************************************************************************
-#
-# 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
+require "api_classes/api_dsl"
 
+class Event < ZabbixAPI_Base
 end
+
+Event.get
+Event.acknowledge
+Event.delete

data/api_classes/dsl_graph.rb

@@ -0,0 +1,31 @@
+# Title:: Zabbix API Ruby Library
+# 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: dsl_graph.rb 409 2012-09-11 23:39:58Z nelsonab $
+# $Revision: 409 $
+##########################################
+#++
+
+require "api_classes/api_dsl"
+
+class Graph < ZabbixAPI_Base
+  actions :get, :create, :update, :delete
+end

data/api_classes/dsl_history.rb

@@ -0,0 +1,33 @@
+# Title:: Zabbix API Ruby Library
+# 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: dsl_history.rb 337 2011-10-14 16:11:39Z nelsonab $
+# $Revision: 337 $
+##########################################
+#++
+
+require "api_classes/api_dsl"
+
+class History < ZabbixAPI_Base
+end
+
+History.get
+History.delete

data/api_classes/dsl_host.rb

@@ -0,0 +1,49 @@
+require "api_classes/api_dsl"
+
+class Host < ZabbixAPI_Base
+  actions :update, :massAdd, :massUpdate, :massRemove
+
+  action :get do
+    #arg_processor "1.3" do |params|
+    #  params["output"]="extend"
+    #  params
+    #end
+
+    add_valid_params "1.3", ["nodeids","groupids","hostids","templateids",
+                             "itemids","triggerids","graphids","proxyids","maintenanceids",
+                             "dhostids","dserviceids","monitored_hosts","templated_hosts",
+                             "proxy_hosts","with_items","with_monitored_items",
+                             "with_historical_items","with_triggers","with_monitored_triggers",
+                             "with_httptests","with_monitored_httptests","with_graphs",
+                             "editable","filter","search","startSearch","excludeSearch",
+                             "searchWildcardsEnabled","output","select_groups","selectParentTemplates",
+                             "select_items","select_triggers","select_graphs","select_applications",
+                             "select_macros","select_profile","countOutput","groupOutput",
+                             "preservekeys","sortfield","sortorder","limit","extendoutput"]
+  end
+
+  action :exists do
+    add_valid_params "1.3", ["nodeids","hostid","host"]
+  end
+
+  action :create do
+    add_valid_params "1.3", ["host","port","status","useip",
+        "dns","ip","proxy_hostid","useipmi","ipmi_ip","ipmi_port",
+        "ipmi_authtype","ipmi_privilege","ipmi_username",
+        "ipmi_password","groups","templates"]
+  end
+
+  action :delete do
+    add_arg_processor "0" do |params|
+      retval=nil
+      if params.is_a?(Fixnum)
+        retval=[{"hostid"=>params}]
+      else
+        retval=params
+      end
+
+      retval
+    end
+  end
+
+end