redisque 1.0.2

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 1.0.2 (2012-11-02)
+* Migrated to rspec
+
+## 1.0.1 (2012-05-23)
+* Fixed "uninitialized constant Redisque::JSON" error
+
+## 1.0.0 (2012-05-17)
+* Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+gemspec
+gem 'rspec'
+gem 'rspec-mocks'

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    redisque (1.0.2)
+      json (>= 1.7.5)
+      redis (>= 3.0.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    json (1.7.5)
+    redis (3.0.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  redisque!
+  rspec
+  rspec-mocks

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2012 Yuri Belogub
+
+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,122 @@
+[![Dependency Status](https://gemnasium.com/belogub/redisque.png)](https://gemnasium.com/belogub/redisque)
+About
+----
+Redisque is yet another lightweight and simple to use queue manager with [Redis DB](http://www.redis.io) backend. 
+Installation
+-----
+Run ``` $ sudo gem install redisque ```
+How to use
+-----
+Redisque has only three methods that you will employ:
+
+
+``` ruby 
+Redisque.connect(options)
+``` 
+with the help of this method you can customize your connection to Redis DB. `options` is a `Hash` and can have the keys: `:address, :port, :password` and `:db`.
+``` ruby 
+Redisque.enqueue(queue, data) 
+```
+makes possible to add task represented by `data` (Hash) to `queue` (String).
+``` ruby 
+Redisque.workoff(queue, pause = 5, &block) 
+``` 
+manages the queue: asks the `queue` for the next entry (job that is represented with JSONized Hash) and if it gets one then the `block` is executed with data received otherwise sleep for `pause` time set in seconds, this way we give a chance to another processes to do their job :)
+
+
+***Usage scenario might look like:***
+
+in your application:
+
+``` ruby 
+require "redisque"
+[
+  {:id => 1, :city => 'New York'},
+  {:id => 2, :city => 'Pekin'},
+  {:id => 3, :city => 'Mumbai'},
+  {:id => 4, :city => 'Paris'},
+  {:id => 5, :city => 'Madrid'}
+].each {|chunk| Redisque.enqueue('my_queue', chunk)}
+```
+in your [Worker] *.rb file:
+
+``` ruby 
+require "redisque"
+Redisque.connect(:password => 'secret')
+Redisque.workoff('my_queue') do |data|
+   puts "Next city is: %s" % data["city"]
+end
+```
+
+***Halting Redisque:***
+
+Redisque has a key `halting` and you can use it to halt the execution, i.e. in your [Worker] *.rb file:
+``` ruby
+trap('INT')  do
+  print "1. (Q)uit now\n2. (W)ait for current task to finish\n3. (C)ontinue\n"  
+  case gets.chomp
+  when 'Q'
+    exit
+  when 'W'
+    Redisque.halting = true
+    print 'Redisque instance resumes until current Job is finished'
+  else    
+  end
+end
+trap('TERM') {exit}
+
+require "json"
+require "redisque"
+
+...
+
+```
+
+
+Caution
+-----
+Redisque creates backup queue when it's run with the following name convention:
+
+original `queue` name that is preceded with `asterisk symbol`
+
+e.g. if your queue name was `my_queue` then the backup queue name would be `*my_queue` so you should keep it in mind when working with other queues that some names are already automatically reserved for backup queues
+
+In case Worker was interrupted, backup queue data (if any) will be shifted into active queue on next Worker start, thus if task was running but didn't succeed, it's entry will be restored from backup queue. For your Worker to function properly it has to be able to redo all steps regardless the execution moment it was stopped at.
+
+Contribute to project 
+-----
+Please do. 
+
+If you feel that it lacks some functionality or enhancement or anything else, please feel free to:
+- clone the project 
+- create a branch do your changes or improvements in it and
+- make a pull request 
+
+to review code and merge the branch.
+
+Thank you
+
+License
+-----
+MIT License
+
+Copyright (c) 2012 Yuri Belogub
+
+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/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/redisque.rb

@@ -0,0 +1,73 @@
+require 'redis'
+require 'json'
+
+module Redisque
+  extend self
+
+  attr_accessor :halting
+
+  @options = {:address => '127.0.0.1', :port => 6379, :password => '', :db => 0}
+
+  # Connect to Redis DB
+  # Example:
+  #   Redisque.connect(:password => 'secret', :db => 1)
+  # Arguments:
+  #   options: (Hash)
+  def connect(options)
+    @options.merge! options    
+    @redis = Redis.new(@options)
+  end
+
+  # Add task to queue 
+  # Example:
+  #   Redisque.enqueue('tasks', {:id => 1, :email => 'my@email.com'})
+  # Arguments:
+  #   queue: (String)
+  #   data: (Hash)
+  def enqueue(queue, data)
+    redis.lpush(queue, JSON(data))
+  end
+
+  # Run along the queue and execute tasks
+  def workoff(queue, pause = 5, &block)
+    @backup_queue = '*' << queue
+    crash_check(queue)
+    loop do        
+      process(queue, &block)
+      break if @halting
+      # anyway, we need to get some sleep
+      sleep pause 
+    end     
+  end
+
+  # Return Redis connection
+  # Arguments:
+  #   options: (Hash)
+  def redis(options = @options)
+    @redis || connect(options) 
+  end
+
+  # Process the queue
+  # Arguments:
+  #   queue: (String)
+  def process(queue)
+    # wait for new value in `queue` for `timeout` time 
+    # pop it and copy to bak queue named `*{queue}`
+    value = redis.rpoplpush(queue, @backup_queue)
+    # if we do have some valid value then launch the worker
+    if value
+      yield(JSON.parse(value))
+      # Remove task from backup queue
+      redis.rpop @backup_queue
+    end
+  end
+
+  # Check if backup queue has any task
+  # Arguments:
+  #   queue: (String)
+  def crash_check(queue)    
+    redis.lrange(@backup_queue,  0, -1).each { |unfinished| redis.lpush(queue, unfinished) }
+    redis.del(@backup_queue)
+  end
+
+end

data/spec/redisque_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Redisque do
+
+  let(:queue_data) {[
+      {:weather => 'is good'}.to_json,
+      {:sky => 'is blue'}.to_json
+  ]}
+
+  let(:redis) {
+    mock('redis', { :rpoplpush => queue_data[0], :rpop => queue_data[0] })
+  }
+
+  before(:each) do
+    Redisque.stub(:redis).and_return redis
+  end
+
+  it ".process" do
+    Redisque.process('queue') do |data|
+      expect(data.has_key?('weather')).to be_true
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'json'
+
+require_relative '../lib/redisque'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: redisque
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Yuri Belogub
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.5
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Redis Database lightweight and simple to use queue manager
+email: belogub@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE
+files:
+- lib/redisque.rb
+- spec/redisque_spec.rb
+- spec/spec_helper.rb
+- .rspec
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- README.md
+- CHANGELOG.md
+- LICENSE
+homepage: https://github.com/belogub/redisque
+licenses:
+- MIT
+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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Redis queue manager
+test_files: []