zenoss_client 0.0.4 → 0.1.0

data/README.rdoc

@@ -24,6 +24,8 @@ on how add the custom script:
 
 http://distributed-frostbite.blogspot.com/2010/04/using-ruby-with-zenoss-part-1.html
 
+UPDATE: The script itself is now part of the source tree and can be found here: tools/callZenossMethod.py
+It should still be installed in the same fashion as the blog post steps through.
 
 == TO USE:
 A gem is now available.  'gem install zenoss_client'
@@ -49,5 +51,8 @@ A gem is now available.  'gem install zenoss_client'
 	# Get the uptime of the device
 	dev.sys_uptime
 
+  # Get a list of events for this system
+  dev.get_events
+
 
 Have fun and let me know what needs to be fixed / added.

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.1.0

data/lib/events/event.rb

@@ -0,0 +1,35 @@
+#############################################################################
+# Copyright © 2010 Dan Wanek <dwanek@nd.gov>
+#
+#
+# This file is part of zenoss_client.
+# 
+# zenoss_client is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+# 
+# zenoss_client 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 General
+# Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with zenoss_client.  If not, see <http://www.gnu.org/licenses/>.
+#############################################################################
+
+module Zenoss
+  module Event
+    class Event
+      include Zenoss
+      def initialize(event_hash)
+        event_hash.each_pair do |key,value|
+          instance_variable_set("@#{key}",value)
+          self.class.send(:define_method, key, proc { instance_variable_get("@#{key}")})
+        end
+      end
+    end # Event
+  end # Event
+end # Zenoss
+
+require 'events/zevent'

data/lib/events/zevent.rb

@@ -0,0 +1,29 @@
+#############################################################################
+# Copyright © 2010 Dan Wanek <dwanek@nd.gov>
+#
+#
+# This file is part of zenoss_client.
+# 
+# zenoss_client is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+# 
+# zenoss_client 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 General
+# Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with zenoss_client.  If not, see <http://www.gnu.org/licenses/>.
+#############################################################################
+
+module Zenoss
+  module Event
+    class ZEvent < Event
+      include Zenoss
+      include Zenoss::Event
+
+    end # ZEvent
+  end # Event
+end # Zenoss

data/lib/model/devices/device.rb

@@ -40,6 +40,16 @@ module Zenoss
         model_init
       end
 
+
+      # ------------------ Custom REST Calls ------------------ #
+      # These are not part of the official Zenoss API
+
+      def get_events
+        get_event_manager.get_event_list(nil,"device='#{@device}'")
+      end
+
+
+
       # ------------------ REST Calls ------------------ #
 
       # Move this Device to the given DeviceClass.

data/lib/model/event_view.rb

@@ -21,8 +21,16 @@ module Zenoss
   module Model
     module EventView
 
+      # ------------------ REST Calls ------------------ #
+
       def get_event_history
-        rest('getEventHistory')
+        #rest('getEventHistory')
+        get_event_manager('history')
+      end
+
+      def get_event_manager(table='status')
+        manager = rest("getEventManager?table=#{table}")
+        Model::Events::MySqlEventManager.new(manager.sub(/.* at (.*)>$/,'\1'))
       end
 
       # Fetches that status number for this device or component

data/lib/model/events/event_manager_base.rb

@@ -0,0 +1,66 @@
+#############################################################################
+# Copyright © 2010 Dan Wanek <dwanek@nd.gov>
+#
+#
+# This file is part of zenoss_client.
+# 
+# zenoss_client is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+# 
+# zenoss_client 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 General
+# Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with zenoss_client.  If not, see <http://www.gnu.org/licenses/>.
+#############################################################################
+require 'uri'
+module Zenoss
+  module Model
+    module Events
+      class EventManagerBase
+        include Zenoss::Model
+
+        def initialize(manager_base)
+          @manager = manager_base.sub(/^(\/zport\/dmd\/)?([^\/]+)$/,'\2')
+
+          # Initialize common things from Model
+          model_init
+        end
+
+
+        # ------------------ REST Calls ------------------ #
+
+        def get_event_list(resultFields=nil, where=nil, orderby=nil, severity=nil, state=2, startdate=nil, enddate=nil, offset=0, rows=0, get_total_count=false, filter=nil, filters=nil)
+          method = "getEventList?"
+          method << (resultFields.nil? ? "None&" : "#{resultFields.join(',')}&")
+          method << (where.nil? ? "&" : URI.encode(where,'='))
+          events = []
+          (parse_array(custom_rest(method, 'getEventFields'))).each do |event|
+            events << Zenoss::Event::ZEvent.new(Hash[event])
+          end
+          events
+        end
+
+        # Parameters:
+        # * evid (string) - Event ID
+        # * dedupid (string) - string used to determine duplicates
+        # * better (boolean) - provide even more detail than normal?
+        # Returns: EventDetail object fields from the event 
+        def get_event_detail(evid=nil, dedupid=nil, better=false)
+        end
+
+
+        private
+
+        def rest(method)
+          super("#{@manager}/#{method}")
+        end
+
+      end # EventManagerBase
+    end # Events
+  end # Model
+end # Zenoss

