sky_zabbix 2.4.0.1.1 → 2.4.0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fb647d368370fcae96f40b4bec79c2c8ac12df2
-  data.tar.gz: 609a93e458e73c4722ae198b1057b17ab346f1b5
+  metadata.gz: 88126fe264f9f23743b4070832f3488d3c133b94
+  data.tar.gz: c0fb42cfd106f0cafd9a83c3b70fbd7fb099c674
 SHA512:
-  metadata.gz: 49b47e355888f9778153849432a4616b676b2c7417262ae9533a19f7d7d77de807d98a84147096ac84e426b113cb443e2b8488335706a98be27b0de82ef480e1
-  data.tar.gz: 7bfea44310ff870fadc04bb8f05b59576a709a1b92f6f81468a25555203fe5c5e588de5cc2969f872f55f84ec5400d465d68e38dad6c0bf0d093fd3af7627459
+  metadata.gz: bd187bc00c8411decdae5a3ce5145a88ad4edb40489000a470e0feca7c3cd5a79157ffba5783262234c0fca078ea5ccc0daa4867892b6452dac654653a69d936
+  data.tar.gz: c0936ecee108baed4826554888390e126401d972dd0120abb0366d1c4a7eacca06617838742b0f0933dd8df93ce5481910eb1886d293bd303e06c3f1b5328d1b

data/README.md

@@ -89,7 +89,21 @@ requests = []
 requests.push client.host.build_get()
 requests.push client.user.build_get()
 requests.push client.hostgroup.build_get()
