zabbixapi 3.1.0 → 3.2.1

data/lib/zabbixapi/classes/users.rb

@@ -1,43 +1,65 @@
 class ZabbixApi
   class Users < Basic
-
+    # The method name used for interacting with Users via Zabbix API
+    #
+    # @return [String]
     def method_name
-      "user"
+      'user'
     end
 
+    # The keys field name used for User objects via Zabbix API
+    #
+    # @return [String]
     def keys
-      "userids"
+      'userids'
     end
 
+    # The key field name used for User objects via Zabbix API
+    #
+    # @return [String]
     def key
-      "userid"
+      'userid'
     end
 
+    # The id field name used for identifying specific User objects via Zabbix API
+    #
+    # @return [String]
     def indentify
-      "alias"
+      'alias'
     end
 
+    # Add media to users using Zabbix API
+    #
+    # @param data [Hash] Needs to include userids and media to mass add media to users
+    # @raise [ApiError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Integer] Zabbix object id (media)
     def add_medias(data)
       result = @client.api_request(
-        :method => "user.addMedia",
+        :method => 'user.addMedia',
         :params => {
           :users => data[:userids].map { |t| {:userid => t} },
-          :medias => data[:media]
+          :medias => data[:media],
         }
       )
       result ? result['mediaids'][0].to_i : nil
     end
 
+    # Update media for users using Zabbix API
+    #
+    # @param data [Hash] Needs to include userids and media to mass update media for users
+    # @raise [ApiError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Integer] Zabbix object id (user)
     def update_medias(data)
       result = @client.api_request(
-        :method => "user.updateMedia",
+        :method => 'user.updateMedia',
         :params => {
           :users => data[:userids].map { |t| {:userid => t} },
-          :medias => data[:media]
+          :medias => data[:media],
         }
       )
       result ? result['userids'][0].to_i : nil
     end
-
   end
 end

data/lib/zabbixapi/classes/valuemaps.rb

@@ -0,0 +1,50 @@
+class ZabbixApi
+  class ValueMaps < Basic
+    # The method name used for interacting with ValueMaps via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'valuemap'
+    end
+
+    # The key field name used for ValueMap objects via Zabbix API
+    #
+    # @return [String]
+    def key
+      'valuemapid'
+    end
+
+    # The id field name used for identifying specific ValueMap objects via Zabbix API
+    #
+    # @return [String]
+    def indentify
+      'name'
+    end
+
+    # Get or Create ValueMap object using Zabbix API
+    #
+    # @param data [Hash] Needs to include valuemapids [List] to properly identify ValueMaps via Zabbix API
+    # @raise [ApiError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Integer] Zabbix object id
+    def get_or_create(data)
+      log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
+
+      unless (id = get_id(:valuemapids => data[:valuemapids]))
+        id = create(data)
+      end
+      id
+    end
+
+    # Create or update Item object using Zabbix API
+    #
+    # @param data [Hash] Needs to include valuemapids to properly identify ValueMaps via Zabbix API
+    # @raise [ApiError] Error returned when there is a problem with the Zabbix API call.
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Integer] Zabbix object id
+    def create_or_update(data)
+      valuemapid = get_id(:name => data[:name])
+      valuemapid ? update(data.merge(:valuemapids => [:valuemapid])) : create(data)
+    end
+  end
+end

data/lib/zabbixapi/client.rb

@@ -1,20 +1,27 @@
-require 'json'
-require 'net/https'
 require 'net/http'
+require 'json'
 
 class ZabbixApi
   class Client
+    # @param (see ZabbixApi::Client#initialize)
+    # @return [Hash]
+    attr_reader :options
 
-    attr :options
-
+    # @return [Integer]
     def id
-      rand(100000)
+      rand(100_000)
     end
 
+    # Returns the API version from the Zabbix Server
+    #
+    # @return [String]
     def api_version
-      @version ||= api_request(:method => "apiinfo.version", :params => {})
+      @version ||= api_request(:method => 'apiinfo.version', :params => {})
     end
 
+    # Log in to the Zabbix Server and generate an auth token using the API
+    #
+    # @return [Hash]
     def auth
       api_request(
         :method => 'user.login',
@@ -25,9 +32,20 @@ class ZabbixApi
       )
     end
 
