zbxapi 0.3.1 → 0.3.2

data/api_classes/api_dsl.rb

@@ -26,6 +26,43 @@
 
 require "zbxapi/zdebug"
 require "zbxapi/exceptions"
+require "pp"
+
+class ZabbixAPI_ParametersDSL
+  attr_reader :valid_params, :required_params
+
+  def initialize(other_validparams,other_requiredparams)
+    @other_valid_parameters=other_validparams
+    @other_required_parameters=other_requiredparams
+    @valid_params=[]
+    @required_params=[]
+  end
+
+  def inherit(ver)
+    @valid_params=@other_valid_parameters[ver] || []
+    @required_params=@other_required_parameters[ver] || []
+  end
+
+  def add(*params)
+    @valid_params+=params
+    @valid_params.flatten!
+  end
+
+  def remove(*params)
+    #TODO Add sanity checking to ensure that a removed parameter is also removed from the required list
+    @valid_params-=params
+  end
+
+  def from(var)
+    var
+  end
+
+  def requires(*params)
+    #TODO Add sanity checking to ensure that required arguments are also valid arguments
+    @required_params+=params
+    @required_params.flatten!
+  end
+end
 
 class ZabbixAPI_Method
   include ZDebug
@@ -67,6 +104,12 @@ class ZabbixAPI_Method
     @deprecated={ver=>(msg || "") }
   end
 
