zabbix_api_gem 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6c8f297f2139a9f7c49a789f9e1ffd4600e5912d9e0b1a63330f761752fcd1e
-  data.tar.gz: 50b8942c322c9875c94c28a75080feb1b72f93910511e2bfa10c3353740577d7
+  metadata.gz: 2931f6d3227276d1c3120dfc210eae257e5224898a6374964eeb54b7a3644b0d
+  data.tar.gz: 397ac9e648e3c451bbc3a3334a1672067fbfa4fc271e00dff774bdf103aa8af2
 SHA512:
-  metadata.gz: ba97284983467df1d8b2ead9f52b04883f5978bf78c38d0d0c3fc229cbc5a07ce81cb3ec8d79c5332ec591e6c0f7943f60d7cea4c29a57d0650c8e6a764bfc08
-  data.tar.gz: 28858aaa64c5fb2e9666949d83108e1751192d64042023afb6e7800ff037fe6e810f972692e8e5179c0fd89d0d5e506e03b56c762821a2162ab1f5a026f6a757
+  metadata.gz: f2daaeb129b09004f106f296cee34f9137ad856b02e60c862697ce66b424ea770b6572cbc169d0b1c46023947988ff38055eed9ee1a56fd723290b8e2809458e
+  data.tar.gz: 0ea22a6f6b11afa5fd5499aac69bc425bed70a23710a669878a44789ef82aaa8440835bb37254de0144dbdeccc3a337ddae8ee68a2268e08a8cb459102f4c3d9

data/CHANGELOG.md

@@ -2,3 +2,10 @@
 
 ## [0.1.0] - 2024-02-09
 - Initial release
+
+## [0.2.0] - 2024-02-12
+- Include events and method to get object by id
+
+## [0.3.0] - 2024-02-20
+- ConfigurationError raised if not configured properly
+

data/Gemfile

@@ -7,4 +7,5 @@ gemspec
 
 gem 'rake', '~> 13.0'
 gem 'rubocop', '~> 1.7'
+gem 'simplecov', require: false, group: :test
 gem 'wrapi'

data/README.md

@@ -1,4 +1,7 @@
 # Zabbix API
+[![Version](https://img.shields.io/gem/v/zabbix_api_gem.svg)](https://rubygems.org/gems/zabbix_api_gem)
+[![Maintainability](https://api.codeclimate.com/v1/badges/de2999161abdc8179fde/maintainability)](https://codeclimate.com/github/jancotanis/zabbix/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/de2999161abdc8179fde/test_coverage)](https://codeclimate.com/github/jancotanis/zabbix/test_coverage)
 
 This is a wrapper for the Zabix rest API. You can see the API endpoints here https://www.zabbix.com/documentation/current/en/manual/api/reference/
 
@@ -24,7 +27,7 @@ Or install it yourself as:
 
 Before you start making the requests to API provide the client id and client secret and email/password using the configuration wrapping.
 
-```
+```ruby
 require 'zabbix_api_gem'
 
 # use do block
@@ -47,7 +50,7 @@ end
 
 ## Resources
 ### Authentication
-```
+```ruby
 # setup configuration
 #
 client.login
@@ -59,7 +62,7 @@ client.login
 
 ### Server settings
 Return zabbix server settings
-```
+```ruby
 puts client.settings.default_theme
 ```
 
@@ -84,15 +87,16 @@ end
 
 |Resource|API endpoint|
 |:--|:--|
-|.hostgroups|hostgroup.get|
-|.hosts|hosts.get|
-|.problems|problems.get|
+|hostgroups, hostgroup(hostgroup_id)|hostgroup.get|
+|.hosts, host(host_id)|hosts.get|
+|.problems, problem(event_id)|problems.get|
+|.events, event(event_id)|problems.get|
 
 
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jancotanis/veeam.
+Bug reports and pull requests are welcome on GitHub at https://github.com/jancotanis/zabbix.
 
 ## License
 

data/Rakefile

@@ -1,12 +1,20 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
+require 'dotenv'
 require 'rake/testtask'
 
+Dotenv.load
+
+system './bin/cc-test-reporter before-build'
+
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
+  at_exit do
+    system './bin/cc-test-reporter after-build'
+  end
 end
 
 require 'rubocop/rake_task'

data/lib/zabbix/authentication.rb

@@ -3,12 +3,12 @@ module Zabbix
   # Deals with authentication flow and stores it within global configuration
   module Authentication
 
-    # https://helpcenter.veeam.com/docs/vac/rest/reference/vspc-rest.html?ver=80#tag/Authentication
-    # Authorize to the Veeam portal and return access_token
+    # Authorize to the Zabbix portal using the access_token
+    # @see https://www.zabbix.com/documentation/current/en/manual/api
     def login(options = {})
-      raise ArgumentError, "Accesstoken/api-key not set" unless access_token
+      raise ConfigurationError, "Accesstoken/api-key not set" unless access_token
       # only bearer token needed 
-      # will do sanitty check if token if valid
+      # will do sanity check if token if valid
       rpc_call('settings.get')
     rescue RPCError => e
       raise AuthenticationError, e

data/lib/zabbix/client.rb

@@ -6,18 +6,32 @@ module Zabbix
   # @note All methods have been separated into modules and follow the same grouping used in api docs
   # @see https://www.zabbix.com/documentation/current/en/manual/api
   class Client < API
-
-    def self.def_rpc_call(method, rpc_method)
+  private
+    def self.def_rpc_call(method, rpc_method, id_field = nil)
       self.send(:define_method, method) do |params = nil|
         rpc_call(rpc_method, params)
       end
+      if id_field
+        # strip trailing 's'
+        singular = method.to_s.chop.to_sym
+        self.send(:define_method, singular) do |ids,params = nil|
+          if ids.is_a?(Array)
+            rpc_call(rpc_method, {"#{id_field}":ids}.merge(params || {}))
+          else
+            rpc_call(rpc_method, {"#{id_field}":[ids]}.merge(params || {})).first
+          end
+        end
+      end
     end
 
-    def_rpc_call(:api_info, 'api.info')
-    def_rpc_call(:settings, 'settings.get')
-    def_rpc_call(:hostgroups, 'hostgroup.get')
-    def_rpc_call(:hosts, 'host.get')
-    def_rpc_call(:problems, 'problem.get')
+  public
+    def_rpc_call :api_info, 'api.info'
+    def_rpc_call :settings, 'settings.get'
+    def_rpc_call :hostgroups, 'hostgroup.get', 'groupids'
+    def_rpc_call :hosts, 'host.get', 'hostids'
+    def_rpc_call :problems, 'problem.get', 'problemids'
+    def_rpc_call :events, 'event.get', 'eventids'
+    def_rpc_call :acknowledge_events, 'event.acknowledge'
 
   end
 end

data/lib/zabbix/error.rb

@@ -6,6 +6,9 @@ module Zabbix
   # Raised when Zabbix RPC protocol returns error object
   class RPCError < ZabbixError; end
 
+  # Raised when Zabbix not configured correctly
+  class ConfigurationError < ZabbixError; end
+
   # Error when authentication fails
   class AuthenticationError < ZabbixError; end
 end

data/lib/zabbix/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Zabbix
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
 end

data/zabbix.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'dotenv'
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'simplecov'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zabbix_api_gem
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Janco Tanis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-12 00:00:00.000000000 Z
+date: 2024-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email: gems@jancology.com
 executables: []
@@ -92,6 +106,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/cc-test-reporter.exe
 - lib/zabbix.rb
 - lib/zabbix/api.rb
 - lib/zabbix/authentication.rb