deferred_job 0.0.1 → 0.2.0

data/README.md

@@ -1,17 +1,29 @@
 # DeferredJob
 
-DeferredJob is a small library meant to work with Resque that allows you to add
-a set of pre-conditions that must be met before a Resque job kicks off.
+DeferredJob is a small library meant to work with Resque or Sidekiq that allows
+you to add a set of pre-conditions that must be met before a job kicks off.
+
+``` bash
+$ gem install deferred_job
+```
 
 ## Usage
 
+### Configuration
+
+You'll need to tell DeferredJob which message processing system you're using:
+
+``` ruby
+DeferredJob::Job.adapter = :sidekiq
+```
+
 ### Creating a DeferredJob
 
 To create a deferred job, you must give it an id, and the name/arguments
 of a worker to kick off when the preconditions are met:
 
 ``` ruby
-job = Resque::DeferredJob.create id, SomeWorker, 'worker', 'args'
+job = DeferredJob::Job.create(id, SomeWorker, 'worker', 'args')
 ```
 
 _NOTE:_ If you try to re-create an existing job, you'll clear it out.
@@ -22,9 +34,9 @@ To add preconditions, you can use `#wait_for`.  So if you wanted to wait until
 a few things are done, you can add them one at a time, or in bulk:
 
 ``` ruby
-job.wait_for 'import-1-data'
-job.wait_for 'import-2-data'
-job.wait_for 'import-1-photos', 'import-2-photos'
+job.wait_for('import-1-data')
+job.wait_for('import-2-data')
+job.wait_for('import-1-photos', 'import-2-photos')
 ```
 
 ### Checking preconditions
