active_ksql 0.1.0.alpha.1 → 0.1.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b20299186218124c1dfb90e4d9c24182757d6c8586b98eeff4dedb7c9f7ef199
-  data.tar.gz: a6b43eead19a6b9a15ad45251a96091728858bf6449b07d886404180ac3ef2bd
+  metadata.gz: ed32db6caaefec386bec8b56b10c5ae5ade155754979fcf9eef206bbd7047bdf
+  data.tar.gz: 23f1c2fc21198aab2fd93992e32b5bccef1c0ff737d9d4e590d4eec9f6214e68
 SHA512:
-  metadata.gz: 28462710785bb2a04a5607281bdf59c32b015f29dd9b21c39f02732f8cb7a336b32879303adf355d7f998bc54aff5eb7f229906e7c90923b4850723dee61ca65
-  data.tar.gz: '09e88ca0f9db991606ab76dea2dd2cfbe535e12e01676535d2703431a0090e4daba2ad015b702781d09c35c30518cf65171a8bdb6e23970e3553255d421d9e3c'
+  metadata.gz: 18ae1889a5b69e617241c6fb2aebdc3a09801aea2e3f3c0134d1f74a5f24fff8a14664fc72b14b857ed4ab45c97178036bbe09af19273c7fbe729b93ef58f3a6
+  data.tar.gz: bd3d778eff708977199b12006ce9180365172913ddb315e93014d7525e2d3cdb6b08afcf9610ef15c8e5b6904c5ae60f68a7a3dee90c42924babc88a728d5317

data/.rubocop.yml

@@ -1,180 +1,13 @@
-# Allow longer lines and methods
-Layout/LineLength:
-  Max: 240
-
-Metrics/MethodLength:
-  Max: 30
-
-# Tests are declarative, no block length test
-Metrics/BlockLength:
-  IgnoredMethods: ['describe', 'context', 'namespace']
-
 AllCops:
-  TargetRubyVersion: 2.5
-  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
-  # to ignore them, so only the ones explicitly set in this file are enabled.
-  DisabledByDefault: true
-  Exclude:
-    - '**/templates/**/*'
-    - '**/vendor/**/*'
-    - '**/vendor/**/.*'
-    - '**/node_modules/**/*'
-    - 'actionpack/lib/action_dispatch/journey/parser.rb'
-
-# Prefer &&/|| over and/or.
-Style/AndOr:
-  Enabled: true
-
-# Align `when` with `case`.
-Layout/CaseIndentation:
-  Enabled: true
-
-# Align comments with method definitions.
-Layout/CommentIndentation:
-  Enabled: true
-
-Layout/ElseAlignment:
-  Enabled: true
-
-# Align `end` with the matching keyword or starting expression except for
-# assignments, where it should be aligned with the LHS.
-Layout/EndAlignment:
-  Enabled: true
-  EnforcedStyleAlignWith: variable
-  AutoCorrect: true
-
-Layout/EmptyLineAfterMagicComment:
-  Enabled: true
-
-# In a regular class definition, no empty lines around the body.
-Layout/EmptyLinesAroundClassBody:
-  Enabled: true
-
-# In a regular method definition, no empty lines around the body.
-Layout/EmptyLinesAroundMethodBody:
-  Enabled: true
-
-# In a regular module definition, no empty lines around the body.
-Layout/EmptyLinesAroundModuleBody:
-  Enabled: true
-
-Layout/FirstArgumentIndentation:
-  Enabled: true
-
-# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
-Style/HashSyntax:
-  Enabled: true
-
-# Method definitions after `private` or `protected` isolated calls need one
-# extra level of indentation.
-Layout/IndentationConsistency:
-  Enabled: true
-  EnforcedStyle: indented_internal_methods
-
-# Two spaces, no tabs (for indentation).
-Layout/IndentationWidth:
-  Enabled: true
-
-Layout/LeadingCommentSpace:
-  Enabled: true
-
-Layout/SpaceAfterColon:
-  Enabled: true
-
-Layout/SpaceAfterComma:
-  Enabled: true
-
-Layout/SpaceAroundEqualsInParameterDefault:
-  Enabled: true
+  TargetRubyVersion: 2.4
 
