zenoss_client 0.0.3 → 0.0.4

data/README.rdoc

@@ -16,19 +16,13 @@ Gems:
 * tzinfo: For Python DateTime to Ruby DateTime conversion
 
 
-Zenoss Event Information:
+== UNSUPPORTED REST METHODS:
+Some methods within Zope are unsupported due to type conversion issues.
+I have created a work-around but you must add a custom Python script
+to Zope in order to do this.  Please see this blog post for information
+on how add the custom script:
 
-If you want to access Zenoss event information via REST you may need the
-following patch.  The methods Zenoss::Model::EventView#get_status_img_src and
-EventView#get_status_css_class depend on the 'status' parameter being an
-integer. When the call is unmarshalled on the Zenoss side it is always a
-string unless you apply this patch:
-
-http://gist.github.com/328414
-
-This has been reported and is filed as a product defect:
-
-http://dev.zenoss.com/trac/ticket/6282
+http://distributed-frostbite.blogspot.com/2010/04/using-ruby-with-zenoss-part-1.html
 
 
 == TO USE:

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/model/devices/device.rb

@@ -22,6 +22,7 @@ module Zenoss
     class Device
       include Zenoss::Model
       include Zenoss::Model::EventView
+      include Zenoss::Model::RRDView
       include Zenoss::Model::DeviceResultInt
 
       attr_reader :path, :device, :os, :hw

data/lib/model/devices/device_class.rb

@@ -55,13 +55,23 @@ module Zenoss
 
       # Name of the device in Zenoss.  This method will return the first
       # match if the device_name is not fully qualified.
+      #
+      # @param [String] device_name the hostname of the device
+      # @return [Device,nil] Device object of passed hostname or nil if the device doesn't exist
       def find_device_path(device_name)
         devpath = rest("findDevicePath?devicename=#{device_name}")
-        return Device.new(devpath)
+        devpath.nil? ? nil : Device.new(devpath)
       end
 
+      # @return [Array<Device>] an Array of Devices (or some Device subclass)
       def get_sub_devices
-        plist_to_array( rest('getSubDevices') )
+        (plist_to_array( rest('getSubDevices') )).map do |dstr|
+          # I'm using this regex here so some day we can generate
+          # Devices and sub Device types with an eval like so:
+          # eval "#{$1}.new(#{$2})"
+          dev = dstr.sub(/^<([\w]+)\s+at\s+(.*)>$/,'\2')
+          Device.new(dev)
+        end
       end
 
 

data/lib/model/event_view.rb

@@ -1,23 +1,22 @@
 #############################################################################
-# Copyright © 2009 Dan Wanek <dwanek@nd.gov>
+# Copyright © 2010 Dan Wanek <dwanek@nd.gov>
 #
 #
-# This file is part of Zenoss-RubyREST.
+# This file is part of zenoss_client.
 # 
-# Zenoss-RubyREST is free software: you can redistribute it and/or
+# 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-RubyREST is distributed in the hope that it will be useful,
+# 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-RubyREST.  If not, see <http://www.gnu.org/licenses/>.
+# with zenoss_client.  If not, see <http://www.gnu.org/licenses/>.
 #############################################################################
-
 module Zenoss
   module Model
     module EventView
@@ -40,7 +39,7 @@ module Zenoss
       # need to apply this patch to Zenoss:
       # http://gist.github.com/328414
       def get_status_img_src(status_number)
-        rest("getStatusImgSrc?status=#{status_number}")
+        custom_rest("getStatusImgSrc?status=#{status_number}")
       end
 
       # Fetches the css class for this status number.  This is usually the
@@ -48,7 +47,7 @@ module Zenoss
       # need to apply this patch to Zenoss:
       # http://gist.github.com/328414
       def get_status_css_class(status_number)
-        rest("getStatusCssClass?status=#{status_number}")
+        custom_rest("getStatusCssClass?status=#{status_number}")
       end
 
     end # EventView

data/lib/model/model.rb

@@ -46,6 +46,7 @@ module Zenoss
 end # Zenoss
 
 require 'model/event_view'
+require 'model/rrd_view'
 
 # Device Loader interface.  You can use it directly or use the
 # utility methods in DeviceClass to create devices beneath

data/lib/model/rrd/rrd_data_point.rb

@@ -0,0 +1,56 @@
+#############################################################################
+# 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
+    class RRDDataPoint
+      include Zenoss
+      include Zenoss::Model
+
+      def initialize(datapoint_path)
+        @path = datapoint_path
+
+        # Initialize common things from Model
+        model_init
+      end
+
+      # ------------------------- Utility Methods ------------------------- #
+      # These are methods that do not exist as part of the official Zenoss
+      # API, but from an object model they seem to make sense to me.
+      # ------------------------------------------------------------------- #
+
+
+
+      # --------------------------- REST Methods -------------------------- #
+
+      # @return [String] Name of the data source
+      def name
+        @cache_vars[:name] ||= rest('name')
+      end
+
+
+      private
+
+      def rest(method, path = "#{@path}")
+        super("#{path}/#{method}")
+      end
+
+    end # DeviceClass
+  end # Model
+end # Zenoss

data/lib/model/rrd_view.rb

