resque-uuid 0.1.0

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'jeweler'
+gem 'rake'
+gem 'resque'
+gem 'uuidtools'
+
+group :test do
+  gem 'test-unit'
+  gem 'shoulda'
+  gem 'mocha'
+end

data/Gemfile.lock

@@ -0,0 +1,54 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    metaclass (0.0.1)
+    mocha (0.11.4)
+      metaclass (~> 0.0.1)
+    multi_json (1.3.6)
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    redis (2.2.2)
+    redis-namespace (1.0.3)
+      redis (< 3.0.0)
+    resque (1.20.0)
+      multi_json (~> 1.0)
+      redis-namespace (~> 1.0.2)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+    sinatra (1.3.2)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    test-unit (2.5.0)
+    tilt (1.3.3)
+    uuidtools (2.1.2)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  mocha
+  rake
+  resque
+  shoulda
+  test-unit
+  uuidtools

data/README.md

@@ -0,0 +1,18 @@
+resque-uuid
+===========
+
+ResqueUUID will assign random UUIDs to your Resque jobs so that they can be uniquely identified.
+
+Usage
+-----
+
+```ruby
+require 'resque'
+require 'resque-uuid'
+
+Resque::Plugins::ResqueUUID.enable!
+```
+
+UUIDs can be returned via:
+* Resque::Job#uuid
+* YourJobPayloadClass.uuid, if your payload class responds to .uuid= and .uuid

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "resque-uuid"
+    gem.summary = "Generates a UUID for Resque jobs as they are enqueued"
+    gem.email = "davebenvenuti@gmail.com"
+    gem.homepage = "http://github.com/davebenvenuti/resque-uuid"
+    gem.authors = ["davebenvenuti"]
+    gem.add_dependency "resque", "1.13.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/resque/plugins/resque_uuid/job_extensions.rb

@@ -0,0 +1,13 @@
+module Resque
+  module Plugins
+    module ResqueUUID
+
+      module JobExtensions
+        def uuid
+          self.payload['uuid']
+        end
+      end
+
+    end
+  end
+end

data/lib/resque/plugins/resque_uuid/resque_extensions.rb

@@ -0,0 +1,22 @@
+require 'uuidtools'
+
+module Resque
+  module Plugins
+    module ResqueUUID
+
+      module ResqueExtensions
+        def self.extended(extender)
+          extender.send(:alias_method, :push_without_uuid, :push)
+        end
+
+        def push(queue, item)
+          item['uuid'] = UUIDTools::UUID.random_create.to_s if item.respond_to?(:[]=)
+
+          push_without_uuid(queue, item)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/resque/plugins/resque_uuid.rb

@@ -0,0 +1,19 @@
+module Resque
+  module Plugins
+
+    module ResqueUUID
+
+      def self.enable!
+        Resque.send(:extend, Resque::Plugins::ResqueUUID::ResqueExtensions)
+        Resque::Job.send(:include, Resque::Plugins::ResqueUUID::JobExtensions)
+
+        old_after_fork = Resque.after_fork
+
+        Resque.after_fork do |job|
+          job.payload_class.uuid = job.payload['uuid'] if job.payload_class.respond_to?(:uuid=)
+          old_after_fork.call(job) if old_after_fork
+        end
+      end
+    end
+  end
+end

data/lib/resque-uuid.rb

@@ -0,0 +1,3 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '/resque/plugins/resque_uuid'))
+require File.expand_path(File.join(File.dirname(__FILE__), '/resque/plugins/resque_uuid/resque_extensions'))
+require File.expand_path(File.join(File.dirname(__FILE__), '/resque/plugins/resque_uuid/job_extensions'))

data/resque-uuid.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "resque-uuid"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["davebenvenuti"]
+  s.date = "2012-06-17"
+  s.email = "davebenvenuti@gmail.com"
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/resque-uuid.rb",
+    "lib/resque/plugins/resque_uuid.rb",
+    "lib/resque/plugins/resque_uuid/job_extensions.rb",
+    "lib/resque/plugins/resque_uuid/resque_extensions.rb",
+    "resque-uuid.gemspec",
+    "test/redis-test.conf",
+    "test/resque/plugins/resque_uuid/job_extensions_test.rb",
+    "test/resque/plugins/resque_uuid/resque_extensions_test.rb",
+    "test/resque/plugins/resque_uuid_test.rb",
+    "test/test_helper.rb"
+  ]
+  s.homepage = "http://github.com/davebenvenuti/resque-uuid"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "Generates a UUID for Resque jobs as they are enqueued"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<jeweler>, [">= 0"])
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_runtime_dependency(%q<resque>, [">= 0"])
+      s.add_runtime_dependency(%q<uuidtools>, [">= 0"])
+      s.add_runtime_dependency(%q<resque>, ["= 1.13.0"])
+    else
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<resque>, [">= 0"])
+      s.add_dependency(%q<uuidtools>, [">= 0"])
+      s.add_dependency(%q<resque>, ["= 1.13.0"])
+    end
+  else
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<resque>, [">= 0"])
+    s.add_dependency(%q<uuidtools>, [">= 0"])
+    s.add_dependency(%q<resque>, ["= 1.13.0"])
+  end
+end
+

