zenoss_client 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccd337639449bce606235f44cb65d9b008412765
-  data.tar.gz: b8b9151a872dcd01862a6bd1fbf65b0963e72427
+  metadata.gz: c50bb43ef8360b1861920b2db604b4620f67379d
+  data.tar.gz: d788721031d0bb940b2f4546b3c988ff599b7a91
 SHA512:
-  metadata.gz: 441829da815122c4c59e03ad880b32e9fbbd8b7502ab9bf12b4442f76e3b76bcf110c0a40d78cea354c10f5f4a327548be701021e6aa4b7106330b832c9e0f5d
-  data.tar.gz: 19ffccd5bb28309aa0335578a1748c2e00bce494c3981ba3b1a10c55fce2e60f20330e7c93a94b7f3535f0e30749bdbf22eb5fa7ed4efdb8ea867c5c07e501c1
+  metadata.gz: c8cbf8ca1804409707f13efc42daf0c09514274ea54b56b964203f902309c3244b915518fbb37ec73c75bbad6751700413464f767600bb99178e621365a90b40
+  data.tar.gz: 9489a2223bbbdee4f4202b66cd9f026388ea197953ca3b6bf84494715f7d7602470a1794269d178ce3875417f8c8c0b2b1f31b598eebce5ea3fcc644c3d90d80

data/VERSION

@@ -1 +1 @@
-0.9.0
+0.9.1

data/lib/zenoss/jsonapi/device_router.rb

@@ -61,6 +61,17 @@ 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
+
       # =============== Non-API Helper methods ===============
 
       # This method will allow you to search for devices by name. If you put a partial name

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

@@ -5,14 +5,14 @@ http_interactions:
     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=https%3A%2F%2Fhttp:://localhost:8080/zport/dmd%2Fzport%2Fdmd
+      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:
-      - Tue, 19 Feb 2019 22:36:46 GMT
+      - Mon, 25 Feb 2019 23:20:05 GMT
       Content-Type:
       - application/x-www-form-urlencoded
       Cookie: ''
@@ -26,7 +26,7 @@ http_interactions:
       Content-Type:
       - text/plain; charset=utf-8
       Date:
-      - Tue, 19 Feb 2019 22:36:47 GMT
+      - Mon, 25 Feb 2019 23:20:06 GMT
       Location:
       - "/zport/dmd?submitted=true"
       Server: ''
@@ -41,20 +41,20 @@ http_interactions:
       encoding: UTF-8
       string: "/zport/dmd?submitted=true"
     http_version: 
-  recorded_at: Tue, 19 Feb 2019 22:36:47 GMT
+  recorded_at: Mon, 25 Feb 2019 23:20:06 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=https%3A%2F%2Fhttp:://localhost:8080/zport/dmd%2Fzport%2Fdmd
+      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:
-      - Tue, 19 Feb 2019 22:36:47 GMT
+      - Mon, 25 Feb 2019 23:20:06 GMT
       Content-Type:
       - application/x-www-form-urlencoded
       Cookie: ''
@@ -68,7 +68,7 @@ http_interactions:
       Content-Type:
       - text/html; charset=utf-8
       Date:
-      - Tue, 19 Feb 2019 22:36:47 GMT
+      - Mon, 25 Feb 2019 23:20:07 GMT
       Server: ''
       Set-Cookie: ''
       Strict-Transport-Security:
@@ -87,52 +87,7 @@ http_interactions:
       encoding: UTF-8
       string: "\\n\\n    <!DOCTYPE html>\\n<html>\\n"
     http_version: 
-  recorded_at: Tue, 19 Feb 2019 22:36:48 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:
-      - Tue, 19 Feb 2019 22:36:48 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:49 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": "02f12150-4aa5-4616-a35d-fd4b942421a4", "action": "DeviceRouter",
-        "result": {"new_jobs": [{"uuid": "3bbee1ec-4f40-44ce-ada1-cc064eb40505", "description":
-        "Create UnitTestDevice under /Devices/Server", "uid": "/zport/dmd/JobManager"}],
-        "success": true}, "tid": 1, "type": "rpc", "method": "addDevice"}'
-    http_version: 
-  recorded_at: Tue, 19 Feb 2019 22:36:49 GMT
+  recorded_at: Mon, 25 Feb 2019 23:20:07 GMT
 - request:
     method: post
     uri: http://localhost:8080/zport/dmd/zport/dmd/device_router
@@ -145,7 +100,7 @@ http_interactions:
       Accept:
       - "*/*"
       Date:
-      - Tue, 19 Feb 2019 22:36:49 GMT
+      - Mon, 25 Feb 2019 23:20:07 GMT
       Content-Type:
       - application/json; charset=utf-8
       Cookie: ''
@@ -157,7 +112,7 @@ http_interactions:
       Content-Type:
       - application/json
       Date:
