redis_stream 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e7e670f9058b83d4320a7d90f7bc6d65cbc01eed157f48ff0080a12cb5f1005
-  data.tar.gz: 3719676857cc946547a6b2198298bb6a05a0d4b100d8c8eeb01097a9a7db7685
+  metadata.gz: 4f61cf214e2178d4b843245af1622d226b9636903c17308de97ccfc0bd75bab3
+  data.tar.gz: dbc74cb1808d5838fa4d26de5c86669f35d292b207e900f6aaf45d55e62ce06a
 SHA512:
-  metadata.gz: 2636062233cd1f964469caf870be2e22b7eaf4b4cb6a187ac452ae693a90248ad83683d5c19ad9df589d466f100dd912ab20c123404dbb2b19d289bd4fd8e099
-  data.tar.gz: fbe67b94482dc9f1401783afec0e0e478f8b0bcdd68c60ac540360c2cfe51ac211c686e9b994d480c39da5401a01538ce6f12e01866f3fdf207d26705eb5165e
+  metadata.gz: a83b7e3985d5f30f3a66e35bd32d8d8dfe55f89ddb1d77af8354981f4419beab642e26732f3c2b0775694a0a23602ee25fc63ae0321b1a9c7891fb5e5c423b03
+  data.tar.gz: 57b88bc65f63499cc5c372bd94e14b1a6b3236203479b2f59b98942fc118c252ba542f0fa2003c7e62e00c005f68e2596969794f875b23f267403db7bfd702f7

data/Gemfile.lock

@@ -1,30 +1,43 @@
 PATH
   remote: .
   specs:
-    redis_stream (0.1.0)
+    redis_stream (0.3.0)
       redis (~> 4.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.2)
+    diff-lcs (1.3)
     method_source (0.9.2)