data/test/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 ./test/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 ./test/
+
+# 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/test/resque/plugins/resque_uuid/job_extensions_test.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "../../../test_helper"))
+
+class JobExtensionsTest < Test::Unit::TestCase
+
+  should "define uuid method for Resque::Job" do
+    job = Resque::Job.new :my_queue, 'some' => 'payload', 'uuid' => 'some_unique_id'
+
+    assert_equal 'some_unique_id', job.uuid
+  end
+end

data/test/resque/plugins/resque_uuid/resque_extensions_test.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "../../../test_helper"))
+
+class ResqueExtensionsTest < Test::Unit::TestCase
+  class << self
+    # we need to startup and shutdown a redis server for this test case so we can enqueue resque push/pop still work properly
+    def startup
+      startup_test_redis
+    end
+
+    def shutdown
+      shutdown_test_redis
+    end
+  end
+
+  should "add a uuid to job payload when pushed" do
+    test_uuid = UUIDTools::UUID.random_create
+    UUIDTools::UUID.expects(:random_create).returns(test_uuid)
+
+    fake_payload = { 'payload' => 'blah' }
+
+    Resque.push :my_queue, fake_payload
+
+    popped = Resque.pop :my_queue
+
+    assert_equal fake_payload.merge('uuid' => test_uuid.to_s), popped
+  end
+
+end

data/test/resque/plugins/resque_uuid_test.rb

@@ -0,0 +1,53 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "/../../test_helper"))
+
+class FakeJobClass
+  def self.old_after_fork_ran!
+    @old_after_fork_ran = true
+  end
+
+  def self.old_after_fork_ran?
+    !!@old_after_fork_ran
+  end
+
+  def self.uuid=(val)
+    @uuid = val
+  end
+
+  def self.uuid
+    @uuid
+  end
+end
+
+class FakeJobClassNoUUID
+  # no self.uuid= method defined
+end
+
+class ResqueUUIDTest < Test::Unit::TestCase
+
+  should "extend Resque" do
+    assert Resque.is_a?(Resque::Plugins::ResqueUUID::ResqueExtensions)
+  end
+
+  should "extend Resque::Job" do
+    assert Resque::Job.include?(Resque::Plugins::ResqueUUID::JobExtensions)
+  end
+
+  should "define Resque.after_fork" do
+    fake_job = Resque::Job.new :my_queue, 'some' => 'payload', 'uuid' => 'my_uuid', 'class' => 'FakeJobClass'
+
+    Resque.after_fork.call(fake_job)
+
+    # the old after_fork call is defined in test_helper
+    assert fake_job.payload['old_after_fork'], "previously defined after_fork did not execute"
+    assert_equal 'my_uuid', fake_job.uuid, "job uuid should be set from payload, but isn't"
+    assert_equal 'my_uuid', FakeJobClass.uuid, "payload class uuid should be set from payload, but isn't"
+  end
+
+  should "gracefully handle payload classes with now uuid= method" do
+    fake_job = Resque::Job.new :my_queue, 'some' => 'payload', 'uuid' => 'my_uuid', 'class' => 'FakeJobClassNoUUID'
+
+    assert_nothing_raised do
+      Resque.after_fork.call(fake_job)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,37 @@
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'resque'
+
+TEST_DIR_BASE = File.dirname(File.expand_path(__FILE__))
+
+require File.expand_path(File.join(TEST_DIR_BASE, '/../lib/resque-uuid'))
+
+#
+# make sure we can run redis.  we run an actual redis-server to enqure resque push/pop still works properly
+#
+if !system("which redis-server")
+  puts '', "** can't find `redis-server` in your path"
+  puts "** try running `sudo rake install`"
+  abort ''
+end
+
+# startup and shutdown of test redis server more or less stolen directly from resque test_helper
+def startup_test_redis
+  `redis-server #{TEST_DIR_BASE}/redis-test.conf`
+  Resque.redis = 'localhost:9736'
+end
+
+def shutdown_test_redis
+  processes = `ps -A -o pid,command | grep [r]edis-test`.split("\n")
+  pids = processes.map { |process| process.split(" ")[0] }
+  `rm -f #{TEST_DIR_BASE}/dump.rdb`
+  pids.each { |pid| Process.kill("KILL", pid.to_i) }
+end
+
+# define another after_fork to ensure we don't mess up other after_forks that might get created
+Resque.after_fork do |job|
+  job.payload['old_after_fork'] = true
+end
+
+Resque::Plugins::ResqueUUID.enable!

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: resque-uuid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- davebenvenuti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &25018580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *25018580
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &25017980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *25017980
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &25017360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *25017360
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: &25016680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *25016680
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &25015720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *25015720
+description: 
+email: davebenvenuti@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
+- lib/resque-uuid.rb
+- lib/resque/plugins/resque_uuid.rb
+- lib/resque/plugins/resque_uuid/job_extensions.rb
+- lib/resque/plugins/resque_uuid/resque_extensions.rb
+- resque-uuid.gemspec
+- test/redis-test.conf
+- test/resque/plugins/resque_uuid/job_extensions_test.rb
+- test/resque/plugins/resque_uuid/resque_extensions_test.rb
+- test/resque/plugins/resque_uuid_test.rb
+- test/test_helper.rb
+homepage: http://github.com/davebenvenuti/resque-uuid
+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.15
+signing_key: 
+specification_version: 3
+summary: Generates a UUID for Resque jobs as they are enqueued
+test_files: []