+    # Initializes a new Client object
+    #
+    # @param options [Hash]
+    # @option opts [String] :url The url of zabbixapi(example: 'http://localhost/zabbix/api_jsonrpc.php')
+    # @option opts [String] :user
+    # @option opts [String] :password
+    # @option opts [String] :http_user A user for basic auth.(optional)
+    # @option opts [String] :http_password A password for basic auth.(optional)
+    # @option opts [Integer] :timeout Set timeout for requests in seconds.(default: 60)
+    #
+    # @return [ZabbixApi::Client]
     def initialize(options = {})
       @options = options
-      if ENV['http_proxy'] != nil && options[:no_proxy] != true
+      if !ENV['http_proxy'].nil? && options[:no_proxy] != true
         @proxy_uri = URI.parse(ENV['http_proxy'])
         @proxy_host = @proxy_uri.host
         @proxy_port = @proxy_uri.port
@@ -39,39 +57,44 @@ class ZabbixApi
       @auth_hash = auth
     end
 
+    # Convert message body to JSON string for the Zabbix API
+    #
+    # @param body [Hash]
+    # @return [String]
     def message_json(body)
       message = {
         :method  => body[:method],
         :params  => body[:params],
         :id      => id,
-        :jsonrpc => '2.0'
+        :jsonrpc => '2.0',
       }
 
-      message[:auth] = @auth_hash unless (body[:method] == 'apiinfo.version' or body[:method] == 'user.login')
+      message[:auth] = @auth_hash unless body[:method] == 'apiinfo.version' || body[:method] == 'user.login'
 
       JSON.generate(message)
     end
 
+    # @param body [String]
+    # @return [String]
     def http_request(body)
       uri = URI.parse(@options[:url])
+
       # set the time out the default (60) or to what the user passed
-      @options[:timeout] == nil ? timeout = 60 : timeout = @options[:timeout]
+      timeout = @options[:timeout].nil? ? 60 : @options[:timeout]
       puts "[DEBUG] Timeout for request set to #{timeout} seconds" if @options[:debug]
 
-      unless @proxy_uri.nil?
+      if @proxy_uri
         http = Net::HTTP.Proxy(@proxy_host, @proxy_port, @proxy_user, @proxy_pass).new(uri.host, uri.port)
-
-        if uri.scheme == 'https'
-          http.use_ssl = true
-          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-        end
       else
         http = Net::HTTP.new(uri.host, uri.port)
-        if uri.scheme == 'https'
-          http.use_ssl = true
-          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-        end
       end
+
+      if uri.scheme == 'https'
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      http.open_timeout = timeout
       http.read_timeout = timeout
 
       request = Net::HTTP::Post.new(uri.request_uri)
@@ -79,21 +102,37 @@ class ZabbixApi
       request.add_field('Content-Type', 'application/json-rpc')
       request.body = body
       response = http.request(request)
+
       raise HttpError.new("HTTP Error: #{response.code} on #{@options[:url]}", response) unless response.code == '200'
+
       puts "[DEBUG] Get answer: #{response.body}" if @options[:debug]
       response.body
     end
 
+    # @param body [String]
+    # @return [Hash, String]
     def _request(body)
       puts "[DEBUG] Send request: #{body}" if @options[:debug]
       result = JSON.parse(http_request(body))
-      raise ApiError.new("Server answer API error\n #{JSON.pretty_unparse(result['error'])}\n on request:\n #{JSON.pretty_unparse(JSON.parse(body))}", result) if result['error']
+      raise ApiError.new("Server answer API error\n #{JSON.pretty_unparse(result['error'])}\n on request:\n #{pretty_body(body)}", result) if result['error']
       result['result']
     end
 
+    def pretty_body(body)
+      parsed_body = JSON.parse(body)
+
+      # If password is in body hide it
+      parsed_body['params']['password'] = '***' if parsed_body['params'].is_a?(Hash) && parsed_body['params'].key?('password')
+
+      JSON.pretty_unparse(parsed_body)
+    end
+
+    # Execute Zabbix API requests and return response
+    #
+    # @param body [Hash]
+    # @return [Hash, String]
     def api_request(body)
       _request message_json(body)
     end
-
   end
 end

data/lib/zabbixapi/version.rb

@@ -1,3 +1,3 @@
 class ZabbixApi
-  VERSION = "3.1.0"
+  VERSION = '3.2.1'.freeze
 end

data/zabbixapi.gemspec

@@ -1,26 +1,29 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'zabbixapi/version'
 
