resque-picky_worker 0.0.1

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+# Specify your gem's dependencies in pp-crawler.gemspec
+gemspec
+
+gem "SystemTimer"
+
+group :test do
+  gem "rspec"
+end

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    resque-picky_worker (0.0.1)
+      resque
+      resqueue-metadata
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    SystemTimer (1.2.3)
+    diff-lcs (1.1.2)
+    json (1.5.1)
+    rack (1.3.0)
+    redis (2.2.2)
+    redis-namespace (1.0.3)
+      redis (< 3.0.0)
+    redis-objects (0.5.1)
+      redis (>= 2.1.1)
+    resque (1.17.1)
+      json (< 1.6, >= 1.4.6)
+      redis-namespace (~> 1.0.2)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    resqueue-metadata (0.0.1)
+      redis-objects
+      resque
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sinatra (1.2.6)
+      rack (~> 1.1)
+      tilt (< 2.0, >= 1.2.2)
+    tilt (1.3.2)
+    vegas (0.1.8)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  SystemTimer
+  resque-picky_worker!
+  rspec

data/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+begin
+  require "spec"
+rescue LoadError => e
+  require "rubygems"
+  require "spec"
+end
+
+begin
+  require 'spec/rake/spectask'
+
+  desc "Run all specs"
+  Spec::Rake::SpecTask.new('spec') do |t|
+    t.spec_files = FileList['spec/**/*.rb']
+  end
+rescue LoadError => e
+  puts "Warning: RSpec not found. spec task won't work until you `gem install rspec`"
+end

data/example.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+require "rubygems"
+require "bundler/setup"
+$:.unshift File.expand_path("lib", File.dirname(__FILE__))
+
+require "resque/picky_worker/override"
+
+# Try not to trample on other things in redis
+Resque.redis.namespace = "example:pickyworker"
+
+# Make sure we've got some queues to choose from
+Resque.redis.del "queues"
+%w(1 2 3 4).each do |x|
+  Resque.redis.sadd "queues", x
+end
+
+# Define how to choose a queue, we'll go for the max integer one
+Resque::Worker.chooser = lambda do |queues|
+  queues.map(&:to_i).select {|i| i % 2 == 0 }.max.to_s
+end
+
+Resque::Worker.pick_queue # => "4"

data/lib/resque/picky_worker/override.rb

@@ -0,0 +1,8 @@
+unless defined?(Resque::PickyWorker)
+  require "resque/picky_worker"
+end
+
+# Swap this stuff out without generating a warning
+original_verbosity, $VERBOSE = $VERBOSE, nil
+Resque::Worker = Resque::PickyWorker
+$VERBOSE, original_verbosity = original_verbosity, nil

data/lib/resque/picky_worker.rb

@@ -0,0 +1,41 @@
+require "resque"
+require "resqueue-metadata"
+
+module Resque
+  class PickyWorker < Worker
+    Error = Class.new(StandardError)
+
+    class << self
+      attr_accessor :default_max_workers
+      # Something that responds to #call (eg. Proc) and takes a single argument - array of queue names
+      # Should return a string which is a valid queue name
+      attr_accessor :chooser
+    end
+    self.default_max_workers ||= 5
+
+    def self.chooser
+      @chooser || raise(Error, "chooser must be specified or I cannot choose a queue to listen to")
+    end
+
+    # Returns a string (name of a queue)
+    def self.pick_queue
+      cue = chooser.call(Resque.queues)
+      raise(Error, "chooser returned an invalid queue name") unless Resque.queues.include?(cue)
+      cue
+    end
+
+    def self.queue_max name
+      (Resque::Queue::Metadata.new(name)["max_workers"] || default_max_workers).to_i
+    end
+    
+    def self.queue_current name
+      all.select {|worker| worker.queues.include?(name) }.size
+    end
+
+    # Invoke the worker class with a randomly picked queue
+    def initialize
+      super(PickyWorker.pick_queue)
+    end
+
+  end
+end

data/readme.md

@@ -0,0 +1,34 @@
+# Resque::PickyWorker
+
+Picky worker is a very opinionated worker that will just not be told what work to do. It prefers to pick and choose from the available queues, slotting in where it's needed to help others. Also kills itself quietly if left with no work to do.
+
+## Installation
+
+Install with rubygems (might need to run this as root, depending on your setup)
+
+    gem install resque-picky_worker
+
+Or in your Gemfile
+
+    gem "resque-picky_worker"
+
+## Usage
+
+You'll need to require the picky worker, usually with `require "resque/picky_worker/override"` to make it the default Worker class in resque. (Means it *Just Works*™.)
+
+Then you need to define how you want a queue to be chosen. Lets say we have a bunch of queues named after numbers and we want to choose the highest number available at the time the worker starts:
+
+    Resque::PickyWorker.chooser = lambda { | queues | queues.map(&:to_i).max.to_s }
+
+Then just fire up your resque workers as normal and they'll choose the highest queue available to listen to!
+
+## MIT Licence
+
+Copyright (c) 2011 PizzaPowered LLP <caius@pizzapowered.com>
+
+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.
+
+See http://pizzapowered.com/ for contact details.

