zenoss_client 0.6.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 981ffe9b6d5043244cd38fbf2edf62bdccbd62b9
-  data.tar.gz: 80f7544773d814c72ccae5a3d2e657064e5af513
+SHA256:
+  metadata.gz: c64cb525b567ce659a11d844a5b2d5d4e5212bdc799d320fa3134e3e3beee4d1
+  data.tar.gz: 1a3de47b44a7b48662d2b8135179f158d1d7fe06d204e587a063af2dcc7ef6e0
 SHA512:
-  metadata.gz: a70d8df6d60198b6807bcc5ed44b89c80532961563f00684914abcdc4700d1459143d234519aac926b842eeeae4f5a378b8381973345347275355b76cc6e5497
-  data.tar.gz: 8fb27680573b2bd8cc81f10bcf1700849d9acd784e963d58ea785fef9487c1bbc9204cfc05b90584ea13ac463e510f7dd31c04c3a0e002b8061d91bba9084dfc
+  metadata.gz: c8d2eeb2cdb2bd4db0e82b9888f6cc1d3d1c766f046bb87e4f6d7d5abc1297594136c1420cf438873b16ad3ee19e5cbf40367c1d9c869e9af76a0ebd44b0038f
+  data.tar.gz: 4f64c02de20bd54c98215cb93d0302f55d8b7f85e94ca65c676eb4ab240a7c935d2925ec0f93ce9904b3865959b1f9b7a67a26ac1f249fb2aec7e24cd69b9748

data/.travis.yml

@@ -1,13 +1,15 @@
 language: ruby
 script: bundle exec rake test
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.2.0
-  - ruby-head
-  - jruby-head
+  - 2.0.0-p648
+  - 2.1.10
+  - 2.2.10
+  - 2.3.8
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
 
 install:
-  - gem install bundler
+  - gem install bundler -v 1.17.3
   - bundle install --jobs=3 --retry=3

data/VERSION

@@ -1 +1 @@
-0.6.1
+0.10.0

data/lib/zenoss.rb

@@ -45,7 +45,7 @@ module Zenoss
   def plist_to_array(list)
     return nil if list.nil?
     list = sanitize_str(list)
-    (list.gsub /[\[\]]/,'').split /,\s+/
+    list.gsub(/[\[\]]/, '').split(/,\s+/)
   end
 
   # Some of the REST methods return Strings that are formated like a Python list.

data/lib/zenoss/connection.rb

@@ -32,6 +32,7 @@ module Zenoss
     include Zenoss::RESTAPI
 
     def initialize(url, user, pass, opts = {}, &block)
+      @zenoss_version = opts[:version]
       @zenoss_uri = (url.is_a?(URI) ? url : URI.parse(url))
       @request_number = 1
       @httpcli = HTTPClient.new

data/lib/zenoss/events/event.rb

@@ -28,8 +28,20 @@ module Zenoss
       def initialize(zenoss,zhash)
         @zenoss = zenoss
         super zhash
-        self.firstTime = DateTime.parse(self.firstTime) if self.firstTime
-        self.lastTime  = DateTime.parse(self.lastTime) if self.lastTime
+        self.firstTime &&= convert_time(self.firstTime)
+        self.lastTime &&= convert_time(self.lastTime)
+      end
+
+      # Converts a string or float to a Time object
+      # Zenoss version 4 emits the time format as a string
+      # Zenoss version 6 emits the time as a float
+      # @return[Time]
+      def convert_time(time)
+        if time.is_a?(String)
+          Time.parse(time)
+        else
+          Time.at(time)
+        end
       end
 
       def detail(history = false)

data/lib/zenoss/jsonapi/device_router.rb

@@ -51,14 +51,42 @@ module Zenoss
       end
 
       def get_templates(device_id)
-        resp = json_request('DeviceRouter', 'getTemplates', [{:id => device_id}])
+        json_request('DeviceRouter', 'getTemplates', [{:id => device_id}])
       end
 
       def get_info(device_id, keys = nil)
         data = {}
         data[:uid]  = device_id
         data[:keys] = keys if keys
