kapacitor-ruby 1.0.2 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 97fd28ae0c38ca2649dc1aa6caf64d93486148ab
-  data.tar.gz: 87c38785fbf478b9c4bb5bcb1aed5f983173da63
+SHA256:
+  metadata.gz: 4855f87f3ec102488bb9c853b8f7a9d1d9e161d759ec62617859a784b8b521ac
+  data.tar.gz: a7875fdb26ce45b801297caec2ebc17946a6b8e1932f07c11e73fced251e03cd
 SHA512:
-  metadata.gz: 976de61620d4e124b53d5acfc26fcf711ff2fdcb0c9e936fbc85d2cd652262a94f9bf67078205ae6afb88d53fa34733373490617c2a0e7de166821710628e0c4
-  data.tar.gz: 6c2fe44b7f27e0bf7b40b1ce636c057bf3b0fe876c17b51b7e140a3d70ce6ce03c007603401b1332fa60d4238abd0ba1279670d7aea5a12545d6049c6e2a8ca8
+  metadata.gz: 6a7c13869776805389686060b8e3a47abda670b81d1adf2c8ff2690774af85d61dda6cf83c3ad35fb21f286b37f01d62c668253403e7c45d405dc76148f196c8
+  data.tar.gz: 321f5d4263ae5ec53fde9bb28ea158a4881967643e0071edaee2778ac37485cdf5db72de58503c6659fe06da362786a6f5d1cc667726e21bcac6708053502780

data/lib/kapacitor/client.rb

@@ -13,9 +13,9 @@ module Kapacitor
     # @param url [String] Kapacitor REST API's URL (defaults to `http://localhost:9092`)
     # @param version [Integer] API version (defaults to `v1preview`)
     #
-    def initialize(url: 'http://localhost:9092/kapacitor', version: 'v1preview')
-      @url = URI.join(url, version)
+    def initialize(url: 'http://localhost:9092/kapacitor', version: 'v1')
       @http = HTTPClient.new
+      @url = [url, version].join('/')
     end
 
     # Define a Kapacitor template
@@ -33,7 +33,7 @@ module Kapacitor
         'script' => script
       }
 
-      api_post(endpoint: '/templates', data: req)
+      api_post(endpoint: 'templates', data: req)
     end
 
     # Update a Kapacitor template
@@ -50,7 +50,7 @@ module Kapacitor
         raise ArgumentError, "Kapacitor template type can be either 'batch' or 'stream'" unless opts[:type] == 'batch' or opts[:type] == 'stream'
       end
 
-      api_patch(endpoint: "/templates/#{id}", data: req) unless req.empty?
+      api_patch(endpoint: "templates/#{id}", data: req) unless req.empty?
     end
 
     # Delete a Kapacitor template
@@ -58,7 +58,16 @@ module Kapacitor
     # @param id [String] Template ID
     #
     def delete_template(id:)
-      api_delete(endpoint: "/templates/#{id}")
+      api_delete(endpoint: "templates/#{id}")
+    end
+
+    # Retrieve Kapacitor topic
+    #
+    # @return [List[String]] List of topics
+    #
+    def topics()
+      res = api_get(endpoint: "alerts/topics")
+      return res['topics'].map { |v| v['id'] }
     end
 
     # Retrieve Kapacitor templates
@@ -89,7 +98,7 @@ module Kapacitor
     def define_task(id:, dbrps:, **opts)
       if (opts[:template_id].nil? && opts[:type].nil? && opts[:script].nil?) || (opts[:template_id] && (opts[:type] || opts[:script]))
         raise ArgumentError, "Must specify either a Template ID or a script and type"
-      elsif opts['template_id'].nil? && (opts['type'].nil? || opts['script'].nil?)
+      elsif opts[:template_id].nil? && (opts[:type].nil? || opts[:script].nil?)
         raise ArgumentError, "Must specify both task type and script when not using a Template ID"
       end
 
@@ -116,7 +125,7 @@ module Kapacitor
 
       req['vars'] = opts[:vars] if opts[:vars]
 
-      api_post(endpoint: '/tasks', data: req)
+      api_post(endpoint: 'tasks', data: req)
     end
 
     # Update a Kapacitor task
@@ -141,7 +150,7 @@ module Kapacitor
         raise ArgumentError, "Kapacitor task status can be either 'enabled' or 'disabled'" unless opts[:status] == 'enabled' || opts[:status] == 'disabled'
       end
 
