zenoss_api 0.2.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02ea431c2beadc81cf178cdd7b1a8986fa0d0d3d
-  data.tar.gz: 6df145478e48b9e4cdec8bd5e38b40bb16ed6d5b
+  metadata.gz: 268afdc946036a964e71a205ae5dc00c8fbf4082
+  data.tar.gz: 0eff486cdeacf9d2b876ea6c8c973437fad79aac
 SHA512:
-  metadata.gz: 912a9fe207ca7021244f94a23a74585310b03597e09101b96d4358fd5c47dd017172abfec1a69dbb4bca5b032345a0fdbd01feaccd35529ca468369f54dbabcf
-  data.tar.gz: 3af7d6c35a9588277cafdeb43795d2d21588b679808ff554c1c8586a226512ac47a579a2ec903e93d05f37b40fc23909eac9a98564562b6449c7b16d92d054df
+  metadata.gz: cb7b5b69304243c9bc2b05ea309049621ff12650f053b4e7cb769ca1312a20b3268d0968fd29f4b08dfabf6dcea34c92ccbe57c4b31d0d6256b19f30f272b9d9
+  data.tar.gz: ef4ada9af5a98ec50a1c2157ca1745a7bdf540ce76c6b4a2eeb02a72676303738daf0e9345f3ab3035827b0fa48da4db8cf2a724af563f2cddba4ae4295842e7

data/README.md

@@ -4,8 +4,6 @@ Command line interface abstraction of zenoss api method calls.
 
 ## Installation
 
-*Not currently published to rubygems.org, see Development*
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -25,7 +23,7 @@ Or install it yourself as:
 Get all device classes:
 
 ```bash
-zenapi -m getDevices -p name:admin01.ctl.gdl.englab.netapp.com | jq '.devices[]'
+zenapi -m getDeviceClasses | jq '.devices[]'
 ```
 
 Get all groups:
@@ -37,12 +35,12 @@ zenapi -m getGroups | jq '.groups[] | .name'
 Get devices in device class, limit to 30:
 
 ```bash
-zenapi --uid '/Devices/Server/Linux/CTL' --limit 30 | jq '.devices[] | .name'
+zenapi --uid '/Devices/Server/Linux' --limit 30 | jq '.devices[] | .name'
 ```
 Get device by name:
 
 ```bash
-zenapi -m getDevices -a name:admin01.ctl.gdl.englab.netapp.com
+zenapi -m getDevices -a name:hostname.fqdn
 ```
 
 Get most recent events, limit to 10:

data/bin/zenapi

