ksql 0.1.0.beta → 0.1.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cd9a1d71cc892172f660cee8406014672b19bc7a510cf6897194201ab9fbf76
-  data.tar.gz: acef9c5aca159a91667816ef3b6c53c54bfa432e141bdff755cbad7ea7a3e986
+  metadata.gz: 0afbab26e682135667899a8b214c02ddf8d11447b1356dba698194940b5950e8
+  data.tar.gz: 0f5ac452b2743ae96b77c7d117d944e0c7cab05a654237f4d2f0a7dd2ea1e803
 SHA512:
-  metadata.gz: 603741e0d00a8bc9c8193473600b2314c9cebb4fbbf0de321127ce52d91d78cfe70710a45d6ec1721e80109811645f207186b2c3aedab967c5485771e822bac6
-  data.tar.gz: 3e50792e2df0bca4ccf27fb8991ff727099d761284bff71303390fdaa23233ea12756dc92fda170d72ddcdfb4bb3112360c88658ca90a8a4f8f97ddbda58b5ea
+  metadata.gz: 9308eae9d92548b0c13e5021d8dc9d1eb06d57d5c59b610aae4ea53b1e8fe7999ec29f7953a294e4fbbe489baae72f4d1b56769091fce84c6fa2ec5b30effc4a
+  data.tar.gz: d2336d0b3fddded18b21fda1ded2fdb8786cbcfff273022722aeface5e98acf8048253646012471f9fe7632d6f2a7bff570132da4f5c20c9780d3379fe425975

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Releases]
 
+## [0.1.0.beta.1] - 2022-03-17
+
+### Added
+
+- `/clusterStatus` endpoint support
+- `/healthcheck` endpoint support
+- `/info` endpoint support
+- `/terminate` endpoint support
+
 ## [0.1.0.beta] - 2022-02-24
 
 - Beta release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at lapoelisacci@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile.lock

@@ -1,31 +1,24 @@
 PATH
   remote: .
   specs:
-    ksql (0.1.0)
+    ksql (0.1.0.beta)
       activesupport (>= 5)
-      hashie (~> 4)
       net-http2 (~> 0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.1)
+    activesupport (7.0.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     byebug (11.1.3)
     concurrent-ruby (1.1.9)
-    crack (0.4.5)
-      rexml
     diff-lcs (1.5.0)
-    hashdiff (1.0.1)
-    hashie (4.1.0)
     http-2 (0.11.0)
-    i18n (1.9.1)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     minitest (5.15.0)
     net-http2 (0.18.4)
@@ -33,7 +26,6 @@ GEM
     parallel (1.21.0)
     parser (3.0.3.2)
       ast (~> 2.4.1)
-    public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.6)
     regexp_parser (2.2.0)
@@ -66,13 +58,9 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
-    vcr (6.0.0)
-    webmock (3.14.0)
-      addressable (>= 2.8.0)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-darwin-20
 
 DEPENDENCIES
@@ -81,8 +69,6 @@ DEPENDENCIES
   rake (~> 13)
   rspec (~> 3)
   rubocop (~> 1)
-  vcr (~> 6)
-  webmock (~> 3)
 
 BUNDLED WITH
    2.3.7

data/README.md