-Gem::Specification.new do |s|
-  s.name        = "zabbixapi"
-  s.version     = ZabbixApi::VERSION
-  s.authors     = ["Vasiliev D.V.", "Ivan Evtuhovich"]
-  s.email       = %w(vadv.mkn@gmail.com evtuhovich@gmail.com)
-  s.homepage    = "https://github.com/express42/zabbixapi"
-  s.summary     = %q{Realization for Zabbix API.}
-  s.description = %q{Allows you to work with zabbix api from ruby.}
-  s.licenses    = %w(MIT)
-
-  s.add_runtime_dependency 'json'
-  s.required_ruby_version = Gem::Requirement.new(">= 2".freeze)
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec'
-
-  s.rubyforge_project = "zabbixapi"
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = %w(lib)
+Gem::Specification.new do |spec|
+  spec.add_dependency 'http', '~> 2.0'
+  spec.add_dependency 'json', '~> 2.0'
+  spec.add_development_dependency 'bundler', '~> 1.0'
+
+  spec.name        = 'zabbixapi'
+  spec.version     = ZabbixApi::VERSION
+  spec.authors     = ['Vasiliev D.V.', 'Ivan Evtuhovich']
+  spec.email       = ['vadv.mkn@gmail.com', 'evtuhovich@gmail.com']
+
+  spec.summary     = 'Simple and lightweight ruby module for working with the Zabbix API'
+  spec.description = 'Allows you to work with zabbix api from ruby.'
+  spec.homepage    = 'https://github.com/express42/zabbixapi'
+  spec.licenses    = 'MIT'
+
+  spec.rubyforge_project = 'zabbixapi'
+
+  spec.files         = ['.yardopts', 'CHANGELOG.md', 'LICENSE.md', 'README.md', 'zabbixapi.gemspec'] + Dir['lib/**/*.rb']
+  spec.require_paths = 'lib'
+  spec.required_ruby_version = '>= 2.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zabbixapi
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.1
 platform: ruby
 authors:
 - Vasiliev D.V.
@@ -9,50 +9,50 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-23 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '2.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 description: Allows you to work with zabbix api from ruby.
 email:
 - vadv.mkn@gmail.com
@@ -61,17 +61,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
-- LICENSE
+- LICENSE.md
 - README.md
-- Rakefile
-- json-1.x.Gemfile
-- json-1.x.Gemfile.lock
 - lib/zabbixapi.rb
 - lib/zabbixapi/basic/basic_alias.rb
 - lib/zabbixapi/basic/basic_func.rb
@@ -98,29 +91,9 @@ files:
 - lib/zabbixapi/classes/usergroups.rb
 - lib/zabbixapi/classes/usermacros.rb
 - lib/zabbixapi/classes/users.rb
+- lib/zabbixapi/classes/valuemaps.rb
 - lib/zabbixapi/client.rb
 - lib/zabbixapi/version.rb
-- spec/action.rb
-- spec/application.rb
-- spec/basic_func.rb
-- spec/configuration.rb
-- spec/graph.rb
-- spec/host.rb
-- spec/hostgroup.rb
-- spec/httptest.rb
-- spec/item.rb
-- spec/maintenance.rb
-- spec/mediatype.rb
-- spec/query.rb
-- spec/screen.rb
-- spec/script.rb
-- spec/server.rb
-- spec/spec_helper.rb
-- spec/template.rb
-- spec/trigger.rb
-- spec/user.rb
-- spec/usergroup.rb
-- spec/usermacro.rb
 - zabbixapi.gemspec
 homepage: https://github.com/express42/zabbixapi
 licenses:
@@ -134,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -142,29 +115,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: zabbixapi
-rubygems_version: 2.6.10
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Realization for Zabbix API.
-test_files:
-- spec/action.rb
-- spec/application.rb
-- spec/basic_func.rb
-- spec/configuration.rb
-- spec/graph.rb
-- spec/host.rb
-- spec/hostgroup.rb
-- spec/httptest.rb
-- spec/item.rb
-- spec/maintenance.rb
-- spec/mediatype.rb
-- spec/query.rb
-- spec/screen.rb
-- spec/script.rb
-- spec/server.rb
-- spec/spec_helper.rb
-- spec/template.rb
-- spec/trigger.rb
-- spec/user.rb
-- spec/usergroup.rb
-- spec/usermacro.rb
+summary: Simple and lightweight ruby module for working with the Zabbix API
+test_files: []