resque-uniq 0.0.3

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,7 @@
+source :rubygems
+
+gem "resque"
+
+group :development do
+  gem "rake"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Trung Duc Tran
+
+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,69 @@
+# resque-uniq
+
+A Resque plugin to ensure only one job instance is queued or running at a time
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'resque-uniq'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque-uniq
+
+## Usage
+
+Make your job class extend `Resque::Plugins::UniqueJob`, like this
+
+    class BigJob
+      extend Resque::Plugins::UniqueJob  # <--- add this line
+      @queue = :big_job
+
+      def self.perform
+        # ...
+      end
+    end
+
+## How it works
+
+_resque-uniq_ associates a unique lock with each job instance being enqueued. A lock is a simple Redis _key/value_ pair.
+The key name is derived uniquely from the job class name and job args. The value is `Time.now.to_i`. If the lock already
+exists a new job instance is not enqueued. If not a new lock is created and a job is enqueued. The lock is removed after
+its job's `perform` method has finished.
+
+There is another lock, called _run lock_, which is being held during the execution of `perform` method. Before enqueuing
+a new job instance, _resque-uniq_ checks if there is any orphaned _run lock_. This way it can detect if Resque workers
+have crashed during job execution and left behind stale locks.
+
+You can tell _resque-uniq_ to auto-expire job locks by setting `@unique_lock_autoexpire`
+
+    class BigJob
+      extend Resque::Plugins::UniqueJob
+      @queue = :big_job
+      @unique_lock_autoexpire = 6 * 3600   # TTL = 6 hours
+
+      def self.perform
+        # ...
+      end
+    end
+
+This is usually not necessary, but you can if you want.
+
+## Credits
+
+There are several similar Resque plugins. We tried them all but for one reason or another they don't work reliably
+for us. We wrote our own version which we think works better for us. Nonetheless we would like to thank the authors
+of those plugins for inspiration.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/resque/plugins/unique_job.rb

@@ -0,0 +1,85 @@
+module Resque
+  module Plugins
+    module UniqueJob
+      LOCK_NAME_PREFIX = 'lock'
+      RUN_LOCK_NAME_PREFIX = 'running_'
+
+      def lock(*args)
+        "#{LOCK_NAME_PREFIX}:#{name}-#{obj_to_string(args)}"
+      end
+
+      def run_lock(*args)
+        run_lock_from_lock(lock(*args))
+      end
+
+      def run_lock_from_lock(lock)
+        "#{RUN_LOCK_NAME_PREFIX}#{lock}"
+      end
+
+      def lock_from_run_lock(rlock)
+        rlock.sub(/^#{RUN_LOCK_NAME_PREFIX}/, '')
+      end
+
+      def stale_lock?(lock)
+        return false unless Resque.redis.get(lock)
+
+        rlock = run_lock_from_lock(lock)
+        return false unless Resque.redis.get(rlock)
+
+        Resque.working.map {|w| w.job }.map do |item|
+          payload = item['payload']
+          klass = Resque::Job.constantize(payload['class'])
+          args = payload['args']
+          return false if rlock == klass.run_lock(*args)
+        end
+        true
+      end
+
+      def before_enqueue_lock(*args)
+        lock_name = lock(*args)
+        if stale_lock? lock_name
+          Resque.redis.del lock_name
+          Resque.redis.del "#{RUN_LOCK_NAME_PREFIX}#{lock_name}"
+        end
+        nx = Resque.redis.setnx(lock_name, Time.now.to_i)
+        if defined?(@unique_lock_autoexpire) && @unique_lock_autoexpire > 0
+          Resque.redis.expire(lock_name, @unique_lock_autoexpire)
+        end
+        nx
+      end
+
+      def around_perform_lock(*args)
+        rlock = run_lock(*args)
+        Resque.redis.set(rlock, Time.now.to_i)
+
+        begin
+          yield
+        ensure
+          Resque.redis.del(rlock)
+          Resque.redis.del(lock(*args))
+        end
+      end
+
+
+      private
+
+      def obj_to_string(obj)
+        case obj
+        when Hash
+          s = []
+          obj.keys.sort.each do |k|
+            s << obj_to_string(k)
+            s << obj_to_string(obj[k])
+          end
+          s.to_s
+        when Array
+          s = []
+          obj.each { |a| s << obj_to_string(a) }
+          s.to_s
+        else
+          obj.to_s
+        end
+      end
+    end
+  end
+end

data/lib/resque-uniq/version.rb

@@ -0,0 +1,3 @@
+module ResqueUniq
+  VERSION = "0.0.3"
+end

data/lib/resque-uniq.rb

@@ -0,0 +1 @@
+require 'resque/plugins/unique_job'

data/resque-uniq.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'resque-uniq/version'
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Trung Duc Tran"]
+  gem.email         = ["trung@tdtran.org"]
+  gem.summary       = "A Resque plugin to ensure only one job instance is queued or running at a time."
+  gem.homepage      = "http://github.com/tdtran/resque-uniq"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "resque-uniq"
+  gem.require_paths = ["lib"]
+  gem.version       = ResqueUniq::VERSION
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: resque-uniq
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Trung Duc Tran
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-22 00:00:00 Z
+dependencies: []
+
+description: 
+email: 
+- trung@tdtran.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/resque-uniq.rb
+- lib/resque-uniq/version.rb
+- lib/resque/plugins/unique_job.rb
+- resque-uniq.gemspec
+homepage: http://github.com/tdtran/resque-uniq
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Resque plugin to ensure only one job instance is queued or running at a time.
+test_files: []
+