data/resque-picky_worker.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "resque-picky_worker"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Caius Durling"]
+  s.email       = ["caius@pizzapowered.com"]
+  s.homepage    = "http://pizzapowered.com/"
+  s.summary     = %q{Resque worker, but picky about what queues it listens to}
+  s.description = %q{Resque worker that evaluates queues and chooses which one to pull jobs from}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.bindir        = "bin"
+
+  s.add_dependency "resque", "~> 2.2"
+  s.add_dependency "resqueue-metadata", "~> 0.0.1"
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "bundler/setup"
+require File.expand_path("../lib/resque_picky_worker", File.dirname(__FILE__))
+
+Resque.redis = "localhost:6379"
+
+require "irb"
+IRB.start(__FILE__)

data/spec/resque/picky_worker_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe Resque::PickyWorker do
+  before do
+    @odd_queues = %w(1 3)
+    @even_queues = %w(2 4 6)
+    @queues = @odd_queues | @even_queues
+    Resque.stub!(:queues).and_return(@queues)
+
+    @chooser = lambda do |queues|
+      # Choose the highest even numbered queue we can find
+      queues.map(&:to_i).select {|i| i % 2 == 0 }.max.to_s
+    end
+    Resque::PickyWorker.chooser = @chooser
+  end
+
+  describe ".pick_queue" do
+    before do
+      @queue = Resque::PickyWorker.pick_queue
+    end
+    it "returns a string" do
+      @queue.should be_a(String)
+    end
+    it "should be a crawl queue" do
+      @even_queues.should include(@queue)
+    end
+  end
+
+  describe ".chooser" do
+    it "should be required" do
+      Resque::PickyWorker.chooser = nil
+
+      lambda do
+        Resque::PickyWorker.chooser
+      end.should raise_error(Resque::PickyWorker::Error, "chooser must be specified or I cannot choose a queue to listen to")
+    end
+  end
+
+  describe ".queue_max" do
+    context "with a max count set" do
+      it "should return it" do
+        Resque::Queue::Metadata.new("testing-queue-name-here")["max_workers"]
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require File.expand_path("../lib/resque/picky_worker", File.dirname(__FILE__))
+
+Resque.redis = "localhost:6379"
+Resque.redis.namespace = "resque-picky-worker-spec"

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: resque-picky_worker
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Caius Durling
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-23 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 2
+        version: "2.2"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: resqueue-metadata
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :runtime
+  version_requirements: *id002
+description: Resque worker that evaluates queues and chooses which one to pull jobs from
+email: 
+- caius@pizzapowered.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .rspec
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- example.rb
+- lib/resque/picky_worker.rb
+- lib/resque/picky_worker/override.rb
+- readme.md
+- resque-picky_worker.gemspec
+- script/console
+- spec/resque/picky_worker_spec.rb
+- spec/spec_helper.rb
+- vendor/cache/SystemTimer-1.2.3.gem
+- vendor/cache/diff-lcs-1.1.2.gem
+- vendor/cache/json-1.5.1.gem
+- vendor/cache/rack-1.3.0.gem
+- vendor/cache/redis-2.2.2.gem
+- vendor/cache/redis-namespace-1.0.3.gem
+- vendor/cache/redis-objects-0.5.1.gem
+- vendor/cache/resque-1.17.1.gem
+- vendor/cache/resqueue-metadata-0.0.1.gem
+- vendor/cache/rspec-2.6.0.gem
+- vendor/cache/rspec-core-2.6.4.gem
+- vendor/cache/rspec-expectations-2.6.0.gem
+- vendor/cache/rspec-mocks-2.6.0.gem
+- vendor/cache/sinatra-1.2.6.gem
+- vendor/cache/tilt-1.3.2.gem
+- vendor/cache/vegas-0.1.8.gem
+has_rdoc: true
+homepage: http://pizzapowered.com/
+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.6.2
+signing_key: 
+specification_version: 3
+summary: Resque worker, but picky about what queues it listens to
+test_files: 
+- spec/resque/picky_worker_spec.rb
+- spec/spec_helper.rb