redis-deque 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1cdd48df50df7ac6187df87833dea87bc081d62fef36043681b57de55a720440
+  data.tar.gz: c91128c60fed13783d74d73c2a59c60974074d23403a2f4af150c4f1e2dbf3ad
+SHA512:
+  metadata.gz: b3443c68eed981dd345298f79f001eab472a129dca821a5a48cbd2f678a3f62f66b697c2a14a8fc254a1b79ecb644e0a9525626c112313d5a31a9e2f421cd851
+  data.tar.gz: 6117efd7dfd74d2c639813eca093dca92c2d0ae08a9dc67f9c7f8d04a6e75e7db577f9ab12d45436f7caea8d0c4c4612e7d05d14f144497db6b6654035fcff57

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in redis-queue.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Francesco Laurita
+
+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,74 @@
+redis-deque
+=============
+Requires the redis gem.
+
+Adds Redis::Deque class which can be used as Distributed-Deque based on Redis.
+Redis is often used as a messaging server to implement processing of background jobs or other kinds of messaging tasks.
+It implements Reliable-queue pattern decribed here: http://redis.io/commands/rpoplpush.
+
+Installation
+----------------
+    $ gem install redis-deque
+
+Testing
+----------------
+    $ bundle install
+    $ rake
+
+Simple usage
+----------------
+
+```ruby
+require "redis-deque"
+redis = Redis.new
+queue = Redis::Deque.new('q_test', redis: redis)
+
+#Adding some elements
+queue.push "b"
+queue << "a" # << is an alias of push
+
+# Process messages
+
+# By default, calling pop method is a blocking operation
+# Your code will wait here for a new
+while message=queue.pop
+  #Remove message from the backup queue if the message has been processed without errors
+  queue.commit if YourTask.new(message).perform.succeed?
+end
+
+#Process messages using block
+
+queue.process do |message|
+  #queue.commit is called if last statement of the block returns true
+  YourTask.new(message).perform.succeed?
+end
+
+# Process messages with timeout (starting from version 0.0.3)
+# Wait for 15 seconds for new messages, then exit
+queue.process(false, 15) do |message|
+  puts "'#{message}'"
+end
+
+# Process messages in a non blocking-way
+# A soon as the queue is empty, the block will exit
+queue.process(true) do |message|
+  puts "'#{message}'"
+end
+```
+Contributing to redis-deque
+----------------
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+----------------
+
+Copyright (c) 2013 Francesco Laurita. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/*_spec.rb'
+end
+
+task default: :spec
+task test: :spec

data/example/blocking.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'redis-deque'
+redis = Redis.new
+# Create a queue that will listen for a new element for 10 seconds
+queue = Redis::Deque.new('__test', redis: redis, timeout: 10)
+queue.clear true
+
+100.times { queue << rand(100) }
+
+# Simulate a delayed insert
+t = Thread.new do
+  sleep 3
+  # We should use a second connection here since the first one is busy
+  # on a blocking call
+  other_redis = Redis.new
+  other_queue = Redis::Deque.new('__test', redis: other_redis)
+  100.times { other_queue << "e_#{rand(100)}" }
+end
+
+# When all elements are de-queued, process method will wait for 10 secods before exit
+queue.process do |message|
+  puts "'#{message}'"
+end
+t.join

data/example/non-blocking.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'redis-deque'
+
+redis = Redis.new
+
+queue = Redis::Deque.new('__test', redis: redis)
+queue.clear true
+
+100.times { queue << rand(100) }
+
+queue.process(true) { |m| puts m }

data/lib/redis-deque.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'redis'
+require 'redis/deque'

data/lib/redis/deque.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+class Redis
+  class Deque
+    VERSION = '0.1.0'
+
+    def self.version
+      "redis-deque version #{VERSION}"
+    end
+
+    def initialize(queue_name, options = {})
+      raise ArgumentError, 'queue_name must be a non-empty string'  if !queue_name.is_a?(String) || queue_name.empty?
+      raise ArgumentError, 'process_queue_name must be a non-empty string' if options.key?(:process_queue_name) && (!options[:process_queue_name].is_a?(String) || options[:process_queue_name].empty?)
+      raise ArgumentError, 'queue_name and process_queue_name must be different' if options[:process_queue_name] == queue_name
+
+      @redis = options[:redis] || Redis.current
+      @queue_name = queue_name
+      @process_queue_name = options[:process_queue_name] || "#{queue_name}_process"
+      @last_message = nil
+      @timeout = options[:timeout] ||= 0
+    end
+
+    def length
+      @redis.llen @queue_name
+    end
+
+    def clear(clear_process_queue = false)
+      @redis.del @queue_name
+      @redis.del @process_queue_name if clear_process_queue
+    end
+
+    def empty?
+      length <= 0
+    end
+
+    def push(obj)
+      @redis.lpush(@queue_name, obj)
+    end
+
+    def unshift(obj)
+      @redis.rpush(@queue_name, obj)
+    end
+
+    def pop(non_block = false)
+      @last_message = if non_block
+                        @redis.rpoplpush(@queue_name, @process_queue_name)
+                      else
+                        @redis.brpoplpush(@queue_name, @process_queue_name, @timeout)
+                      end
+      @last_message
+    end
+
+    def commit
+      @redis.lrem(@process_queue_name, 0, @last_message)
+    end
+
+    def process(non_block = false, timeout = nil)
+      @timeout = timeout unless timeout.nil?
+      loop do
+        message = pop(non_block)
+        ret = yield message if block_given?
+        commit if ret
+        break if message.nil? || (non_block && empty?)
+      end
+    end
+
+    def refill
+      while (message = @redis.lpop(@process_queue_name))
+        unshift(message)
+      end
+      true
+    end
+
+    alias size  length
+    alias dec   pop
+    alias shift pop
+    alias enc   push
+    alias <<    push
+  end
+end

data/redis-deque.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+require File.expand_path('lib/redis/deque', __dir__)
+
+Gem::Specification.new do |s|
+  s.name        = 'redis-deque'
+  s.version     = Redis::Deque::VERSION
+  s.authors     = ['Jaakko Rinta-Filppula', 'Francesco Laurita']
+  s.email       = ['jaakko@r-f.fi', 'francesco.laurita@gmail.com']
+  s.homepage    = 'https://github.com/tophattom/redis-deque'
+  s.summary     = 'A distributed deque based on Redis'
+  s.description = '
+    Adds Redis::Deque class which can be used as Distributed-Deque based on Redis.
+    Redis is often used as a messaging server to implement processing of background jobs or other kinds of messaging tasks.
+    It implements Reliable-queue pattern decribed here: http://redis.io/commands/rpoplpush
+  '
+
+  s.licenses = ['MIT']
+
+  s.rubyforge_project = 'redis-deque'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'redis', '>= 3.3.5', '< 5'
+
+  s.add_development_dependency 'rspec', '~> 2.13', '>= 2.13.0'
+end

data/spec/redis_deque_spec.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'timeout'
+
+describe Redis::Deque do
+  before(:all) do
+    @redis = Redis.new
+    @queue = Redis::Deque.new('__test', process_queue_name: 'bp__test')
+    @queue.clear true
+  end
+
+  before(:each) do
+    @queue.clear true
+  end
+
+  after(:all) do
+    @queue.clear true
+  end
+
+  after(:each) do
+    @queue.clear true
+  end
+
+  it 'should return correct version string' do
+    Redis::Deque.version.should == "redis-deque version #{Redis::Deque::VERSION}"
+  end
+
+  it 'should create a new redis-queue object' do
+    queue = Redis::Deque.new('__test', process_queue_name: 'bp__test')
+    queue.class.should == Redis::Deque
+  end
+
+  it 'should create default process_queue_name if one is not given' do
+    queue = Redis::Deque.new '__test_queue'
+    queue.instance_variable_get(:@process_queue_name).should be == '__test_queue_process'
+  end
+
+  it 'should not allow same name for queue_name and process_queue_name' do
+    expect {
+      Redis::Deque.new '__test_queue', process_queue_name: '__test_queue'
+    }.to raise_error(ArgumentError)
+  end
+
+  it 'should add an element to the queue' do
+    @queue << 'a'
+    @queue.size.should be == 1
+  end
+
+  it 'should add an element to the front of the queue' do
+    @queue.unshift 'a'
+    @queue.unshift 'b'
+    @queue.size.should be == 2
+
+    message = @queue.pop(true)
+    message.should be == 'b'
+  end
+
+  it 'should return an element from the queue' do
+    @queue << 'a'
+    message = @queue.pop(true)
+    message.should be == 'a'
+  end
+
+  it 'should remove the element from bp_queue if commit is called' do
+    @queue << 'a'
+    @queue.pop true
+
+    @redis.llen('bp__test').should be == 1
+    @queue.commit
+    @redis.llen('bp__test').should be == 0
+  end
+
+  it 'should implements fifo pattern' do
+    @queue.clear
+    payload = %w[a b c d e]
+    payload.each { |e| @queue << e }
+    test = []
+    while (e = @queue.pop(true))
+      test << e
+    end
+    payload.should be == test
+  end
+
+  it 'should implement lifo pattern with unshift' do
+    payload = %w(a b c d e)
+    payload.each { |e| @queue.unshift e }
+    test = []
+    while (e = @queue.pop(true))
+      test << e
+    end
+    test.should be == payload.reverse
+  end
+
+  it 'should remove all of the elements from the main queue' do
+    %w[a b c d e].each { |e| @queue << e }
+    @queue.size.should be > 0
+    @queue.pop(true)
+    @queue.clear
+    @redis.llen('bp__test').should be > 0
+  end
+
+  it 'should reset queues content' do
+    @queue.clear(true)
+    @redis.llen('bp__test').should be == 0
+  end
+
+  it 'should prcess a message' do
+    @queue << 'a'
+    @queue.process(true) { |m| m.should be == 'a'; true }
+  end
+
+  it 'should prcess a message leaving it into the bp_queue' do
+    @queue << 'a'
+    @queue << 'a'
+    @queue.process(true) { |m| m.should be == 'a'; false }
+    @redis.lrange('bp__test', 0, -1).should be == %w[a a]
+  end
+
+  it 'should refill a main queue' do
+    @queue.clear(true)
+    @queue << 'a'
+    @queue << 'a'
+    @queue.process(true) { |m| m.should be == 'a'; false }
+    @redis.lrange('bp__test', 0, -1).should be == %w[a a]
+    @queue.refill
+    @redis.lrange('__test', 0, -1).should be == %w[a a]
+    @redis.llen('bp__test').should be == 0
+  end
+
+  it 'should work with the timeout parameters' do
+    @queue.clear(true)
+    2.times { @queue << rand(100) }
+    is_ok = true
+    begin
+      Timeout.timeout(3) do
+        @queue.process(false, 2) { |_m| true }
+      end
+    rescue Timeout::Error => _e
+      is_ok = false
+    end
+
+    is_ok.should be_truthy
+  end
+
+  it 'should honor the timeout param in the initializer' do
+    redis = Redis.new
+    queue = Redis::Deque.new('__test_tm', process_queue_name: 'bp__test_tm', redis: redis, timeout: 2)
+    queue.clear true
+
+    is_ok = true
+    begin
+      Timeout.timeout(4) do
+        queue.pop
+      end
+    rescue Timeout::Error => _e
+      is_ok = false
+    end
+    queue.clear
+    is_ok.should be_truthy
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.color = true
+end
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'redis-deque'

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: redis-deque
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jaakko Rinta-Filppula
+- Francesco Laurita
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+description: "\n    Adds Redis::Deque class which can be used as Distributed-Deque
+  based on Redis.\n    Redis is often used as a messaging server to implement processing
+  of background jobs or other kinds of messaging tasks.\n    It implements Reliable-queue
+  pattern decribed here: http://redis.io/commands/rpoplpush\n  "
+email:
+- jaakko@r-f.fi
+- francesco.laurita@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/blocking.rb
+- example/non-blocking.rb
+- lib/redis-deque.rb
+- lib/redis/deque.rb
+- redis-deque.gemspec
+- spec/redis_deque_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tophattom/redis-deque
+licenses:
+- MIT
+metadata: {}
+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: A distributed deque based on Redis
+test_files:
+- spec/redis_deque_spec.rb
+- spec/spec_helper.rb