-      - Tue, 19 Feb 2019 22:36:49 GMT
+      - Mon, 25 Feb 2019 23:20:07 GMT
       Server: ''
       Strict-Transport-Security:
       - max-age=31536000
@@ -168,21 +123,23 @@ http_interactions:
       X-Xss-Protection:
       - 1; mode=block
       Content-Length:
-      - '904'
+      - '1063'
       Set-Cookie: ''
     body:
       encoding: UTF-8
-      string: '{"uuid": "8c081232-47f0-43f1-9e06-691574b5a164", "action": "DeviceRouter",
+      string: '{"uuid": "05f56525-8c70-487e-90ad-0b4480e3a9e5", "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",
+        null, "collector": "zencollector01", "osModel": null, "productionState": -1,
+        "systems": [], "priority": 3, "hwModel": null, "tagNumber": "", "osManufacturer":
+        null, "location": null, "groups": [{"uid": "/zport/dmd/Groups/BackboneDevices",
+        "path": "/Groups/BackboneDevices", "uuid": "65142f38-df6e-482e-a74d-ec825af8e058",
+        "name": "/BackboneDevices"}], "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": 2, "type": "rpc", "method": "getDevices"}'
     http_version: 
-  recorded_at: Tue, 19 Feb 2019 22:36:49 GMT
+  recorded_at: Mon, 25 Feb 2019 23:20:07 GMT
 recorded_with: VCR 4.0.0

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

@@ -0,0 +1,100 @@
+---
+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":15}]'
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.3.3 (2016-11-21))
+      Accept:
+      - "*/*"
+      Date:
+      - Mon, 25 Feb 2019 23:20:07 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Cookie: ''
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 25 Feb 2019 23:20:08 GMT
+      Server: ''
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '1064'
+      Set-Cookie: ''
+    body:
+      encoding: UTF-8
+      string: '{"uuid": "6245a13a-8add-4ee0-a04d-8e6206b8d8c8", "action": "DeviceRouter",
+        "result": {"totalCount": 1, "hash": "1", "success": true, "devices": [{"ipAddressString":
+        null, "serialNumber": "", "pythonClass": "Products.ZenModel.Device", "hwManufacturer":
+        null, "collector": "zencollector01", "osModel": null, "productionState": -1,
+        "systems": [], "priority": 3, "hwModel": null, "tagNumber": "", "osManufacturer":
+        null, "location": null, "groups": [{"uid": "/zport/dmd/Groups/BackboneDevices",
+        "path": "/Groups/BackboneDevices", "uuid": "65142f38-df6e-482e-a74d-ec825af8e058",
+        "name": "/BackboneDevices"}], "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": 15, "type": "rpc", "method": "getDevices"}'
+    http_version: 
+  recorded_at: Mon, 25 Feb 2019 23:20:08 GMT
+- request:
+    method: post
+    uri: http://localhost:8080/zport/dmd/zport/dmd/device_router
+    body:
+      encoding: UTF-8
+      string: '[{"action":"DeviceRouter","method":"setInfo","data":[{"uid":"/zport/dmd/Devices/Server/devices/UnitTestDevice","productionState":-1}],"type":"rpc","tid":16}]'
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.3.3 (2016-11-21))
+      Accept:
+      - "*/*"
+      Date:
+      - Mon, 25 Feb 2019 23:20:08 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Cookie: ''
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 25 Feb 2019 23:20:08 GMT
+      Server: ''
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '150'
+      Set-Cookie: ''
+    body:
+      encoding: UTF-8
+      string: '{"uuid": "7e7ea36e-b80b-4fa6-bb1f-3ba6ab104996", "action": "DeviceRouter",
+        "result": {"success": true}, "tid": 16, "type": "rpc", "method": "setInfo"}'
+    http_version: 
+  recorded_at: Mon, 25 Feb 2019 23:20:08 GMT
+recorded_with: VCR 4.0.0

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

