zenoss_api 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe7cb83a35e2b25f8e17900d100565a10cf4ae07
-  data.tar.gz: ba880498c462e7869ccbf543e8ebaecabbf9f2e7
+  metadata.gz: ccc01b38fe84290c614679cf9e4dec45178becb6
+  data.tar.gz: cefda83026ebac1c440221b8c340026e6f3b7522
 SHA512:
-  metadata.gz: 4a87e98751f54151c4fd3794468efe43ec17a4ea56d314cf15b3aff593d4c6da32d3893f7d33fdcf3b20bbead2fa36170ef380ac9858c1214e9a9ca4b2f1ea2d
-  data.tar.gz: bb0d699f1ef580806fa90e88d632747f44209b16aa2ba1197381a802a972be63b10abbf17efb51be3293d27a2da038e01a9c7443a48c0281371ddc43dd85ba02
+  metadata.gz: febce1894dd23e4dbd8138fcfadde4f3190e6ea27a1820ab8d9b53acccfc869613ed978c4f6a04e156356fbf5916bfbe5d8efd01fde36bf4ae1ff2f746716cec
+  data.tar.gz: a6d91efa744df6e8c604da51f4b7b63fef8c424629e72cbee45f16ea59aa6589b73c7d762f52eff337952179ec9a2c1ff4da4573ff8be75eb6e3d7dadf5e2c45

data/lib/zenoss_api/version.rb

@@ -1,3 +1,3 @@
 module ZenossApi
-  VERSION = "0.3.3"
+  VERSION = "0.3.4"
 end

data/lib/zenoss_api.rb

@@ -23,6 +23,11 @@ module ZenossApi
     :UsersRouter => 'users',
     :EventClassesRouter => 'Events/evclasses',
   }