@@ -0,0 +1,46 @@
+#############################################################################
+# 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 RRDView
+      include Zenoss::Model
+
+      # @return [Array] of datapoints
+      def get_rrd_data_points
+        (plist_to_array( custom_rest('getRRDDataPoints') )).map do |dstr|
+          dp = dstr.sub(/^<([\w]+)\s+at\s+(.*)>$/,'\2')
+          RRDDataPoint.new(dp)
+        end
+      end
+
+      # Get key/value pairs of RRD Values for the passed data source names.
+      #
+      # @param [Array <String>] dsnames data source names from RRDDataPoint#name
+      # @return [Hash] key/value pairs of data source name and data source values
+      def get_rrd_values(dsnames)
+        pdict_to_hash(custom_rest("getRRDValues?dsnames=[#{dsnames.join(',')}]"))
+      end
+
+    end # RRDView
+  end # Model
+end # Zenoss
+
+# Load the RRD related files
+require 'model/rrd/rrd_data_point'

data/lib/zenoss.rb

@@ -25,6 +25,9 @@ require 'uri'
 module Zenoss
 
   # Set the Base URI of the Zenoss server
+  #
+  # @param [URI, String] uri is the URL we use to connect to the Zenoss server
+  # @return [URI] the URI that was parsed and used as our base connection
   def Zenoss.uri(uri)
     if(uri.kind_of?(URI))
       uri.path << '/' unless(uri.path.index /\/$/)
@@ -35,23 +38,26 @@ module Zenoss
     end
   end
 
+  # @param [String] user
+  # @param [String] pass
+  # @return [Boolean]
   def Zenoss.set_auth(user, pass)
     const_set(:USER, user)
     const_set(:PASS, pass)
     true
   end
 
-  # Return the base DeviceClass /zport/dmd/Devices
+  # @return [Model::DeviceClass] the base DeviceClass /zport/dmd/Devices
   def Zenoss.devices
     Model::DeviceClass.new('/zport/dmd/Devices')
   end
 
-  # Return the base ServiceOrganizer /zport/dmd/Services
+  # @return [Model::ServiceOrganizer] the base ServiceOrganizer /zport/dmd/Services
   def Zenoss.services
     Model::ServiceOrganizer.new('/zport/dmd/Services')
   end
 
-  # Return the base System /zport/dmd/Systems
+  # @return [Model::System] the base System /zport/dmd/Systems
   def Zenoss.systems
     Model::System.new('/zport/dmd/Systems')
   end
@@ -61,25 +67,75 @@ module Zenoss
   private
 
   # Prepend the appropriate path and call the REST method on the URL set with Zenoss#uri
+  #
+  # @param [String] req_path the request path of the REST method
+  # @return [String] the response body of the REST call
   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}")
       req.basic_auth USER, PASS if USER
       response = http.request(req)
+      response.body.chomp! unless response.body.nil?
       return(response.body)
     }
   end
 
+  # Call a custom Zope method to work around some issues of unsupported or bad behaving
+  # REST methods.
+  # @see http://gist.github.com/343627 for more info.
+  #
+  # @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']
+  # @return [String] the response body of the REST call
+  def custom_rest(req_path)
+    meth,args = req_path.split('?')
+    meth = "callZenossMethod?methodName=#{meth}"
+    unless args.nil?
+      meth << '&args=['
+      # 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|
+        meth << "#{delim}#{arg.split('=').last}"
+        delim = ',' if delim.nil?
+      end
+      meth << ']'
+    end
+    rest(meth)
+  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.
+  #
+  # @param [String] list a Python formatted list
+  # @return [Array,nil] a bonafide Ruby Array
   def plist_to_array(list)
     return nil if list.nil?
+    list = sanitize_str(list)
     (list.gsub /[\[\]]/,'').split /,\s+/
   end
 
+  # Converts a String formatted like a Python Dictionary to a Ruby Hash.
+  #
+  # @param [String] dict a Python dictionary
+  # @return [Hash,nil] a Ruby Hash
+  def pdict_to_hash(dict)
+    return nil if dict.nil?
+    puts "Dict: #{dict}"
+    dict = sanitize_str(dict)
+    puts "New Dict: #{dict}"
+    dict = dict.sub(/^\{(.*)\}$/,'\1').split(/[,:]/).map do |str|
+      str.strip
+    end
+    Hash[*dict]
+  end
+
   # Converts a String in Python's DateTime format to Ruby's DateTime format
   # If the pdt parameter is nil the return value is also nil.
+  #
+  # @param [String] pdt a String formatted in Python's DateTime format
+  # @return [DateTime] a bonafide Ruby DateTime object
   def pdatetime_to_datetime(pdt)
     return nil if pdt.nil?
     pdt = pdt.split(/\s+/)
@@ -87,6 +143,14 @@ module Zenoss
     DateTime.strptime("#{pdt[0]} #{pdt[1]} #{tz.current_period.abbreviation.to_s}", '%Y/%m/%d %H:%M:%S.%N %Z')
   end
 
+  # Do some clean-up on the string returned from REST calls.  Removes some
+  # quote characters embedded in the string and other misc.
+  #
+  # @param [String] str string returned from REST call
+  # @return [String] sanitized string
+  def sanitize_str(str)
+    str.gsub(/['"]/,'')
+  end
 
 end # Zenoss
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Dan Wanek
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-29 00:00:00 -05:00
+date: 2010-04-07 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -54,6 +54,8 @@ files:
 - lib/model/manufacturers/manufacturers.rb
 - lib/model/model.rb
 - lib/model/processes/os_process_organizer.rb
+- lib/model/rrd/rrd_data_point.rb
+- lib/model/rrd_view.rb
 - lib/model/services.rb
 - lib/model/services/ip_service.rb
 - lib/model/services/service.rb