@@ -1,19 +1,19 @@
-![][ruby-shield]
-
-# ![ksql-rocket](https://user-images.githubusercontent.com/50866745/155471557-6fe01746-444f-4ff6-a164-eeeb3b4b53a1.png) Ruby ksqlDB Client (Under QA)
-
-![](https://img.shields.io/static/v1?label=Latest&message=0.1.0&color=blue)
-![](https://img.shields.io/static/v1?label=Coverage&message=95%&color=green)
-![](https://img.shields.io/static/v1?label=Documentation&message=98%&color=success)
-![](https://img.shields.io/static/v1?label=Mantained?&message=Yes&color=success)
+## <img src="https://user-images.githubusercontent.com/50866745/156314925-b823bfe2-a9d4-4b83-8376-29a6a659b57f.png" width="48"> ksqlDB Client  <!-- omit in toc -->
+![](https://img.shields.io/static/v1?label=Language&message=Ruby&color=red)
+![](https://img.shields.io/static/v1?label=Latest&message=0.1.0.beta.1&color=blue)
 
 KSQL is a [ksqlDB](https://ksqldb.io/) Ruby client that focuses on ease of use. Supports all recent ksqlDB features and does not have any heavyweight dependencies.
 
-## What is ksqlDB?
+## What is ksqlDB?  <!-- omit in toc -->
 
 ksqlDB is a database purpose-built for [Apache Kafka®](https://kafka.apache.org/) streams processing applications, more details [here](https://ksqldb.io/).
 
-## Installation
+**Official KLIP:**  <!-- omit in toc -->
+
+- https://github.com/confluentinc/ksql/pull/8794
+- https://github.com/confluentinc/ksql/pull/8865 
+
+## Installation  <!-- omit in toc -->
 
 Add this line to your application's Gemfile:
 
@@ -29,12 +29,32 @@ Or install it yourself as:
 
     $ gem install ksql
 
-## Usage
+## Usage  <!-- omit in toc -->
 
 The gem allows you to perform requests to ksqlDB REST API.
 Checkout the ksqlDB official documentation [here](https://docs.ksqldb.io/en/latest/developer-guide/api/).
 
-### Configuration
+## Table of contents <!-- omit in toc -->
+
+- [Configuration](#configuration)
+- [Statements](#statements)
+- [Queries](#queries)
+  - [Persistent Query](#persistent-query)
+  - [Push Query](#push-query)
+  - [Pull Query](#pull-query)
+- [Cluster Status](#cluster-status)
+- [Health Check](#health-check)
+- [Info](#info)
+- [Terminate](#terminate)
+- [Example](#example)
+- [Supported ksqlDB versions](#supported-ksqldb-versions)
+- [Known issues](#known-issues)
+  - [ksqlDB close-query](#ksqldb-close-query)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Configuration
 
 The gem requires a minimum configuration to connect to ksqlDB, it is shipped with a built-in generator to create a Rails initializer.
 
@@ -44,13 +64,10 @@ The gem requires a minimum configuration to connect to ksqlDB, it is shipped wit
 ```Ruby
 Ksql.configure do |config|
   config.host = 'http://localhost:8088' # Required
-  # config.auth = 'user:password' # optional
 end
 ```
 
-**The Client supports Basic Authentication only**
-
-### [Statements](https://docs.ksqldb.io/en/latest/developer-guide/ksqldb-rest-api/ksql-endpoint/)
+## [Statements](https://docs.ksqldb.io/en/latest/developer-guide/ksqldb-rest-api/ksql-endpoint/)
 
 All statements, except those starting with `SELECT` can be run with the `ksql` method:
 
@@ -185,6 +202,46 @@ end
 locations.count
 ```
 
+## [Cluster Status](https://docs.ksqldb.io/en/latest/developer-guide/ksqldb-rest-api/cluster-status-endpoint/)
+
+The client allows you to introspect the cluster status with the `cluster_status` method.
+
+**Careful:** The `/clusterStatus` endpoint is not enabled by default, read more [here](https://docs.ksqldb.io/en/latest/developer-guide/ksqldb-rest-api/cluster-status-endpoint/)
+
+```Ruby
+  Ksql::Client.cluster_status
+```
+
+## [Health Check](https://docs.ksqldb.io/en/latest/developer-guide/ksqldb-rest-api/info-endpoint/)
+
+You can also check the health of your ksqlDB server by calling the `health_check` method.
+
+```Ruby
+  Ksql::Client.health_check
+```
+
+## [Info](https://docs.ksqldb.io/en/latest/developer-guide/ksqldb-rest-api/info-endpoint/)
+
+To get information about the status of a ksqlDB Server call the `info` method.
+
+```Ruby
+  Ksql::Client.info
+```
+
+## [Terminate](https://docs.ksqldb.io/en/latest/developer-guide/ksqldb-rest-api/terminate-endpoint/)
+
+You can terminate the cluster and clean up the resources calling the `terminate` method.
+
+```Ruby
+  Ksql::Client.terminate
+```
+
+You can provide a list of kafka topic names or regular expressions for Kafka topic names along to delete all topics with names that are in the list or that match any of the regular expressions in the list.
+
+```Ruby
+  Ksql::Client.terminate(delete_topic_list: ["FOO", "bar.*"])
+```
+
 ## Example
 
 The following example is from the official ksqlDB [Quickstart](https://ksqldb.io/quickstart.html):
@@ -278,6 +335,7 @@ Ksql::Client.ksql('DROP STREAM IF EXISTS riderLocations;')
 
 ```
 
+
 ## Supported ksqlDB versions
 
 | Version |  |
@@ -313,7 +371,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/LapoEl
 ## License
 
 [![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)](https://opensource.org/licenses/MIT)
-
-<!--- MARKDOWN LINKS --->
-
-[ruby-shield]: https://img.shields.io/badge/Ruby-CC342D?style=for-the-badge&logo=ruby&logoColor=white

data/lib/ksql/api/cluster_status.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Ksql
+  module Api
+    class ClusterStatus
+      Headers = { 'Accept' => 'application/json' }.freeze
+
+      #
+      # Build the ksqlDB /clusterStatus request
+      #
+      # @param [Hash] headers Request headers
+      #
+      # @return [Ksql::Connection::Request] Request instance
+      #
+      def self.build(headers:)
+        ::Ksql::Connection::Request.new(
+          {},
+          '/clusterStatus',
+          Headers.merge(headers),
+          :get
+        )
+      end
+    end
+  end
+end

data/lib/ksql/api/health_check.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Ksql
+  module Api
+    class HealthCheck
+      Headers = { 'Accept' => 'application/json' }.freeze
+
+      #
+      # Build the ksqlDB /healthcheck request
+      #
+      # @param [Hash] headers Request headers
+      #
+      # @return [Ksql::Connection::Request] Request instance
+      #
+      def self.build(headers:)
+        ::Ksql::Connection::Request.new(
+          {},
+          '/healthcheck',
+          Headers.merge(headers),
+          :get
+        )
+      end
+    end
+  end
+end

data/lib/ksql/api/info.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Ksql
+  module Api
+    class Info
+      Headers = { 'Accept' => 'application/json' }.freeze
+
+      #
+      # Build the ksqlDB /info request
+      #
+      # @param [Hash] headers Request headers
+      #
+      # @return [Ksql::Connection::Request] Request instance
+      #
+      def self.build(headers:)
+        ::Ksql::Connection::Request.new(
+          {},
+          '/info',
+          Headers.merge(headers),
+          :get
+        )
+      end
+    end
+  end
+end

data/lib/ksql/api/terminate.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Ksql
+  module Api
+    class Terminate
+      Headers = { 'Accept' => 'application/json' }.freeze
+
+      #
+      # Build the ksqlDB /ksql/terminate request
+      #
+      # @param [Array<String>] delete_topic_list Kafka topic names or regular expressions
+      # @param [Hash] headers Request headers
+      #
+      # @return [Ksql::Connection::Request] Request instance
+      #
+      def self.build(delete_topic_list = null, headers:)
+        ::Ksql::Connection::Request.new(
+          { deleteTopicList: delete_topic_list }.compact,
+          '/ksql/terminate',
+          Headers.merge(headers),
+          :post
+        )
+      end
+    end
+  end
+end

data/lib/ksql/client.rb

@@ -17,6 +17,42 @@ module Ksql
         Handlers::Raw.handle(result)
       end
 
+      #
+      # Request /clusterStatus endpoint synchronously
+      #
+      # @param [Hash] headers Request headers
+      #
+      # @return [JSON] Request response
+      #
+      def cluster_status(headers: {})
+        request = Api::ClusterStatus.build(headers: headers)
+        Connection::Client.call_sync(request)
+      end
+
+      #
+      # Request /healthcheck endpoint synchronously
+      #
+      # @param [Hash] headers Request headers
+      #
+      # @return [JSON] Request response
+      #
+      def health_check(headers: {})
+        request = Api::HealthCheck.build(headers: headers)
+        Connection::Client.call_sync(request)
+      end
+
+      #
+      # Request /info endpoint synchronously
+      #
+      # @param [Hash] headers Request headers
+      #
+      # @return [JSON] Request response
+      #
+      def info(headers: {})
+        request = Api::Info.build(headers: headers)
+        Connection::Client.call_sync(request)
+      end
+
       #
       # Request /ksql endpoint
       #
@@ -65,6 +101,18 @@ module Ksql
         client, prepared_request = Connection::Client.call_async(request)
         Handlers::Stream.handle(client, prepared_request)
       end
+
+      #
+      # Request /terminate endpoint synchronously
+      #
+      # @param [Array<String>] delete_topic_list Kafka topic names or regular expressions
+      #
+      # @return [JSON] Request response
+      #
+      def terminate(delete_topic_list: nil, headers: {})
+        request = Api::Terminate.build(delete_topic_list, headers: headers)
+        Connection::Client.call_sync(request)
+      end
     end
   end
 end

data/lib/ksql/connection/request.rb

@@ -9,7 +9,7 @@ module Ksql
       # @return [Array] Request params
       #
       def to_params
-        return method, endpoint, { body: body.to_json, headers: headers.merge(auth_headers) }
+        return method, endpoint, { body: body.to_json, headers: headers.merge(auth_headers) }.compact
       end
 
       private

data/lib/ksql/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ksql
-  VERSION = '0.1.0.beta'
+  VERSION = '0.1.0.beta.1'
 end

data/lib/ksql.rb

@@ -6,9 +6,12 @@ require 'json'
 require 'ostruct'
 
 require_relative 'ksql/api/close_query'
+require_relative 'ksql/api/health_check'
+require_relative 'ksql/api/info'
 require_relative 'ksql/api/ksql'
 require_relative 'ksql/api/query'
 require_relative 'ksql/api/stream'
+require_relative 'ksql/api/terminate'
 
 require_relative 'ksql/handlers/collection'
 require_relative 'ksql/handlers/raw'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ksql
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta
+  version: 0.1.0.beta.1
 platform: ruby
 authors:
 - Lapo Elisacci
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
-- !ruby/object:Gem::Dependency
-  name: hashie
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4'
 - !ruby/object:Gem::Dependency
   name: net-http2
   requirement: !ruby/object:Gem::Requirement
@@ -62,6 +48,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -72,9 +59,13 @@ files:
 - lib/generators/templates/initializer.rb
 - lib/ksql.rb
 - lib/ksql/api/close_query.rb
+- lib/ksql/api/cluster_status.rb
+- lib/ksql/api/health_check.rb
+- lib/ksql/api/info.rb
 - lib/ksql/api/ksql.rb
 - lib/ksql/api/query.rb
 - lib/ksql/api/stream.rb
+- lib/ksql/api/terminate.rb
 - lib/ksql/client.rb
 - lib/ksql/collection.rb
 - lib/ksql/configuration.rb
@@ -111,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.9
 signing_key:
 specification_version: 4
 summary: Kafka ksqlDB Client for Ruby