zenoss_client 0.5.0 → 0.5.1

data/README.textile

@@ -45,7 +45,9 @@ 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'
 
-	require 'zenoss'
+<pre>
+<code>
+  require 'zenoss'
   require 'date'
 
   server = 'https://zenhost:port/zport/dmd'
@@ -57,11 +59,12 @@ A gem is now available.  'gem install zenoss_client'
   rrdpts = dev.get_rrd_data_points
   datapoints = dev.fetch_rrd_value rrdpts.first.name, (DateTime.now - 1)
 
-	# Get the uptime of the device
-	dev.sys_uptime
+  # Get the uptime of the device
+  dev.sys_uptime
 
   # Get a list of events for this system
   dev.get_events
-
+</code>
+</pre>
 
 Have fun and let me know what needs to be fixed / added.

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.5.1

data/lib/zenoss.rb

@@ -21,6 +21,7 @@ require 'rubygems'
 require 'date'
 require 'tzinfo'
 require 'uri'
+require 'ostruct'
 require 'httpclient'
 require 'json'
 

data/lib/zenoss/connection.rb

@@ -35,6 +35,7 @@ module Zenoss
       @zenoss_uri = (url.is_a?(URI) ? url : URI.parse(url))
       @request_number = 1
       @httpcli = HTTPClient.new
+      @httpcli.receive_timeout = 360  # six minutes should be more that sufficient
       sign_in(user,pass)
     end
 

data/lib/zenoss/jsonapi.rb

@@ -62,7 +62,7 @@ module Zenoss
           raise ZenossError, "Bad HTTP Response #{resp.status}: Cound not make JSON call"
         end
 
-        json = JSON.load(resp.body.content)
+        json = JSON.load(resp.http_body.content)
         # Check for JSON success. There are some exceptions where this doesn't make sense:
         #   1. Sometimes the 'success' key does not exist like in EventsRouter#query
         #   2. When json['result'] is not a Hash like a return from ReportRouter#get_tree

data/lib/zenoss/jsonapi/events_router.rb

@@ -21,19 +21,34 @@ module Zenoss
   module JSONAPI
     module EventsRouter
 
-      def get_events(device=nil, component=nil, event_class=nil, limit=100)
-        data = {
-          :start  => 0,
-          :limit  => 100,
-          :dir    => 'DESC',
-          :sort   => 'severity',
-          :params => { :severity => [5,4,3,2,1], :eventState => [0,1]},
+      # Query events for the given parameters.
+      # @param [String] uid the uid to query events for. If this isn't specified
+      #   the query may take a very long time
+      # @param [Hash] opts misc options to limit/filter events
+      # @option opts [Fixnum] :limit the Max index of events to retrieve
+      # @option opts [Fixnum] :start the Min index of events to retrieve
+      # @option opts [String] :sort Key on which to sort the return results (default: 'lastTime')
+      # @option opts [String] :dir Sort order; can be either 'ASC' or 'DESC'
+      # @option opts [Hash] :params Key-value pair of filters for this search. (default: None)
+      # @option opts [Boolean<true>] :history True to search the event history
+      #   table instead of active events (default: False)
+      # @option opts [Array<Hash>] :criteria A list of key-value pairs to to build query's
+      #   where clause (default: None)
+      # @option opts [String] :device limit events to a specific device. This only makes sense
+      #   if the uid being passed is not a device.
+      # @option opts [String] :component limit events to a specific component
+      # @option opts [String] :event_class limit events to a specific eventClass
+      def query_events(uid=nil, opts = {})
+        defaults = {
+          :limit    => 100,
+          :start    => 0,
+          :sort     => 'lastTime',
+          :dir      => 'DESC',
+          :history  => false,
         }
-        data[:params][:device] = device if device
-        data[:params][:component] = component if component
-        data[:params][:eventClass] = event_class if event_class
+        opts = defaults.merge(opts)
 
-        resp = json_request('EventsRouter', 'query', [data])
+        resp = self.ev_query(uid, opts)
 
         events = []
         resp['events'].each do |ev|
@@ -42,6 +57,26 @@ module Zenoss
         events
       end
 
+
+      # @param [String] uid the uid to query events for. If this isn't specified
+      #   the query may take a very long time
+      # @param [Hash] opts misc options to limit/filter events
+      # @see #query_events
+      def ev_query(uid, opts)
+        data = {
+          :limit    => opts[:limit],
+          :start    => opts[:start],
+          :sort     => opts[:sort],
+          :dir      => opts[:dir],
+          :history  => opts[:history],
+        }
+        data[:uid] = uid unless uid.nil?
+        data[:params] = opts[:params] if opts.has_key?(:params)
+        data[:criteria] = opts[:criteria] if opts.has_key?(:criteria)
+
+        json_request('EventsRouter', 'query', [data])
+      end
+
     end # EventsRouter
   end # JSONAPI
 end # Zenoss

data/lib/zenoss/model/devices/device.rb

@@ -38,7 +38,11 @@ module Zenoss
 
       # Get events for this device
       def get_events
-        @zenoss.get_events(self.name)
+        @zenoss.query_events(self.uid)
+      end
+
+      def get_event_history
+        @zenoss.query_events(self.uid,{:history => true})
       end
 
       def get_info(keys = nil)

data/lib/zenoss/model/event_view.rb

@@ -23,16 +23,6 @@ module Zenoss
 
       # ------------------ REST Calls ------------------ #
 
-      def get_event_history
-        #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
       def get_status(statusclass=nil)
         method = 'getStatus'

data/lib/zenoss/restapi.rb

@@ -72,7 +72,7 @@ module Zenoss
           raise ZenossError, "Bad HTTP Response #{resp.status}: Cound not make REST call"
         end
 
-        resp.body.content
+        resp.http_body.content
       end
     end
 

data/zenoss_client.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |gem|
   gem.extra_rdoc_files = %w(README.textile COPYING.txt)
 
   gem.required_ruby_version	= '>= 1.8.7'
-  gem.add_runtime_dependency  'httpclient'
-  gem.add_runtime_dependency  'tzinfo'
-  gem.add_runtime_dependency  'json'
+  gem.add_runtime_dependency  'httpclient', '~> 2.2.0'
+  gem.add_runtime_dependency  'tzinfo', '~> 0.3.20'
+  gem.add_runtime_dependency  'json', '~> 1.5.0'
 end

metadata

@@ -2,7 +2,7 @@
 name: zenoss_client
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - Dan Wanek
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-28 00:00:00 -05:00
+date: 2011-05-31 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -19,9 +19,9 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 2.2.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -30,9 +30,9 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 0.3.20
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -41,9 +41,9 @@ dependencies:
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 1.5.0
   type: :runtime
   version_requirements: *id003
 description: "    This is a wrapper around the Zenoss JSON and REST APIs. For the most things it\n    should feel very familiar to zendmd, but there are some changes do to the merging\n    of the JSON and REST APIs. Please read the API docs for Zenoss and the YARDDoc for\n    this gem (rdoc.info).\n"
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A wrapper around the Zenoss JSON and REST APIs