zbxapi 0.3.9 → 0.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38a9412b166183c0bd43d087a9aaa9a5ad87b81e
-  data.tar.gz: 5fcd9d06059a7c9c66fc67e4c7daf6dde306e57a
+  metadata.gz: da5d57c042b37dff4802268848d2d82d54ad42f5
+  data.tar.gz: a66f80df000a511614d832c579c9f5652f882c34
 SHA512:
-  metadata.gz: 31ff6131737c3746f8f02e5a4f189407d459070c307a7d5a5abdb7f7a24bb3ca3321222e4d36c8bc2c55c59e9ef496d07f0fdd4f079b6f50d9958a1706a3ef44
-  data.tar.gz: 6ec95b61956ef2f18a08a3b03c5fb9395bb9f70bc77e7910d0e96b3b61a98e74ba8a3c1769b92c43adef615ff7e6edcc86e4caa710331c9e2da90e3a9f250d4e
+  metadata.gz: 2fb0555b68e9adc08accb98ec5ac3ce75a574d5223f97026e5e03464fa6069943533836756fbe624f04a6b803dfe4ccbf0c8b2e10d2aaf61300dc3397c2872bd
+  data.tar.gz: 86dc9f211ece6963fcc2f8c1397b5ff4ccf1d6876b73a26fd6e28a1e69f9d239d6bb591940b23032f4d21b5ca35ba065fdb41d746d4ab000ed1bc9b79276cda6

data/api_classes/api_dsl.rb

@@ -29,6 +29,9 @@ require "zbxapi/exceptions"
 require "pp"
 
 class ZabbixAPI_ParametersDSL
+  class InvalidRequiredParameter<RuntimeError
+  end
+
   attr_reader :valid_params, :required_params
 
   def initialize(other_validparams,other_requiredparams)
@@ -38,27 +41,70 @@ class ZabbixAPI_ParametersDSL
     @required_params=[]
   end
 
+  #Inherit the valid and required parameters from the version string ver
   def inherit(ver)
     @valid_params=@other_valid_parameters[ver] || []
     @required_params=@other_required_parameters[ver] || []
   end
 
   def add(*params)
+    location=caller.select {|i| i=~/api_classes\/dsl/}.first.split(":")[0..1].join(":")
+    #Iterate through the parameters and check to see if it's in the valid parameters list
+    #and check to see if it's been given before.
+    params.delete_if do |param|
+      if @valid_params.include? param
+        warn("Parameter '#{param}' is already a valid parameter, skipping: #{location}")
+        true
+      else
+        false
+      end
+    end
     @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
+    @required_params-=params
   end
 
+  #Function to provide some syntactic sugar for the DSL
   def from(var)
     var
   end
 
+  #Set the list of required parameters to the parameter list
+  def set_requires(*params)
+    location=caller.select {|i| i=~/api_classes\/dsl/}.first.split(":")[0..1].join(":")
+    #Iterate through the parameters and check to see if it's in the valid parameters list
+    #and check to see if it's been given before.
+    params.each do |param|
+      if !@valid_params.include? param
+        raise InvalidRequiredParameter.new("Parameter '#{param}' is not in the valid list of parameters: #{location}")
+      end
+    end
+
+    @required_params=params
+    @required_params.flatten!
+  end
+
+  #Append the parameters given to the required parameters list.
   def requires(*params)
-    #TODO Add sanity checking to ensure that required arguments are also valid arguments
+    location=caller.select {|i| i=~/api_classes\/dsl/}.first.split(":")[0..1].join(":")
+    #Iterate through the parameters and check to see if it's in the valid parameters list
+    #and check to see if it's been given before.
+    params.delete_if do |param|
+      if !@valid_params.include? param
+        raise InvalidRequiredParameter.new("Parameter '#{param}' is not in the valid list of parameters: #{location}")
+      end
+      if @required_params.include? param
+        warn("Parameter '#{param}' is already a required parameter, skipping: #{location}")
+        true
+      else
+        false
+      end
+    end
+
     @required_params+=params
     @required_params.flatten!
   end
@@ -376,14 +422,17 @@ class ZabbixAPI_Base
     @api_aliases
   end
 
-  def self.alias(from,to)
+  # Define an alias for an existing method.
+  # From: the new method name
+  # To: the existing method which the alias "from" will point to
+  def self.api_alias(from,to)
     @api_aliases={} if @api_aliases.nil?
     @api_aliases[from]=to
 
-    @api_methods[to]=@api_methods[from]
+    @api_methods[from]=@api_methods[to]
 
-    define_method(to) do |params|
-      self.class.api_methods[to].do(@server,params)
+    define_method(from) do |params|
+      self.class.api_methods[from].do(@server,params)
     end
   end
 

data/api_classes/dsl_host.rb

@@ -90,15 +90,17 @@ class Host < ZabbixAPI_Base
     end
 
     parameters "2.4" do