-        resp = json_request('DeviceRouter', 'getInfo', [data])
+        json_request('DeviceRouter', 'getInfo', [data])
+      end
+
+      # @param [Hash] opts arguments to pass to setInfo
+      # @option opts [String] :uid required; device id in Zenoss
+      def set_info(opts = {})
+        if @zenoss_version && @zenoss_version > '6'
+          json_request('DeviceRouter', 'setInfo', [opts])
+        else
+          raise ZenossError, 'setInfo method on DeviceRouter is only allowed '\
+                             'for version 6 and above'
+        end
+      end
+
+      # @param [String] uid required; device id in Zenoss
+      # @param [String] plugins takes a string.  A plugin respresents a Modeler
+      # plugin such as cisco.snmp.Interfaces
+      # @param [Boolean] background whether to schedule a job in background
+      def remodel(uid, plugins = nil, background = false)
+        if @zenoss_version && @zenoss_version > '6'
+          data = {}
+          data[:deviceUid] = uid
+          data[:collectPlugins] = plugins || ''
+          data[:background] = background
+          json_request('DeviceRouter', 'remodel', [data])
+        else
+          raise ZenossError, 'remodel method on DeviceRouter is only allowed '\
+                             'for version 6 and above'
+        end
       end
 
       # =============== Non-API Helper methods ===============

data/lib/zenoss/jsonapi/events_router.rb

@@ -57,7 +57,19 @@ module Zenoss
         events
       end
 
+      # @param [Hash] data evids that should be closed
+      # @option data [Array] :evids Array of evids that is closed
+      def close_events(data = {})    
+        json_request('EventsRouter', 'close', [data])
+      end
 
+      # @param [Hash] data data specifying event that should have a logmessage appended
+      # @option data [String] :evid evid that message should be appended to
+      # @option data [String] :message text that should be appended to the event log
+      def write_log(data= {})
+        json_request('EventsRouter','write_log', [data])
+      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

data/lib/zenoss/jsonapi/report_router.rb

@@ -22,11 +22,15 @@ module Zenoss
     module ReportRouter
 
       def get_report_types
-        resp = json_request('ReportRouter', 'getReportTypes')
+        json_request('ReportRouter', 'getReportTypes')
       end
 
       def get_report_tree(id = '/zport/dmd/Reports')
-        resp = json_request('ReportRouter', 'getTree', [{:id => id}])
+        if @zenoss_version && @zenoss_version > '6'
+          json_request('ReportRouter', 'asyncGetTree', [id])
+        else
+          json_request('ReportRouter', 'getTree', [{:id => id}])
+        end
       end
 
     end # ReportRouter

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

@@ -50,6 +50,11 @@ module Zenoss
         @zenoss.get_info(self.uid, keys)
       end
 
+      def set_info(opts = {})
+        opts[:uid] = self.uid
+        @zenoss.set_info(opts)
+      end
+
       # ------------------ Legacy REST Calls ------------------ #
 
       # Move this Device to the given DeviceClass.
@@ -181,7 +186,7 @@ module Zenoss
         components = rest(method)
 
         # Turn the return string into an array of components
-        (components.gsub /[\[\]]/,'').split /,\s+/
+        components.gsub(/[\[\]]/, '').split(/,\s+/)
       end
 
       # Return list of all DeviceComponents on this device

data/lib/zenoss/model/z_device_loader.rb

@@ -48,7 +48,7 @@ module Zenoss
       def add_system(system_path)
         method = "addSystem?newSystemPath=#{system_path}"
         rest(method)
-        sys = System.new("/Systems/#{system_path}")
+        System.new("/Systems/#{system_path}")
       end
 
       

data/test/fixtures/vcr_cassettes/6_2_1_initial_connection.yml

