zenoss_client 0.5.1 → 0.5.2

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.5.2

data/lib/zenoss/connection.rb

@@ -31,11 +31,12 @@ module Zenoss
     include Zenoss::JSONAPI::ReportRouter
     include Zenoss::RESTAPI
 
-    def initialize(url, user, pass)
+    def initialize(url, user, pass, &block)
       @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
+      yield(@httpcli) if block_given?
       sign_in(user,pass)
     end
 

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

@@ -24,6 +24,7 @@ module Zenoss
       include Zenoss::Model::EventView
       include Zenoss::Model::RRDView
       include Zenoss::Model::DeviceResultInt
+      include Zenoss::Model::ZenPropertyManager
 
       # Initialize this object from a Hash returned via getDevices from the JSON api
       # @param[Zenoss] zenoss the current instance we are connecting with

data/lib/zenoss/model/zen_property_manager.rb

@@ -0,0 +1,85 @@
+#############################################################################
+# 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 ZenPropertyManager
+
+      # ------------------ REST Calls ------------------ #
+
+      # @param [TrueClass,FalseClass] all true to return all Ids or false
+      #   to get just the overridden Ids.
+      # @return [Array] Return an Array of zProperty Ids for this device
+      def zen_property_ids(all=true)
+        method = "zenPropertyIds?all=#{all.to_s.capitalize}"
+
+        plist_to_array( custom_rest(method) )
+      end
+
+      # @return [Hash] Return a Hash of zProperies and values
+      def zen_property_items
+        method = 'zenPropertyItems'
+
+        outstr = rest(method)
+        ptuples_to_hash outstr.slice(1..-2).split(/,(?=\s\()/)
+      end
+
+      # Set a zProperty
+      # @param [String] propname the property to set
+      # @param [String, Array, Boolean] propvalue the value to set the property to
+      # @return [Boolean] true on success false otherwise
+      def set_zen_property(propname, propvalue)
+        method = 'setZenProperty'
+        if(propvalue.is_a? Array)
+          custom_rest("#{method}?propname=#{propname}&propvalue=[#{propvalue.join(',')}]") == "None\n"
+        else
+          if(propvalue.is_a?(TrueClass) || propvalue.is_a?(FalseClass))
+            propvalue = propvalue.to_s.capitalize
+          end
+          custom_rest("#{method}?propname=#{propname}&propvalue=#{propvalue}") == "None\n"
+        end
+      end
+
+      # Delete a zProperty from the device
+      # @param [String] propname the overridden zProperty to delete from the device
+      # @return [Boolean] true on success false otherwise
+      def delete_zen_property(propname)
+        method = "deleteZenProperty?propname=#{propname}"
+        custom_rest(method) == "None\n"
+      end
+
+      def cust_property_ids
+        plist_to_array( rest('custPropertyIds') )
+      end
+
+      def get_cust_property(id)
+        custom_rest("getProperty?id=#{id}").chomp
+      end
+
+      def set_cust_property(id, value)
+        set_zen_property(id, value)
+      end
+
+      def delete_cust_property(id)
+        delete_zen_property(id)
+      end
+
+    end # ZenPropertyManager
+  end # Model
+end # Zenoss

data/lib/zenoss/model.rb

@@ -48,6 +48,9 @@ end # Zenoss
 require 'zenoss/model/event_view'
 require 'zenoss/model/rrd_view'
 
+# Methods related to zProperties
+require 'zenoss/model/zen_property_manager'
+
 # Device Loader interface.  You can use it directly or use the
 # utility methods in DeviceClass to create devices beneath
 # that class

data/lib/zenoss/restapi.rb

@@ -57,7 +57,7 @@ module Zenoss
       end
       meth << "&filterFunc=#{callback_func}" unless callback_func.nil?
       meth << "&filterAttr=#{callback_attr}" unless callback_attr.nil?
-      meth = "#{URI.encode(dev_path)}/#{meth}"
+      meth = "#{URI.encode(dev_path)}/#{URI.encode(meth)}"
       puts "METHOD: #{meth}" if $DEBUG
       rest(meth)
     end

data/lib/zenoss.rb

@@ -32,8 +32,8 @@ module Zenoss
 
   # initialize a connection to a Zenoss server. This is the same as doing
   #   Zenoss::Connection.new(server,user,pass)
-  def Zenoss.connect(server, user, pass)
-    Connection.new(server,user,pass)
+  def Zenoss.connect(server, user, pass, &block)
+    Connection.new(server,user,pass,&block)
   end
 
   # Some of the REST methods return Strings that are formated like a Python list.
@@ -84,7 +84,7 @@ module Zenoss
         while( list[0] =~ /\d/ )
           token << list.shift
         end
-      narray << token.to_i
+        narray << token.to_i
       end
     end
 
@@ -122,8 +122,20 @@ module Zenoss
   # @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)
+    return nil if tuple_array.empty?
+    thash = {}
     tuple_array.each do |tuple|
+      str = sanitize_str(tuple.strip)
+      k, *v = str.slice!(1..-2).split(/\s*,\s*/)
+      if(v.length <= 1)
+        thash[k] = v.first
+      else
+        v[0]  = v[0].slice(1..-1)
+        v[-1] = v[-1].slice(0..-2)
+        thash[k] = v
+      end
     end
+    thash
   end
 
   # Do some clean-up on the string returned from REST calls.  Removes some
@@ -132,7 +144,9 @@ module Zenoss
   # @param [String] str string returned from REST call
   # @return [String] sanitized string
   def sanitize_str(str)
-    str.gsub(/['"]/,'')
+    str.gsub!(/['"]/,'')
+    str.chomp!
+    str
   end
 
 end # Zenoss

metadata

@@ -2,7 +2,7 @@
 name: zenoss_client
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors: 
 - Dan Wanek
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-31 00:00:00 -05:00
+date: 2011-07-08 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,6 +57,7 @@ extra_rdoc_files:
 - COPYING.txt
 files: 
 - COPYING.txt
+- Gemfile
 - README.textile
 - Rakefile
 - VERSION
@@ -91,6 +92,7 @@ files:
 - lib/zenoss/model/systems.rb
 - lib/zenoss/model/systems/system.rb
 - lib/zenoss/model/z_device_loader.rb
+- lib/zenoss/model/zen_property_manager.rb
 - lib/zenoss/model/zenpack/zenpack_manager.rb
 - lib/zenoss/restapi.rb
 - lib/zenoss_client.rb