resque-queue-lock 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) Chris Wanstrath, Ray Krueger
+
+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,39 @@
+Resque Queue Lock
+=================
+
+A [Resque][rq] plugin. Requires Resque 1.7.0.
+
+If you want only one instance of your job queued at a time, extend it with this module.
+
+For example:
+
+    require 'resque/plugins/queue/lock'
+
+    class ExampleJob
+      extend Resque::Plugins::Queue::Lock
+
+      def self.perform(*args)
+        heavy_lifting
+      end
+    end
+
+While this job is queued, no other ExampleJob jobs with the same arguments will be placed on the queue.
+
+If you want to define the lock id yourself you can override the `queue_lock` class method in your job class. It takes the same arguments as `perform`. e.g.
+
+    class ExampleJob
+      extend Resque::Plugins::Queue::Lock
+
+      def self.queue_lock(*args)
+        "network-graph"
+      end
+
+      def self.perform(*args)
+        heavy_lifting
+      end
+    end
+
+This differs from the [Resque Lock plugin][resque-lock] in that this plugin will allow jobs with the same lock key to be running and in the queue at the same time. It only prevents multiple jobs with the same lock from being in the queue.
+
+[rq]: http://github.com/defunkt/resque
+[resque-lock]: https://github.com/defunkt/resque-lock

data/Rakefile

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

data/lib/resque/plugins/queue/lock.rb

@@ -0,0 +1,65 @@
+module Resque
+  module Plugins
+    module Queue
+      module Lock
+        # Override in your job to control the lock key. It is
+        # passed the same arguments as `perform`, that is, your job's
+        # payload.
+        def queue_lock(*args)
+          "#{name}-#{args.to_s}"
+        end
+
+        def before_enqueue__queue_lock(*args)
+          _acquire_lock(*args)
+        end
+
+        def before_dequeue__queue_lock(*args)
+          _release_lock(*args)
+        end
+
+        def before_perform__queue_lock(*args)
+          _release_lock(*args)
+        end
+
+
+        def _release_lock(*args)
+          _reliably do
+            Resque.redis.del( _namespaced_queue_lock(*args) )
+          end
+        end
+
+        def _acquire_lock(*args)
+          _reliably do
+            Resque.redis.setnx( _namespaced_queue_lock(*args), Time.now )
+          end
+        end
+
+        def _namespaced_queue_lock(*args)
+          lock_name = queue_lock( *Resque::Job.decode(Resque::Job.encode(args)) )
+          "queuelock:#{lock_name}"
+        end
+
+        def _reliably
+          tries = 0
+          begin
+            tries += 1
+            yield
+          rescue Redis::CannotConnectError
+            if tries < 30
+              sleep tries
+              retry
+            end
+          end
+        end
+
+        def self.all_queue_locks
+          Resque.redis.keys('queuelock:*')
+        end
+
+        def self.clear_all_queue_locks
+          all_queue_locks.each{ |queue_lock| Resque.redis.del(queue_lock) }
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: resque-queue-lock
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mike Nicholaides
+- Jason Garber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  name: rake
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  name: rspec
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+    none: false
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: ! "A Resque plugin. If you want only one instance of your job\nqueued
+  at a time, extend it with this module.\n\nFor example:\n\n    class ExampleJob\n
+  \     extend Resque::Jobs::Queue::Lock\n\n      def self.perform(repo_id)\n        heavy_lifting\n
+  \     end\n    end\n"
+email: admin@mashion.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- LICENSE
+- lib/resque/plugins/queue/lock.rb
+homepage: http://github.com/mashion/resque-queue-lock
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Resque plugin for ensuring only one instance of your job is queued at a
+  time.
+test_files: []