kapacitor-ruby 1.0.1 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 79bbedb54161374f17dfd6d1781e1baf8d483760
-  data.tar.gz: 9e0d4b2b4aa32da574f330bb32037918d07256b4
+SHA256:
+  metadata.gz: 821ace263cd605e3233f42c76b01ff93c8d9a2bd08764634d843183296eef674
+  data.tar.gz: ce299b58d8e2d5eb1efc792c36a6a101fb3504773e4b610fc8ea91457369936b
 SHA512:
-  metadata.gz: 6925cab3a4ac82ce9dd82a163b6bce11a45d80b43b871e3e8190749700a403fdb8b1299ff88720343b38910ec905dd3561c8e23722da662f4798a8949e4f8599
-  data.tar.gz: 7c68807eb08758aa8bb953cbf09a6c346681754e764ad647232a0b211676342631dcc9a19e4e6774c1098ad91694b99a0e97571fe025c1f970c0493cd5613f46
+  metadata.gz: ab76b9f3b5dd49d919f7b38422c68f5d2ae286694584dbaa53dd1e2b7e72fc088022a78b996c8106846f9047985f23776bf18f3d4c7b53456bf3d7f606b58181
+  data.tar.gz: 509abc65bc1104000e58cc8871e36d8557055db8b937a09c90d19f35f3c6cdb67ce6ae469d1847bf35aba2dee371b7c36f4d2c09372ed24cbf7dfd81de585979

data/lib/kapacitor/client.rb

@@ -1,10 +1,10 @@
-require 'net/http'
+require 'httpclient'
 require 'json'
 
 module Kapacitor
   class Client
     # @return [URI] Kapacitor REST API URL
-    attr_reader :uri
+    attr_reader :url
     # @return [Net::HTTP] HTTP client instance
     attr_reader :http
 
@@ -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', version: 'v1preview')
-      @uri = URI.parse("#{url}/kapacitor/#{version}")
-      @http = Net::HTTP.new(@uri.host, @uri.port)
+    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
@@ -71,7 +80,7 @@ module Kapacitor
       ret = []
 
       loop do
-        res = api_get(endpoint: "/templates?offset=#{offset}&limit=#{limit}")['templates']
+        res = api_get(endpoint: "templates?offset=#{offset}&limit=#{limit}")['templates']
         break unless res.size > 0
         ret += res
         offset += limit
@@ -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
@@ -162,11 +171,11 @@ module Kapacitor
       tasks = []
 
       loop do
-        res = api_get(endpoint: "/tasks?fields=id&offset=#{offset}&limit=#{limit}")['tasks']
+        res = api_get(endpoint: "tasks?fields=id&offset=#{offset}&limit=#{limit}")['tasks']
         break unless res.size > 0
 
         res.each do |task|
-          tasks << api_get(endpoint: "/tasks/#{task['id']}")
+          tasks << api_get(endpoint: "tasks/#{task['id']}")
         end
 
         offset += limit
@@ -193,7 +202,7 @@ module Kapacitor
       end
 
       req['actions'] = actions
-      api_post(endpoint: "/alerts/topics/#{topic}/handlers", data: req)
+      api_post(endpoint: "alerts/topics/#{topic}/handlers", data: req)
     end
 
     # Update a topic handler
@@ -209,7 +218,7 @@ module Kapacitor
       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?
+      api_put(endpoint: "alerts/topics/#{topic}/handlers/#{id}", data: req) unless req.empty?
     end
 
     # Delete a topic handler
@@ -218,7 +227,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
@@ -227,28 +236,27 @@ module Kapacitor
     # @return [Array[Hash]] List of handlers
     #
     def topic_handlers(topic:)
-      return api_get(endpoint: "/alerts/topics/#{topic}/handlers")['handlers']
+      api_get(endpoint: "alerts/topics/#{topic}/handlers")['handlers']
     end
 
 private
     # Perform a HTTP GET request
     #
     # @param endpoint [String] HTTP API endpoint
+    # @param query [String] HTTP query
     # @return [Array[Hash], Hash] API response
     #
-    def api_get(endpoint:)
+    def api_get(endpoint:, query: nil)
       begin
-        req = Net::HTTP::Get.new(self.uri.path + endpoint, {'Content-type' => 'application/json', 'Accept' => 'application/json'})
-        resp = self.http.request(req)
-
-        if resp.code == '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.code}, Error: #{resp.message})"
+        resp = self.http.get([self.url, endpoint].join('/'), query, {'Content-type' => 'application/json', 'Accept' => 'application/json'})
+        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,18 +272,15 @@ private
     #
     def api_post(endpoint:, data:)
       begin
-        req = Net::HTTP::Post.new(self.uri.path + endpoint, {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
-        req.body = data.to_json
-        resp = self.http.request(req)
-
-        if resp.code == '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.code}, Error: #{resp.message})"
+        resp = self.http.post([self.url, endpoint].join('/'), data.to_json, {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+        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 (#{$!})"
@@ -290,19 +295,15 @@ private
     #
     def api_delete(endpoint:)
       begin
-        req = Net::HTTP::Delete.new(self.uri.path + endpoint, {'Content-type' => 'application/json', 'Accept' => 'application/json'})
-        resp = self.http.request(req)
-
-        if resp.code == '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 (Code: #{resp.code}, Error: #{resp.message})"
+        resp = self.http.delete([self.url, endpoint].join('/'), {'Content-type' => 'application/json', 'Accept' => 'application/json'})
+        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 (#{$!})"
@@ -318,18 +319,15 @@ private
     #
     def api_patch(endpoint:, data:)
       begin
-        req = Net::HTTP::Patch.new(self.uri.path + endpoint, {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
-        req.body = data.to_json
-        resp = self.http.request(req)
-
-        if resp.code == '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.code}, Error: #{resp.message})"
+        resp = self.http.patch([self.url, endpoint].join('/'), data.to_json, {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+        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 (#{$!})"
@@ -345,18 +343,15 @@ private
     #
     def api_put(endpoint:, data:)
       begin
-        req = Net::HTTP::Put.new(self.uri.path + endpoint, {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
-        req.body = data.to_json
-        resp = self.http.request(req)
-
-        if resp.code == '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.code}, Error: #{resp.message})"
+        resp = self.http.put([self.url, endpoint].join('/'), data.to_json, {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+        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.1"
+  VERSION = "1.0.6"
 
   def self.version
     VERSION

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: kapacitor-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.6
 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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -38,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
@@ -53,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