resque-priority-jobs 0.2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    resque-priority-jobs (0.1)
+      resque
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    facets (2.9.3)
+    json (1.6.3)
+    rack (1.3.5)
+    redis (2.2.2)
+    redis-namespace (0.7.0)
+      redis (< 3.0.0)
+    resque (1.9.8)
+      json (>= 1.1.0)
+      redis-namespace (~> 0.7.0)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    sinatra (1.2.6)
+      rack (~> 1.1)
+      tilt (>= 1.2.2, < 2.0)
+    tilt (1.3.3)
+    vegas (0.1.8)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  facets
+  resque-priority-jobs!
+  rspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 rajofchennai
+
+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,29 @@
+# Resque::Priority::Jobs
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'resque-priority-jobs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque-priority-jobs
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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-priority-jobs/job.rb

@@ -0,0 +1,10 @@
+module Resque
+  class Job
+    # checks if klass and queue are valid
+    #FIXME: Not implemented Resque.inline?
+    def self.create_with_priority queue, klass, priority, *args
+      Resque.validate(klass, queue)
+      Resque.push_with_priority(queue, priority, :class => klass.to_s, :args => args)
+    end
+  end
+end

data/lib/resque-priority-jobs/multi_queue.rb

@@ -0,0 +1,30 @@
+module Resque
+  class MultiQueue
+    # worker polling aliased
+    #TODO: Known Performance issue to ensure that same job is not done twice. Can be fixed after redis-2.6 is released
+    def poll_with_priority timeout
+      normal_queue_names = @queues.map {|queue| queue.redis_name  unless queue.is_a_priority_queue? }
+      normal_queue_names.compact!
+      priority_queue_names = @queues.map {|queue| queue.redis_name if queue.is_a_priority_queue? }
+      priority_queue_names.compact!
+      priority_queue_names.each do |queue_name|
+        synchronize do
+          payload = Resque::JobFetch.fetch_one_job @redis, queue_name
+          if payload
+            queue = @queue_hash[queue_name]
+            return [queue, queue.decode(payload)]
+          end
+        end
+      end
+      normal_queue_names = normal_queue_names.size == 0 ? "" : normal_queue_names
+      queue_name, payload = @redis.blpop(normal_queue_names, :timeout => timeout)
+      return unless payload
+
+      synchronize do
+        queue = @queue_hash[queue_name]
+        [queue, queue.decode(payload)]
+      end
+    end
+    alias :poll :poll_with_priority
+  end
+end

data/lib/resque-priority-jobs/queue.rb

@@ -0,0 +1,40 @@
+module Resque
+  class Queue
+    # adds entry into redis
+    def push_with_priority priority, object
+      synchronize do
+        @redis.zadd @redis_name, priority, encode(object)
+      end
+    end
+
+    # remove entry from queue use default pop in case of non-priority queue see alias_method_chain
+    def pop_with_priority non_block = false
+      return pop_without_priority non_block unless is_a_priority_queue?
+      synchronize do
+        value = Resque::JobFetch.fetch_one_job @redis, @redis_name until non_block || value
+        raise ThreadError if non_block && !value
+        decode value
+      end
+    end
+    alias :pop_without_priority :pop
+    alias :pop :pop_with_priority
+
+    # not optimial has an extra redis call for priority call. Assumtion is that there are lesser queues using priority
+    def length
+      @redis.llen @redis_name rescue @redis.zcard @redis_name
+    end
+
+    # To identify whether a queue is priority queue or not. Empty queues are always non-priority
+    # Assumption : Once a queue type is set to be a priority queue, it cannot be changed and vice-versa.
+    def is_a_priority_queue?
+      @@queue_types ||= {}
+      (@@queue_types[@redis_name] ||= queue_type) == 'zset'
+    end
+
+    def queue_type
+      type = @redis.type(@redis_name)
+      type == 'none' ? nil : type
+    end
+
+  end
+end

data/lib/resque-priority-jobs/version.rb

@@ -0,0 +1,7 @@
+module Resque
+  module Priority
+    module Jobs
+      VERSION = "0.2"
+    end
+  end
+end

data/lib/resque-priority-jobs.rb

@@ -0,0 +1,47 @@
+require 'resque'
+require 'resque-priority-jobs/queue'
+require 'resque-priority-jobs/multi_queue'
+require 'resque-priority-jobs/job'
+
+# Max priority is the highest priority similarly for min priority. These numbers are arbitrary
+MIN_PRIORITY = 20
+MAX_PRIORITY = 1
+
+module Resque
+  # Queues which need priority scheduling need to use this method instead of enqueue
+  #FIXME: Known issue - If a use is already enqueued without priority and then we do a enqueue with priority we get an error of different datatype from redis.
+  def enqueue_with_priority klass, priority = MIN_PRIORITY, *args
+    queue = queue_from_class(klass)
+    before_hooks = Plugin.before_enqueue_hooks(klass).collect do |hook|
+      klass.send(hook, *args)
+    end
+    return nil if before_hooks.any? { |result| result == false }
+
+    Job.create_with_priority(queue, klass, priority, *args)
+
+    Plugin.after_enqueue_hooks(klass).each do |hook|
+      klass.send(hook, *args)
+    end
+
+    return true
+  end
+
+  def push_with_priority queue, priority, item
+    queue(queue).push_with_priority priority, item
+  end
+
+  class JobFetch
+    def self.fetch_one_job redis, queue
+      #lua script to get item with maximum priority
+      get_and_rem = "local resp = redis.call('zrangebyscore', KEYS[1], '-inf', '+inf', 'LIMIT', '0', '1');
+        if (resp[1] ~= nil) then
+          local val = resp[# resp]
+          redis.call('zrem', KEYS[1], val)
+          return val
+        else
+          return false
+        end"
+      redis.eval get_and_rem, [queue]
+    end
+  end
+end

data/resque-priority-jobs.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/resque-priority-jobs/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["rajofchennai"]
+  gem.email         = ["rajofchennai@yahoo.com"]
+  gem.description   = %q{resque plugin to have priority in the queue}
+  gem.summary       = %q{This plugin can be used to have priority inside a queue for resques}
+  gem.homepage      = ""
+
+  gem.add_dependency "resque"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "facets"
+  gem.add_development_dependency "systemtimer"
+  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-priority-jobs"
+  gem.require_paths = ["lib"]
+  gem.version       = Resque::Priority::Jobs::VERSION
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: resque-priority-jobs
+version: !ruby/object:Gem::Version
+  version: '0.2'
+  prerelease: 
+platform: ruby
+authors:
+- rajofchennai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: facets
+  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'
+- !ruby/object:Gem::Dependency
+  name: systemtimer
+  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: resque plugin to have priority in the queue
+email:
+- rajofchennai@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/resque-priority-jobs.rb
+- lib/resque-priority-jobs/job.rb
+- lib/resque-priority-jobs/multi_queue.rb
+- lib/resque-priority-jobs/queue.rb
+- lib/resque-priority-jobs/version.rb
+- resque-priority-jobs.gemspec
+homepage: ''
+licenses: []
+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: This plugin can be used to have priority inside a queue for resques
+test_files: []