nogara-resque-loner 1.2.1

data/lib/resque-loner/version.rb

@@ -0,0 +1,7 @@
+module Resque
+  module Plugins
+    module Loner
+      VERSION = "1.2.1"
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'resque-loner'

data/resque-loner.gemspec

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'resque-loner/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'nogara-resque-loner'
+  s.version     = Resque::Plugins::Loner::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Jannis Hermanns']
+  s.email       = ['jannis@moviepilot.com']
+  s.homepage    = 'http://github.com/jayniz/resque-loner'
+  s.summary     = 'Adds unique jobs to resque'
+  s.has_rdoc    = false
+
+  s.rubyforge_project = 'resque-loner'
+
+  s.add_dependency 'resque', '~>1.0'
+  {
+    'rake'                => '> 0.8.7',
+    'rack-test'           => '~> 0.5.7',
+    'rspec'               => '~> 2.5.0',
+    'mock_redis'          => '~> 0.2.0',
+    'yajl-ruby'           => '~> 0.8.2'
+  }.each do |lib, version|
+    s.add_development_dependency lib, version
+  end
+
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.description = <<desc
+Makes sure that for special jobs, there can be only one job with the same workload in one queue.
+
+Example:
+    class CacheSweeper
+
+       include Resque::Plugins::UniqueJob
+
+       @queue = :cache_sweeps
+
+       def self.perform(article_id)
+         # Cache Me If You Can...
+       end
+    end
+desc
+end

data/spec/loner_spec.rb

