job_hunter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c244340865960e0c4717ffd181cc0e12f11b4ed1
-  data.tar.gz: b714e3c2548e5303b23095470b2f8fd426b5cb6a
+  metadata.gz: d2b4465adfe13c33ce17ab91820f12af51f646c6
+  data.tar.gz: 1895c7dfc3ea369904d621fce89cea593f96ff9d
 SHA512:
-  metadata.gz: 29221c28c88302be1a112924f2bfa5467101f39886ac7936ceba6b00ec3ffdf5ef95a33d3fa3c9dc9b5979735eaf2b59a38d9b883e32d098f3ffb7abb3a14e43
-  data.tar.gz: c0777983d23b3d20c83328b0eafe5b2ab2702665f61c78e915094cf52b1496fc501331b877cb3f3072c60e32b4e35c0d45c28d8800629290124dc7d7f44913d0
+  metadata.gz: 424a79f337a54bb1f8f68cd6f0a8d190dd06b3b86cc8b79a925567a589596401a3ba2a222e87a26386bdf4f1c744e8494cf80f0ad75a2b076348ded39ef224d0
+  data.tar.gz: 09e41ede15f6743e121c4b575f3dbce3a3996c4a3460e53cd5144e9c057e16925afe128bfba44b8e690260d6158097af1f8a1aa7284b13a1b0b805ef6f5e61ff

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    job_hunter (0.0.0)
-      delayed_job (>= 3.0, < 5.0)
+    job_hunter (0.2.0)
+      delayed_job_active_record (>= 3.0, < 5.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,2 +1,80 @@
-job_hunter
+JobHunter
 ==========
+
+JobHunter is a library that cuts down on boilerplate when creating and finding [Delayed::Job](https://github.com/collectiveidea/delayed_job) custom jobs.
+
+Installation
+-------
+
+JobHunter supports DelayedJob 3.0+ with ActiveRecord as the backend. Just add `job_hunter` to your `Gemfile`.
+
+Usage
+-------
+
+Add `extend JobHunter` at the top of a class you plan to use as a custom job. After this line, you can set defaults for this job with `run_at`, `priority`, `queue`, and `max_attempts`:
+
+
+```ruby
+class KustomJob < Struct.new(:model_id, :details)
+  extend JobHunter
+  
+  run_at -> { 24.hours.from.now }
+  priority 37
+  queue :sugar_glider
+  max_attempts 4
+
+  def perform
+    # do amazing things
+  end
+end
+```
+
+`run_at` accepts a Proc object. The value is evaluated when you enqueue a new custom job.
+
+JobHunter also provides class methods to find, create, and destroy jobs:
+
+```ruby
+model_id = 22
+details  = "You seem to a have a squid on your head."
+
+KustomJob.create(model_id, details)
+
+KustomJob.find(model_id, details)
+
+KustomJob.find_or_create(model_id, details)
+
+KustomJob.delete(model_id, details)
+  
+```
+
+Adding an index to `handler` in the `delayed_jobs` table is recommended if you plan on making regular use of `find` or `find_or_create`.
+
+All of these methods will return a `Delayed::Job` if they find, create, or destroy a job and `nil` otherwise.
+
+The `create` and `find_or_create` methods accept the same options hash as `Delayed::Job.enqueue`. Options passed in to these methods (`run_at`, `queue`, and `priority`) will override the defauls set in your custom job class. Options passed in to `find_or_create` will not affect a job already enqueued.
+
+These class methods have corresponding instance methods:
+
+```ruby
+model_id = 22
+details  = "You seem to a have a squid on your head."
+
+custom_job = KustomJob.new model_id, details
+
+job.find
+
+job.create
+
+job.find_or_create
+
+job.delete
+```
+
+Unlike the identically named class methods, `#create` and `#find_or_create` do not take an options hash. However, you can still override defaults by initializing your class by using `new_with_options`:
+
+```ruby
+super_custom_job = KustomJob.new_with_options model_id, details, run_at: 12.minutes.from.now
+
+super_custom_job.create
+```
+

data/job_hunter.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'delayed_job', ['>= 3.0', '< 5.0']
+  gem.add_dependency 'delayed_job_active_record', ['>= 3.0', '< 5.0']
 
   gem.add_development_dependency 'rake', '~> 10'
   gem.add_development_dependency 'rspec', '~> 3'

data/lib/job_hunter/defaults.rb

@@ -0,0 +1,23 @@
+module JobHunter
+  def run_at(proc)
+    @run_at = proc
+  end
+
+  def priority(pri)
+    @priority = pri
+  end
+
+  def queue(queue)
+    @queue = queue
+  end
+
+  def max_attempts(value)
+    define_method(:max_attempts) { value }
+  end
+
+  def _defaults_
+    { priority: @priority, 
+      run_at: @run_at.try(:call),
+      queue: @queue }.select { |k, v| v }
+  end
+end

data/lib/job_hunter/dj_wrappers.rb

@@ -1,20 +1,52 @@
 module JobHunter
+  def self.extended(klass)
+    klass.include(InstanceMethods)
+  end
+
   def create(*args)
-    options = args.last.is_a?(Hash) ? args.pop : {}
-    Delayed::Job.enqueue(new(*args), options)
+    new_with_options(*args).create
   end
 
   def find(*args)
-    handler = new(*args).to_yaml
-    Delayed::Job.where(handler: handler).first
+    new_with_options(*args).find
   end
 
   def find_or_create(*args)
-    job_args = args.last.is_a?(Hash) ? args[0..-2] : args
-    find(*job_args) or create(*args)
+    new_with_options(*args).find_or_create
   end
 
   def destroy(*args)
-    find(*args).try(:destroy)
+    new_with_options(*args).destroy
+  end
+
+  def new_with_options(*args)
+    options = args.extract_options!
+    job = new(*args)
+    job.define_singleton_method :_options_,
+      -> { self.class._defaults_.merge(options) }
+    job
+  end
+
+  module InstanceMethods
+    def find
+      Delayed::Job.where(handler: to_yaml).first
+    end
+
+    def create
+      Delayed::Job.enqueue(self, _options_)
+    end
+
+    def find_or_create
+      find || create
+    end
+
+    def destroy
+      find.try(:destroy)
+    end
+
+    private
+    def _options_
+      {}
+    end
   end
 end

data/lib/job_hunter/version.rb

@@ -1,3 +1,3 @@
 module JobHunter
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/job_hunter.rb

@@ -1,4 +1,2 @@
+require 'job_hunter/defaults'
 require 'job_hunter/dj_wrappers'
-
-module JobHunter
-end

data/spec/job_hunter_spec.rb

@@ -5,6 +5,10 @@ class KustomJob < Struct.new(:model_id, :details)
 
   def perform
   end
+
+  def self.remove_method(sym)
+    define_method(name) { super }
+  end
 end
 
 describe JobHunter do
@@ -79,5 +83,77 @@ describe JobHunter do
     it 'returns nil if there is nothing to destory' do
       expect(KustomJob.destroy model_id, details).to be_nil
     end
-  end  
+  end
+
+  context '.max_attempts' do
+    let(:attempts) { 3 }
+
+    it 'sets max attempts in an instance method of the same name' do
+      kustom_job = KustomJob.new
+      expect {
+        KustomJob.max_attempts attempts
+      }.to change{kustom_job.try(:max_attempts)}.from(nil).to(attempts)
+    end
+
+    after do
+      KustomJob.remove_method :max_attempts
+    end
+  end
+
+  context '.run_at' do
+    let(:default_time) { -> { DateTime.parse('April 23, 2015 07:23') } }
+    let(:override) { 6.hours.from_now }
+
+    before do
+      KustomJob.run_at default_time
+    end
+
+    it 'gives jobs the default run_at time' do
+      job = KustomJob.create
+      expect(job.run_at).to eq(default_time.call)
+    end
+
+    it 'allows overriding the default time' do
+      job = KustomJob.create run_at: override
+      expect(job.run_at).to eq(override)
+    end
+  end
+
+  context '.priority' do
+    let(:default_priority) { 37 }
+    let(:override) { 13 }
+
+    before do
+      KustomJob.priority default_priority
+    end
+
+    it 'gives jobs the default priority' do
+      job = KustomJob.create
+      expect(job.priority).to eq(default_priority)
+    end
+
+    it 'allows overriding the default priority' do
+      job = KustomJob.create priority: override
+      expect(job.priority).to eq(override)
+    end
+  end
+
+  context '.queue' do
+    let(:default_queue) { 'sugar_glider' }
+    let(:override) { 'sugar_moo' }
+
+    before do
+      KustomJob.queue default_queue
+    end
+
+    it 'gives jobs the default queue' do
+      job = KustomJob.create
+      expect(job.queue).to eq(default_queue)
+    end
+
+    it 'allows overriding the default queue' do
+      job = KustomJob.create queue: override
+      expect(job.queue).to eq(override)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: job_hunter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryan Moser
@@ -11,7 +11,7 @@ cert_chain: []
 date: 2014-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: delayed_job
+  name: delayed_job_active_record
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,6 +87,7 @@ files:
 - Rakefile
 - job_hunter.gemspec
 - lib/job_hunter.rb
+- lib/job_hunter/defaults.rb
 - lib/job_hunter/dj_wrappers.rb
 - lib/job_hunter/version.rb
 - spec/job_hunter_spec.rb