zenoss_client 0.0.1 → 0.0.2

data/{README.markdown → README.rdoc}

@@ -1,3 +1,5 @@
+= zenoss_client: A Ruby library for REST access to Zenoss
+
 This is a work-in-progress to create an easy to use client REST API for
 Zenoss (http://www.zenoss.com) written in Ruby.  I love Zenoss as a
 product, but I am much more efficient in Ruby than Python so I decided
@@ -8,9 +10,26 @@ Cheers,
 
 Dan Wanek
 
+== REQUIREMENTS:
+Gems:
+
+* tzinfo: For Python DateTime to Ruby DateTime conversion
+
+
+Zenoss Event Information:
+
+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
+
+
+== TO USE:
+A gem is now available.  'gem install zenoss_client'
 
-TO USE:
--------
 	require 'zenoss'
 
 	# You must set the URI before doing anything else
@@ -32,6 +51,5 @@ TO USE:
 	# Get the uptime of the device
 	dev.sys_uptime
 
----------
 
 Have fun and let me know what needs to be fixed / added.

data/Rakefile

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'rake/clean'
 require 'rake/gempackagetask'
+require 'rake/rdoctask'
 
 CLEAN.include("pkg")
 CLEAN.include("doc")
@@ -25,11 +26,11 @@ GEMSPEC = Gem::Specification.new do |gem|
   gem.files = `git ls-files`.split(/\n/)
   gem.require_path = "lib"
   gem.rdoc_options	= %w(-x wsdl/ -x test/ -x examples/)
-  gem.extra_rdoc_files = %w(README.markdown COPYING.txt)
+  gem.extra_rdoc_files = %w(README.rdoc COPYING.txt)
 
   gem.required_ruby_version	= '>= 1.8.7'
   gem.add_runtime_dependency  'tzinfo'
-  gem.post_install_message	= "See README.markdown"
+  gem.post_install_message	= "See README.rdoc"
 end
  
 Rake::GemPackageTask.new(GEMSPEC) do |pkg|
@@ -51,6 +52,11 @@ task :versionup do
 	puts "New version: #{ver}"
 end
 
+Rake::RDocTask.new do |rd|
+	rd.main = 'README.rdoc'
+	rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+end
+
 
 def up_min_version
 	f = File.open('VERSION', 'r+')

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/model/device.rb

@@ -20,62 +20,154 @@
 module Zenoss
   module Model
     class Device
-      include Zenoss
       include Zenoss::Model
+      include Zenoss::Model::EventView
 
-      @@zenoss_methods = []
-
-      zenoss_list( {:get_device_group_names => 'getDeviceGroupNames', :get_system_names => 'getSystemNames'} )
-      zenoss_datetime( {:get_last_change => 'getLastChange', :get_snmp_last_collection => 'getSnmpLastCollection' } )
-      zenoss_string( {:sys_uptime => 'sysUpTime', :get_hw_product_name => 'getHWProductName', :get_location_link => 'getLocationLink',
-                    :get_location_name => 'getLocationName', :get_data_for_json => 'getDataForJSON', :get_manage_ip => 'getManageIp',
-                    :get_performance_server_name => 'getPerformanceServerName', :get_ping_status_string => 'getPingStatusString',
-                    :get_pretty_link => 'getPrettyLink', :get_priority_string => 'getPriorityString',
-                    :get_production_state_string => 'getProductionStateString', :get_snmp_status_string => 'getSnmpStatusString',
-                    :uptime_str => 'uptimeStr'
-      } )
-
-      zenoss_int( {:get_priority => 'getPriority'} )
-
-      zenoss_boolean( {:monitor_device? => 'monitorDevice', :snmp_monitor_device? => 'snmpMonitorDevice' } )
-
+      attr_reader :path, :device, :os, :hw
 
       def initialize(device_path)
         device_path.sub(/^\/zport\/dmd\/(.*)\/([^\/]+)$/) do |m|
           @path = $1
           @device = $2
         end
+
+        @os = OperatingSystem.new(self)
+        @hw = DeviceHW.new(self)
       end
 
+      # ------------------ REST Calls ------------------ #
+
       # Instead of calling the /getId REST method, this method simply returns
       # the @device value since it is the same anyway.
       def get_id()
         @device
       end
 
-      # Return an array of implemented Zenoss REST methods
-      def zenoss_methods
-        @@zenoss_methods
+      def sys_uptime
+        rest("sysUpTime")
+      end
+
+      def get_hw_product_name
+        rest('getHWProductName')
+      end
+
+      # Get the HTML formatted link to the Location that this devices exists at.
+      # If you are looking for just the name, use #get_location_name instead.
+      def get_location_link
+        rest('getLocationLink')
+      end
+
+      # Returns a String value of the Location that this device exists at.  You can
+      # also issue #get_location_link if you want an HTML link to the location page.
+      def get_location_name
+        rest('getLocationName')
+      end
+
+      # Returns data ready for serialization
+      def get_data_for_json
+        plist_to_array( rest('getDataForJSON') )
+      end
+
+      def get_device_group_names
+        plist_to_array( rest('getDeviceGroupNames') )
+      end
+
+      # Returns a DateTime instance when this device was last modified.
+      def get_last_change
+        pdatetime_to_datetime( rest('getLastChange') )
+      end
+
+      # Return the management ip for this device.
+      def get_manage_ip
+        rest('getManageIp')
+      end
+
+      # Returns the name of the Zenoss Collector that this host currently belogs to.
+      def get_performance_server_name
+        rest('getPerformanceServerName')
+      end
+
+      # Return the pingStatus as a string
+      def get_ping_status_string
+        rest('getPingStatusString')
+      end
+
+      def get_pretty_link
+        rest('getPrettyLink')
+      end
+
+      # Return the numeric device priority.
+      def get_priority
+        (rest('getPriority')).to_i
+      end
+
+      # Return the device priority as a string.
+      def get_priority_string
+        rest('getPriorityString')
+      end
+
+      # Return the prodstate as a string.
+      def get_production_state_string
+        rest('getProductionStateString')
+      end
+
+      def get_rrd_templates
+      end
+
+      # Returns a DateTime instance when this device was last collected from.
+      def get_snmp_last_collection
+        pdatetime_to_datetime( rest('getSnmpLastCollection') )
+      end
+
+      # Return the snmpStatus as a string.
+      def get_snmp_status_string
+        rest('getSnmpStatusString')
+      end
+
+      # Returns an Array of Zenoss /Systems that this device belogs to.
+      def get_system_names
+        plist_to_array( rest('getSystemNames') )
+      end
+
+      # Returns true if the device production state >= zProdStateThreshold.
+      def monitor_device?
+        (rest('monitorDevice')).eql?('True') ? true : false
+      end
+
+      # Returns true if the device is subject to SNMP monitoring
+      def snmp_monitor_device?
+        (rest('snmpMonitorDevice')).eql?('True') ? true : false
+      end
+
+      # Return the SNMP uptime
+      def uptime_str
+        rest('uptimeStr')
+      end
+
+      # Update the devices hardware tag with the passed string
+      def set_hw_tag(asset_tag)
+        puts "No REST implementation yet."
+        #rest("setHWTag?assettag#{asset_tag}")
       end
 
       # Return list of monitored DeviceComponents on this device
       def get_monitored_components(collector=nil, type=nil)
         method = "getMonitoredComponents"
         method << '?' unless(collector.nil? && type.nil?)
-        method << "collector=#{collector}" unless collector.nil?
+        method << "collector=#{collector}&" unless collector.nil?
         method << "type=#{type}" unless type.nil?
         components = rest(method)
 
         # Turn the return string into an array of components
         (components.gsub /[\[\]]/,'').split /,\s+/
       end
-      
+
       # Return list of all DeviceComponents on this device
       def get_device_components(monitored=nil, collector=nil, type=nil)
         method = "getDeviceComponents"
         method << '?' unless(monitored.nil? && collector.nil? && type.nil?)
-        method << "monitored=#{monitored}" unless monitored.nil?
-        method << "collector=#{collector}" unless collector.nil?
+        method << "monitored=#{monitored}&" unless monitored.nil?
+        method << "collector=#{collector}&" unless collector.nil?
         method << "type=#{type}" unless type.nil?
         components = rest(method)
 
@@ -89,10 +181,6 @@ module Zenoss
       end
 
 
-      # -------- Methods from DeviceResultInt.DeviceResultInt -------- #
-      zenoss_string( {:get_device_class_name => 'getDeviceClassName'} )
-
-
       private
 
       def rest(method)

data/lib/model/device_hw.rb

@@ -0,0 +1,42 @@
+#############################################################################
+# Copyright © 2009 Dan Wanek <dwanek@nd.gov>
+#
+#
+# This file is part of Zenoss-RubyREST.
+# 
+# Zenoss-RubyREST 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,
+# 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/>.
+#############################################################################
+module Zenoss
+  module Model
+    class DeviceHW
+      include Zenoss
+      include Zenoss::Model
+
+      @@zenoss_methods = []
+
+
+      def initialize(device)
+        @device = device
+      end
+
+
+      private
+
+      def rest(method)
+        super("#{@device.path}/#{@device.device}/hw/#{method}")
+      end
+
+    end # Device
+  end # Model
+end # Zenoss

data/lib/model/event_view.rb

@@ -0,0 +1,56 @@
+#############################################################################
+# Copyright © 2009 Dan Wanek <dwanek@nd.gov>
+#
+#
+# This file is part of Zenoss-RubyREST.
+# 
+# Zenoss-RubyREST 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,
+# 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/>.
+#############################################################################
+
+module Zenoss
+  module Model
+    module EventView
+
+      def get_event_history
+        rest('getEventHistory')
+      end
+
+      # Fetches that status number for this device or component
+      def get_status(statusclass=nil)
+        method = 'getStatus'
+        method << "?statusclass=#{statusclass}" unless statusclass.nil?
+
+        # nil.to_i is 0 so we should be OK for nil returns
+        rest(method).to_i
+      end
+
+      # Fetches the img src path for this status number.  This is usually the
+      # output from the #get_status method.  If this is not working you may
+      # need to apply this patch to Zenoss:
+      # http://gist.github.com/328414
+      def get_status_img_src(status_number)
+        rest("getStatusImgSrc?status=#{status_number}")
+      end
+
+      # Fetches the css class for this status number.  This is usually the
+      # output from the #get_status method.  If this is not working you may
+      # need to apply this patch to Zenoss:
+      # http://gist.github.com/328414
+      def get_status_css_class(status_number)
+        rest("getStatusCssClass?status=#{status_number}")
+      end
+
+    end # EventView
+  end # Model
+end # Zenoss

data/lib/model/model.rb

@@ -24,8 +24,21 @@ module Zenoss
   module Model
     include Zenoss
 
+
+    # -------- Methods from DeviceResultInt.DeviceResultInt -------- #
+
+    def get_device_class_name
+      rest('getDeviceClassName')
+    end
+
   end # Model
 end # Zenoss
 
+# Modules
+require 'model/event_view'
+
+# Classes
 require 'model/device'
 require 'model/device_class'
+require 'model/device_hw'
+require 'model/operating_system'

data/lib/model/operating_system.rb

@@ -0,0 +1,41 @@
+#############################################################################
+# Copyright © 2009 Dan Wanek <dwanek@nd.gov>
+#
+#
+# This file is part of Zenoss-RubyREST.
+# 
+# Zenoss-RubyREST 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,
+# 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/>.
+#############################################################################
+module Zenoss
+  module Model
+    class OperatingSystem
+      include Zenoss
+      include Zenoss::Model
+
+      @@zenoss_methods = []
+
+      def initialize(device)
+        @device = device
+      end
+
+
+      private
+
+      def rest(method)
+        super("#{@device.path}/#{@device.device}/os/#{method}")
+      end
+
+    end # Device
+  end # Model
+end # Zenoss

data/lib/zenoss.rb

@@ -22,9 +22,6 @@ require 'date'
 require 'tzinfo'
 require 'uri'
 
-# Include extensions to classes for helper methods
-require 'extensions'
-
 module Zenoss
 
   # Set the Base URI of the Zenoss server
@@ -50,7 +47,6 @@ module Zenoss
   end
 
 
-
   private
 
   # Prepend the appropriate path and call the REST method on the URL set with Zenoss#uri

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: zenoss_client
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Dan Wanek
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-08 00:00:00 -06:00
+date: 2010-03-11 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,24 +30,26 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.markdown
+- README.rdoc
 - COPYING.txt
 files: 
 - COPYING.txt
-- README.markdown
+- README.rdoc
 - Rakefile
 - VERSION
-- lib/extensions.rb
 - lib/model/device.rb
 - lib/model/device_class.rb
+- lib/model/device_hw.rb
+- lib/model/event_view.rb
 - lib/model/model.rb
+- lib/model/operating_system.rb
 - lib/zenoss.rb
 - preamble
 has_rdoc: true
 homepage: http://github.com/zenchild/zenoss_client
 licenses: []
 
-post_install_message: See README.markdown
+post_install_message: See README.rdoc
 rdoc_options: 
 - -x
 - wsdl/

data/lib/extensions.rb

@@ -1,101 +0,0 @@
-#############################################################################
-# Copyright © 2010 Dan Wanek <dwanek@nd.gov>
-#
-#
-# This file is part of Zenoss-RubyREST.
-# 
-# Zenoss-RubyREST 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,
-# 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/>.
-#############################################################################
-require 'rubygems'
-require 'date'
-require 'tzinfo'
-require 'uri'
-
-# String is extended to for method renaming purposes
-class String
-  def ruby_case
-    self.split(/(?=[A-Z])/).join('_').downcase
-  end
-
-  def camel_case
-    self.split(/_/).map {|word| word.capitalize}.join
-  end
-end
-
-# Class is extended in order to add Zenoss REST methods declaratively.
-class Class
-
-  # Takes a Hash as an argument in the form {:ruby_name => 'RestName'}
-  def zenoss_list(methods)
-    methods.each_pair do |ruby_name,rest_name|
-      add_to_zenoss_methods(ruby_name)
-
-      define_method(ruby_name) do
-        plist_to_array( rest(rest_name) )
-      end
-    end
-  end
-
-  def zenoss_datetime(methods)
-    methods.each_pair do |ruby_name,rest_name|
-      add_to_zenoss_methods(ruby_name)
-
-      define_method(ruby_name) do
-        pdatetime_to_datetime( rest(rest_name) )
-      end
-    end
-  end
-
-  def zenoss_string(methods)
-    methods.each_pair do |ruby_name,rest_name|
-      add_to_zenoss_methods(ruby_name)
-
-      define_method(ruby_name) do
-        rest(rest_name)
-      end
-    end
-  end
-
-  def zenoss_int(methods)
-    methods.each_pair do |ruby_name,rest_name|
-      add_to_zenoss_methods(ruby_name)
-
-      define_method(ruby_name) do
-        retval = rest(rest_name)
-        retval.to_i unless retval.nil?
-      end
-    end
-  end
-  
-  def zenoss_boolean(methods)
-    methods.each_pair do |ruby_name,rest_name|
-      add_to_zenoss_methods(ruby_name)
-
-      define_method(ruby_name) do
-        (rest(rest_name)).eql?('True') ? true : false
-      end
-    end
-  end
-
-
-
-  private
-
-  # Update the class variable @@zenoss_methods with this method
-  def add_to_zenoss_methods(method_sym)
-    z_methods = class_variable_get(:@@zenoss_methods)
-    z_methods << method_sym.to_s
-    class_variable_set(:@@zenoss_methods, z_methods)
-  end
-end