@@ -0,0 +1,165 @@
+require 'spec_helper'
+
+
+#
+#  Resque-loner specific specs. I'm shooting right through the stack here and just
+#  test the outcomes, because the implementation will change soon and the tests run
+#  quite quickly.
+#
+
+class SomeJob
+  @queue = :some_queue
+end
+
+class SomeUniqueJob 
+
+  include Resque::Plugins::UniqueJob
+
+  @queue = :other_queue
+  def self.perform(foo); end
+end
+
+class FailingUniqueJob
+  include Resque::Plugins::UniqueJob
+  @queue = :other_queue
+  def self.perform(foo)
+    raise "I beg to differ"
+  end
+end
+
+class DeprecatedUniqueJob < Resque::Plugins::Loner::UniqueJob
+
+  @queue = :other_queue
+  def self.perform(foo); end
+end
+
+class UniqueJobWithTtl
+  include Resque::Plugins::UniqueJob
+  @queue = :unique_with_ttl
+  @loner_ttl = 300
+
+  def self.perform(*args); end
+end
+
+describe "Resque" do
+
+  before(:each) do
+    Resque.redis.flushall
+    Resque.size(:other_queue).should == 0
+    Resque.size(:some_queue).should == 0
+  end
+
+  describe "Jobs" do
+    it "can put multiple normal jobs on a queue" do
+      Resque.enqueue SomeJob, "foo"
+      Resque.enqueue SomeJob, "foo"
+      Resque.size(:some_queue).should == 2
+    end
+
+    it "should allow only one of the same job to sit in a queue" do
+      Resque.enqueue SomeUniqueJob, "foo"
+      Resque.enqueue SomeUniqueJob, "foo"
+      Resque.size(:other_queue).should == 1
+    end
+
+    it "should support deprecated Resque::Plugins::Loner::UniqueJob class" do
+      Resque.enqueue DeprecatedUniqueJob, "foo"
+      Resque.enqueue DeprecatedUniqueJob, "foo"
+      Resque.size(:other_queue).should == 1
+    end
+
+    it "should allow the same jobs to be executed one after the other" do
+      Resque.enqueue SomeUniqueJob, "foo"
+      Resque.enqueue SomeUniqueJob, "foo"
+      Resque.size(:other_queue).should == 1
+
+      Resque.reserve(:other_queue)
+      Resque.size(:other_queue).should == 0
+
+      Resque.enqueue SomeUniqueJob, "foo"
+      Resque.enqueue SomeUniqueJob, "foo"
+      Resque.size(:other_queue).should == 1
+    end
+
+    it "should be robust regarding hash attributes" do
+      Resque.enqueue SomeUniqueJob, :bar => 1, :foo => 2
+      Resque.enqueue SomeUniqueJob, :foo => 2, :bar => 1
+      Resque.size(:other_queue).should == 1
+    end
+
+    it "should be robust regarding hash attributes (JSON does not distinguish between string and symbol)" do
+      Resque.enqueue SomeUniqueJob, :bar => 1, :foo  => 1
+      Resque.enqueue SomeUniqueJob, :bar => 1, "foo" => 1
+      Resque.size(:other_queue).should == 1
+    end
+
+    it "should mark jobs as unqueued, when Job.destroy is killing them" do
+      Resque.enqueue SomeUniqueJob, "foo"
+      Resque.enqueue SomeUniqueJob, "foo"
+      Resque.size(:other_queue).should == 1
+
+      Resque::Job.destroy(:other_queue, SomeUniqueJob)
+      Resque.size(:other_queue).should == 0
+
+      Resque.enqueue SomeUniqueJob, "foo"
+      Resque.enqueue SomeUniqueJob, "foo"
+      Resque.size(:other_queue).should == 1
+    end
+
+    it "should mark jobs as unqueued, when they raise an exception during #perform" do
+      2.times { Resque.enqueue( FailingUniqueJob, "foo" ) }
+      Resque.size(:other_queue).should == 1
+
+      worker = Resque::Worker.new(:other_queue)
+      worker.work 0
+      Resque.size(:other_queue).should == 0
+
+      2.times { Resque.enqueue( FailingUniqueJob, "foo" ) }
+      Resque.size(:other_queue).should == 1
+    end
+
+    it "should report if a job is queued or not" do
+      Resque.enqueue SomeUniqueJob, "foo"
+      Resque.enqueued?(SomeUniqueJob, "foo").should be_true
+      Resque.enqueued?(SomeUniqueJob, "bar").should be_false
+    end
+
+    it "should report if a job is in a special queue or not" do
+      default_queue = SomeUniqueJob.instance_variable_get(:@queue)
+      SomeUniqueJob.instance_variable_set(:@queue, :special_queue)
+
+      Resque.enqueue SomeUniqueJob, "foo"
+      Resque.enqueued_in?( :special_queue, SomeUniqueJob, "foo").should be_true
+
+      SomeUniqueJob.instance_variable_set(:@queue, default_queue)
+
+      Resque.enqueued?( SomeUniqueJob, "foo").should be_false
+    end
+
+    it "should not be able to report if a non-unique job was enqueued" do
+      Resque.enqueued?(SomeJob).should be_nil
+    end
+
+    it "should cleanup all loners when a queue is destroyed" do
+      Resque.enqueue SomeUniqueJob, "foo"
+      Resque.enqueue FailingUniqueJob, "foo"
+
+      Resque.remove_queue(:other_queue)
+
+      Resque.enqueue(SomeUniqueJob, "foo")
+      Resque.size(:other_queue).should == 1
+    end
+    
+    it 'should not raise an error when deleting an already empty queue' do
+      expect { Resque.remove_queue(:other_queue) }.to_not raise_error
+    end
+
+    it 'should honor loner_ttl in the redis key' do
+      Resque.enqueue UniqueJobWithTtl
+      Resque.enqueued?(UniqueJobWithTtl).should be_true
+      k=Resque.redis.keys "loners:queue:unique_with_ttl:job:*"
+      k.length.should == 1
+      Resque.redis.ttl(k[0]).should be_within(2).of(UniqueJobWithTtl.loner_ttl)
+    end
+  end
+end

data/spec/redis-test.conf