@@ -55,9 +67,9 @@ to finish things in the same order you put them in (and hopefully you
 aren't):
 
 ``` ruby
-job.done 'import-1-data'
-job.done 'import-1-photos', 'import-2-photos'
-job.done 'import-2-data' # job kick off!
+job.done('import-1-data')
+job.done('import-1-photos', 'import-2-photos')
+job.done('import-2-data') # job kick off!
 ```
 
 ### Loading an existing job
@@ -68,24 +80,24 @@ In that case, load a previous job like so:
 
 ``` ruby
 # Check existence if you'd like
-Resque::DeferredJob.exists? id # true
+DeferredJob::Job.exists? id # true
 
 # Load the job up
-job = Resque::DeferredJob.find id
+job = DeferredJob::Job.find id
 ```
 
 _NOTE:_ If you try to find a job that does not exist, you'll raise an
-exception (`Resque::NoSuchKey`).
+exception (`DeferredJob::NoSuchJob`).
 
 ## Advanced
 
 ### Redis Client
 
-By default, `DeferredJob` will use the same redis instance as Resque.
+By default, `DeferredJob` will use the same redis instance as your message processing tool.
 If you'd like to change that, you can set the redis instace like so:
 
 ``` ruby
-Resque::DeferredJob.redis = your_instace
+DeferredJob::Job.redis = your_instance
 ```
 
 ### Key Generation
@@ -95,7 +107,7 @@ like `deferred-job:#{id}`.  It can be useful to change that, so you can
 specify a new lambda expression for generating the keys:
 
 ``` ruby
-Resque::DeferredJob.key_lambda = lambda { |id| "job:#{id}" }
+DeferredJob.key_lambda = lambda { |id| "job:#{id}" }
 ```
 
 ## License

data/lib/adapters/resque_adapter.rb

@@ -0,0 +1,19 @@
+begin
+  require 'resque'
+
+  module DeferredJob
+
+    class ResqueAdapter
+
+      def enqueue(klass, *args)
+        ::Resque.enqueue(klass, *args)
+      end
+
+      def with_redis(&block)
+        block.call(::Resque.redis)
+      end
+    end
+  end
+rescue LoadError
+  # no mas
+end

data/lib/adapters/sidekiq_adapter.rb

@@ -0,0 +1,19 @@
+begin
+  require 'sidekiq'
+
+  module DeferredJob
+
+    class SidekiqAdapter
+
+      def enqueue(klass, *args)
+        klass.perform_async(*args)
+      end
+
+      def with_redis(&block)
+        Sidekiq.redis(&block)
+      end
+    end
+  end
+rescue LoadError
+  # no mas
+end

data/lib/deferred_job.rb

@@ -1,5 +1,4 @@
 require 'bundler/setup'
-require 'resque'
 
 begin
   require 'active_support/core_ext/string/inflections'
@@ -7,14 +6,17 @@ rescue LoadError
   require 'active_support'
 end
 
-module Resque
+require_relative 'adapters/resque_adapter'
+require_relative 'adapters/sidekiq_adapter'
 
-  class NoSuchKey < StandardError
-  end
+module DeferredJob
+
+  autoload :VERSION, 'deferred_job/version'
 
-  class DeferredJob
+  class NoSuchJob < StandardError
+  end
 
-    include Helpers
+  class Job
 
     attr_accessor :verbose
     attr_reader :id, :klass, :args, :set_key
@@ -32,13 +34,15 @@ module Resque
 
     # Clear all entries in the set
     def clear
-      redis.del @set_key
+      with_redis { |redis| redis.del(@set_key) }
     end
 
     # Clear and then remove the key for this job
     def destroy
-      redis.del @set_key
-      redis.del @id
+      with_redis do |redis|
+        redis.del(@set_key)
+        redis.del(@id)
+      end
     end
 
     # Determine if the set is empty
@@ -50,7 +54,7 @@ module Resque
     # Count the number of elements in the set
     # @return [Fixnum] the count of the elements in the set
     def count
-      redis.scard(@set_key).to_i
+      with_redis { |redis| redis.scard(@set_key).to_i }
     end
 
     # Wait for a thing before continuing
@@ -60,16 +64,16 @@ module Resque
     def wait_for(*things)
       things.each do |thing|
         log "DeferredJob #{@id} will wait for #{thing.inspect}"
-        redis.sadd @set_key, thing
+        with_redis { |redis| redis.sadd @set_key, thing }
       end
     end
 
     def waiting_for?(thing)
-      redis.sismember(@set_key, thing)
+      with_redis { |redis| redis.sismember(@set_key, thing) }
     end
 
     def waiting_for
-      redis.smembers(@set_key)
+      with_redis { |redis| redis.smembers(@set_key) }
     end
 
     # Mark a thing as finished
@@ -77,13 +81,16 @@ module Resque
     # @return [Fixnum] the number of things removed
     # NOTE >= 2.4 should use srem with multiple things
     def done(*things)
-      results = redis.multi do
-        redis.scard @set_key
-        things.each do |thing|
-          log "DeferredJob #{id} done with #{thing.inspect}"
-          redis.srem @set_key, thing
+      results = nil
+      with_redis do |redis|
+        results = redis.multi do
+          redis.scard @set_key
+          things.each do |thing|
+            log "DeferredJob #{id} done with #{thing.inspect}"
+            redis.srem @set_key, thing
+          end
+          redis.scard @set_key
         end
-        redis.scard @set_key
       end
       if results.first > 0
         if results.last.zero?
@@ -104,12 +111,16 @@ module Resque
 
     private
 
-    # A helper (similar to Resque::Helpers)
-    def redis
-      self.class.redis
+    # A helper
+    def with_redis(&block)
+      self.class.with_redis(&block)
+    end
+
+    def adapter
+      self.class.adapter
     end
 
-    # How to log - mirrors a pattern in resque
+    # How to log
     def log(msg)
       if verbose
         if defined?(Rails)
@@ -120,14 +131,14 @@ module Resque
       end
     end
 
-    # Execute the job with resque
+    # Execute the job with the adapter
     def execute
-      Resque.enqueue klass, *args
+      adapter.enqueue klass, *args
     end
 
     class << self
 
-      attr_writer :redis, :key_lambda
+      attr_writer :redis, :key_lambda, :adapter
 
       # The way we turn id into set_key
       # @param [Object] id - the id of the job
@@ -141,10 +152,10 @@ module Resque
       # @param [Object] id - the id of the job
       # @param [Class, String] klass - The class of the job to run
       # @param [Array] args - The args to send to the job
-      # @return [Resque::DeferredJob] - the job, cleared
+      # @return [DeferredJob] - the job, cleared
       def create(id, klass, *args)
         plan = [klass.to_s, args]
-        redis.set(id, MultiJson.encode(plan))
+        with_redis { |redis| redis.set(id, MultiJson.encode(plan)) }
         # Return the job
         job = new(id, klass, *args)
         job.clear
@@ -153,12 +164,12 @@ module Resque
 
       # Find an existing DeferredJob
       # @param [Object] id - the id of the job
-      # @return [Resque::DeferredJob] - the job
+      # @return [DeferredJob] - the job
       def find(id)
-        plan_data = redis.get(id)
-        # If found, return the job, otherwise raise NoSuchKey
+        plan_data = with_redis { |redis| redis.get(id) }
+        # If found, return the job, otherwise raise NoSuchJob
         if plan_data.nil?
-          raise ::Resque::NoSuchKey.new "No Such DeferredJob: #{id}"
+          raise NoSuchJob.new "No Such DeferredJob: #{id}"
         else
           plan = MultiJson.decode(plan_data)
           new(id, plan.first, *plan.last)
@@ -169,17 +180,28 @@ module Resque
       # @param [Object] id - the id of the job to lookup
       # @return [Boolean] - whether or not the job exists
       def exists?(id)
-        !redis.get(id).nil?
+        with_redis { |redis| !redis.get(id).nil? }
       end
 
-      # Our own redis instance in case people want to separate from resque
+      # Our own redis instance in case people want to separate from the message processor
       # @return [Redis::Client] - a redis client
-      def redis
-        @redis || Resque.redis
+      def with_redis(&block)
+        if @redis
+          block.call(@redis)
+        else
+          adapter.with_redis(&block)
+        end
       end
 
+      def adapter
+        @adapter_instance ||= begin
+          if @adapter.nil? || @adapter == :resque
+            ResqueAdapter.new
+          elsif @adapter == :sidekiq
+            SidekiqAdapter.new
+          end
+        end
+      end
     end
-
   end
-
 end

data/lib/deferred_job/version.rb

@@ -0,0 +1,5 @@
+module DeferredJob
+
+  VERSION = '0.2.0'
+
+end

metadata

@@ -1,16 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: deferred_job
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
 - John Crepezzi
+- Aubrey Holland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-21 00:00:00.000000000 Z
+date: 2013-01-04 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: :development
+  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
@@ -60,14 +77,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -76,7 +93,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: resque
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -91,12 +108,15 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Resque Deferred Jobs
-email: john@brewster.com
+description: Deferred Jobs
+email: aubrey@brewster.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/adapters/resque_adapter.rb
+- lib/adapters/sidekiq_adapter.rb
+- lib/deferred_job/version.rb
 - lib/deferred_job.rb
 - README.md
 - spec/spec_helper.rb
@@ -123,7 +143,6 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Resque Deferred Job Library
+summary: Deferred job library for Resque or Sidekiq
 test_files:
 - spec/spec_helper.rb
-has_rdoc: