resque-single 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 64d6d2ad6223b4a2d43938640d464e63e9b62743
+  data.tar.gz: ba36f7360b4e5584944b11a17a50f17a781d9b2b
+SHA512:
+  metadata.gz: 570b7839c31da2f740249bfa33c3529fa95bc93e8628b4d11b25a9d94aa79ef0d473b4fc296a69aaec308f3fcc2e3b74eedabe948c55ddce8e6e7858b59bea11
+  data.tar.gz: 563345347ce30a36583822caa0d8c6204032d4a5f2a883e85f3dcc0526ef8bbec82c15be7b0382b1c0490d6e7f39c9ea5eea405fc24a2e8a411bbd35f54c80ff

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 bibendi
+
+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,31 @@
+# Resque::Single
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resque-unique'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque-unique
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://bitbucket.org/shiplix/resque-single/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 a new Pull Request

data/Rakefile

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

data/lib/resque/single.rb

@@ -0,0 +1,157 @@
+require 'resque/single/version'
+require 'resque'
+require 'digest/sha1'
+require 'active_support/core_ext/module/aliasing'
+require 'resque/plugins/lock'
+silence_warnings { require 'resque/plugins/progress' } # suppress Resque::Helpers warn
+
+# Unique job
+#
+# Examples
+#   class MyJob
+#     extend Resque::Single
+#
+#     # jobs are considered as equal if their first argument is the same
+#     lock_on { |*args| args.first }
+#
+#     def self.execute(image_id)
+#       # do it
+#     end
+#   end
+#
+#   MyJob.enqueue(11)
+module Resque
+  module Single
+    def self.extended(base)
+      base.extend(Resque::Plugins::Progress)
+      base.extend(Resque::Plugins::Lock)
+      base.extend(ClassMethods)
+      base.singleton_class.class_eval do
+        alias_method_chain :enqueue, :check
+      end
+    end
+
+    module ClassMethods
+      def scheduled(queue, klass, *args)
+        klass.constantize.enqueue(*args)
+      end
+
+      def retry_args(*args)
+        args.shift
+        args
+      end
+
+      # Get or set proc returning unique arguments
+      def lock_on(&block)
+        if block_given?
+          @unique = block
+        else
+          @unique ||= proc { |*args| args }
+        end
+      end
+
+      # LockID should be independent from MetaID
+      def lock(meta_id, *args)
+        "lock:#{name}-#{Digest::SHA1.hexdigest(obj_to_string(lock_on[*args]))}"
+      end
+
+      # Overriding +meta_id+ here so now it generates the same MetaID for Jobs with same args
+      def meta_id(*args)
+        Digest::SHA1.hexdigest(['resque-unique', self, lock_on[*args]].join)
+      end
+
+      # get meta object associated with job
+      def meta
+        get_meta(@meta_id)
+      end
+
+      # default `perform` method override
+      def perform(meta_id, *args)
+        execute(*args)
+      end
+
+      def execute(*)
+        raise NotImplementedError, "You should implement `execute' method"
+      end
+
+      # When job is failed we should remove lock
+      def on_failure_lock(e, *args)
+        unlock(*args)
+      end
+
+      # Before dequeue check if job is running
+      def before_dequeue_lock(*args)
+        (meta_id = args.first) &&
+        (meta = get_meta(meta_id)) &&
+        !meta.working?
+      end
+
+      # When job is dequeued we should remove lock
+      def after_dequeue_lock(*args)
+        unlock(*args) if args.any?
+      end
+
+      # Fail metadata if dequeue succeed
+      def after_dequeue_meta(*args)
+        if (meta_id = args.first) && (meta = get_meta(meta_id))
+          meta.fail!
+        end
+      end
+
+      # Is job already in queue or in process?
+      def enqueued?(*args)
+        # if lock exists and timeout not exceeded
+        if locked?(*args)
+          get_meta(meta_id(*args))
+        else
+          nil
+        end
+      end
+
+      # Returns true if resque job is in locked state
+      def locked?(*args)
+        key = lock(nil, *args)
+        now = Time.now.to_i
+
+        Resque.redis.exists(key) && now <= Resque.redis.get(key).to_i
+      end
+
+      # Dequeue unique job
+      def dequeue(*args)
+        Resque.dequeue(self, meta_id(*args), *args)
+      end
+
+      # Overriding +enqueue+ method here so now it returns existing metadata if job already queued
+      def enqueue_with_check(*args) #:nodoc:
+        meta = enqueued?(*args) and return meta
+
+        # enqueue job and retrieve its meta
+        enqueue_without_check(*args)
+      end
+
+      private
+      # Remove lock for job with given +args+
+      def unlock(*args)
+        Resque.redis.del(lock(*args))
+      end
+
+      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/single/version.rb

@@ -0,0 +1,5 @@
+module Resque
+  module Single
+    VERSION = "0.0.2"
+  end
+end

data/resque-single.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resque/single/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "resque-single"
+  spec.version       = Resque::Single::VERSION
+  spec.authors       = ["bibendi"]
+  spec.email         = ["bibendi@bk.ru"]
+  spec.summary       = 'Integration of resque with resque-progress and resque-lock'
+  spec.homepage      = "https://bitbucket.org/shiplix/resque-single"
+  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_runtime_dependency 'activesupport', '>= 3.0'
+  spec.add_runtime_dependency 'resque', '~> 1.25'
+  spec.add_runtime_dependency 'resque-lock', '~> 1.1.0'
+  spec.add_runtime_dependency 'resque-meta', '>= 2.0.0'
+  spec.add_runtime_dependency 'resque-progress', '~> 1.0.1'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: resque-single
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- bibendi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  name: activesupport
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :runtime
+  name: resque
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  name: resque-lock
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  name: resque-meta
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  name: resque-progress
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  name: bundler
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  name: rake
+description: 
+email:
+- bibendi@bk.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/resque/single.rb
+- lib/resque/single/version.rb
+- resque-single.gemspec
+homepage: https://bitbucket.org/shiplix/resque-single
+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.4.2
+signing_key: 
+specification_version: 4
+summary: Integration of resque with resque-progress and resque-lock
+test_files: []