@@ -0,0 +1,115 @@
+# Redis configuration file example
+
+# By default Redis does not run as a daemon. Use 'yes' if you need it.
+# Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
+daemonize yes
+
+# When run as a daemon, Redis write a pid file in /var/run/redis.pid by default.
+# You can specify a custom pid file location here.
+pidfile ./spec/redis-test.pid
+
+# Accept connections on the specified port, default is 6379
+port 9736
+
+# If you want you can bind a single interface, if the bind option is not
+# specified all the interfaces will listen for connections.
+#
+# bind 127.0.0.1
+
+# Close the connection after a client is idle for N seconds (0 to disable)
+timeout 300
+
+# Save the DB on disk:
+#
+#   save <seconds> <changes>
+#
+#   Will save the DB if both the given number of seconds and the given
+#   number of write operations against the DB occurred.
+#
+#   In the example below the behaviour will be to save:
+#   after 900 sec (15 min) if at least 1 key changed
+#   after 300 sec (5 min) if at least 10 keys changed
+#   after 60 sec if at least 10000 keys changed
+save 900 1
+save 300 10
+save 60 10000
+
+# The filename where to dump the DB
+dbfilename dump.rdb
+
+# For default save/load DB in/from the working directory
+# Note that you must specify a directory not a file name.
+dir ./spec/
+
+# Set server verbosity to 'debug'
+# it can be one of:
+# debug (a lot of information, useful for development/testing)
+# notice (moderately verbose, what you want in production probably)
+# warning (only very important / critical messages are logged)
+loglevel debug
+
+# Specify the log file name. Also 'stdout' can be used to force
+# the demon to log on the standard output. Note that if you use standard
+# output for logging but daemonize, logs will be sent to /dev/null
+logfile stdout
+
+# Set the number of databases. The default database is DB 0, you can select
+# a different one on a per-connection basis using SELECT <dbid> where
+# dbid is a number between 0 and 'databases'-1
+databases 16
+
+################################# REPLICATION #################################
+
+# Master-Slave replication. Use slaveof to make a Redis instance a copy of
+# another Redis server. Note that the configuration is local to the slave
+# so for example it is possible to configure the slave to save the DB with a
+# different interval, or to listen to another port, and so on.
+
+# slaveof <masterip> <masterport>
+
+################################## SECURITY ###################################
+
+# Require clients to issue AUTH <PASSWORD> before processing any other
+# commands.  This might be useful in environments in which you do not trust
+# others with access to the host running redis-server.
+#
+# This should stay commented out for backward compatibility and because most
+# people do not need auth (e.g. they run their own servers).
+
+# requirepass foobared
+
+################################### LIMITS ####################################
+
+# Set the max number of connected clients at the same time. By default there
+# is no limit, and it's up to the number of file descriptors the Redis process
+# is able to open. The special value '0' means no limts.
+# Once the limit is reached Redis will close all the new connections sending
+# an error 'max number of clients reached'.
+
+# maxclients 128
+
+# Don't use more memory than the specified amount of bytes.
+# When the memory limit is reached Redis will try to remove keys with an
+# EXPIRE set. It will try to start freeing keys that are going to expire
+# in little time and preserve keys with a longer time to live.
+# Redis will also try to remove objects from free lists if possible.
+#
+# If all this fails, Redis will start to reply with errors to commands
+# that will use more memory, like SET, LPUSH, and so on, and will continue
+# to reply to most read-only commands like GET.
+#
+# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
+# 'state' server or cache, not as a real DB. When Redis is used as a real
+# database the memory usage will grow over the weeks, it will be obvious if
+# it is going to use too much memory in the long run, and you'll have the time
+# to upgrade. With maxmemory after the limit is reached you'll start to get
+# errors for write operations, and this may even lead to DB inconsistency.
+
+# maxmemory <bytes>
+
+############################### ADVANCED CONFIG ###############################
+
+# Glue small output buffers together in order to send small replies in a
+# single TCP packet. Uses a bit more CPU but most of the times it is a win
+# in terms of number of queries per second. Use 'yes' if unsure.
+glueoutputbuf yes

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+
+require 'ruby-debug'
+require 'mock_redis'
+require 'resque'
+require 'resque-loner'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    Resque.redis = MockRedis.new
+  end
+end

data/tasks/redis.rake