@@ -18,7 +18,7 @@ options = {
   :zenoss_instance => zenrc['url'],
   :router => 'DeviceRouter',
   :method => 'getDevices',
-  :filters => {},
+  :zenoss_params_arg => [],
   :limit => nil,
   :uid => nil,
   :keys => nil,
@@ -43,18 +43,14 @@ opts_parser = OptionParser.new do |opts|
   opts.on('-m', '--method method', 'method: default is getDevices') do |method|
     options[:method] = method
   end
-  opts.on('-f', '--filters key:value', 'method filter: default is none') do |filters|
-    filters_hash = {}
-    if filters.match /^({.*})$/ 
-      filters_hash = JSON.parse(filters)
+  opts.on('-p', '--params key=value', Array, 'zenoss method params: default is none') do |params|
+    if params[0].match /^({.*})$/ 
+      params_hash = JSON.parse(params)
     else 
-      filters_array = filters.split(",")
-      filters_array.each do |i|
-        e = i.split(":")
-        filters_hash[e[0]] = e[1]
-      end
+      key_pairs = params.map { |x| x.split('=') } 
+      key_hashes = key_pairs.map { |y| { y[0] => y[1] } } 
+      key_hashes.each { |k| options[:zenoss_params_arg].push k } 
     end
-    options[:filters] = filters_hash
   end
   opts.on('-l', '--limit integer', 'limit results: default 50') do |limit|
     options[:limit] = limit.to_i
@@ -68,8 +64,8 @@ opts_parser = OptionParser.new do |opts|
   opts.on('-k', '--keys key1,key2,key3', Array, 'list of keys to return: defaull all') do |keys|
     options[:keys] = keys
   end
-  opts.on('-a', '--args arg1:val1,arg2:val2', Array, 'arugments:values passed to api method') do |arguments|
-    key_pairs = arguments.map { |x| x.split(':') } 
+  opts.on('-a', '--arg arg1=val1', Array, 'arugment=value passed to api method') do |arguments|
+    key_pairs = arguments.map { |x| x.split('=') } 
     key_hashes = key_pairs.map { |y| { y[0] => y[1] } } 
     key_hashes.each { |k| options[:arguments].push k } 
   end
@@ -111,6 +107,10 @@ opts_parser = OptionParser.new do |opts|
     json = JSON.parse(uids)
     options[:uids_file] = json  
   end
+  opts.on('-v', '--version') do
+    puts ZenossApi::VERSION
+    exit 0
+  end
 end
 
 opts_parser.parse!
@@ -140,40 +140,44 @@ if options[:password].nil?
   STDOUT.flush
 end
 
-z = ZenossAPI::Client.new(options[:zenoss_instance], options[:username], options[:password], options[:verify_ssl])
+z = ZenossApi::Client.new(options[:zenoss_instance], options[:username], options[:password], options[:verify_ssl])
 
-method_params = {}
+api_method_args = {}
 
-if ZenossAPI::METHOD_PARAMS.key? options[:router].to_sym
-default_method_parms = ZenossAPI::METHOD_PARAMS[options[:router].to_sym][options[:method].to_sym]
+if ZenossApi::DEFAULT_API_METHOD_ARGS.key? options[:router].to_sym
+default_api_method_args = ZenossApi::DEFAULT_API_METHOD_ARGS[options[:router].to_sym][options[:method].to_sym]
 end
 
-if default_method_parms
-  default_method_parms.each do |k,v|
-    # options override default params
-    method_params[k] = options[k.to_sym] || v
+if default_api_method_args
+  default_api_method_args.each do |k,v|
+    # args passed as options override default api method args
+    api_method_args[k] = options[k.to_sym] || v
   end
 end
 
-method_params['uid'] = z.validateUids(options[:uid]) unless not options[:uid]
-method_params['uids'] = z.validateUids(options[:uids]) unless not options[:uids]
-method_params['keys'] = options[:keys] unless not options[:keys]
-method_params['limit'] = options[:limit] unless not options[:limit]
-method_params['hashcheck'] = options[:hashcheck] unless not options[:hashcheck]
-method_params['action'] = options[:action] unless not options[:action]
-method_params['start'] = options[:offset] unless not options[:offset]
+api_method_args['uid'] = z.validateUids(options[:uid]) unless not options[:uid]
+api_method_args['uids'] = z.validateUids(options[:uids]) unless not options[:uids]
+api_method_args['keys'] = options[:keys] unless not options[:keys]
+api_method_args['limit'] = options[:limit] unless not options[:limit]
+api_method_args['hashcheck'] = options[:hashcheck] unless not options[:hashcheck]
+api_method_args['action'] = options[:action] unless not options[:action]
+api_method_args['start'] = options[:offset] unless not options[:offset]
 
 
 options[:arguments].each do |arg|
-  method_params.merge! arg
+  api_method_args.merge! arg
 end
 
-# filters set in  method parameter 'params' from key:value hash
-method_params['params'] = options[:filters] unless options[:filters].empty?
-#method_params['params'] = { 'productionState' => 1000 }
+# zenoss method params parameter from options[:params] array of hashes 
+if not options[:zenoss_params_arg].empty?
+  api_method_args['params'] = {}
+  options[:zenoss_params_arg].each do |param|
+    api_method_args['params'].merge! param
+  end
+end
 
 if options[:command] == "api" 
-  response = z.router(options[:router], options[:method], method_params, options)
+  response = z.router(options[:router], options[:method], api_method_args, options)
 
   if options[:paginate]
     response.each do |x|
@@ -184,7 +188,7 @@ if options[:command] == "api"
       p response.headers.to_json
     end
   
-   response['query'] = method_params 
+   response['query'] = api_method_args
    puts response.to_hash.to_json
   end
 end
@@ -203,3 +207,4 @@ exit 0
 #########################################
 #[{"tid": 1, "type": "rpc", "method_params": [], "method": "getDeviceClasses", "action": "DeviceRouter"}]
 
+

data/lib/zenoss_api/version.rb

@@ -1,3 +1,3 @@
 module ZenossApi
-  VERSION = "0.2.0"
+  VERSION = "0.3.2"
 end

data/lib/zenoss_api.rb

@@ -1,6 +1,6 @@
 require "zenoss_api/version"
 
-module ZenossAPI
+module ZenossApi
   require 'json'
   require 'httparty'
  
@@ -21,9 +21,10 @@ module ZenossAPI
     :JobsRouter => 'jobs',
     :IntrospectionRouter => 'introspection',
     :UsersRouter => 'users',
+    :EventClassesRouter => 'Events/evclasses',
   }
   
-  METHOD_PARAMS = { 
+  DEFAULT_API_METHOD_ARGS = { 
     :DeviceRouter => {
       :getDevices => {
         'uid' => nil,

data/zenoss_api.gemspec

@@ -16,12 +16,12 @@ Gem::Specification.new do |spec|
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against " \
+  #    "public gem pushes."
+  #end
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: zenoss_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Todd Stoll
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-25 00:00:00.000000000 Z
+date: 2018-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: io-console
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Execute api calls given the router, method, and parameters. Returns response
@@ -89,7 +89,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -104,25 +104,24 @@ files:
 homepage: ''
 licenses:
 - MIT
-metadata:
-  allowed_push_host: 'TODO: Set to ''http://mygemserver.com'''
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Zenoss API via command line.