-      api_patch(endpoint: "/tasks/#{id}", data: req) unless req.empty?
+      api_patch(endpoint: "tasks/#{id}", data: req) unless req.empty?
     end
 
     # Delete a Kapacitor task
@@ -149,7 +158,7 @@ module Kapacitor
     # @param id [String] Task ID
     #
     def delete_task(id:)
-      api_delete(endpoint: "/tasks/#{id}")
+      api_delete(endpoint: "tasks/#{id}")
     end
 
     # Retrieve Kapacitor tasks
@@ -179,37 +188,36 @@ module Kapacitor
     #
     # @param id [String] Handler ID
     # @param topic [String] Topic name
-    # @param actions [Array[Hash]] Handler actions
+    # @param kind [String] Kind of handler
+    # @param match [String] Lambda expression
+    # @param options [Hash] Handler options
     #
-    def define_topic_handler(id:, topic:, actions:)
-      req = {}
-      req['id'] = id
-
-      actions = [actions] unless actions.is_a?(Array)
-      raise ArgumentError, "Kapacitor topic handler requires one or more actions" unless actions.size > 0
-
-      actions.each do |action|
-        raise ArgumentError, "Missing required kind attribute for action #{action}"
-      end
-
-      req['actions'] = actions
-      api_post(endpoint: "/alerts/topics/#{topic}/handlers", data: req)
+    def define_topic_handler(id:, topic:, kind:, match: nil, options: {})
+      req = {
+        'id': id,
+        'kind': kind
+      }
+      req['match'] = match unless match.nil?
+      req['options'] = options
+      api_post(endpoint: "alerts/topics/#{topic}/handlers", data: req)
     end
 
     # Update a topic handler
     #
     # @param id [String] Handler ID
     # @param topic [String] Topic name
-    # @param actions [Array[Hash]] Handler actions
+    # @param kind [String] Kind of handler
+    # @param match [String] Lambda expression
+    # @param options [Hash] Handler options
     #
-    def update_topic_handler(id:, topic:, actions:)
-      req = {}
-
-      actions = [actions] unless actions.is_a?(Array)
-      raise ArgumentError, "Kapacitor topic handler requires one or more actions" unless actions.size > 0
-
-      req['actions'] = actions
-      api_put(endpoint: "/alerts/topics/#{topic}/handlers/#{id}", data: req) unless req.empty?
+    def update_topic_handler(id:, topic:, kind:, match: nil, options: {})
+      req = {
+        'id': id,
+        'kind': kind
+      }
+      req['match'] = match unless match.nil?
+      req['options'] = options
+      api_put(endpoint: "alerts/topics/#{topic}/handlers/#{id}", data: req) unless req.empty?
     end
 
     # Delete a topic handler
@@ -218,7 +226,7 @@ module Kapacitor
     # @param topic [String] Topic name
     #
     def delete_topic_handler(id:, topic:)
-      api_delete(endpoint: "/alerts/topics/#{topic}/handlers/#{id}")
+      api_delete(endpoint: "alerts/topics/#{topic}/handlers/#{id}")
     end
 
     # Retrieve topic's handlers
@@ -240,14 +248,14 @@ private
     def api_get(endpoint:, query: nil)
       begin
         resp = self.http.get([self.url, endpoint].join('/'), query, {'Content-type' => 'application/json', 'Accept' => 'application/json'})
-        if resp.status == 200
-          begin
-            data = JSON.parse(resp.body)
-          rescue JSON::ParserError
-            raise Exception, "Failed to decode response message"
-          end
-        else
-          raise Exception, "Query returned a non successful HTTP code (Status: #{resp.status}, Reason: #{resp.reason})"
+        begin
+          data = JSON.parse(resp.body) unless resp.body.empty?
+        rescue JSON::ParserError
+          raise Exception, "Failed to decode response message"
+        end
+        if resp.status != 200
+          error = data.include?('error') ? data['error'] : data.inspect if data
+          raise Exception, "Query returned a non successful HTTP code (Status: #{resp.status}, Reason: #{resp.reason}#{", Error: #{error}" if error}"
         end
       rescue
         raise Exception, "Failed to execute GET request to Kapacitor REST API (#{$!})"
