ristretta 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e2dee7894e25b7b85adc61ae2f669b6c459bcfc82507b25806416f182053f24
+  data.tar.gz: 63a9267063194183b52ec09b7f2100eb5ad05c58ec918cb44ceec6b8bf06de20
+SHA512:
+  metadata.gz: 6d7bf30b573e099f82af6a010fd61bdb915ac83c86e79e8fae3463b74f975193fd17c59e9d97345b99ca9f505a3ee6987198cc80b53e7db3210c66bc601e7259
+  data.tar.gz: a847a5732bc5863be930440eb533818cfe0cd8e04742fffe229607e7f732cec012bc54e9426c76d83e39aa6a69734121d560b2e380ea37de8cc21af1e70b95e1

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.4.5
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-05-27
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ristretta.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    ristretta (0.1.0)
+      redis
+      redis-namespace
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    redis (4.2.5)
+    redis-namespace (1.8.1)
+      redis (>= 3.0.4)
+    regexp_parser (2.1.1)
+    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.2)
+    rubocop (1.12.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  rake (~> 13.0)
+  ristretta!
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.16

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Lord Meidar
+
+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,81 @@
+# Ristretta
+
+Ristretta is a library that allows easily collecting event data in Redis sorted sets. It uses a timestamp as the event score to ensure the oridnality.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ristretta'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ristretta
+
+## Usage
+
+### Configuration
+
+Ristretta accepts a configuration block that allows the following options:
+
+```ruby
+Ristretta.config do |config|
+    config.redis_client = redis # a pre-configured Redis client
+    config.namespace = 'ristretta' # namespace for all your redis keys
+    config.version = 1 # easily expire all previous event collectors
+    config.subject_id_method = :id # This is the method that will be used to extract an unique id for the passed event_subject instance
+end
+
+```
+
+### Recording Events
+
+```ruby
+Ristretta::Event.create(event_subject, event_type, event_attrs, timestamp)
+```
+
+| Parameter | Description | Required | Default |
+| --------- | ----------- | -------- | ------- |
+| event_subject | the object that the event will be associated with | V | X |
+| event_type | the event name (string) | V | X |
+| event_attrs | hash with the event details | x | `{}` |
+| timestamp | the event timestamp | x | `Time.now.to_i` |
+
+
+### Fetching Events
+
+```ruby
+Ristretta::Event.find(options = {})
+```
+
+`options` includes the following keys:
+
+| key | Description | Required | Default |
+| --------- | ----------- | -------- | ------- |
+| event_subject | the object that the event will be associated with | V | X |
+| event_type | the event name (string) | V | X |
+| since | timestamp of the olders event you want | x | beginning of time |
+| until | timestamp of the newest event you want | x | `Time.now.to_i` |
+
+the returned value is a series of time ordered events (new to old) that will respond to `event_attrs` and `timestamp`
+
+## 
+## Development
+
+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/eladmeidar/ristretta.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "ristretta"
+
+# 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"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ristretta.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'redis'
+require 'redis-namespace'
+require 'json'
+require_relative "ristretta/version"
+require_relative "ristretta/exceptions"
+require_relative "ristretta/configuration"
+require_relative "ristretta/event"
+
+module Ristretta
+  
+  def self.config(&block)
+    yield(configuration)
+  end
+  
+  def self.client
+    configuration.client
+  end
+
+  def self.event_key(options = {})
+    key = "events:v#{configuration.version.to_s}:#{options[:event_subject].send(configuration.subject_id_method)}:#{options[:event_type]}"
+    save_key_name(key)
+    key
+  end
+
+  def self.clear_all_events!
+    client.smembers("events:keys").each do |key|
+      client.del key
+    end
+  end
+
+  private
+
+  def self.save_key_name(key)
+    client.sadd "events:keys", key
+  end
+
+  def self.configuration
+    @configuration || Ristretta::Configuration.new
+  end
+end

data/lib/ristretta/configuration.rb

@@ -0,0 +1,18 @@
+module Ristretta
+  class Configuration
+    attr_accessor :redis_client, 
+                  :namespace,
+                  :subject_id_method,
+                  :version
+
+    def initialize
+      @version = "1"
+      @namespace = "ristretta"
+      @subject_id_method = :id
+    end
+
+    def client
+      @client ||= Redis::Namespace.new(namespace.to_sym, redis: redis_client)
+    end
+  end
+end

data/lib/ristretta/event.rb

@@ -0,0 +1,29 @@
+module Ristretta
+  class Event
+    attr_reader :event_attrs, :timestamp
+
+    def initialize(event_attrs, timestamp)
+      @event_attrs = JSON.parse(event_attrs)
+      @timestamp = timestamp.to_i
+    end
+
+    def Event.create(event_subject, event_type, event_attrs, timestamp = Time.now.to_i)
+      Ristretta.client.zadd(Ristretta.event_key({
+        event_type: event_type,
+        event_subject: event_subject
+      }), timestamp, (event_attrs.merge(timestamp: timestamp.to_i)).to_json, nx: true)
+    end
+
+    def Event.find(options = {})
+      raise(Exceptions::SubjectNotSpecified, "event_subject must be specified") if options[:event_subject].nil?
+      raise(Exceptions::TypeNotSpecified, "event_type must be specified") if options[:event_type].nil?
+
+      start_timestamp = options[:since].to_i
+      end_timestamp = options[:until] || Time.now.to_i
+      
+      Ristretta.client.zrangebyscore(Ristretta.event_key(options), start_timestamp, end_timestamp, with_scores: true).collect do |event_data|
+        self.new(event_data.first, event_data.last.to_i)
+      end
+    end
+  end
+end

data/lib/ristretta/exceptions.rb

@@ -0,0 +1,6 @@
+module Ristretta
+  module Exceptions
+    class TypeNotSpecified < ArgumentError; end
+    class SubjectNotSpecified < ArgumentError; end
+  end
+end

data/lib/ristretta/version.rb

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

data/ristretta.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/ristretta/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ristretta"
+  spec.version       = Ristretta::VERSION
+  spec.authors       = ["Lord Meidar"]
+  spec.email         = ["elad@shinobidevs.com"]
+
+  spec.summary       = "RISTRETTA is a Redis based library to track time series events"
+  spec.description   = "RISTRETTA is a Redis based library to track time series events"
+  spec.homepage      = "https://github.com/eladmeidar/ristretta"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/eladmeidar/ristretta"
+  spec.metadata["changelog_uri"] = "https://github.com/eladmeidar/ristretta"
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  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 "redis"
+  spec.add_dependency "redis-namespace"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: ristretta
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lord Meidar
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RISTRETTA is a Redis based library to track time series events
+email:
+- elad@shinobidevs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ristretta.rb
+- lib/ristretta/configuration.rb
+- lib/ristretta/event.rb
+- lib/ristretta/exceptions.rb
+- lib/ristretta/version.rb
+- ristretta.gemspec
+homepage: https://github.com/eladmeidar/ristretta
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/eladmeidar/ristretta
+  source_code_uri: https://github.com/eladmeidar/ristretta
+  changelog_uri: https://github.com/eladmeidar/ristretta
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: RISTRETTA is a Redis based library to track time series events
+test_files: []