redis-queue 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+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,63 @@
+redis-queue
+=============
+Requires the redis gem.
+
+Adds Redis::Queue class which can be used as Distributed-Queue 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-queue
+
+Testing
+----------------
+    $ bundle install
+    $ rake
+
+Simple usage
+----------------
+
+```ruby
+require "redis-queue"
+redis = Redis.new
+queue = Redis::Queue.new('q_test','bp_q_test',  :redis => redis)
+
+#Adding some elements
+queue.push "b" 
+queue << "a" # << is an alias of push
+
+# Process messages
+
+# By default, calling pop methid 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
+
+```
+Contributing to redis-queue
+----------------
+ 
+* 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,9 @@
+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/lib/redis-queue.rb

@@ -0,0 +1,2 @@
+require "redis"
+require "redis/queue"

data/lib/redis/queue.rb

@@ -0,0 +1,71 @@
+class Redis
+  class Queue
+    
+    VERSION = "0.0.1"
+
+    def self.version
+      "redis-queue version #{VERSION}"
+    end
+
+    def initialize(queue_name, process_queue_name, options = {})
+      raise ArgumentError, 'First argument must be a non emmpty string'  if !queue_name.is_a?(String) || queue_name.empty?
+      raise ArgumentError, 'Second argument must be a non emmpty string' if !process_queue_name.is_a?(String) || process_queue_name.empty?
+      raise ArgumentError, 'Queue and Process queue have the same name'  if process_queue_name == queue_name 
+
+      @redis = options[:redis] || Redis.current
+      @queue_name = queue_name
+      @process_queue_name = process_queue_name
+      @last_message = nil
+    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 pop(non_block=false)
+      if non_block
+        @last_message = @redis.rpoplpush(@queue_name,@process_queue_name)
+      else
+        @last_message = @redis.brpoplpush(@queue_name,@process_queue_name)
+      end
+      @last_message
+    end
+
+    def commit
+      @redis.lrem(@process_queue_name, 0, @last_message)
+    end
+
+    def process(non_block=false)
+      while message=pop(non_block)
+        ret = yield message if block_given?
+        commit if ret
+      end
+    end
+
+    def refill
+      while message=@redis.lpop(@process_queue_name)
+        @redis.rpush(@queue_name, message)
+      end
+      true
+    end
+
+    alias :size  :length
+    alias :dec   :pop
+    alias :shift :pop
+    alias :enc   :push
+    alias :<<    :push
+  end
+end

data/redis-queue.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "redis-queue"
+
+Gem::Specification.new do |s|
+  s.name        = "redis-queue"
+  s.version     = Redis::Queue::VERSION
+  s.authors     = ["Francesco Laurita"]
+  s.email       = ["francesco.laurita@gmail.com"]
+  s.homepage    = "https://github.com/taganaka/redis-queue"
+  s.summary     = %q{A distributed queue based on Redis}
+  s.description = %q{
+    Adds Redis::Queue class which can be used as Distributed-Queue 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.rubyforge_project = "redis-queue"
+
+  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_dependency "redis", "~> 3.0.4"
+  s.add_dependency "hiredis", "~> 0.4.5"
+
+  s.add_development_dependency "rspec", "~> 2.13.0"
+end

data/spec/redis_queue_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe Redis::Queue do
+  before(:all) do
+    @redis = Redis.new
+    @queue = Redis::Queue.new('__test', 'bp__test')
+    @queue.clear true 
+  end
+
+  after(:all) do
+    @queue.clear true
+  end
+
+  it 'should return correct version string' do
+    Redis::Queue.version.should == "redis-queue version #{Redis::Queue::VERSION}"
+  end
+
+  it 'should create a new redis-queue object' do
+    queue = Redis::Queue.new('__test', 'bp__test')
+    queue.class.should == Redis::Queue
+  end
+
+  it 'should add an element to the queue' do
+    @queue << "a"
+    @queue.size.should be == 1
+  end
+
+  it 'should return an element from the queue' do
+    message = @queue.pop(true)
+    message.should be == "a"
+  end
+
+  it 'should remove the element from bp_queue if commit is called' do 
+    @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 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 == ['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 == ['a', 'a']
+    @queue.refill
+    @redis.lrange('__test',0, -1).should be == ['a', 'a']
+    @redis.llen('bp__test').should be == 0
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler'
+require 'rspec'
+
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'redis-queue'

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: redis-queue
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Francesco Laurita
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+- !ruby/object:Gem::Dependency
+  name: hiredis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+description: ! "\n    Adds Redis::Queue class which can be used as Distributed-Queue
+  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:
+- francesco.laurita@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis-queue.rb
+- lib/redis/queue.rb
+- redis-queue.gemspec
+- spec/redis_queue_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/taganaka/redis-queue
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: redis-queue
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A distributed queue based on Redis
+test_files:
+- spec/redis_queue_spec.rb
+- spec/spec_helper.rb