@@ -264,14 +272,14 @@ private
     def api_post(endpoint:, data:)
       begin
         resp = self.http.post([self.url, endpoint].join('/'), data.to_json, {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
-        if resp.status == 200
-          begin
-            data = JSON.parse(resp.body)
-          rescue JSON::ParserError
-            raise Exception, "Failed to decode response message"
-          end
-        else
-          raise Exception, "Query returned a non successful HTTP code (Status: #{resp.status}, Reason: #{resp.reason})"
+        begin
+          data = JSON.parse(resp.body) unless resp.body.empty?
+        rescue JSON::ParserError
+          raise Exception, "Failed to decode response message"
+        end
+        if resp.status != 200
+          error = data.include?('error') ? data['error'] : data.inspect if data
+          raise Exception, "Query returned a non successful HTTP code (Status: #{resp.status}, Reason: #{resp.reason}#{", Error: #{error}" if error}"
         end
       rescue
         raise Exception, "Failed to execute POST request to Kapacitor REST API (#{$!})"
@@ -287,16 +295,14 @@ private
     def api_delete(endpoint:)
       begin
         resp = self.http.delete([self.url, endpoint].join('/'), {'Content-type' => 'application/json', 'Accept' => 'application/json'})
-        if resp.status == 204
-          if resp.body
-            begin
-              data = JSON.parse(resp.body)
-            rescue JSON::ParserError
-              raise Exception, "Failed to decode response message"
-            end
-          end
-        else
-          raise Exception, "Query returned a non successful HTTP code (Status: #{resp.status}, Reason: #{resp.reason})"
+        begin
+          data = JSON.parse(resp.body) unless resp.body.empty?
+        rescue JSON::ParserError
+          raise Exception, "Failed to decode response message"
+        end
+        if resp.status != 204
+          error = data.include?('error') ? data['error'] : data.inspect if data
+          raise Exception, "Query returned a non successful HTTP code (Status: #{resp.status}, Reason: #{resp.reason}#{", Error: #{error}" if error}"
         end
       rescue
         raise Exception, "Failed to execute DELETE request to Kapacitor REST API (#{$!})"
@@ -313,14 +319,14 @@ private
     def api_patch(endpoint:, data:)
       begin
         resp = self.http.patch([self.url, endpoint].join('/'), data.to_json, {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
-        if resp.status == 200
-          begin
-            data = JSON.parse(resp.body)
-          rescue JSON::ParserError
-            raise Exception, "Failed to decode response message"
-          end
-        else
-          raise Exception, "Query returned a non successful HTTP code (Code: #{resp.status}, Reason: #{resp.reason})"
+        begin
+          data = JSON.parse(resp.body) unless resp.body.empty?
+        rescue JSON::ParserError
+          raise Exception, "Failed to decode response message"
+        end
+        if resp.status != 200
+          error = data.include?('error') ? data['error'] : data.inspect if data
+          raise Exception, "Query returned a non successful HTTP code (Status: #{resp.status}, Reason: #{resp.reason}#{", Error: #{error}" if error}"
         end
       rescue
         raise Exception, "Failed to execute PATCH request to Kapacitor REST API (#{$!})"
@@ -337,14 +343,14 @@ private
     def api_put(endpoint:, data:)
       begin
         resp = self.http.put([self.url, endpoint].join('/'), data.to_json, {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
-        if resp.status == 200
-          begin
-            data = JSON.parse(resp.body)
-          rescue JSON::ParserError
-            raise Exception, "Failed to decode response message"
-          end
-        else
-          raise Exception, "Query returned a non successful HTTP code (Status: #{resp.status}, Reason: #{resp.reason})"
+        begin
+          data = JSON.parse(resp.body) unless resp.body.empty?
+        rescue JSON::ParserError
+          raise Exception, "Failed to decode response message"
+        end
+        if resp.status != 200
+          error = data.include?('error') ? data['error'] : data.inspect if data
+          raise Exception, "Query returned a non successful HTTP code (Status: #{resp.status}, Reason: #{resp.reason}#{", Error: #{error}" if error}"
         end
       rescue
         raise Exception, "Failed to execute PUT request to Kapacitor REST API (#{$!})"

data/lib/kapacitor/version.rb

@@ -3,7 +3,7 @@
 #
 
 module Kapacitor
-  VERSION = "1.0.2"
+  VERSION = "1.0.7"
 
   def self.version
     VERSION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kapacitor-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.7
 platform: ruby
 authors:
 - Matteo Cerutti
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-09-04 00:00:00.000000000 Z
+date: 2020-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -52,7 +52,7 @@ homepage: https://github.com/m4ce/kapacitor-ruby
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -67,9 +67,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.0.1
+signing_key:
 specification_version: 4
 summary: Ruby client library that allows to interact with the Kapacitor JSON REST
   API