-Layout/SpaceAroundKeyword:
-  Enabled: true
-
-Layout/SpaceAroundOperators:
-  Enabled: true
-
-Layout/SpaceBeforeComma:
-    Enabled: true
-
-Layout/SpaceBeforeFirstArg:
-    Enabled: true
-
-Style/DefWithParentheses:
-  Enabled: true
-
-# Defining a method with parameters needs parentheses.
-Style/MethodDefParentheses:
-  Enabled: true
-
-# Style/FrozenStringLiteralComment:
-#   Enabled: true
-#   EnforcedStyle: always
-#   Exclude:
-#     - 'actionview/test/**/*.builder'
-#     - 'actionview/test/**/*.ruby'
-#     - 'actionpack/test/**/*.builder'
-#     - 'actionpack/test/**/*.ruby'
-#     - 'activestorage/db/migrate/**/*.rb'
-#     - 'db/migrate/**/*.rb'
-#     - 'db/*.rb'
-
-# Use `foo {}` not `foo{}`.
-Layout/SpaceBeforeBlockBraces:
-  Enabled: true
-
-# Use `foo { bar }` not `foo {bar}`.
-Layout/SpaceInsideBlockBraces:
-  Enabled: true
-
-# Use `{ a: 1 }` not `{a:1}`.
-Layout/SpaceInsideHashLiteralBraces:
-  Enabled: true
-
-Layout/SpaceInsideParens:
-  Enabled: true
-
-# Check quotes usage according to lint rule below.
 Style/StringLiterals:
   Enabled: true
-  EnforcedStyle: single_quotes
+  EnforcedStyle: double_quotes
 
-# Detect hard tabs, no hard tabs.
-Layout/IndentationStyle:
+Style/StringLiteralsInInterpolation:
   Enabled: true
+  EnforcedStyle: double_quotes
 
-# Blank lines should not have any spaces.
-Layout/TrailingEmptyLines:
-  Enabled: true
-
-# No trailing whitespace.
-Layout/TrailingWhitespace:
-  Enabled: true
-
-# Use quotes for string literals when they are enough.
-Style/RedundantPercentQ:
-  Enabled: true
-
-# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
-Lint/RequireParentheses:
-  Enabled: true
-
-Lint/RedundantStringCoercion:
-  Enabled: true
-
-# Supports --auto-correct
-Style/RedundantSelf:
-  Description: Don't use self where it's not needed.
-  StyleGuide: https://github.com/rubocop-hq/ruby-style-guide#no-self-unless-required
-  Enabled: true
-
-Style/RedundantReturn:
-  Enabled: true
-  AllowMultipleReturnValues: true
-
-Style/Semicolon:
-  Enabled: true
-  AllowAsExpressionSeparator: true
-
-# Prefer Foo.method over Foo::method
-Style/ColonMethodCall:
-  Enabled: true
+Layout/LineLength:
+  Max: 120

data/README.md

@@ -1,23 +1,15 @@
-![][ruby-shield]
+# ActiveKsql
 
-<p align="center">
-  <img width="200" src="https://user-images.githubusercontent.com/50866745/147449973-a743b690-fef4-4b97-86d3-cc01f1695118.png" >
-</p>
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/active_ksql`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-
-# ActiveKsql 
-
-[![GitHub license](https://badgen.net/github/license/Naereen/Strapdown.js)](https://github.com/Naereen/StrapDown.js/blob/master/LICENSE) ![gem](https://img.shields.io/badge/gem-0.1.0.alpha-blue) [![stability-alpha](https://img.shields.io/badge/stability-alpha-f4d03f.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#alpha) 
-
-ActiveKsql allows you to perform SQL requests to your ksqlDB server.
-You can find the ksqlDB official documentation [here](https://docs.ksqldb.io/en/latest/developer-guide/ksqldb-reference/quick-reference/).
+TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'active_ksql', '0.1.0.alpha.1'
+gem 'active_ksql'
 ```
 
 And then execute:
