zenoss_client 0.1.0 → 0.5.0

data/lib/{model → zenoss/model}/systems.rb

@@ -17,4 +17,4 @@
 # 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 'model/systems/system'
+require 'zenoss/model/systems/system'

data/lib/zenoss/restapi.rb

@@ -0,0 +1,80 @@
+#############################################################################
+# 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 RESTAPI
+
+    # 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)
+      resp = @httpcli.get "#{@zenoss_uri}#{req_path}"
+      parse_rest(resp)
+    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']
+    # @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(dev_path, req_path, callback_func = nil, callback_attr=nil)
+      puts "ORIGINAL: #{req_path}" if $DEBUG
+      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).
+        meth << args.split('&').inject('') do |parms,arg|
+          arg.gsub!(/'/, "'''") # This may cause problems if the passed argument is already triple quoted.
+          parms << '===' unless parms.empty?
+          parms << arg.split('=').last
+        end
+        meth << ']'
+      end
+      meth << "&filterFunc=#{callback_func}" unless callback_func.nil?
+      meth << "&filterAttr=#{callback_attr}" unless callback_attr.nil?
+      meth = "#{URI.encode(dev_path)}/#{meth}"
+      puts "METHOD: #{meth}" if $DEBUG
+      rest(meth)
+    end
+
+
+    private
+
+    # Check the HTTP and REST response for errors and return appropriate response
+    def parse_rest(resp)
+      begin
+        if(resp.status >= 300)
+          raise ZenossError, "Bad HTTP Response #{resp.status}: Cound not make REST call"
+        end
+
+        resp.body.content
+      end
+    end
+
+  end # RESTAPI
+end # Zenoss

data/lib/zenoss_client.rb

@@ -0,0 +1,3 @@
+# You should actually load it with require 'zenoss' but this is here to stay
+# consistent with the gem name
+require 'zenoss'

data/zenoss_client.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+require 'date'
+
+Gem::Specification.new do |gem|
+  gem.name = "zenoss_client"
+  gem.version = File.open('VERSION').readline.chomp
+  gem.date		= Date.today.to_s
+  gem.platform = Gem::Platform::RUBY
+  gem.rubyforge_project  = nil
+
+  gem.author = "Dan Wanek"
+  gem.email = "dan.wanek@gmail.com"
+  gem.homepage = "http://github.com/zenchild/zenoss_client"
+
+  gem.summary = "A wrapper around the Zenoss JSON and REST APIs"
+  gem.description	= <<-EOF
+    This is a wrapper around the Zenoss JSON and REST APIs. For the most things it
+    should feel very familiar to zendmd, but there are some changes do to the merging
+    of the JSON and REST APIs. Please read the API docs for Zenoss and the YARDDoc for
+    this gem (rdoc.info).
+  EOF
+
+  gem.files = `git ls-files`.split(/\n/)
+  gem.require_path = "lib"
+  gem.rdoc_options	= %w(-x test/ -x examples/)
+  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'
+end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: zenoss_client
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+  prerelease: 
+  version: 0.5.0
 platform: ruby
 authors: 
 - Dan Wanek
@@ -14,101 +10,123 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-28 00:00:00 -05:00
+date: 2011-03-28 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: tzinfo
+  name: httpclient
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
-description: "  \tThis is a Ruby library for accessing Zenoss through its REST interface.  It is a work in progress and as functionality is testing\n\
-  \tit will be added.  For documentation on what the method calls do see the official Zenoss API docs.\n"
+- !ruby/object:Gem::Dependency 
+  name: tzinfo
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "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"
 email: dan.wanek@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
+- README.textile
 - COPYING.txt
 files: 
 - COPYING.txt
-- README.rdoc
+- README.textile
 - 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
-- lib/model/devices/device_hw.rb
-- 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
-- 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
-- lib/model/services/service_class.rb
-- lib/model/services/service_organizer.rb
-- lib/model/services/win_service.rb
-- lib/model/systems.rb
-- lib/model/systems/system.rb
-- lib/model/z_device_loader.rb
-- lib/model/zenpack/zenpack_manager.rb
+- lib/ext/ipaddr.rb
 - lib/zenoss.rb
+- lib/zenoss/connection.rb
+- lib/zenoss/events.rb
+- lib/zenoss/events/event.rb
+- lib/zenoss/events/zevent.rb
+- lib/zenoss/exceptions.rb
+- lib/zenoss/jsonapi.rb
+- lib/zenoss/jsonapi/device_router.rb
+- lib/zenoss/jsonapi/events_router.rb
+- lib/zenoss/jsonapi/report_router.rb
+- lib/zenoss/model.rb
+- lib/zenoss/model/devices.rb
+- lib/zenoss/model/devices/device.rb
+- lib/zenoss/model/devices/device_class.rb
+- lib/zenoss/model/devices/device_hw.rb
+- lib/zenoss/model/devices/operating_system.rb
+- lib/zenoss/model/event_view.rb
+- lib/zenoss/model/manufacturers/manufacturers.rb
+- lib/zenoss/model/processes/os_process_organizer.rb
+- lib/zenoss/model/rrd/rrd_data_point.rb
+- lib/zenoss/model/rrd_view.rb
+- lib/zenoss/model/services.rb
+- lib/zenoss/model/services/ip_service.rb
+- lib/zenoss/model/services/service.rb
+- lib/zenoss/model/services/service_class.rb
+- lib/zenoss/model/services/service_organizer.rb
+- lib/zenoss/model/services/win_service.rb
+- lib/zenoss/model/systems.rb
+- lib/zenoss/model/systems/system.rb
+- lib/zenoss/model/z_device_loader.rb
+- lib/zenoss/model/zenpack/zenpack_manager.rb
+- lib/zenoss/restapi.rb
+- lib/zenoss_client.rb
 - preamble
 - tools/callZenossMethod.py
+- zenoss_client.gemspec
 has_rdoc: true
 homepage: http://github.com/zenchild/zenoss_client
 licenses: []
 
-post_install_message: See README.rdoc
+post_install_message: 
 rdoc_options: 
 - -x
-- wsdl/
-- -x
 - test/
 - -x
 - examples/
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 8
-      - 7
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
-summary: A Ruby API for accessing Zenoss via REST
+summary: A wrapper around the Zenoss JSON and REST APIs
 test_files: []
 

data/README.rdoc

@@ -1,58 +0,0 @@
-= 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
-to start hacking this library together.  It is very incomplete and I am
-just adding functionality as I need it or it is requested.
-
-Cheers,
-
-Dan Wanek
-
-== REQUIREMENTS:
-Gems:
-
-* tzinfo: For Python DateTime to Ruby DateTime conversion
-
-
-== 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:
-
-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'
-
-	require 'zenoss'
-
-	# You must set the URI before doing anything else
-	Zenoss.uri 'https://zenhost:port/zport/dmd/'
-
-	# Add the appropriate credentials
-	Zenoss.set_auth('user','pass')
-	
-	# This returns the base DeviceClass '/zport/dmd/Devices'
-	# It is the equivilent in zendmd of 'dmd.Devices'
-	devices = Zenoss.devices
-
-	# Search for a device
-	dev = devices.find_device_path('devname')
-
-	# List all implemented REST methods for this object
-	puts dev.zenoss_methods.sort.join(', ')
-
-	# 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/lib/model/events/event_manager_base.rb

@@ -1,66 +0,0 @@
-#############################################################################
-# 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