data/lib/model/events/mysql_event_manager.rb

@@ -0,0 +1,36 @@
+#############################################################################
+# Copyright © 2010 Dan Wanek <dwanek@nd.gov>
+#
+#
+# This file is part of zenoss_client.
+# 
+# zenoss_client is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+# 
+# zenoss_client 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 General
+# Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with zenoss_client.  If not, see <http://www.gnu.org/licenses/>.
+#############################################################################
+module Zenoss
+  module Model
+    module Events
+      class MySqlEventManager < EventManagerBase
+        include Zenoss::Model
+
+        def initialize(manager_base)
+          super(manager_base)
+        end
+
+
+        # ------------------ REST Calls ------------------ #
+
+      end # MySqlEventManager
+    end # Events
+  end # Model
+end # Zenoss

data/lib/model/model.rb

@@ -56,6 +56,10 @@ require 'model/z_device_loader'
 # Device Related ( /zport/dmd/Devices )
 require 'model/devices'
 
+# Event Related
+require 'model/events/event_manager_base'
+require 'model/events/mysql_event_manager'
+
 # Service Related ( /zport/dmd/Services )
 require 'model/services'
 

data/lib/zenoss.rb

@@ -73,6 +73,7 @@ module Zenoss
   def rest(req_path)
     Net::HTTP.start(Zenoss::BASE_URI.host,Zenoss::BASE_URI.port) {|http|
       req = Net::HTTP::Get.new("#{BASE_URI.path}#{req_path}")
+      puts "Request: #{BASE_URI.path}#{req_path}"
       req.basic_auth USER, PASS if USER
       response = http.request(req)
       response.body.chomp! unless response.body.nil?
@@ -87,8 +88,10 @@ module Zenoss
   # @param [String] req_path the request path of the REST method ( as if it wasn't misbehaving )
   #   @example req_path
   #     getRRDValues?dsnames=['ProcessorTotalUserTime_ProcessorTotalUserTime','MemoryPagesOutputSec_MemoryPagesOutputSec']
+  # @param [String] callback_func the name of the function to be called on the returned object before giving it back to Ruby
+  # @param [String] callback_attr the name of the attribute to fetch on the returned object before giving it back to Ruby
   # @return [String] the response body of the REST call
-  def custom_rest(req_path)
+  def custom_rest(req_path,callback_func = nil, callback_attr=nil)
     meth,args = req_path.split('?')
     meth = "callZenossMethod?methodName=#{meth}"
     unless args.nil?
@@ -96,11 +99,15 @@ module Zenoss
       # Remove the named parameters because we can't dynamically call named parameters in Python.
       # This method uses positional parameters via the passed Array (Python List).
       args.split('&').inject(nil) do |delim,arg|
+        arg.gsub!(/'/, "'''") # This may cause problems if the passed argument is already triple quoted.
         meth << "#{delim}#{arg.split('=').last}"
-        delim = ',' if delim.nil?
+        delim = '===' if delim.nil?
       end
       meth << ']'
     end
+    meth << "&filterFunc=#{callback_func}" unless callback_func.nil?
+    meth << "&filterAttr=#{callback_attr}" unless callback_attr.nil?
+    puts "METHOD: #{meth}"
     rest(meth)
   end
 
@@ -116,6 +123,49 @@ module Zenoss
     (list.gsub /[\[\]]/,'').split /,\s+/
   end
 
+  # Some of the REST methods return Strings that are formated like a Python list.
+  # This method turns that String into a Ruby Array.
+  # If the list parameter is nil the return value is also nil.
+  # WARNING: This will soon supersede #plist_to_array
+  #
+  # @param [String, Array] list a Python formatted list or Array of chars
+  # @param [Boolean] first a flag that tells whether this is a recursive call or not
+  # @return [Array,nil] a bonafide Ruby Array
+  def parse_array(list, first = true)
+    return nil if list.nil?
+    open = false
+    narray = []
+    list = list.chars.to_a unless list.is_a?(Array)
+    while( token = list.shift )
+      case token
+      when /[\[\(]/
+        open = true
+        if(first)
+          narray = parse_array(list, false)
+        else
+          narray << parse_array(list, false)
+        end
+      when /[\]\)]/ 
+        open = false
+        return narray
+      when /["']/
+        qtype = token
+        tokenstr = ''
+        while( (token = list.shift) !~ /#{qtype}/ )
+          tokenstr << token
+        end
+        narray << tokenstr
+      when /\d/
+        while( list[0] =~ /\d/ )
+          token << list.shift
+        end
+      narray << token.to_i
+      end
+    end
+
+    narray
+  end
+
   # Converts a String formatted like a Python Dictionary to a Ruby Hash.
   #
   # @param [String] dict a Python dictionary
@@ -143,6 +193,16 @@ module Zenoss
     DateTime.strptime("#{pdt[0]} #{pdt[1]} #{tz.current_period.abbreviation.to_s}", '%Y/%m/%d %H:%M:%S.%N %Z')
   end
 
+  # This takes an array of two element Python tuples and turns it into a
+  # Ruby hash.
+  #
+  # @param [Array] tuple_array an Array of Strings formatted like two-element Python tuples
+  # @return [Hash] a Ruby hash of key-value pairs taken from the tuple argument
+  def ptuples_to_hash(tuple_array)
+    tuple_array.each do |tuple|
+    end
+  end
+
   # Do some clean-up on the string returned from REST calls.  Removes some
   # quote characters embedded in the string and other misc.
   #
@@ -155,3 +215,4 @@ module Zenoss
 end # Zenoss
 
 require 'model/model'
+require 'events/event'

data/tools/callZenossMethod.py

@@ -0,0 +1,151 @@
+# This code is a bit verbose because unfortunately I cannot get the 're' module to work
+# in Zope. For some reason it keeps redirecting me to the login page when I try and use it.
+
+# This script depends on the user passing a parameter called "methodName" which maps to a
+# Zenoss method to be called. It also depends on a parameter called "args" which is passed
+# in the form of an array so we can position the arguments to the method correctly. This
+# is done because I could not find a way to use named parameters when the names themselves
+# are dynamic.
+# How to pass arguments:
+# * make sure no spaces exist in your argument list or your browser won't pass them correctly
+# * Use '===' to delimit multiple arguments to "args"
+# * To embed quotes use a triple quote.  ''' or """
+#
+# There is now basic support for callbacks.  If you want to get an attribute of an object
+# like object.id, set 'id' as the filterAttr:
+#   * filterAttr=id
+# or if it is a function like object.getName() set the filterFunc:
+#   * filterFunc=getName
+#
+# Example method call:
+# http://zenoss1:8080/zport/dmd/Devices/Server/Windows/WMI/server1/callZenossMethod?methodName=getRRDValues&args=[['ProcessorTotalUserTime_ProcessorTotalUserTime','MemoryPagesOutputSec_MemoryPagesOutputSec']]
+
+request = container.REQUEST
+
+# ---------------- Conversion Methods ----------------
+# Convert "item" to an appropriate type. This really only handles
+# floats, ints, None, True/False, and strings at this time.
+# This is for use in map calls
+def convertType(item):
+  if(item.count('.') == 1):
+    items = item.split('.')
+    if(items[0].isdigit() and items[1].isdigit()):
+      return float(item)
+    else:
+      return item
+  elif(item.isdigit()):
+    return int(item)
+  elif(item == 'None'):
+    return None
+  elif(item == 'True'):
+    return True
+  elif(item == 'False'):
+    return False
+  else: # Assuming the item is a string
+    return item
+
+
+def convertToList(string, split_char = ','):
+  # This strange bit of confusion allows us to pass wanted quotes as arguments.  It first converts
+  # them to non-quote chars, replaces unwanted quotes, then converts them back to quotes.  An example
+  # of where this is needed is in EventManagerBase.getEventList() function.  It has an argument that
+  # is a SQL 'where' statement that needs the embedded quotes.
+  nstring = string.replace('"""','---').replace("'''","___")
+  nstring = nstring.replace('"','').replace("'","").replace(" ","")
+  nstring = nstring.replace('___',"'").replace('---','"')
+  if(nstring == "[]"):
+    return []
+  else:
+    return map(convertType, nstring[1:-1].split(split_char))
+
+
+def convertToTuple(string):
+  newtuple = convertToList(string)
+  return tuple(newtuple)
+
+
+def convertToDict(string):
+  # See convertToList() description of what is going on here.
+  nstring = string.replace('"""','---').replace("'''","___")
+  nstring = nstring.replace('"','').replace("'","").replace(" ","")
+  nstring = nstring.replace('___',"'").replace('---','"')
+  if(nstring == "{}"):
+    return {}
+  else:
+    return dict(map(convertType,item.split(':')) for item in nstring[1:-1].split(','))
+
+
+# -------------- End Conversion Methods --------------
+
+# ------------- Start Convenience Methods ------------
+
+def isList(item):
+  return same_type(item, [])
+
+def callFilterFunc(object):
+  return getattr(object, filterFunc)()
+
+def callFilterAttr(object):
+  return getattr(object, filterAttr)
+
+
+# -------------- End Convenience Methods -------------
+
+method = request.form['methodName']
+if( request.form.has_key('args') ):
+  args = convertToList(request.form['args'],"===")
+else:
+  args = []
+
+if(request.form.has_key('filterFunc')):
+  filterFunc = request.form['filterFunc']
+else:
+  filterFunc = False
+
+if(request.form.has_key('filterAttr')):
+  filterAttr = request.form['filterAttr']
+else:
+  filterAttr = False
+
+for ind in range(len(args)):
+  if( not isinstance(args[ind], str) ):
+    args[ind]
+  elif( args[ind].find('[') >= 0 ):
+    #print "found list", args[ind]
+    args[ind] = convertToList(args[ind])
+  elif( args[ind].find('(') >= 0 ):
+    #print "found tuple", args[ind]
+    args[ind] = convertToTuple(args[ind])
+  elif( args[ind].find('{') >= 0 ):
+    #print "found hash", args[ind]
+    args[ind] = convertToDict(args[ind])
+  else:
+    args[ind]
+    # Leave it as a string
+
+
+#print "Method: ", method
+#print "Args: ", args
+
+
+# Call the method
+if(len(args) > 0):
+  retval = getattr(context, method)(*args)
+else:
+  retval = getattr(context, method)()
+
+# Call callback functions if they were passed
+if(filterFunc):
+  if isList(retval):
+    print map(callFilterFunc, retval)
+  else:
+    print callFilterFunc(retval)
+elif(filterAttr):
+  if isList(retval):
+    print map(callFilterAttr, retval)
+  else:
+    print callFilterAttr(retval)
+else:
+  print retval
+
+return printed

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 4
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors: 
 - Dan Wanek
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-07 00:00:00 -05:00
+date: 2010-04-28 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,6 +44,8 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- lib/events/event.rb
+- lib/events/zevent.rb
 - lib/model/devices.rb
 - lib/model/devices/device.rb
 - lib/model/devices/device_class.rb
@@ -51,6 +53,8 @@ files:
 - lib/model/devices/operating_system.rb
 - lib/model/event_view.rb
 - lib/model/events/event_class.rb
+- lib/model/events/event_manager_base.rb
+- lib/model/events/mysql_event_manager.rb
 - lib/model/manufacturers/manufacturers.rb
 - lib/model/model.rb
 - lib/model/processes/os_process_organizer.rb
@@ -68,6 +72,7 @@ files:
 - lib/model/zenpack/zenpack_manager.rb
 - lib/zenoss.rb
 - preamble
+- tools/callZenossMethod.py
 has_rdoc: true
 homepage: http://github.com/zenchild/zenoss_client
 licenses: []