@@ -0,0 +1,232 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:8080/zport/dmd/zport/acl_users/cookieAuthHelper/login
+    body:
+      encoding: UTF-8
+      string: __ac_name=admin&__ac_password=zenoss&submitted=true&came_from=http://localhost:8080/zport/dmd
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.3.3 (2016-11-21))
+      Accept:
+      - "*/*"
+      Date:
+      - Wed, 15 Apr 2020 20:38:47 GMT
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Cookie: ''
+  response:
+    status:
+      code: 302
+      message: Found
+    headers:
+      Content-Length:
+      - '25'
+      Content-Type:
+      - text/plain; charset=utf-8
+      Date:
+      - Wed, 15 Apr 2020 20:38:50 GMT
+      Location:
+      - "/zport/dmd?submitted=true"
+      Server: ''
+      Set-Cookie: ''
+      Strict-Transport-Security:
+      - max-age=31536000
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: "/zport/dmd?submitted=true"
+    http_version: 
+  recorded_at: Wed, 15 Apr 2020 20:38:51 GMT
+- request:
+    method: post
+    uri: http://localhost:8080/zport/dmd//zport/dmd?submitted=true
+    body:
+      encoding: UTF-8
+      string: __ac_name=admin&__ac_password=zenoss&submitted=true&came_from=http://localhost:8080/zport/dmd
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.3.3 (2016-11-21))
+      Accept:
+      - "*/*"
+      Date:
+      - Wed, 15 Apr 2020 20:38:51 GMT
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Cookie: ''
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - max-age=0, no-cache
+      Content-Type:
+      - text/html; charset=utf-8
+      Date:
+      - Wed, 15 Apr 2020 20:38:51 GMT
+      Server: ''
+      Set-Cookie: ''
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Page-Speed:
+      - 1.11.33.4-0
+      X-Xss-Protection:
+      - 1; mode=block
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: "\\n\\n    <!DOCTYPE html>\\n<html>\\n"
+    http_version: 
+  recorded_at: Wed, 15 Apr 2020 20:38:52 GMT
+- request:
+    method: post
+    uri: http://localhost:8080/zport/dmd/zport/dmd/device_router
+    body:
+      encoding: UTF-8
+      string: __ac_name=admin&__ac_password=zenoss&submitted=true&came_from=https%3A%2F%2Fhttp:://localhost:8080/zport/dmd%2Fzport%2Fdmd
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.3.3 (2016-11-21))
+      Accept:
+      - "*/*"
+      Date:
+      - Wed, 15 Apr 2020 20:38:52 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Cookie: ''
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 15 Apr 2020 20:38:54 GMT
+      Server: ''
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '309'
+      Set-Cookie: ''
+    body:
+      encoding: UTF-8
+      string: '{"uuid": "a34caf64-2209-480c-96ed-dd94117ef7ac", "action": "DeviceRouter",
+        "result": {"new_jobs": [{"uuid": "b0c01851-394f-49a1-8547-acd02633194e", "description":
+        "Create UnitTestDevice under /Devices/Server", "uid": "/zport/dmd/JobManager"}],
+        "success": true}, "tid": 1, "type": "rpc", "method": "addDevice"}'
+    http_version: 
+  recorded_at: Wed, 15 Apr 2020 20:38:54 GMT
+- request:
+    method: post
+    uri: http://localhost:8080/zport/dmd/zport/dmd/device_router
+    body:
+      encoding: UTF-8
+      string: __ac_name=admin&__ac_password=zenoss&submitted=true&came_from=https%3A%2F%2Fhttp:://localhost:8080/zport/dmd%2Fzport%2Fdmd
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.3.3 (2016-11-21))
+      Accept:
+      - "*/*"
+      Date:
+      - Wed, 15 Apr 2020 20:38:54 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Cookie: ''
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 15 Apr 2020 20:38:54 GMT
+      Server: ''
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '197'
+      Set-Cookie: ''
+    body:
+      encoding: UTF-8
+      string: '{"uuid": "48c067ba-5c1e-4d81-aac0-3c49aadba9fc", "action": "DeviceRouter",
+        "result": {"totalCount": 0, "hash": "0", "success": true, "devices": []},
+        "tid": 2, "type": "rpc", "method": "getDevices"}'
+    http_version: 
+  recorded_at: Wed, 15 Apr 2020 20:38:54 GMT
+- request:
+    method: post
+    uri: http://localhost:8080/zport/dmd/zport/dmd/device_router
+    body:
+      encoding: UTF-8
+      string: __ac_name=admin&__ac_password=zenoss&submitted=true&came_from=https%3A%2F%2Fhttp:://localhost:8080/zport/dmd%2Fzport%2Fdmd
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.3.3 (2016-11-21))
+      Accept:
+      - "*/*"
+      Date:
+      - Wed, 15 Apr 2020 20:39:09 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Cookie: ''
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 15 Apr 2020 20:39:11 GMT
+      Server: ''
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '905'
+      Set-Cookie: ''
+    body:
+      encoding: UTF-8
+      string: '{"uuid": "91ffde13-d44b-4a5e-9846-2155070ba803", "action": "DeviceRouter",
+        "result": {"totalCount": 1, "hash": "1", "success": true, "devices": [{"ipAddressString":
+        null, "serialNumber": "", "pythonClass": "Products.ZenModel.Device", "hwManufacturer":
+        null, "collector": "localhost", "osModel": null, "productionState": 1000,
+        "systems": [], "priority": 3, "hwModel": null, "tagNumber": "", "osManufacturer":
+        null, "location": null, "groups": [], "uid": "/zport/dmd/Devices/Server/devices/UnitTestDevice",
+        "ipAddress": null, "events": {"info": {"count": 0, "acknowledged_count": 0},
+        "clear": {"count": 0, "acknowledged_count": 0}, "warning": {"count": 0, "acknowledged_count":
+        0}, "critical": {"count": 0, "acknowledged_count": 0}, "error": {"count":
+        0, "acknowledged_count": 0}, "debug": {"count": 0, "acknowledged_count": 0}},
+        "name": "UnitTestDevice"}]}, "tid": 3, "type": "rpc", "method": "getDevices"}'
+    http_version: 
+  recorded_at: Wed, 15 Apr 2020 20:39:11 GMT
+recorded_with: VCR 4.0.0