@@ -0,0 +1,100 @@
+---
+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":21}]'
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.3.3 (2016-11-21))
+      Accept:
+      - "*/*"
+      Date:
+      - Mon, 25 Feb 2019 23:20:08 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Cookie: ''
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 25 Feb 2019 23:20:08 GMT
+      Server: ''
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '1064'
+      Set-Cookie: ''
+    body:
+      encoding: UTF-8
+      string: '{"uuid": "9e2f968f-be4a-4cc2-836a-9e5687d3c86c", "action": "DeviceRouter",
+        "result": {"totalCount": 1, "hash": "1", "success": true, "devices": [{"ipAddressString":
+        null, "serialNumber": "", "pythonClass": "Products.ZenModel.Device", "hwManufacturer":
+        null, "collector": "zencollector01", "osModel": null, "productionState": -1,
+        "systems": [], "priority": 3, "hwModel": null, "tagNumber": "", "osManufacturer":
+        null, "location": null, "groups": [{"uid": "/zport/dmd/Groups/BackboneDevices",
+        "path": "/Groups/BackboneDevices", "uuid": "65142f38-df6e-482e-a74d-ec825af8e058",
+        "name": "/BackboneDevices"}], "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": 21, "type": "rpc", "method": "getDevices"}'
+    http_version: 
+  recorded_at: Mon, 25 Feb 2019 23:20:08 GMT
+- request:
+    method: post
+    uri: http://localhost:8080/zport/dmd/zport/dmd/device_router
+    body:
+      encoding: UTF-8
+      string: '[{"action":"DeviceRouter","method":"setInfo","data":[{"uid":"/zport/dmd/Devices/Server/devices/UnitTestDevice","productionState":-1}],"type":"rpc","tid":22}]'
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.3.3 (2016-11-21))
+      Accept:
+      - "*/*"
+      Date:
+      - Mon, 25 Feb 2019 23:20:08 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Cookie: ''
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 25 Feb 2019 23:20:09 GMT
+      Server: ''
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '150'
+      Set-Cookie: ''
+    body:
+      encoding: UTF-8
+      string: '{"uuid": "25ba2f17-7cdd-4229-9a5f-7c4e1d0c240b", "action": "DeviceRouter",
+        "result": {"success": true}, "tid": 22, "type": "rpc", "method": "setInfo"}'
+    http_version: 
+  recorded_at: Mon, 25 Feb 2019 23:20:09 GMT
+recorded_with: VCR 4.0.0

data/test/zenoss_client_test.rb

@@ -70,7 +70,7 @@ describe Zenoss do
   end
 
   before do
-    VCR.insert_cassette gen_cassette_name, :match_requests_on => [:method, :path, :query]
+    VCR.insert_cassette gen_cassette_name, :match_requests_on => [:method, :path, :query], :allow_playback_repeats => true
     @zen = self.class.zen
     @dev = @zen.find_devices_by_name(TEST_DEVICE_NAME).first
   end
@@ -138,6 +138,27 @@ describe Zenoss do
       renamed_device.rename_device(TEST_DEVICE_NAME)
     end
   end
+
+  if ZENOSS_VERSION > '6'
+    it 'sets info for a device' do
+      opts = {}
+      opts[:uid] = @dev.uid
+      opts[:productionState] = -1
+      set_info = @zen.set_info(opts)
+      set_info.must_be_kind_of Hash
+      set_info.wont_be_empty
+      set_info['success'].must_equal true
+    end
+
+    it 'sets info for a device on a device object' do
+      opts = {}
+      opts[:productionState] = -1
+      set_info = @dev.set_info(opts)
+      set_info.must_be_kind_of Hash
+      set_info.wont_be_empty
+      set_info['success'].must_equal true
+    end
+  end
 end
 
 describe Zenoss::Events::Event do

data/test/zenoss_model_device_test.rb

@@ -0,0 +1,25 @@
+require_relative './test_helper'
+require 'minitest/autorun'
+
+describe Zenoss::Model::Device do
+  it 'raises error on #set_info when version is less than 6' do
+    opts = {}
+    opts[:version] = '4.2.5'
+    opts[:no_sign_in] = true
+    connection = Zenoss::Connection.new('http://localhost', 'admin', 'zenoss', opts)
+    zhash = {
+      productionState: 400,
+      priority: 3,
+      uid: '/zport/dmd/Devices/Server/devices/UnitTestDevice',
+      name: 'UnitTestDevice'
+    }
+
+    dev = Zenoss::Model::Device.new(connection, zhash)
+    options = {}
+    options[:productionState] = -1
+    exception = assert_raises Zenoss::ZenossError do
+      dev.set_info(options)
+    end
+    assert_equal('setInfo method on DeviceRouter is only allowed for version 6 and above', exception.message)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zenoss_client
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Dan Wanek
@@ -205,8 +205,11 @@ files:
 - test/fixtures/vcr_cassettes/6_2_1_test_0007_fetches_the_report_tree.yml
 - test/fixtures/vcr_cassettes/6_2_1_test_0008_fetches_available_report_types_and_returns_a_Hash.yml
 - test/fixtures/vcr_cassettes/6_2_1_test_0009_renames_the_device.yml
+- test/fixtures/vcr_cassettes/6_2_1_test_0010_sets_info_for_a_device.yml
+- test/fixtures/vcr_cassettes/6_2_1_test_0011_sets_info_for_a_device_on_a_device_object.yml
 - test/test_helper.rb
 - test/zenoss_client_test.rb
+- test/zenoss_model_device_test.rb
 - tools/callZenossMethod.py
 - zenoss_client.gemspec
 homepage: http://github.com/RubyOpenSource/zenoss_client