redis-unique-queue 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08e6d28a812e7ea4f3bbd69649e692f0ded84def
+  data.tar.gz: 2569d5650a87dac3266157b1f2311ec3d166ffa3
+SHA512:
+  metadata.gz: 36fa4528e09fc89e6d93e246f8fc16cc74e5f40d7d9243da87657446da6e32066b78f9f1f01f37875bdd5eed84bfa777c04009625184ed9e8e1f3ea71f88ca85
+  data.tar.gz: 387f34f683a67af91e6d3d111957f703f5a39e7fabd297b458ce6ddc82cb78b62de32df46f92db8516109ae74cfe500c14cbe4556b8f016fe515257932056ec6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redis-unique-queue.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Misha Conway
+
+MIT License
+
+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,102 @@
+# Redis::Unique::Queue
+
+A unique FIFO queue with atomic operations built on top of Redis. Useful if you want to enqueue data without worrying about it existing multiple times in the queue.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis-unique-queue'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis-unique-queue
+
+## Getting started
+
+You can instantiate a named queue using your default Redis configuration.
+
+```ruby
+q = Redis::Unique::Queue.new 'jobs'
+```
+
+Or you can pass in your own instance of the Redis class.
+
+```ruby
+q = Redis::Unique::Queue.new 'jobs', Redis.new(:host => "10.0.1.1", :port => 6380, :db => 15)
+```
+
+A third option is to instead pass your Redis configurations.
+
+```ruby
+q = Redis::Unique::Queue.new 'jobs', :host => "10.0.1.1", :port => 6380, :db => 15
+```
+
+## Using the queue
+
+You can push data to the queue.
+
+```ruby
+q.push "hello"
+q.push "world"
+q.push "hello" # the item 'hello' will only exist once in the queue since it is unique
+```
+
+You can pop data from the queue.
+
+```ruby
+result = q.pop
+```
+
+You can get the size of the queue.
+
+```ruby
+q.size
+```
+
+You can read the first item in the queue.
+
+```ruby
+q.front
+```
+
+You can see if an item exists in the queue.
+
+```ruby
+q.include? "hello"
+```
+
+You can remove an arbitrary item from the queue. Note that it doesn't have to be the first item.
+
+```ruby
+q.remove "world"
+```
+
+You can get all items in the queue.
+
+```ruby
+q.all
+```
+
+You can also peek into arbitrary ranges in the queue.
+
+```ruby
+q.peek 1 #read the item at index 1
+q.peek 23 #read the item at index 23
+q.peek 10, 5 #peek at five items starting at index 10
+```
+
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/redis-unique-queue/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/redis/unique/queue.rb

@@ -0,0 +1,76 @@
+require "redis"
+
+class Redis
+  module Unique
+    class Queue
+      attr_reader :name
+
+      VERSION = "0.0.3"
+
+      def initialize(name, redis_or_options = {})
+        @name  = name
+        @redis = if redis_or_options.kind_of? Redis
+                   redis_or_options
+                 elsif redis_or_options.kind_of? Hash
+                   Redis.new redis_or_options
+                 end
+      end
+
+      #Add an item to the queue. delay is in seconds.
+      def push data, delay=0
+        score = Time.now.to_f + delay
+        @redis.zadd(name, score, data)
+      end
+
+      def pop
+        begin
+          success, result = attempt_atomic_pop
+        end while !success && result
+        result
+      end
+
+      def front
+        @redis.zrange(name, 0, 0).first
+      end
+
+      def remove data
+        @redis.zrem name, data
+      end
+
+      def size
+        @redis.zcard name
+      end
+
+      def all
+        peek 0, size
+      end
+
+      def peek index, amount=1
+        @redis.zrange name, index, index + amount - 1
+      end
+
+      def include? data
+        !@redis.zscore(name, data).nil?
+      end
+
+      private
+
+      def attempt_atomic_pop
+        min_score = 0
+        max_score = Time.now.to_f
+
+        result  = nil
+        success = @redis.watch(name) do
+          result = @redis.zrangebyscore(name, min_score, max_score, :with_scores => false, :limit => [0, 1]).first
+          if result
+            @redis.multi do |multi|
+              multi.zrem name, result
+            end
+          end
+        end
+
+        [success, result]
+      end
+    end
+  end
+end

data/redis-unique-queue.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis/unique/queue'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis-unique-queue"
+  spec.version       = Redis::Unique::Queue::VERSION
+  spec.authors       = ["Misha Conway"]
+  spec.email         = ["mishaAconway@gmail.com"]
+  spec.summary       = %q{A unique queue with atomic operations implemented in Redis}
+  spec.description   = %q{A unique queue with atomic operations implemented in Redis.}
+  spec.homepage      = "https://github.com/MishaConway/ruby-redis-unique-queue"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency 'redis'
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: redis-unique-queue
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Misha Conway
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A unique queue with atomic operations implemented in Redis.
+email:
+- mishaAconway@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis/unique/queue.rb
+- redis-unique-queue.gemspec
+homepage: https://github.com/MishaConway/ruby-redis-unique-queue
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A unique queue with atomic operations implemented in Redis
+test_files: []