-    minitest (5.13.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     rake (13.0.1)
-    redis (4.1.3)
+    redis (4.2.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.17)
-  minitest (~> 5.0)
   pry (~> 0.12)
   rake (~> 13.0)
   redis_stream!
+  rspec (~> 3.9)
 
 BUNDLED WITH
    1.17.3

data/README.md

@@ -5,10 +5,6 @@
   <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
@@ -18,19 +14,9 @@ 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'
+# Gemfile
 
-redis = Redis.new # set it up as you need
-client = RedisStream.new(redis)
+gem "redis_stream", "~> 0.3.0"
 ```
 
 ### Adding messages to the stream
@@ -38,38 +24,36 @@ client = RedisStream.new(redis)
 ```ruby
 require 'redis_stream'
 
-client = RedisStream.new
-
-weather_stream = client.stream('weather')
+daily_temperature = RedisStream.stream(name: "daily_temperature")
 
-weather_stream.add({ temp: 20.0 })
-weather_stream.add({ temp: 21.0 })
-weather_stream.add({ temp: 22.0 })
+daily_temperature << 20.0
+daily_temperature << 21.0
+daily_temperature << 22.0
 
-puts weather_stream.len
+puts daily_temperature.size
 #=> 3
 ```
 
 ### Consuming messages from the stream
 
-```ruby
-require 'redis_stream'
-
-client = RedisStream.new
-messages_stream = client.stream('messages')
-
-messages_stream.add({ msg: 'Message 1' })
-messages_stream.add({ msg: 'Message 2' })
+Stream implements most of operations that can be performed on ruby Array.
 
-messages_stream.each_message do |message|
+```ruby
+daily_temperature.each do |temperature|
   puts message
 end
-# => { "msg" => Message 1 }
-# => { "msg" => Message 2 }
+# => 20.0
+# => 21.0
+# => 22.0
+
+puts daily_temperature.last
+# => 22.0
 
-puts messages_stream.last
-# => { "msg" => Message 2 }
+puts daily_temperature.first
+# => 20.0
 
-puts messages_stream.first
-# => { "msg" => Message 2 }
+average = daily_temperature.sum / daily_temperature.length
+min = daily_temperature.min
+max = daily_temperature.max
+puts "Average: #{average} Min: #{min} Max: #{max}"
 ```

data/lib/redis_stream.rb

@@ -2,13 +2,22 @@ require 'redis'
 require 'redis_stream/version'
 require 'redis_stream/group'
 require 'redis_stream/stream'
+require 'redis_stream/consumer'
 require 'redis_stream/client'
 
 module RedisStream
   class Error < StandardError; end
 
-  def self.new(redis: nil)
-    redis = redis.nil? ? Redis.new : redis
-    Client.new(redis)
+  # @param name <String> Name of a stream
+  # @return <RedisStream::Stream>
+  def self.stream(name:)
+    Stream.new(name: name)
+  end
+
+  # @param name <String> Name of a group
+  # @param stream <RedisStream::Stream> Stream that group should consume
+  # @return <RedisStream::Group>
+  def self.group(name:, stream:)
+    Group.new(name: name, stream: stream)
   end
 end

data/lib/redis_stream/consumer.rb

@@ -0,0 +1,35 @@
+module RedisStream
+  class Consumer
+    include Enumerable
+
+    attr_reader :name, :group, :stream
+
+    def initialize(name:, group:, stream:)
+      @name = name
+      @group = group
+      @stream = stream
+    end
+
+    def each(&block)
+      while
+        result = read_next
+        break if result.empty?
+
+        message = result[stream.name].first
+        id, content = message
+        block.call(load(content))
+        Redis.current.xack(stream.name, name, id)
+      end
+    end
+
+    private
+
+    def read_next
+      Redis.current.xreadgroup(group.name, name, stream.name, '>', count: 1)
+    end
+
+    def load(message_content)
+      Marshal.load(message_content["value"])
+    end
+  end
+end

data/lib/redis_stream/group.rb

@@ -1,54 +1,36 @@
 module RedisStream
   class Group
-    attr_reader :key, :name
+    attr_reader :name, :stream
 
-    def initialize(redis:, key:, name:)
-      @redis = redis
-      @key = key
+    # @param name <String>
+    # @param stream <RedisStream::Stream>
+    # @return RedisStream::Group
+    def initialize(name:, stream:)
       @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
+      @stream = stream
 
-    # @return [Group]
-    def destroy
-      @redis.xgroup(:destroy, key, name)
-      self
+      create_group
     end
 
-    def info
-      find_me(@redis.xinfo(:groups, key))
-    rescue Redis::CommandError
-      nil
+    # @param name <String> Consumer name
+    # @return <RedisStream::Consumer>
+    def consumer(name)
+      RedisStream::Consumer.new(name: name, group: self, stream: stream)
     end
 
-    def each_message(consumer: 'c1', ack: true)
-      while
-        result = @redis.xreadgroup(name, consumer, key, '>', count: 1)
-        break if result.empty?
-
-        messages = result[key]
-        messages.each do |message|
-          id, entry = message
-          yield(entry)
-          @redis.xack(key, name, id) if ack
-        end
-      end
+    # Resets group's next id on the stream
+    def reset(id = "0")
+      Redis.current.xgroup(:setid, stream.name, name, id)
+      self
     end
 
     private
 
-    def find_me(groups)
-      groups.find { |group| group['name'] == name }
+    def create_group
+      Redis.current.xgroup(
+        :create, stream.name, name, "$", mkstream: true)
+    rescue Redis::CommandError
+      nil
     end
   end
 end

data/lib/redis_stream/stream.rb

@@ -1,53 +1,62 @@
 module RedisStream
   class Stream
-    attr_reader :key
+    include Enumerable
 
-    def initialize(key:, redis:)
-      @key = key
-      @redis = redis
-    end
+    attr_reader :name
 
-    def add(entry)
-      @redis.xadd(key, entry)
+    def initialize(name:)
+      @name = name
+      @values = []
     end
 
-    def len
-      @redis.xlen(key)
+    def <<(value)
+      Redis.current.xadd(name, dump(value))
+      self
     end
+    alias_method :push, :<<
 
     def clear
-      @redis.xtrim(key, 0)
+      Redis.current.xtrim(name, 0)
     end
 
-    def group(name:)
-      RedisStream::Group.new(redis: @redis, key: key, name: name)
+    def last(count = 1)
+      messages = Redis.current.xrevrange(name, '+', '-', count: count)
+      messages.reverse!
+
+      result = messages.map do |message|
+        _id, content = message
+        load(content)
+      end
+
+      count == 1 ? result.first : result
     end
 
-    def each_message
-      last_id = '0'
+    def length
+      Redis.current.xlen(name)
+    end
+    alias_method :size, :length
+
+    def each(&block)
+      current_message_id = "0"
 
       while
-        result = @redis.xread(key, last_id, count: 1)
+        result = Redis.current.xread(name, current_message_id, count: 1)
         break if result.empty?
 
-        messages = result[key]
-        messages.each do |message|
-          last_id, entry = message
-          yield(entry)
-        end
+        message = result[name].first
+        current_message_id, message_content = message
+        block.call(load(message_content))
       end
     end
 
-    # XREVRANGE [name] + - COUNT 1
-    def last
-      _id, entry = @redis.xrevrange(key, '+', '-', count: 1).first
-      entry
+    private
+
+    def dump(value)
+      { value: Marshal.dump(value) }
     end
 
-    # XRANGE [name] - + COUNT 1
-    def first
-      _id, entry = @redis.xrange(key, '-', '+', count: 1).first
-      entry
+    def load(message_content)
+      Marshal.load(message_content["value"])
     end
   end
 end

data/lib/redis_stream/version.rb

@@ -1,3 +1,3 @@
 module RedisStream
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/redis_stream.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['choixer@gmail.com']
 
   spec.summary       = %q{Interface around Redis Streams for Ruby}
-  spec.description   = %q{..}
+  spec.description   = %q{Make Redis Streams feel like a first-class citizen in Ruby}
   spec.homepage      = 'https://github.com/antonvolkoff/redis-stream'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -28,17 +28,19 @@ Gem::Specification.new do |spec|
 
   # 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)/}) }
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features|examples)/})
+    end
   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_dependency "redis", "~> 4.1"
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'pry', '~> 0.12'
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "pry", "~> 0.12"
+  spec.add_development_dependency "rspec", "~> 3.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_stream
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Anton Volkov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2020-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -53,34 +53,34 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
-description: ".."
+        version: '3.9'
+description: Make Redis Streams feel like a first-class citizen in Ruby
 email:
 - choixer@gmail.com
 executables: []
@@ -99,6 +99,7 @@ files:
 - docker-compose.yml
 - lib/redis_stream.rb
 - lib/redis_stream/client.rb
+- lib/redis_stream/consumer.rb
 - lib/redis_stream/group.rb
 - lib/redis_stream/stream.rb
 - lib/redis_stream/version.rb