+
+  ROUTER_RETURN_KEYS = {
+    'DeviceRouter' => 'devices',
+    'EventsRouter' => 'events'
+  }
   
   DEFAULT_API_METHOD_ARGS = { 
     :DeviceRouter => {
@@ -58,6 +63,14 @@ module ZenossApi
  
   }
 
+  PRODUCTION_STATE = {
+    :production     => 1000,
+    :pre_production => 500,
+    :test           => 400,
+    :maintenance    => 300,
+    :decomissioned  => -1,
+  }
+
   EVENT_SEVERITY = {
     :clear    => 0, # Green
     :debug    => 1, # Grey
@@ -80,15 +93,16 @@ module ZenossApi
       @verify = verify_ssl
     end
 
-    def paginated_get(url, payload, xoffset=0)
+    def _paginated_post(url, payload, xoffset=0)
       Enumerator.new do |y|
         total = 0
         offset = 0
+        key = ROUTER_RETURN_KEYS[payload[0]['action']]
         limit = payload[0]['data'][0]['limit']
         loop do
           response = self._post(url, payload.to_json)
-          totalCount = response['result']['totalCount']
-          data = response['result']['events']
+          totalCount = response['totalCount']
+          data = response[key]
           total += data.length
           offset += limit
           payload[0]['data'][0]['start'] = offset
@@ -102,6 +116,11 @@ module ZenossApi
       end
     end
 
+    # http post to api
+    # 
+    # @param [String] url of api endpoint
+    # @param [String] json data
+    # @return [Hash] result of api query 
     def _post(url, payload) 
      #### TODO wrap in rescue and handle exceptions
      response = HTTParty.post(url,
@@ -113,18 +132,24 @@ module ZenossApi
          :verify => @verify,
        }) 
      if response.code == 200
-       response 
+       response['result']
      else 
-       response
+       raise ({ code: response.code, response: response }).to_json
      end
     end
-    
-
-    def router(router, method, method_params={}, options={})
-      if method_params.empty? 
-        _method_params = []
+   
+    # api endpoint router method
+    # 
+    # @param router [String] name of the zenoss api router
+    # @param method [String] name of the zenoss api method
+    # @param data [hash] api method arguments
+    # @param options [Hash] api execution control options
+    # @return [Hash] result of api query
+    def router(router, method, data={}, options={})
+      if data.empty? 
+        _data = []
       else 
-        _method_params = [ method_params ]
+        _data = [ data ]
       end
 
       raise "Error: #{router} is not a valid route." unless ROUTERS.key?(router.to_sym)
@@ -133,20 +158,16 @@ module ZenossApi
       payload = [{ 
         'action' => router,
         'method' => method,
-        'data' => _method_params,
+        'data' => _data,
         'type' => 'rpc',
         'tid' => @rec_count
       }]
     
        if options[:paginate]  
-         self.paginated_get(api_call, payload)
+         self._paginated_post(api_call, payload)
        else 
          self._post(api_call, payload.to_json) 
        end
-       #@rec_count += 1
-    end
-
-    def _returnDeviceProperty()
     end
  
     def validateUids(uids, type="devices")
@@ -163,46 +184,66 @@ module ZenossApi
       else 
         response = self.getDeviceProps(u, [ "uid" ])
         if not response.nil?
-          response['result'][type][0]['uid']
+          response[type][0]['uid']
         else 
           nil
         end
       end
     end 
-      
-    def getDeviceProps(device, props=[])
-      response = self.router("DeviceRouter", "getDevices", { 'keys' => props, 'params' => { 'name' => device } })
-      if response['result']['success'] == true and response['result']['totalCount'] == 1
-        response
+     
+    # get device properties
+    #
+    # @param device [String] the name of the device (device title or id)
+    # @param properties [Array] properties to be returned; default uid 
+    # @return [Hash] of device properties or nil if device not found 
+    def getDeviceProperties(device, properties=[])
+      data = { 'keys' => properties, 'params' => { 'name' => device }, }
+      result = self.router("DeviceRouter", "getDevices", data)
+      if result['success'] == true and result['totalCount'] == 1
+        result
       else
         nil
+      end
     end
+
+    # helper method to extract uid from a router device query
+    #
+    # @param result [Hash] response from router request
+    # @return [String] device uid
+    def getResultUid(result)
+      result['devices'][0]['uid']
     end
-    
-    def setProductionState(fqdn, state = 1000)
-      # set a single device prod state
 
-      # Production:1000
-      # Pre-Production:500
-      # Test:400
-      # Maintenance:300
-      # Decommissioned:-1
+    # helper method to extract hash from a router query
+    #
+    # @param result [Hash] response from router request
+    # @return [String] device uid
+    def getResultHash(result)
+      result['hash']
+    end
+ 
+    # sets the production state on a device
+    #
+    # @param device [String] the name of the device (device title or id)
+    # @param state [Int] production state to set 
+    def setProductionState(device, state = PRODUCTION_STATE[:production])
+      result = self.getDeviceProperties(device, ["uid"])
+      data = { 
+        'uids' => [ self.getResultUid(result) ],
+        'hashcheck' => self.getResultHash(result),
+        'prodState' => state,
+      }
+      self.router("DeviceRouter", "setProductionState", data)
+    end
 
-      # lookup device uid
-      node = self.getDeviceProps(fqdn, ["uid"])
-      # set prod state
-      if not node.nil?
-        uids = [ node['result']['devices'][0]['uid'] ]
-        hashcheck = node['result']['hash']  
-      	method_params = { 
-          'uids' => uids, 
-          'prodState' => state,
-          'hashcheck' => hashcheck, 
-        }
-        self.router("DeviceRouter", "setProductionState", method_params)
-      else 
-        "Set production state falied"
-      end
+    # get a list of devices under a device class
+    #
+    # @param device_class [String] device class to search
+    # @return [hash] 
+    def getDevicesInDeviceClass(device_class='/zport/dmd/Devices', keys=['uid'], limit=nil)
+      data = { 'uid' => device_class, 'keys' => keys, 'limit' => limit }
+      result = self.router('DeviceRouter', 'getDevices', data)
     end
   end
 end
+

data/zenoss_api.gemspec

@@ -33,6 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_dependency "json"
-  spec.add_dependency "io-console"
+  spec.add_dependency "io-console", "~> 0.4.5"
   spec.add_dependency "httparty"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zenoss_api
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Todd Stoll
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-06 00:00:00.000000000 Z
+date: 2018-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,16 +56,16 @@ dependencies:
   name: io-console
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.5
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement