redis_stream 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 49b0969e58e3218a98bca0a7fee77b867319d714939bb2f362d26caefda7276e
+  data.tar.gz: ae4dfad5e0111d8d194dd2efb42c760169d6ff1779be54c7f0be880b85543865
+SHA512:
+  metadata.gz: 0ccc6e83373da211edac19337381cb91be66cf54348be8014e41241f41ad5fd3499026d4efde8251e79911bf79f1ec450ad58f3b7f914b468407ac9a46093f02
+  data.tar.gz: 2716f3534212900fd4b5079f201acd072f9cc193ef75c9daf6eee303a8a358e7bdcc3570c81e20c8df682759572398c4ad87036f9103ade017cca4b28149816b

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+sudo: false
+services:
+  - redis-server
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in redis_stream.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    redis_stream (0.1.0)
+      redis (~> 4.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    method_source (0.9.2)
+    minitest (5.13.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    redis (4.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  pry (~> 0.12)
+  rake (~> 10.0)
+  redis_stream!
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,69 @@
+# RedisStream
+
+<p align="center">
+  <a href="https://codeclimate.com/github/tomorrowhq/redis-stream/maintainability"><img src="https://api.codeclimate.com/v1/badges/73f0d460cf35b758e624/maintainability" /></a>
+  <a href="https://codeclimate.com/github/tomorrowhq/redis-stream/test_coverage"><img src="https://api.codeclimate.com/v1/badges/73f0d460cf35b758e624/test_coverage" /></a>
+</p>
+
+## Status
+
+Currently project is under active development.
+
+## Usage
+
+### Setting up
+
+Under the hood RedisStream is using redis gem, which means that you can use it
+out of the box if you are using redis. It will be using same `REDIS_URL`
+environment variable to establish connection with Redis.
+
+```ruby
+require 'redis_stream'
+
+client = RedisStream.new
+```
+
+When you need to have control over redis connection you can pass redis instance
+in initializer.
+
+```ruby
+require 'redis_stream'
+
+redis = Redis.new # set it up as you need
+client = RedisStream.new(redis)
+```
+
+### Adding messages to the stream
+
+```ruby
+require 'redis_stream'
+
+client = RedisStream.new
+
+weather_stream = client.stream('weather')
+
+weather_stream.add(20.0)
+weather_stream.add(21.0)
+weather_stream.add(22.0)
+
+puts weather_stream.len
+#=> 3
+```
+
+### Consuming messages from the stream
+
+```ruby
+require 'redis_stream'
+
+client = RedisStream.new
+messages_stream = client.stream('messages')
+
+messages_stream.add('Message 1')
+messages_stream.add('Message 2')
+
+messages_stream.each_message do |message|
+  puts message
+end
+# => Message 1
+# => Message 2
+```

data/Rakefile

@@ -0,0 +1,10 @@
+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
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redis_stream"
+
+# 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/docker-compose.yml

@@ -0,0 +1,7 @@
+version: '3'
+
+services:
+  redis:
+    image: redis:5-alpine
+    ports:
+      - 6379:6379

data/lib/redis_stream/client.rb

@@ -0,0 +1,16 @@
+module RedisStream
+  class Client
+    def initialize(redis)
+      @redis = redis
+    end
+
+    def stream(key)
+      Stream.new(redis: @redis, key: key)
+    end
+
+    def group(key:, name:)
+      new_group = Group.new(redis: @redis, key: key, name: name)
+      new_group.create
+    end
+  end
+end

data/lib/redis_stream/group.rb

@@ -0,0 +1,54 @@
+module RedisStream
+  class Group
+    attr_reader :key, :name
+
+    def initialize(redis:, key:, name:)
+      @redis = redis
+      @key = key
+      @name = name
+      @last_delivered_id = '0'
+    end
+
+    # Creates group and stream if group does not exist.
+    # @return [Group]
+    def create
+      if info.nil?
+        @redis.xgroup(:create, key, name, @last_delivered_id, mkstream: true)
+      end
+
+      self
+    end
+
+    # @return [Group]
+    def destroy
+      @redis.xgroup(:destroy, key, name)
+      self
+    end
+
+    def info
+      find_me(@redis.xinfo(:groups, key))
+    rescue Redis::CommandError
+      nil
+    end
+
+    def each_message(consumer: 'c1', ack: true)
+      while
+        result = @redis.xreadgroup(name, consumer, key, '>')
+        break if result.empty?
+
+        messages = result[key]
+        messages.each do |message|
+          id, entry = message
+          yield(entry['value'])
+          @redis.xack(key, name, id) if ack
+        end
+      end
+    end
+
+    private
+
+    def find_me(groups)
+      groups.find { |group| group['name'] == name }
+    end
+  end
+end

data/lib/redis_stream/stream.rb

@@ -0,0 +1,37 @@
+module RedisStream
+  class Stream
+    attr_reader :key
+
+    def initialize(key:, redis:)
+      @key = key
+      @redis = redis
+    end
+
+    def add(entry)
+      @redis.xadd(key, value: entry)
+    end
+
+    def len
+      @redis.xlen(key)
+    end
+
+    def clear
+      @redis.xtrim(key, 0)
+    end
+
+    def each_message
+      last_id = '0'
+
+      while
+        result = @redis.xread(key, last_id, count: 1)
+        break if result.empty?
+
+        messages = result[key]
+        messages.each do |message|
+          last_id, entry = message
+          yield(entry['value'])
+        end
+      end
+    end
+  end
+end

data/lib/redis_stream/version.rb

@@ -0,0 +1,3 @@
+module RedisStream
+  VERSION = "0.1.0"
+end

data/lib/redis_stream.rb

@@ -0,0 +1,14 @@
+require 'redis'
+require 'redis_stream/version'
+require 'redis_stream/group'
+require 'redis_stream/stream'
+require 'redis_stream/client'
+
+module RedisStream
+  class Error < StandardError; end
+
+  def self.new(redis: nil)
+    redis = redis.nil? ? Redis.new : redis
+    Client.new(redis)
+  end
+end

data/redis_stream.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_stream/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'redis_stream'
+  spec.version       = RedisStream::VERSION
+  spec.authors       = ['Anton Volkov']
+  spec.email         = ['choixer@gmail.com']
+
+  spec.summary       = %q{Interface around Redis Streams for Ruby}
+  spec.description   = %q{..}
+  spec.homepage      = 'https://github.com/antonvolkoff/redis-stream'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  # spec.bindir        = "exe"
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'redis', '~> 4.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'pry', '~> 0.12'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: redis_stream
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anton Volkov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: ".."
+email:
+- choixer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- lib/redis_stream.rb
+- lib/redis_stream/client.rb
+- lib/redis_stream/group.rb
+- lib/redis_stream/stream.rb
+- lib/redis_stream/version.rb
+- redis_stream.gemspec
+homepage: https://github.com/antonvolkoff/redis-stream
+licenses: []
+metadata:
+  homepage_uri: https://github.com/antonvolkoff/redis-stream
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Interface around Redis Streams for Ruby
+test_files: []