data/test/fixtures/vcr_cassettes/6_2_1_test_0001_returns_an_Array_of_devices_when_searched_by_name.yml

@@ -0,0 +1,107 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:8080/zport/dmd/zport/dmd/device_router
+    body:
+      encoding: UTF-8
+      string: '[{"action":"DeviceRouter","method":"getDevices","data":[{"uid":"/zport/dmd/Devices","params":{"name":"UnitTestDevice"}}],"type":"rpc","tid":7}]'
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.3.3 (2016-11-21))
+      Accept:
+      - "*/*"
+      Date:
+      - Tue, 19 Feb 2019 22:36:50 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Cookie: ''
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Tue, 19 Feb 2019 22:36:50 GMT
+      Server: ''
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '904'
+      Set-Cookie: ''
+    body:
+      encoding: UTF-8
+      string: '{"uuid": "99425e21-1fb5-4a6c-8466-b1969bf927ec", "action": "DeviceRouter",
+        "result": {"totalCount": 1, "hash": "1", "success": true, "devices": [{"ipAddressString":
+        null, "serialNumber": "", "pythonClass": "Products.ZenModel.Device", "hwManufacturer":
+        null, "collector": "localhost", "osModel": null, "productionState": 400, "systems":
+        [], "priority": 3, "hwModel": null, "tagNumber": "", "osManufacturer": null,
+        "location": null, "groups": [], "uid": "/zport/dmd/Devices/Server/devices/UnitTestDevice",
+        "ipAddress": null, "events": {"info": {"count": 0, "acknowledged_count": 0},
+        "clear": {"count": 0, "acknowledged_count": 0}, "warning": {"count": 0, "acknowledged_count":
+        0}, "critical": {"count": 0, "acknowledged_count": 0}, "error": {"count":
+        0, "acknowledged_count": 0}, "debug": {"count": 0, "acknowledged_count": 0}},
+        "name": "UnitTestDevice"}]}, "tid": 7, "type": "rpc", "method": "getDevices"}'
+    http_version: 
+  recorded_at: Tue, 19 Feb 2019 22:36:50 GMT
+- request:
+    method: post
+    uri: http://localhost:8080/zport/dmd/zport/dmd/device_router
+    body:
+      encoding: UTF-8
+      string: '[{"action":"DeviceRouter","method":"getDevices","data":[{"uid":"/zport/dmd/Devices","params":{"name":"UnitTestDevice"}}],"type":"rpc","tid":8}]'
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.3.3 (2016-11-21))
+      Accept:
+      - "*/*"
+      Date:
+      - Tue, 19 Feb 2019 22:36:50 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Cookie: ''
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Tue, 19 Feb 2019 22:36:51 GMT
+      Server: ''
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '904'
+      Set-Cookie: ''
+    body:
+      encoding: UTF-8
+      string: '{"uuid": "b7f6ae66-d850-4deb-96e3-eb70954e4c4e", "action": "DeviceRouter",
+        "result": {"totalCount": 1, "hash": "1", "success": true, "devices": [{"ipAddressString":
+        null, "serialNumber": "", "pythonClass": "Products.ZenModel.Device", "hwManufacturer":
+        null, "collector": "localhost", "osModel": null, "productionState": 400, "systems":
+        [], "priority": 3, "hwModel": null, "tagNumber": "", "osManufacturer": null,
+        "location": null, "groups": [], "uid": "/zport/dmd/Devices/Server/devices/UnitTestDevice",
+        "ipAddress": null, "events": {"info": {"count": 0, "acknowledged_count": 0},
+        "clear": {"count": 0, "acknowledged_count": 0}, "warning": {"count": 0, "acknowledged_count":
+        0}, "critical": {"count": 0, "acknowledged_count": 0}, "error": {"count":
+        0, "acknowledged_count": 0}, "debug": {"count": 0, "acknowledged_count": 0}},
+        "name": "UnitTestDevice"}]}, "tid": 8, "type": "rpc", "method": "getDevices"}'
+    http_version: 
+  recorded_at: Tue, 19 Feb 2019 22:36:51 GMT
+recorded_with: VCR 4.0.0