@@ -30,77 +22,18 @@ Or install it yourself as:
 
 ## Usage
 
-The gem is currently under development although you can start using the beta version.
-
-### Configuration
-
-Run `rails generate active_ksql` to generate the gem initializer.
-
-```Ruby
-ActiveKsql.configure do |config|
-  config.host = "http://localhost:8088"
-  config.api_key = ""
-  config.api_secret = ""
-end
-```
-
-### API Client
-
-At the moment the client allows you to run [queries](https://docs.ksqldb.io/en/latest/developer-guide/ksqldb-rest-api/query-endpoint/) and to execute [statements](https://docs.ksqldb.io/en/latest/developer-guide/ksqldb-rest-api/ksql-endpoint/).
-
-### Queries
-
-To run queries you can use the client's `query` method, like so:
-
-```Ruby
-client = ActiveKsql::Api.new
-
-client.query("SELECT * FROM pageviews EMIT CHANGES;", {
-    streams_properties: {
-        "ksql.streams.auto.offset.reset": "earliest"
-    }
-})
-```
-
-Optional arguments are:
-
-- streams_properties
-
-### Statements
-
-Same as for queries you can use the client's `ksql` method, like so:
-
-```Ruby
-client = ActiveKsql::Api.new
-
-client.ksql("CREATE STREAM pageviews_home AS SELECT * FROM pageviews_original WHERE pageid='home';", {
-    streams_properties: {
-        "ksql.streams.auto.offset.reset": "earliest"
-    }
-})
-```
-
-Optional arguments are:
-
-- streams_properties
-- session_variables
-- command_sequence_number
-
+TODO: Write usage instructions here
 
 ## Development
 
-The gem will soon act as an ORM.
-We're planning to develop and release enhancements early 2022.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/LapoElisacci/active_ksql.
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_ksql.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](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/bin/console

@@ -1,22 +1,15 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'active_ksql'
+require "bundler/setup"
+require "active_ksql"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require 'pry'
+# require "pry"
 # Pry.start
 
-require 'irb'
-
-ActiveKsql.configure do |config|
-  config.host = 'http://localhost:8088'
-  config.api_key = ''
-  config.api_secret = ''
-end
-
+require "irb"
 IRB.start(__FILE__)

data/lib/active_ksql/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveKsql
-  VERSION = '0.1.0.alpha.1'
+  VERSION = "0.1.0.pre"
 end

data/lib/active_ksql.rb

@@ -1,21 +1,8 @@
 # frozen_string_literal: true
 
-# require 'active_support'
-# require 'active_model'
-
-require_relative 'active_ksql/version'
-require_relative 'active_ksql/configuration'
-require_relative 'active_ksql/api'
+require_relative "active_ksql/version"
 
 module ActiveKsql
   class Error < StandardError; end
-
-  class << self
-    attr_accessor :config
-
-    def configure
-      self.config = ActiveKsql::Configuration.new
-      yield(config)
-    end
-  end
+  # Your code goes here...
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_ksql
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha.1
+  version: 0.1.0.pre
 platform: ruby
 authors:
 - Lapo
@@ -10,6 +10,34 @@ bindir: exe
 cert_chain: []
 date: 2021-12-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -33,21 +61,15 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby_version"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/active_ksql.rb
-- lib/active_ksql/api.rb
-- lib/active_ksql/configuration.rb
 - lib/active_ksql/version.rb
-- lib/generators/active_ksql.rb
-- lib/generators/templates/initializer.rb
 homepage: https://github.com/LapoElisacci/ksql
 licenses:
 - MIT

data/.ruby_version

@@ -1 +0,0 @@
-3.0.2

data/Gemfile.lock

@@ -1,64 +0,0 @@
-PATH
-  remote: .
-  specs:
-    active_ksql (0.1.0.pre)
-      httparty (~> 0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    diff-lcs (1.5.0)
-    httparty (0.20.0)
-      mime-types (~> 3.0)
-      multi_xml (>= 0.5.2)
-    mime-types (3.4.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.1115)
-    multi_xml (0.6.0)
-    parallel (1.21.0)
-    parser (3.0.3.2)
-      ast (~> 2.4.1)
-    rainbow (3.0.0)
-    rake (13.0.6)
-    regexp_parser (2.2.0)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.24.0)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.0)
-      parser (>= 3.0.1.1)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.1.0)
-
-PLATFORMS
-  ruby
-  x86_64-darwin-20
-
-DEPENDENCIES
-  active_ksql!
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.7)
-
-BUNDLED WITH
-   2.2.28