-      add "hostid","host","available","description","disable_until","error",
-      "errors_from","flags","ipmi_authtype","ipmi_available",
-      "ipmi_disable_until","ipmi_error","ipmi_errors_from","ipmi_password",
-      "ipmi_privilege","ipmi_username","jmx_available","jmx_disable_until",
-      "jmx_error","jmx_errors_from","maintenance_from","maintenance_status",
-      "maintenance_type","maintenanceid","name","proxy_hostid","snmp_available",
-      "snmp_disable_until","snmp_error","snmp_errors_from","status"
-      requires "host","groups","interfaces"
+      inherit from "2.0"
+      add "hostid","available","description","disable_until","error","errors_from",
+          "flags","inventory","ipmi_available","ipmi_disable_until","ipmi_error",
+          "ipmi_errors_from","jmx_available","jmx_disable_until","jmx_error",
+          "jmx_errors_from","maintenance_from","maintenance_status",
+          "maintenance_type","maintenanceid","snmp_available","snmp_disable_until",
+          "snmp_error","snmp_errors_from"
+      remove "dns","ip","ipmi_ip","port","useip","useipmi"
+      requires "host"
     end
+
   end
 
   action :delete do
@@ -131,7 +133,7 @@ class Host < ZabbixAPI_Base
 
   action :update do
     parameters "2.4" do
-      add "hostid","host","available","description","disable_until","error",
+      add "host","hostid","host","available","description","disable_until","error",
       "errors_from","flags","ipmi_authtype","ipmi_available",
       "ipmi_disable_until","ipmi_error","ipmi_errors_from","ipmi_password",
       "ipmi_privilege","ipmi_username","jmx_available","jmx_disable_until",
@@ -144,7 +146,7 @@ class Host < ZabbixAPI_Base
 
   action :massupdate do
     parameters "2.4" do
-      add "hostid","host","available","description","disable_until","error",
+      add "hostid","host","hosts","available","description","disable_until","error",
       "errors_from","flags","ipmi_authtype","ipmi_available",
       "ipmi_disable_until","ipmi_error","ipmi_errors_from","ipmi_password",
       "ipmi_privilege","ipmi_username","jmx_available","jmx_disable_until",
@@ -155,7 +157,7 @@ class Host < ZabbixAPI_Base
     end
   end
 
-  alias :massAdd :massadd
-  alias :massRemove :massremove
-  alias :massUpdate :massupdate
+  api_alias :massAdd, :massadd
+  api_alias :massRemove, :massremove
+  api_alias :massUpdate, :massupdate
 end

data/zbxapi.rb

@@ -195,10 +195,15 @@ class ZabbixAPI
         'id'=>@id
       }
 
+    # https://www.zabbix.com/documentation/2.4/manual/api/reference/apiinfo/version
+    # https://www.zabbix.com/documentation/2.4/manual/api/reference/user/login
     # Zabbix Doc(2.4): This method is available to unauthenticated
     #  users and must be called without the auth parameter
     #  in the JSON-RPC request.
-    obj.delete("auth") if method =~ /APIInfo/i
+    debug(4, :var => method,:msg => "Method:")
+    obj.delete("auth") if ["apiinfo.version",
+                           "user.login",
+                          ].any? { |str| method =~ /#{str}/i }
 
     debug(10, :msg=>"json_obj:  #{obj}")
     return obj.to_json

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zbxapi
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.3.10
 platform: ruby
 authors:
 - A. Nelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-03 00:00:00.000000000 Z
+date: 2014-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -39,29 +39,29 @@ files:
 - zbxapi/utils.rb
 - zbxapi/result.rb
 - api_classes/api_dsl.rb
-- api_classes/dsl_alert.rb
-- api_classes/dsl_dhost.rb
+- api_classes/dsl_action.rb
 - api_classes/dsl_event.rb
-- api_classes/dsl_graph.rb
+- api_classes/dsl_alert.rb
 - api_classes/dsl_user.rb
 - api_classes/dsl_drule.rb
+- api_classes/dsl_host.rb
+- api_classes/dsl_trigger.rb
+- api_classes/dsl_dcheck.rb
+- api_classes/dsl_history.rb
+- api_classes/dsl_mediatype.rb
 - api_classes/dsl_hostgroup.rb
+- api_classes/dsl_usermedia.rb
 - api_classes/dsl_dservice.rb
-- api_classes/dsl_usergroup.rb
-- api_classes/dsl_template.rb
+- api_classes/dsl_item.rb
 - api_classes/dsl_proxy.rb
-- api_classes/dsl_usermedia.rb
-- api_classes/dsl_hostinterface.rb
-- api_classes/dsl_action.rb
+- api_classes/dsl_template.rb
 - api_classes/dsl_maintenance.rb
-- api_classes/dsl_item.rb
-- api_classes/dsl_history.rb
-- api_classes/dsl_dcheck.rb
-- api_classes/dsl_trigger.rb
+- api_classes/dsl_dhost.rb
 - api_classes/dsl_configuration.rb
+- api_classes/dsl_usergroup.rb
+- api_classes/dsl_hostinterface.rb
 - api_classes/dsl_usermacro.rb
-- api_classes/dsl_mediatype.rb
-- api_classes/dsl_host.rb
+- api_classes/dsl_graph.rb
 homepage: https://github.com/red-tux/zbxapi
 licenses:
 - LGPL 2.1
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Requires json
 rubyforge_project: zbxapi
-rubygems_version: 2.0.14
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper to the Zabbix API