kbaum-resque-priority 0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Brett Buddin
+
+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 Priority
+================
+
+Provides Resque with three levels of (named) priority for a single queue.
+
+For example:
+    
+    require 'resque/plugins/priority'
+    
+    class Job
+      extend Resque::Plugins::Priority
+
+      @queue = :primary
+
+      def self.perform(record)
+        puts @queue #=> :primary_low
+        puts @priority #=> :low
+        other_stuff_and_junk
+      end
+    end
+    
+    # Enqueuing the job
+    Resque.enqueue_with_priority(:low, Job, params)
+
+The above code creates a new Job in the `:primary_low` queue. There are three variations on the queues:
+
+* `:high`
+* `:normal`
+* `:low`
+
+These three priorities produce queue names like, assuming `@queue` is set to "queuename", like:
+
+* `:queuename_high`
+* `:queuename`
+* `:queuename_low`
+
+A Resque worker would then use a `QUEUE` variable like: `QUEUE=queuename_high,queuename,queuename_low`
+
+Your Job `self.perform` methods have have two instance variables available to them: `@queue` and `@priority`. `@queue` is nothing new, it's provided by Resque by default, but Priority has appended the current priority to the existing value; resulting in the actual queue the job originated from (e.g. ":queuename_high"). `@priority` provides you with the priority (e.g. ":high") of the current job execution.

data/Rakefile

@@ -0,0 +1,24 @@
+begin
+  require "jeweler"
+
+  Jeweler::Tasks.new do |gem|
+    gem.name = "resque-priority"
+    gem.version = "0.1"
+    gem.summary = "Resque plugin that provides priority levels"
+    gem.description = <<-desc
+      Provides Resque with three levels of (named) priority for a single queue.
+    desc
+    gem.email = "brett@intraspirit.net"
+    gem.homepage = "http://github.com/brettbuddin/resque-priority"
+    gem.date = Time.now.strftime('%Y-%m-%d')
+    gem.authors = ["Brett Buddin"]
+    gem.files = %w( README.md Rakefile LICENSE )
+    gem.files += Dir["*", "{lib}/**/*"]
+
+    gem.has_rdoc = false
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end

data/lib/resque/plugins/priority.rb

@@ -0,0 +1,46 @@
+module Resque
+  def self.enqueue_with_priority(priority, klass, *args)
+    queue = klass.instance_variable_get(:@queue) || (klass.respond_to?(:queue) and klass.queue)
+    priority ||= :normal
+    if [:high, :low].include?(priority.to_sym)
+      queue = "#{queue}_#{priority}".to_sym
+    end
+    klass.priority = priority
+    Resque::Job.create(queue, klass, *args)
+  end
+
+  module Plugins
+    module Priority
+      def priority=(p)
+        @queue_without_priority ||= @queue
+        if [:high, :low].include?(p.to_sym)
+          @queue = "#{@queue}_#{p}".to_sym
+        end
+        @priority = p.to_sym
+      end
+
+      def priority_key(*args)
+        "priority:#{name}-#{args.to_s}"
+      end
+      
+      def after_enqueue_set_priority(*args)
+        Resque.redis.setnx(priority_key(*args), @priority)
+      end
+
+      def around_perform_retrieve_priority(*args)
+        key = priority_key(*args)
+        priority = Resque.redis.get(key)
+        self.priority = priority && priority.empty? ? :normal : priority
+
+        begin
+          yield
+        ensure
+          Resque.redis.del(key)
+          @queue = @queue_without_priority
+          @priority = nil
+        end
+      end
+    end
+  end
+end
+

data/resque-priority.gemspec

@@ -0,0 +1,43 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{kbaum-resque-priority}
+  s.version = "0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brett Buddin"]
+  s.date = %q{2010-10-01}
+  s.description = %q{      Provides Resque with three levels of (named) priority for a single queue.
+}
+  s.email = %q{brett@intraspirit.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.md",
+     "Rakefile",
+     "lib/resque/plugins/priority.rb",
+     "resque-priority.gemspec"
+  ]
+  s.homepage = %q{http://github.com/brettbuddin/resque-priority}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Resque plugin that provides priority levels}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: kbaum-resque-priority
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Brett Buddin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-01 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: "      Provides Resque with three levels of (named) priority for a single queue.\n"
+email: brett@intraspirit.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- lib/resque/plugins/priority.rb
+- resque-priority.gemspec
+has_rdoc: true
+homepage: http://github.com/brettbuddin/resque-priority
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.7
+signing_key: 
+specification_version: 3
+summary: Resque plugin that provides priority levels
+test_files: []
+