@@ -0,0 +1,159 @@
+# Inspired by rabbitmq.rake the Redbox project at http://github.com/rick/redbox/tree/master
+require 'fileutils'
+require 'open-uri'
+require 'pathname'
+
+class RedisRunner
+
+  def self.redis_dir
+    @redis_dir ||= if ENV['PREFIX']
+                     Pathname.new(ENV['PREFIX'])
+                   else
+                     Pathname.new(`which redis-server`) + '..' + '..'
+                   end
+  end
+
+  def self.bin_dir
+    redis_dir + 'bin'
+  end
+
+  def self.config
+    @config ||= if File.exists?(redis_dir + 'etc/redis.conf')
+                  redis_dir + 'etc/redis.conf'
+                else
+                  redis_dir + '../etc/redis.conf'
+                end
+  end
+
+  def self.dtach_socket
+    '/tmp/redis.dtach'
+  end
+
+  # Just check for existance of dtach socket
+  def self.running?
+    File.exists? dtach_socket
+  end
+
+  def self.start
+    puts 'Detach with Ctrl+\  Re-attach with rake redis:attach'
+    sleep 1
+    command = "#{bin_dir}/dtach -A #{dtach_socket} #{bin_dir}/redis-server #{config}"
+    sh command
+  end
+
+  def self.attach
+    exec "#{bin_dir}/dtach -a #{dtach_socket}"
+  end
+
+  def self.stop
+    sh 'echo "SHUTDOWN" | nc localhost 6379'
+  end
+
+end
+
+namespace :redis do
+
+  desc 'About redis'
+  task :about do
+    puts "\nSee http://code.google.com/p/redis/ for information about redis.\n\n"
+  end
+
+  desc 'Start redis'
+  task :start do
+    RedisRunner.start
+  end
+
+  desc 'Stop redis'
+  task :stop do
+    RedisRunner.stop
+  end
+
+  desc 'Restart redis'
+  task :restart do
+    RedisRunner.stop
+    RedisRunner.start
+  end
+
+  desc 'Attach to redis dtach socket'
+  task :attach do
+    RedisRunner.attach
+  end
+
+  desc 'Install the latest verison of Redis from Github (requires git, duh)'
+  task :install => [:about, :download, :make] do
+    bin_dir = '/usr/bin'
+    conf_dir = '/etc'
+
+    if ENV['PREFIX']
+      bin_dir = "#{ENV['PREFIX']}/bin"
+      sh "mkdir -p #{bin_dir}" unless File.exists?("#{bin_dir}")
+
+      conf_dir = "#{ENV['PREFIX']}/etc"
+      sh "mkdir -p #{conf_dir}" unless File.exists?("#{conf_dir}")
+    end
+
+    %w(redis-benchmark redis-cli redis-server).each do |bin|
+      sh "cp /tmp/redis/#{bin} #{bin_dir}"
+    end
+
+    puts "Installed redis-benchmark, redis-cli and redis-server to #{bin_dir}"
+
+    unless File.exists?("#{conf_dir}/redis.conf")
+      sh "cp /tmp/redis/redis.conf #{conf_dir}/redis.conf"
+      puts "Installed redis.conf to #{conf_dir} \n You should look at this file!"
+    end
+  end
+
+  task :make do
+    sh "cd /tmp/redis && make clean"
+    sh "cd /tmp/redis && make"
+  end
+
+  desc "Download package"
+  task :download do
+    sh 'rm -rf /tmp/redis/' if File.exists?("/tmp/redis/.svn")
+    sh 'git clone git://github.com/antirez/redis.git /tmp/redis' unless File.exists?('/tmp/redis')
+    sh "cd /tmp/redis && git pull" if File.exists?("/tmp/redis/.git")
+  end
+
+end
+
+namespace :dtach do
+
+  desc 'About dtach'
+  task :about do
+    puts "\nSee http://dtach.sourceforge.net/ for information about dtach.\n\n"
+  end
+
+  desc 'Install dtach 0.8 from source'
+  task :install => [:about, :download, :make] do
+
+    bin_dir = "/usr/bin"
+
+    if ENV['PREFIX']
+      bin_dir = "#{ENV['PREFIX']}/bin"
+      sh "mkdir -p #{bin_dir}" unless File.exists?("#{bin_dir}")
+    end
+
+    sh "cp /tmp/dtach-0.8/dtach #{bin_dir}"
+  end
+
+  task :make do
+    sh 'cd /tmp/dtach-0.8/ && ./configure && make'
+  end
+
+  desc "Download package"
+  task :download do
+    unless File.exists?('/tmp/dtach-0.8.tar.gz')
+      require 'net/http'
+
+      url = 'http://downloads.sourceforge.net/project/dtach/dtach/0.8/dtach-0.8.tar.gz'
+      open('/tmp/dtach-0.8.tar.gz', 'wb') do |file| file.write(open(url).read) end
+    end
+
+    unless File.directory?('/tmp/dtach-0.8')
+      sh 'cd /tmp && tar xzf dtach-0.8.tar.gz'
+    end
+  end
+end
+