kapacitor-ruby 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc6d76c1f16e0763148ff55590de5e4cc811a5e2
+  data.tar.gz: 2d9af022a39f11297e7269771f1d4486b6578c57
+SHA512:
+  metadata.gz: 949bd723d24fa51e0698d67d7f76ce793d6964c2128da96556c4d220c13aa6c532b236119b119894060d4c9bd94e503fbc56e1948cf68e0627a13e5b358a13ed
+  data.tar.gz: 46e0e1edebce59617611767286fdae36f8d032c511b89f212fff9c059275724f81d285be67d00186de7e7d2c36c63946e98a76f4a23049edd8604901c2105cba

data/LICENSE

@@ -0,0 +1,12 @@
+ Copyright 2016 Matteo Cerutti
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.

data/README.md

@@ -0,0 +1,73 @@
+# Ruby client library for Kapacitor JSON REST API
+This is a simple Ruby client library that allows to interact with the Kapacitor JSON REST API.
+
+Pull requests to add additional API features are very welcome. I only implemented what I needed.
+
+## Install
+To install it simply issue the following command:
+
+```
+gem install kapacitor-ruby
+```
+
+## Usage
+```
+require 'kapacitor/client'
+kapacitor = Kapacitor::Client.new(host: 'localhost:9092', version: 'v1')
+```
+
+### Templates
+
+#### `define_template`
+Create a new template definition
+```
+define_template(id: 'name', type: 'stream', script: 'tickscript')
+```
+
+#### `update_template`
+Update one or more templates' options
+```
+update_template(id: 'name', type: 'batch')
+```
+
+#### `delete_template`
+Delete a template
+```
+delete_template(id: 'name')
+```
+
+#### `templates`
+Fetch all templates
+```
+templates()
+```
+
+### Tasks
+
+#### `define_task`
+Create a new task
+```
+define_task(id: 'name', template_id: 'optional template', type: 'stream', dbrps: [{'db' => 'telegraf', 'rp' => 'default'}], script: 'tickscript', status: 'enabled', vars: {})
+```
+
+#### `update_task`
+Update one or more task's options
+
+```
+update_task(id: 'name', template_id: 'optional template', type: 'stream', dbrps: [{'db' => 'telegraf', 'rp' => 'default'}], script: 'tickscript', status: 'enabled', vars: {})
+```
+
+#### `delete_task`
+Delete a task
+```
+delete_task(id: 'name')
+```
+
+#### `tasks`
+Fetch all tasks
+```
+tasks()
+```
+
+## Contact
+Matteo Cerutti - matteo.cerutti@hotmail.co.uk

data/lib/kapacitor/client.rb

@@ -0,0 +1,179 @@
+#
+# client.rb
+#
+# Author: Matteo Cerutti <matteo.cerutti@hotmail.co.uk>
+#
+
+require 'net/http'
+require 'json'
+
+module Kapacitor
+  class Client
+    attr_reader :uri, :http
+
+    def initialize(host:, version: 'v1')
+      @uri = URI.parse("http://#{host}/kapacitor/#{version}")
+      @http = Net::HTTP.new(@uri.host, @uri.port)
+    end
+
+    def define_template(id:, type:, script:)
+      req = {
+        'id' => id,
+        'type' => type,
+        'script' => script
+      }
+
+      api_post('/templates', req)
+    end
+
+    def update_template(id:, type: nil, script: nil)
+      req = {}
+      req['type'] = type if type
+      req['script'] = script if script
+
+      api_patch("/templates/#{id}", req) unless req.empty?
+    end
+
+    def delete_template(id:)
+      api_delete("/templates/#{id}")
+    end
+
+    def templates
+      api_get('/templates')['templates']
+    end
+
+    def define_task(id:, template_id: nil, type: nil, dbrps: , script: nil, status: 'enabled', vars: nil)
+      if (template_id.nil? and type.nil? and script.nil?) or (template_id and (type or script))
+        raise ArgumentError, "Must specify either a Template ID or a script and type"
+      elsif template_id.nil? and (type.nil? or script.nil?)
+        raise ArgumentError, "Must specify both task type and script when not using a Template ID"
+      end
+
+      req = {
+        'id' => id,
+        'dbrps' => dbrps,
+        'status' => status
+      }
+
+      if template_id
+        req['template_id'] = template_id
+      else
+        req['type'] = type
+        req['script'] = script
+      end
+
+      req['vars'] = vars if vars
+
+      api_post('/tasks', req)
+    end
+
+    def update_task(id:, template_id: nil, type: nil, dbrps: nil, script: nil, status: nil, vars: nil)
+      req = {}
+      req['template_id'] = template_id if template_id
+      req['type'] = type if type
+      req['dbrps'] = dbrps if dbrps
+      req['script'] = script if script
+      req['status'] = status if status
+      req['vars'] = vars if vars
+
+      api_patch("/tasks/#{id}", req) unless req.empty?
+    end
+
+    def delete_task(id:)
+      api_delete("/tasks/#{id}")
+    end
+
+    def tasks
+      api_get('/tasks')['tasks']
+    end
+
+private
+    def api_get(q)
+      begin
+        req = Net::HTTP::Get.new(self.uri.path + q, {'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})"
+        end
+      rescue
+        raise Exception, "Failed to execute GET request to Kapacitor REST API (#{$!})"
+      end
+
+      data
+    end
+
+    def api_post(q, data)
+      begin
+        req = Net::HTTP::Post.new(self.uri.path + q, {'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})"
+        end
+      rescue
+        raise Exception, "Failed to execute POST request to Kapacitor REST API (#{$!})"
+      end
+
+      data
+    end
+
+    def api_delete(q)
+      begin
+        req = Net::HTTP::Delete.new(self.uri.path + q, {'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})"
+        end
+      rescue
+        raise Exception, "Failed to execute DELETE request to Kapacitor REST API (#{$!})"
+      end
+
+      data
+    end
+
+    def api_patch(q, data)
+      begin
+        req = Net::HTTP::Patch.new(self.uri.path + q, {'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})"
+        end
+      rescue
+        raise Exception, "Failed to execute PATCH request to Kapacitor REST API (#{$!})"
+      end
+
+      data
+    end
+  end
+end

data/lib/kapacitor/version.rb

@@ -0,0 +1,13 @@
+#
+# version.rb
+#
+# Author: Matteo Cerutti <matteo.cerutti@hotmail.co.uk>
+#
+
+module Kapacitor
+  VERSION = "0.0.2"
+
+  def self.version
+    VERSION
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: kapacitor-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Matteo Cerutti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+description: Ruby client library for Kapacitor JSON REST API
+email: matteo.cerutti@hotmail.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/kapacitor/client.rb
+- lib/kapacitor/version.rb
+homepage: https://github.com/m4ce/kapacitor-ruby
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby client library that allows to interact with the Kapacitor JSON REST
+  API
+test_files: []