+  def deprecate_dsl(msg)
+    warn msg
+    caller[1]=~/(.*:\d+):.*`(.*?)'/
+    warn "from: #{$1}"
+  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:
@@ -112,13 +155,21 @@ class ZabbixAPI_Method
   end
 
   def add_valid_params(ver,params)
+    deprecate_dsl("DSL statement add_valid_params is deprecated, use the parameters statement")
     @validparams[ver]=params
   end
 
   def add_required_params(ver,params)
+    deprecate_dsl("DSL statement add_required_params is deprecated, use the parameters statement")
     @requiredparams[ver]=params
   end
 
+  # Return the valid parameters for the method given version.
+  # If version is nil, the highest version number available in the valid
+  # parameters hash is used.
+  # If ver is a version number, the closest version number in the valid
+  # parameters hash which is less than or equal to is returned.
+  # nil is returned is no valid parameters are found
   def get_valid_params(ver)
     ver=get_version(ver,@validparams)
     return nil if ver.nil?
@@ -131,6 +182,15 @@ class ZabbixAPI_Method
     @requiredparams[ver]
   end
 
+  def parameters(ver,*params,&block)
+    parameters=ZabbixAPI_ParametersDSL.new(@validparams,@requiredparams)
+
+    parameters.add(params) if !params.nil?
+    parameters.instance_eval(&block) if !block.nil?
+    @validparams[ver]=parameters.valid_params
+    @requiredparams[ver]=parameters.required_params
+  end
+
   def params_good?(server_version, params)
     debug(8,:msg=>"Server Version", :var=>server_version)
     var=params.is_a?(Hash) ? params.keys : params
@@ -220,16 +280,51 @@ class ZabbixAPI_Method
   #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} }
+    if server
+      #server=server.split(".").map{|i| i.to_i }
+      keys=hash.keys.sort do |a,b|
+        aa=a.split(".")
+        bb=b.split(".")
+        last_pos=((aa.length > bb.length) ? aa.length : bb.length)-1
+        pos=0
+        while aa[pos].to_i==bb[pos].to_i
+          break if pos>=last_pos
+          pos+=1
+        end
+        (aa[pos].to_i<=>bb[pos].to_i)
+      end
 
-    equality=0
-    hash.sort! {|x,y| x<=>y }
-    version=nil
-    hash.each {|i|
-      version=i if (server<=>i)>=0
-    }
-    version.join(".") if !version.nil?
+      keys.delete_if do |k|
+        kk=k.split(".")
+        ss=server.split(".")
+        last_pos=((kk.length > ss.length) ? ss.length : ss.length)-1
+        pos=0
+        while kk[pos].to_i<=ss[pos].to_i
+          break if pos>=last_pos
+          pos+=1
+        end
+        kk[pos].to_i>ss[pos].to_i
+      end
+
+      if keys.empty?
+        return nil
+      else
+        return keys.last
+      end
+    else
+      sorted=hash.keys.sort do |a,b|
+        aa=a.split(".")
+        bb=b.split(".")
+        last_pos=((aa.length > bb.length) ? aa.length : bb.length)-1
+        pos=0
+        while aa[pos].to_i==bb[pos].to_i
+          break if pos>=last_pos
+          pos+=1
+        end
+        (aa[pos].to_i<=>bb[pos].to_i)
+      end
+      sorted.last
+    end
   end
 
 
@@ -251,7 +346,13 @@ class ZabbixAPI_Base
   def valid_params(sym,ver=nil)
     api_method=self.class.api_methods[sym]
     return nil if api_method.nil?
-    api_method.valid_params(ver)
+    api_method.get_valid_params(ver)
+  end
+
+  def required_params(sym,ver=nil)
+    api_method=self.class.api_methods[sym]
+    return nil if api_method.nil?
+    api_method.get_required_params(ver)
   end
 
   def self.method_missing(sym,&block)

data/api_classes/dsl_host.rb

@@ -27,44 +27,50 @@ class Host < ZabbixAPI_Base
     #  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",
-                             "selectInterfaces","select_macros","select_profile","countOutput","groupOutput",
-                             "preservekeys","sortfield","sortorder","limit","extendoutput"]
-    add_valid_params "2.0", ["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",
-                             "selectInterfaces","select_macros","select_profile","countOutput",
-                             "groupOutput", "preservekeys","sortfield","sortorder","limit",
-                             "extendoutput"]
+    parameters "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",
+           "selectInterfaces","select_macros","select_profile","countOutput",
+           "groupOutput","preservekeys","sortfield","sortorder","limit",
+           "extendoutput"
+
+    parameters "2.0" do
+      inherit from "1.3"
+    end
+
+    #parameters "3.0" do
+    #  inherit from "2.0"
+    #  remove "select_macros","preserve_keys","extendoutput"
+    #  add "test_param"
+    #  requires "test_param"
+    #end
   end
 
   action :exists do
-    add_valid_params "1.3", ["nodeids","hostid","host"]
+    parameters "1.3" do
+      add "nodeids","hostid","host"
+    end
   end
 
   action :create do
-    add_valid_params "1.3", ["host","name","port","status","useip",
-                             "dns","ip","proxy_hostid","useipmi","ipmi_ip","ipmi_port",
-                             "ipmi_authtype","ipmi_privilege","ipmi_username",
-                             "ipmi_password","groups","templates"]
-    add_valid_params "2.0", ["host","name","port","status","useip",
-                             "dns","ip","proxy_hostid","useipmi","ipmi_ip","ipmi_port",
-                             "ipmi_authtype","ipmi_privilege","ipmi_username",
-                             "ipmi_password","groups","templates","interfaces"]
+    parameters "1.3" do
+      add "host","name","port","status","useip","dns","ip","proxy_hostid",
+           "useipmi","ipmi_ip","ipmi_port","ipmi_authtype","ipmi_privilege",
+           "ipmi_username","ipmi_password","groups","templates"
+      requires "groups","interfaces"
+    end
+
+    parameters "2.0" do
+      inherit from "1.3"
+      add "interfaces"
+    end
   end
 
   action :delete do

data/api_classes/dsl_trigger.rb

@@ -35,14 +35,15 @@ Trigger.delete
 Trigger.deleteDependencies
 Trigger.exists
 Trigger.get do
-  add_valid_params "1.3", ['triggerids', "select_functions", "nodeids", "groupids", "templateids",
+  parameters "1.3",
+      'triggerids', "select_functions", "nodeids", "groupids", "templateids",
       "hostids", "itemids", "applicationids", "functions", "inherited", "templated", "monitored",
       "active", "maintenance", "withUnacknowledgedEvents", "withAcknowledgedEvents",
       "withLastEventUnacknowledged", "skipDependent", "editable", "lastChangeSince",
       "lastChangeTill", "filter", "group", "host", "only_true", "min_severity", "search",
       "startSearch", "excludeSearch", "searchWildcardsEnabled", "output", "expandData",
       "expandDescription", "select_groups", "select_hosts", "select_items", "select_dependencies",
-      "countOutput", "groupOutput", "preservekeys", "sortfield", "sortorder", "limit"]
+      "countOutput", "groupOutput", "preservekeys", "sortfield", "sortorder", "limit"
 end
 Trigger.update
 

data/zbxapi.rb

@@ -340,6 +340,29 @@ class ZabbixAPI
     end
   end
 
+  def api_info(request=:objects,*options)
+    options = options[0] || {}
+    version=options[:version] || nil
+    request_type=options[:params] || :valid
+
+    case request
+      when :objects then
+        @objects.keys.map { |k| k.to_s }
+      else
+        obj,meth=request.split(".")
+        if meth then
+          case request_type
+            when :valid
+              @objects[obj.intern].valid_params(meth.intern,version)
+            when :required
+              @objects[obj.intern].required_params(meth.intern,version)
+          end
+        else
+          @objects[obj.intern].api_methods.map{ |m| m.to_s }
+        end
+    end
+  end
+
   private
 
   #Select the http object to be used.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zbxapi
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-13 00:00:00.000000000 Z
+date: 2013-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json