data/lib/active_ksql/api.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-require 'httparty'
-
-module ActiveKsql
-  #
-  # KsqlDB API Client
-  #
-  class Api
-    attr_accessor :base_uri, :client, :headers
-
-    KSQL_ENDPOINT = 'ksql'
-    QUERY_ENDPOINT = 'query'
-
-    def initialize
-      @base_uri = ActiveKsql.config.host
-      @headers = {
-        'Accept' => 'application/vnd.ksql.v1+json; q=0.9, application/json; q=0.5',
-        'Authorization' => "Basic #{ActiveKsql.config.api_key}:#{ActiveKsql.config.api_secret}"
-      }
-      @client = HTTParty
-    end
-
-    #
-    # Perform requests to the /ksql endpoint of ksqlDB REST API
-    #
-    # @param [String] sql The ksqlDB SQL Statement
-    # @param [Hash] streams_properties ksqlDB streamsProperties param
-    # @param [Hash] session_variables ksqlDB sessionVariables param
-    # @param [Int] command_sequence_number ksqlDB commandSequenceNumber param
-    #
-    # @return [Hash/Array] Request response
-    #
-    def ksql(sql, streams_properties: nil, session_variables: nil, command_sequence_number: nil)
-      post(KSQL_ENDPOINT, body: { ksql: sql, streamsProperties: streams_properties, sessionVariables: session_variables, commandSequenceNumber: command_sequence_number }.compact)
-    end
-
-    #
-    # Perform requests to the /query endpoint of ksqlDB REST API
-    #
-    # @param [String] sql The ksqlDB SQL Statement
-    # @param [Hash] streams_properties ksqlDB streamsProperties param
-    #
-    # @return [Hash/Array] Request response
-    #
-    def query(sql, streams_properties: nil)
-      post(QUERY_ENDPOINT, body: { ksql: sql, streamsProperties: streams_properties }.compact)
-    end
-
-    private
-
-      #
-      # Perform the HTTP Request
-      #
-      # @param [String] endpoint ksqlDB REST API Endpoint
-      # @param [Hash] body HTTP Request Body
-      #
-      # @return [Hash/Array] Request response
-      #
-      def post(endpoint, body: {})
-        client.post("#{base_uri}/#{endpoint}", headers: headers, body: body.to_json).parsed_response
-      end
-  end
-end

data/lib/active_ksql/configuration.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveKsql
-  #
-  # Ksql configuration
-  #
-  class Configuration
-    attr_accessor :host, :api_key, :api_secret
-  end
-end

data/lib/generators/active_ksql.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators'
-
-# Creates the ActiveKsql initializer file for Rails apps.
-#
-# @example Invokation from terminal
-#   rails generate active_ksql
-#
-class ActiveKsqlGenerator < Rails::Generators::Base
-  desc "Description:\n  This creates a Rails initializer for Ksql"
-
-  source_root File.expand_path('templates', __dir__)
-
-  desc 'Configures Ksql to connect to ksqlDB'
-  def generate_layout
-    template 'initializer.rb', 'config/initializers/active_ksql.rb'
-  end
-end

data/lib/generators/templates/initializer.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-ActiveKsql.configure do |config|
-  config.host = "http://localhost:8088"
-  config.api_key = ""
-  config.api_secret = ""
-end