zenoss_client 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c64cb525b567ce659a11d844a5b2d5d4e5212bdc799d320fa3134e3e3beee4d1
-  data.tar.gz: 1a3de47b44a7b48662d2b8135179f158d1d7fe06d204e587a063af2dcc7ef6e0
+  metadata.gz: 4b19b969c4c6e18b9a4e012dfb56b627c5bdd43e960cdc64a8d7a9e5036df389
+  data.tar.gz: ab09ef31c00e1e38aa6761448c84190c7bf5ee90868d97e12f2bb1aa1eef733c
 SHA512:
-  metadata.gz: c8d2eeb2cdb2bd4db0e82b9888f6cc1d3d1c766f046bb87e4f6d7d5abc1297594136c1420cf438873b16ad3ee19e5cbf40367c1d9c869e9af76a0ebd44b0038f
-  data.tar.gz: 4f64c02de20bd54c98215cb93d0302f55d8b7f85e94ca65c676eb4ab240a7c935d2925ec0f93ce9904b3865959b1f9b7a67a26ac1f249fb2aec7e24cd69b9748
+  metadata.gz: b86a0b85a3e8f36c9cc1a360e4620eff9da777389b732de7083782f9d925f353df261b647b7e8b46de29a4f035d73b116e62fb9d64d5cbcb68fb7e0d2040118e
+  data.tar.gz: aa516bb6da3f17bc94871fdc1dda6ee0582737eda7ba5e9aee33e5095aa0b2fcf9261c152ddd30d06217c36fca1df364c2f0c9f8c69d476b08831976bf258750

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.10.0
+0.10.1

data/zenoss_client.gemspec

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+
 lib = File.expand_path('lib/', __FILE__)
 $:.unshift lib unless $:.include?(lib)
 require 'date'
@@ -18,7 +19,7 @@ Gem::Specification.new do |gem|
   gem.license = 'GPL-3.0'
   gem.description = <<-EOF
     This is a wrapper around the Zenoss JSON and REST APIs. For the most things it
-    should feel very familiar to zendmd, but there are some changes do to the merging
+    should feel very familiar to zendmd, but there are some changes due to the merging
     of the JSON and REST APIs. Please read the API docs for Zenoss and the YARDDoc for
     this gem (rdoc.info).
   EOF
@@ -30,8 +31,8 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = '>= 2.0.0-p648'
   gem.add_runtime_dependency  'httpclient', '~> 2.0'
-  gem.add_runtime_dependency  'tzinfo', '~> 0.3.20'
-  gem.add_runtime_dependency  'json', '~> 1.5'
+  gem.add_runtime_dependency  'tzinfo', '~> 2.0.2'
+  gem.add_runtime_dependency  'json', '~> 2.3'
 
   gem.add_development_dependency('rake')
   gem.add_development_dependency('minitest')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zenoss_client
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Dan Wanek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2020-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo