zenoss_client 0.7.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0604c70eea29dc67d7083fb3521bf52ff3a1adff59160791b8756b06cca753c4
-  data.tar.gz: 385c6c6b898364bb88a16832db0846dbaf594ade55859131e6cd08b3c30b6cf6
+  metadata.gz: 4b19b969c4c6e18b9a4e012dfb56b627c5bdd43e960cdc64a8d7a9e5036df389
+  data.tar.gz: ab09ef31c00e1e38aa6761448c84190c7bf5ee90868d97e12f2bb1aa1eef733c
 SHA512:
-  metadata.gz: 1102a72533a0ca09895d70a9468af7a5766c90f418e63c8bd9fa6616a7f9a4487fb0342d01b3768e2177b8f934755068de39c044d9dbbe50f6e3128c4683fa74
-  data.tar.gz: 5f34aa8d4ce4f292640d6460abfea740aa16857d560e8976468e5f416c72eb5f0910788b49ceffd4e8853135bcad3de3d39c6afc29601b63ed0635ef9016c3bf
+  metadata.gz: b86a0b85a3e8f36c9cc1a360e4620eff9da777389b732de7083782f9d925f353df261b647b7e8b46de29a4f035d73b116e62fb9d64d5cbcb68fb7e0d2040118e
+  data.tar.gz: aa516bb6da3f17bc94871fdc1dda6ee0582737eda7ba5e9aee33e5095aa0b2fcf9261c152ddd30d06217c36fca1df364c2f0c9f8c69d476b08831976bf258750

data/.travis.yml

@@ -1,16 +1,15 @@
 language: ruby
 script: bundle exec rake test
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.0.0-p648
   - 2.1.10
-  - 2.2.8
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
-  - ruby-head
-  - jruby-head
+  - 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/README.rdoc

@@ -0,0 +1,87 @@
+h1. zenoss_client: A Ruby library for JSON/REST access to Zenoss
+
+This is a work-in-progress to create an easy to use client JSON/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
+
+h2. CHANGES SINCE THE 0.1.x BRANCH
+
+Starting with 0.5.0 I am trying to incorporate as much of the new JSON API
+into this library as possible because the type conversion hackery that was
+present in the REST code is largely unnecessary. Please note that the
+initialization is much different because we are using the sign-in form auth
+instead of the Basic auth of the previous version. This is because the JSON
+calls do not support Basic authentication.
+
+There is still much work that needs to be done in order to fully implement
+all of the JSON methods. For now many of the older features fall back to
+REST and some of those will always rely on REST because they are not
+currently supported in the JSON API.
+
+
+h2. REQUIREMENTS:
+Gems:
+
+* tzinfo: For Python DateTime to Ruby DateTime conversion
+
+
+h2. 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'
+
+<pre>
+<code>
+  require 'zenoss'
+  require 'date'
+
+  server = 'https://zenhost:port/zport/dmd'
+  user, pass = 'zuser', 'zpass'
+  @zen = Zenoss.connect server, user, pass
+  dev = (@zen.find_devices_by_name 'myservername').first
+
+  # Get RRD data for this device
+  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 a list of events for this system
+  dev.get_events
+</code>
+</pre>
+
+Have fun and let me know what needs to be fixed / added.
+
+== Testing
+You can invoke a series of minitest based spec test using the supplied
+tests and rake task. Simply run the following to kick off the tests
+@bundle exec rake test@
+
+You should see output similar to the following (The number of tests will
+of course grow over time):
+@3 tests, 6 assertions, 0 failures, 0 errors, 0 skips@
+
+If you get any failures, you should of course address them
+
+Since the test suite requires a working Zenoss installation to test against,
+some docker files are provided under test/docker. From a docker host, clone this
+repo, cd to the appropriate test/docker/ subdirectory, and run @sh start.sh@ to
+build and start the container. Once the container is running, you should be able
+to run the tests as described above.

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.10.1

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

@@ -61,6 +61,34 @@ module Zenoss
         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 ===============
 
       # This method will allow you to search for devices by name. If you put a partial name

data/lib/zenoss/jsonapi/report_router.rb

@@ -26,7 +26,11 @@ module Zenoss
       end
 
       def get_report_tree(id = '/zport/dmd/Reports')
-        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.

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