karma 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56f3714acf48a27fd7815e001ae0db4d3f0620d88b5d56783d0e30f87ba466de
+  data.tar.gz: 60fdd49cd456d5600a82aaa78570987dfc8e6daef337e12611d64b1f3b84ca16
+SHA512:
+  metadata.gz: 97227f14c1a966fc6d6668202954eb113938072fd38ac30a618c9da126359528ccf89174fc1f7b7f5abaa3622afef98408b45236e757acb018d5ecbfbfff9564
+  data.tar.gz: 85c528d67cbdd9b4e19fcd87f76549ced9d8415e8bd1c3fd366e06fb39ff65cbdb1b0253aa0cc1bd9fb981bab7a0e8e8dbfa7187bd3b766b734a50173489e968

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in karma-rb.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 creadone
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,113 @@
+# Karma
+
+Karma is a ~key-value~ key-counter database, you can find it in a separate [repository](https://github.com/creadone/karma). This repo contains straightforward Ruby client for Karma.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add karma
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install karma
+
+## Configuration
+
+```Ruby
+require 'karma'
+
+Karma.configure do |config|
+  config.port = 8080
+  config.host = "localhost"
+end
+
+```
+
+## Usage
+
+The client supports all possible functionality, which means that Karma can be fully managed by commands. Each command returns an execution status in the `success` attribute and an execution result or an error in the `result` attribute. For example:
+
+```Ruby
+# Deletes an existing tree
+Karma.drop('comments')
+
+# success: <OpenStruct success=true, response="OK">
+# error: <OpenStruct success=false, response="Tree \"comments\" not exists">
+```
+
+The control commands allow you to maintain the database:
+
+```Ruby
+# Checks the server
+Karma.ping
+
+# Creates new tree "comments" or check if exists
+Karma.create('comments')
+
+# Get list of trees in the memory
+Karma.trees
+
+# Delete tree "comments"
+Karma.drop('comments')
+
+# Get list of all dumps
+Karma.dumps
+
+# Dumps tree to the backup directory
+Karma.dump('comments')
+
+# Make a backup on FS for each tree in memory
+Karma.dump_all
+
+# Load a dump of the tree into memory (existing tree will overwrited)
+Karma.load('1688496993_comments.tree')
+```
+
+The tree commands allow you to work with specific tree:
+
+```Ruby
+# Increment the value in the tree for the key
+Karma.tree('comments').increment(key: 12345)
+
+# Increment the value in the tree for the key
+Karma.tree('comments').decrement(key: 12345)
+
+# Get total value in the tree for the key
+Karma.tree('comments').sum(key: 12345)
+
+# Get total value in the tree for the key between dates
+Karma.tree('comments').sum(key: 12345, time_from: 20230601, time_to: 20230629)
+
+# Get hash where key is date and value is total for key between dates
+Karma.tree('comments').find(key: 12345, time_from: 20230601, time_to: 20230629)
+
+# Get hash where key is key number and value is total over the tree between dates
+Karma.tree('comments').find(time_from: 20230601, time_to: 20230629)
+
+# Delete all values for the key between dates
+Karma.tree('comments').delete(key: 12345, time_from: 20230601, time_to: 20230629)
+
+# Delete all values over the tree between dates
+Karma.tree('comments').delete(time_from: 20230601, time_to: 20230629)
+
+# Delete all values for the key
+Karma.tree('comments').reset(key: 12345)
+
+# Delete all values for the tree
+Karma.tree('comments').reset
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/creadone/karmarb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/karma.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/karma/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "karma"
+  spec.version = Karma::VERSION
+  spec.authors = ["Sergey Fedorov"]
+  spec.email = ["creadone@gmail.com"]
+
+  spec.summary = "Ruby client for the Karma key-counter database"
+  spec.description = "Ruby client for the Karma key-counter database"
+  spec.homepage = "https://github.com/creadone/karma-rb"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/creadone/karma-rb"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/karma/config.rb

@@ -0,0 +1,18 @@
+module Karma
+  Config = Struct.new(:host, :port) do
+    def initialize
+      self.port = 8080
+      self.host = 'localhost'
+    end
+  end
+
+  def self.configure
+    @config = Config.new
+    yield(@config) if block_given?
+    @config
+  end
+
+  def self.config
+    @config || configure
+  end
+end

data/lib/karma/connection.rb

@@ -0,0 +1,58 @@
+module Karma
+  class Connection
+    def initialize
+      @port   = Karma.config.port
+      @host   = Karma.config.host
+      @maxlen = 4096
+
+      establish_connection!
+    end
+
+    def send_and_read(request)
+      send(request)
+      read
+    end
+
+    private
+
+    def connect
+      begin
+        yield @socket
+      rescue => e
+        establish_connection!
+        retry
+      end
+    end
+
+    def send(message)
+      message = message.to_json
+      connect do |conn|
+        conn.send("#{message}\r\n", 0)
+        conn.flush
+      end
+    end
+
+    def read
+      connect do |conn|
+        response = conn.recv(@maxlen)
+        begin
+          OpenStruct.new(JSON.parse(response))
+        rescue => e
+          return OpenStruct.new({
+            "success" => false,
+            "response" => e.message
+          })
+        end
+      end
+    end
+
+    def establish_connection!
+      @socket = TCPSocket.new(
+        @host,
+        @port,
+        connect_timeout: 0.5
+      )
+    end
+
+  end
+end

data/lib/karma/tree.rb

@@ -0,0 +1,121 @@
+module Karma
+  class Tree
+    def initialize
+      @connection = Connection.new
+      @tree_name  = nil
+    end
+
+    def tree(name)
+      @tree_name = name
+      self
+    end
+
+    def ping
+      request = {
+        command: 'ping'
+      }
+      @connection.send_and_read(request)
+    end
+
+    def trees
+      request = {
+        command: 'trees'
+      }
+      @connection.send_and_read(request)
+    end
+
+    def create(name)
+      request = {
+        command: 'create',
+        tree_name: name
+      }
+      @connection.send_and_read(request)
+    end
+
+    def drop(name)
+      request = {
+        command: 'drop',
+        tree_name: name
+      }
+      @connection.send_and_read(request)
+    end
+
+    def dump(name)
+      request = {
+        command: 'dump',
+        tree_name: name
+      }
+      @connection.send_and_read(request)
+    end
+
+    def dump_all
+      request = {
+        command: 'dump_all'
+      }
+      @connection.send_and_read(request)
+    end
+
+    def dumps
+      request = {
+        command: 'dumps'
+      }
+      @connection.send_and_read(request)
+    end
+
+    def load(name)
+      request = {
+        command: 'load',
+        tree_name: name
+      }
+      @connection.send_and_read(request)
+    end
+
+    def increment(**args)
+      request = {
+        command: 'increment',
+        tree_name: @tree_name
+      }.merge!(args)
+      @connection.send_and_read(request)
+    end
+
+    def decrement(**args)
+      request = {
+        command: 'decrement',
+        tree_name: @tree_name
+      }.merge!(args)
+      @connection.send_and_read(request)
+    end
+
+    def sum(**args)
+      request = {
+        command: 'sum',
+        tree_name: @tree_name
+      }.merge!(args)
+      @connection.send_and_read(request)
+    end
+
+    def find(**args)
+      request = {
+        command: 'find',
+        tree_name: @tree_name
+      }.merge!(args)
+      @connection.send_and_read(request)
+    end
+
+    def reset(**args)
+      request = {
+        command: 'reset',
+        tree_name: @tree_name,
+      }.merge!(args)
+      @connection.send_and_read(request)
+    end
+
+    def delete(**args)
+      request = {
+        command: 'delete',
+        tree_name: @tree_name,
+      }.merge!(args)
+      @connection.send_and_read(request)
+    end
+  end
+end

data/lib/karma/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Karma
+  VERSION = "0.1.0"
+end

data/lib/karma.rb

@@ -0,0 +1,16 @@
+require 'json'
+require 'socket'
+require 'ostruct'
+
+require 'karma/version'
+require 'karma/config'
+require 'karma/connection'
+require 'karma/tree'
+
+module Karma
+  TREE = Tree.new
+
+  def self.method_missing(m, *args, &block)
+    TREE.send(m, *args, &block)
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: karma
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Fedorov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-04 00:00:00.000000000 Z
+dependencies: []
+description: Ruby client for the Karma key-counter database
+email:
+- creadone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- karma.gemspec
+- lib/karma.rb
+- lib/karma/config.rb
+- lib/karma/connection.rb
+- lib/karma/tree.rb
+- lib/karma/version.rb
+homepage: https://github.com/creadone/karma-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/creadone/karma-rb
+  source_code_uri: https://github.com/creadone/karma-rb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Ruby client for the Karma key-counter database
+test_files: []