-host_resp, user_resp, hostgroup_resp = cleint.batch(*requests)
+host_resp, user_resp, hostgroup_resp = client.batch(*requests)
+```
+
+### Logger
+
+Don't log on default.
+If logger is received to constructor, SkyZabbix start logging.
+
+```ruby
+require 'logger'
+logger = Logger.new(STDOUT)
+client = SkyZabbix::Client.new(zabbix_url, logger: logger)
+client.login(zabbix_user, zabbix_pass)
+
+client.host.get()   # =>  I, [2015-06-29T17:35:19.609971 #3500]  INFO -- : [SkyZabbix 200 5.296144592] host.get({})
 ```
 
 ## Development

data/Rakefile

@@ -3,14 +3,11 @@ require "rspec/core/rake_task"
 require 'open3'
 require 'json'
 
-require_relative 'lib/sky_zabbix/version'
-
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
 
 namespace :generate do
-  #TODO: clone zabbix/zabbix, version
   desc "Generate list of method"
   task :methods do |task, args|
     out, err, status = Open3.capture3("php", "build.php")
@@ -27,12 +24,40 @@ namespace :release do
   task :all do |task, args|
     exec = -> (cmd) {
       print '> '; puts cmd.join(' ')
-      system(*cmd)
+      r = system(*cmd)
+      unless r
+        raise "#{cmd} exit with #{$?}"
+      end
+    }
+
+    get_env = -> (name) {
+      v = ENV[name]
+      raise "#{name} environment variable should be set!" unless v
+      return v
     }
 
     versions = %w[2.2 2.4]
-    path = ENV['PATH_ZABBIX']
+    path        = get_env.('PATH_ZABBIX')
+    lib_version = get_env.('LIB_VERSION')
 
+    # check git status
+    unless `git status --short`.empty?
+      raise "Should commit some changes."
+    end
+
+    # Update version
+    v_path = File.expand_path('../lib/sky_zabbix/version.rb', __FILE__)
+    f = File.read(v_path)
+    f[/^\s+LIB_VERSION = "([\d.]+)"$/, 1] = lib_version
+    File.write(v_path, f)
+
+    # version up commit and add tag and push.
+    exec.(%W[git commit -am "Bump\ up\ version to #{lib_version}"])
+    exec.(%W[git tag v#{lib_version}])
+    exec.(%w[git push])
+    exec.(%W[git push origin v#{lib_version}])
+
+    # build gems
     versions.each do |v|
       Dir.chdir(path) do
         latest_tag = `git tag`.split("\n").select{|x|x =~ /^#{Regexp.escape(v)}/}.sort{|a, b|a[/\.(\d+)$/, 1].to_i <=> b[/\.(\d+)$/, 1].to_i}.last
@@ -41,7 +66,9 @@ namespace :release do
       Rake::Task['generate:methods'].execute
       Rake::Task['build'].execute
     end
-    pkgs = Dir.glob(File.join(File.expand_path('../pkg/', __FILE__), "sky_zabbix-*#{SkyZabbix::LIB_VERSION}.gem"))
+
+    pkgs = Dir.glob(File.join(File.expand_path('../pkg/', __FILE__), "sky_zabbix-*#{lib_version}.gem"))
+    # Push gems
     pkgs.each do |p|
       exec.(%W[gem push #{p}])
     end

data/lib/sky_zabbix/client/target_base.rb

@@ -1,3 +1,4 @@
+# TargetBase is a Base Class for target of Zabbix API method.
 # @abstract
 class SkyZabbix::Client::TargetBase
   # @return [String]
@@ -14,6 +15,7 @@ class SkyZabbix::Client::TargetBase
     @client = client
   end
 
+  # Returns list of filtered primary key.
   # @param [Hash] filter
   # @return [Array<String>] List of ID
   def get_ids(filter)
@@ -24,6 +26,7 @@ class SkyZabbix::Client::TargetBase
     return _query('get', params).map{|x|x[pk]}
   end
 
+  # Return filtered primary key of founded first.
   # @param [Hash] filter
   # @return [Array<String>] ID of founded first.
   def get_id(filter)
@@ -40,6 +43,7 @@ class SkyZabbix::Client::TargetBase
 
   # @param [String] method is method name. ex) get, create, delete ...
   # @param [Any] params is parameters.
+  # @return [Hash{Symbol => Any}]
   def _build(method, params)
     raise "Should use method of sub class!" unless _zbx_class
     @client.build("#{_zbx_class}.#{method}", params)
@@ -49,4 +53,9 @@ class SkyZabbix::Client::TargetBase
   def _zbx_class
     return self.class._zbx_class
   end
+
+  # @abstract
+  def pk
+    raise 'Should override pk method!'
+  end
 end

data/lib/sky_zabbix/client/target_gen.rb

@@ -13,12 +13,17 @@ methods.each do |name, v|
     v[:methods].each do |method|
       # Generate query method.
       # Example: user.login()
+      # @param [Any] params
+      # @return [Any] return query response.
       define_method(method) do |params={}|
         _query(method, params)
       end
 
       # Generate build method. For batch request
       # Example: user.build_login()
+      # @param [Any] params
+      # @return [Hash{}] return query response.
+      # @return [Hash{Symbol => Any}]
       define_method("build_#{method}") do |params={}|
         _build(method, params)
       end

data/lib/sky_zabbix/jsonrpc.rb

@@ -12,6 +12,7 @@ class SkyZabbix::Jsonrpc
 
   attr_accessor :token
 
+  # Send normal request.
   # @param [String] method is json-rpc method name.
   # @param [Any?] params is json-rpc parameters.
   # @param [Boolean] notification
@@ -19,23 +20,7 @@ class SkyZabbix::Jsonrpc
     request(build(method, params, notification: notification))
   end
 
-  # @param [Hash{String => Any}] builded is result of 'build' method.
-  # @return [Any?] return result of response
-  def request(builded)
-    uri = URI.parse(@uri)
-
-    resp = do_req(uri, builded)
-
-    return nil unless builded[:id] # when notification
-
-    # Parse and error handling
-    body = JSON.parse(resp.body)
-    raise Error.create(body) if body['error']
-
-    return body['result']
-  end
-
-  # XXX: エラー処理はこれでいい?
+  # Send batch request.
   # @example Return values.
   #   rpc.batch(
   #     rpc.build('a', 'A'),
@@ -50,7 +35,8 @@ class SkyZabbix::Jsonrpc
   #   ) # => Error::BatchError.
   #   #  Can get response of 'a' from ex.result
   # @param [Array<Hash>] buildeds is Array of result of 'build' method.
-  # @return [Array<Any|Error|nil>]
+  # @return [Array<Any|nil>]
+  # @raise [Error::BatchError]
   def batch(buildeds)
     uri = URI.parse(@uri)
     resp = do_req(uri, buildeds)
@@ -83,6 +69,7 @@ class SkyZabbix::Jsonrpc
   # @param [String] method is json-rpc method name.
   # @param [Any?] params is json-rpc parameters.
   # @param [Boolean] notification
+  # @return [Hash{Symbol => Any}]
   def build(method, params, notification: false)
     res = {
       jsonrpc: VERSION,
@@ -98,6 +85,22 @@ class SkyZabbix::Jsonrpc
 
   private
 
+  # @param [Hash{String => Any}] builded is result of 'build' method.
+  # @return [Any?] return result of response
+  def request(builded)
+    uri = URI.parse(@uri)
+
+    resp = do_req(uri, builded)
+
+    return nil unless builded[:id] # when notification
+
+    # Parse and error handling
+    body = JSON.parse(resp.body)
+    raise Error.create(body) if body['error']
+
+    return body['result']
+  end
+
   # @return [Integer] random ID.
   def id_gen
     return rand(10**12)
@@ -131,7 +134,7 @@ class SkyZabbix::Jsonrpc
   # @param [Hash|Array] body is request body.
   # @param [Net::HTTPResponse] resp
   def logging_request(start_time, body, resp)
-    return unless @logger
+    return unless @logger && resp
 
     sec = Time.now - start_time
     msg_body =

data/lib/sky_zabbix/jsonrpc/errors.rb

@@ -1,4 +1,5 @@
 class SkyZabbix::Jsonrpc::Error < StandardError
+  # @param [Array<Hash{String => Any}>] body is response body.
   def initialize(body)
     @error = body['error']
     msg = "#{@error['message']} #{@error['data']}"
@@ -13,6 +14,8 @@ class SkyZabbix::Jsonrpc::Error < StandardError
   class InternalError  < self; end # Internal JSON-RPC error.
   class ServerError    < self; end # Reserved for implementation-defined server-errors.
 
+  # @param [Array<Hash{String => Any}>] body is response body.
+  # @return [Error] A Error instance.
   def self.create(body)
     klass =
       case body['code']
@@ -41,7 +44,7 @@ class SkyZabbix::Jsonrpc::Error < StandardError
       return errors.map(&:message).join(', ')
     end
 
-    # @param [Array<Hash<String => Any>] body is response body.
+    # @param [Array<Hash{String => Any}>] body is response body.
     # @return [Boolean]
     def self.error?(body)
       return body.any?{|x|x['error']}

data/lib/sky_zabbix/version.rb

@@ -1,7 +1,7 @@
 require 'json'
 
 module SkyZabbix
-  LIB_VERSION = "0.1.1"
+  LIB_VERSION = "0.1.2"
   ZABBIX_VERSION = JSON.parse(File.read(File.expand_path('../methods.json', __FILE__)), symbolize_names: true)[:version]
   VERSION = ZABBIX_VERSION + '.' + LIB_VERSION
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sky_zabbix
 version: !ruby/object:Gem::Version
-  version: 2.4.0.1.1
+  version: 2.4.0.1.2
 platform: ruby
 authors:
 - Skyarch Networks Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2016-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: An API Wrapper of Zabbix