active_job_status 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6b9ef8fd6afc49dd42ddff3b89715f7f0bc3c24
-  data.tar.gz: d577c498e486282b0d39346925321696632c2a63
+  metadata.gz: 5431b8cc6fed8a99592123c01fc9357cf4a46192
+  data.tar.gz: bd92db0a996e02e8ac1cabdb1af6d9e8092de953
 SHA512:
-  metadata.gz: 296968828f08cbc8aea202ee67cd135337ad2722ddd7f6c8c9eb69aa2bc23f6dcac85ccb273daa299f1165e6d88db70a857ad9727637a44a8952ff7e73c6ce18
-  data.tar.gz: 6dc29bb46f45a5e91a839a595c05687fd18a01dbecd626d6c194116c7a5f1b4a9159ba94ce3833f18585b606f5e5b30e9398a0b84bcd5264ace27b2fe799a7e7
+  metadata.gz: 1e081751d977356a0315b686321c526e02ddc881b5e8624c59434a187bb40625aa452ca31188a6d7905550eadb93dd0c2f8c03d02390c3c3913f61e4da730480
+  data.tar.gz: 88df222fab4619634fe7073fc024b691c649bbd22df91c5261a9f304e3eaff9117f35ab2a05ff903e6c303a002650f5baa86884c8fd74758f51868a85daefb0f

data/.gitignore

@@ -15,3 +15,4 @@
 mkmf.log
 .DS_Store
 *.swp
+*.gem

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 cache: bundler
 rvm:
-- 2.2.0
+- 2.3.1
 script: bundle exec rake
 services:
   - redis

data/CHANGELOG.md

@@ -1,4 +1,8 @@
 # ActiveJobStatus
+## 1.2.0
+- Add support for Rails 5
+- Adds many small improvements (see https://github.com/cdale77/active_job_status/pull/15)
+
 ## 1.1.0
 - Add support for Redis via the Readthis gem
 

data/README.md

@@ -46,6 +46,8 @@ ActiveJob status will detect Redis and use some nice optimizations.
 
     # config/initializers/active_job_status.rb
     ActiveJobStatus.store = ActiveSupport::Cache::RedisStore.new
+    # or if you are using https://github.com/sorentwo/readthis
+    ActiveJobStatus.store = ActiveSupport::Cache::ReadthisStore.new
 
 ## Usage
 
@@ -58,6 +60,24 @@ upgrading from versions < 1.0, you may need to update your code.*
     class MyJob < ActiveJobStatus::TrackableJob
     end
 
+Or you can just include ActiveJobStatus::Hooks into your job if you are using
+version 1.2 or greater. You might want to use this approach if you are using an
+`ApplicationJob` and do not want all your jobs to be trackable.
+
+    class MyJob < ActiveJob::Base
+      include ActiveJobStatus::Hooks
+    end
+
+or
+
+    class MyJob < ApplicationJob
+      include ActiveJobStatus::Hooks
+    end
+
+    class ApplicationJob < ActiveJob::Base
+    end
+
+
 ### Job Status
 
 Check the status of a job using the ActiveJob job_id. Status of a job will only
@@ -65,8 +85,12 @@ be available for 72 hours after the job is queued. For right now you can't
 change that.
 
     my_job = MyJob.perform_later
-    ActiveJobStatus::JobStatus.get_status(job_id: my_job.job_id)
-    # => :queued, :working, :complete
+    job_status = ActiveJobStatus.fetch(my_job.job_id)
+    job_status.queued?
+    job_status.working?
+    job_status.completed?
+    job_status.status
+    # => :queued, :working, :completed, nil
 
 ### Job Batches
 For job batches you an use any key you want (for example, you might use a
@@ -106,7 +130,8 @@ You can ask the batch for other bits of information:
 You can also search for batches:
     ActiveJobStatus::JobBatch.find(batch_id: my_key)
 
-This method will return nil no associated job ids can be found, otherwise it will 
+This method will return nil if no associated job ids can be found, otherwise it will
+This method will return nil no associated job ids can be found, otherwise it will
 return an ActiveJobStatus::JobBatch object.
 
 ## Contributing

data/active_job_status.gemspec

@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
 
-  spec.add_runtime_dependency "activejob", "~>4.2"
-  spec.add_runtime_dependency "activesupport", "~>4.2"
+  spec.add_runtime_dependency "activejob", "> 4.2"
+  spec.add_runtime_dependency "activesupport", "> 4.2"
 
   spec.post_install_message = "If updating from a version below 1.0, please note " \
                               "TrackabeJob is now namespaced inside of ActiveJob. " \

data/lib/active_job_status.rb

@@ -1,3 +1,4 @@
+require "active_job_status/hooks"
 require "active_job_status/trackable_job"
 require "active_job_status/job_tracker"
 require "active_job_status/job_status"
@@ -7,7 +8,15 @@ require "active_job_status/configure_redis" if defined? Rails
 
 module ActiveJobStatus
   class << self
-    attr_accessor :store
+    attr_accessor :store, :expiration
+
+    def get_status(job_id)
+      fetch(job_id).status
+    end
+
+    def fetch(job_id)
+      status = store.fetch(job_id)
+      JobStatus.new(status)
+    end
   end
 end
-

data/lib/active_job_status/configure_redis.rb

@@ -1,7 +1,7 @@
 require 'rails'
 class ConfigureRedis < Rails::Railtie
   initializer "configure_redis.configure_rails_initializers" do
-    if defined? ActiveSupport::Cache::RedisStore
+    if defined? ActiveSupport::Cache::RedisStore || defined? ActiveSupport::Cache::ReadthisStore
       require "active_job_status/redis"
     end
   end

data/lib/active_job_status/hooks.rb

@@ -0,0 +1,19 @@
+module ActiveJobStatus
+  module Hooks
+    def self.included(base)
+      base.class_eval do
+        before_enqueue { job_tracker.enqueued }
+
+        before_perform { job_tracker.performing }
+
+        after_perform { job_tracker.completed }
+      end
+    end
+
+    private
+
+    def job_tracker
+      @job_tracker ||= ActiveJobStatus::JobTracker.new(job_id: job_id)
+    end
+  end
+end

data/lib/active_job_status/job_batch.rb

@@ -14,7 +14,7 @@ module ActiveJobStatus
 
     def store_data(expire_in:)
       ActiveJobStatus.store.delete(@batch_id) # delete any old batches
-      if ActiveJobStatus.store.class.to_s == "ActiveSupport::Cache::RedisStore"
+      if ["ActiveSupport::Cache::RedisStore", "ActiveSupport::Cache::ReadthisStore"].include? ActiveJobStatus.store.class.to_s
         ActiveJobStatus.store.sadd(@batch_id, @job_ids)
         ActiveJobStatus.store.expire(@batch_id, expire_in)
       else
@@ -24,7 +24,7 @@ module ActiveJobStatus
 
     def add_jobs(job_ids:)
       @job_ids = @job_ids + job_ids
-      if ActiveJobStatus.store.class.to_s == "ActiveSupport::Cache::RedisStore"
+      if ["ActiveSupport::Cache::RedisStore", "ActiveSupport::Cache::ReadthisStore"].include? ActiveJobStatus.store.class.to_s
         # Save an extra redis query and perform atomic operation
         ActiveJobStatus.store.sadd(@batch_id, job_ids)
       else
@@ -34,15 +34,14 @@ module ActiveJobStatus
     end
 
     def completed?
-      job_statuses = []
-      @job_ids.each do |job_id|
-        job_statuses << ActiveJobStatus::JobStatus.get_status(job_id: job_id)
-      end
-      !job_statuses.any?
+      @job_ids.map do |job_id|
+        job_status = ActiveJobStatus.get_status(job_id)
+        job_status == nil || job_status == :completed
+      end.any?
     end
 
     def self.find(batch_id:)
-      if ActiveJobStatus.store.class.to_s == "ActiveSupport::Cache::RedisStore"
+      if ["ActiveSupport::Cache::RedisStore", "ActiveSupport::Cache::ReadthisStore"].include? ActiveJobStatus.store.class.to_s
         job_ids = ActiveJobStatus.store.smembers(batch_id)
       else
         job_ids = ActiveJobStatus.store.fetch(batch_id).to_a
@@ -62,4 +61,3 @@ module ActiveJobStatus
     end
   end
 end
-

data/lib/active_job_status/job_status.rb

@@ -1,11 +1,29 @@
 module ActiveJobStatus
-  module JobStatus
-    # Provides a way to check on the status of a given job
+  class JobStatus
+    ENQUEUED  = :queued
+    WORKING   = :working
+    COMPLETED = :completed
 
-    def self.get_status(job_id:)
-      status = ActiveJobStatus.store.fetch(job_id)
-      status ? status.to_sym : nil
+    attr_reader :status
+
+    def initialize(status)
+      @status = status && status.to_sym
+    end
+
+    def queued?
+      status == ENQUEUED
+    end
+
+    def working?
+      status == WORKING
+    end
+
+    def completed?
+      status == COMPLETED
+    end
+
+    def empty?
+      status.nil?
     end
   end
 end
-

data/lib/active_job_status/job_tracker.rb

@@ -1,17 +1,41 @@
 module ActiveJobStatus
-  module JobTracker
-    # Provides methods to CRUD job status records in Redis
+  class JobTracker
+    DEFAULT_EXPIRATION = 72.hours.freeze
 
-    def self.enqueue(job_id:)
-      ActiveJobStatus.store.write(job_id, "queued", expires_in: 259200)
+    def initialize(job_id:, store: ActiveJobStatus.store, expiration: ActiveJobStatus.expiration)
+      @job_id = job_id
+      @store = store
+      @expiration = expiration
     end
 
-    def self.update(job_id:, status:)
-      ActiveJobStatus.store.write(job_id, status.to_s)
+    def enqueued
+      store.write(
+        job_id,
+        JobStatus::ENQUEUED.to_s,
+        expires_in: expiration || DEFAULT_EXPIRATION
+      )
     end
 
-    def self.remove(job_id:)
-      ActiveJobStatus.store.delete(job_id)
+    def performing
+      store.write(
+        job_id,
+        JobStatus::WORKING.to_s
+      )
     end
+
+    def completed
+      store.write(
+        job_id,
+        JobStatus::COMPLETED.to_s
+      )
+    end
+
+    def deleted
+      store.delete(job_id)
+    end
+
+    private
+
+    attr_reader :job_id, :store, :expiration
   end
 end

data/lib/active_job_status/redis.rb

@@ -14,7 +14,12 @@ module ActiveJobStatus
   end
 end
 
-ActiveSupport::Cache::RedisStore.include(
-  ActiveJobStatus::Redis
-)
-
+if defined? ActiveSupport::Cache::RedisStore
+  ActiveSupport::Cache::RedisStore.include(
+    ActiveJobStatus::Redis
+  )
+elsif defined? ActiveSupport::Cache::ReadthisStore
+  ActiveSupport::Cache::ReadthisStore.include(
+    ActiveJobStatus::Redis
+  )
+end

data/lib/active_job_status/trackable_job.rb

@@ -1,11 +1,8 @@
 require "active_job"
+require "active_job_status/hooks"
+
 module ActiveJobStatus
   class TrackableJob < ActiveJob::Base
-
-    before_enqueue { ActiveJobStatus::JobTracker.enqueue(job_id: @job_id) }
-
-    before_perform { ActiveJobStatus::JobTracker.update(job_id: @job_id, status: :working) }
-
-    after_perform { ActiveJobStatus::JobTracker.remove(job_id: @job_id) }
+    include ActiveJobStatus::Hooks
   end
 end

data/lib/active_job_status/version.rb

@@ -1,3 +1,3 @@
 module ActiveJobStatus
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/spec/job_batch_spec.rb

@@ -57,7 +57,11 @@ describe ActiveJobStatus::JobBatch do
       update_store(id_array: total_jobs, job_status: :working)
       expect(batch.completed?).to be_falsey
     end
-    it "should be true when jobs are completed" do
+    it "should be true when jobs are all completed" do
+      update_store(id_array: total_jobs, job_status: :completed)
+      expect(batch.completed?).to be_truthy
+    end
+    it "should be true when jobs are not in the store" do
       clear_store(id_array: total_jobs)
       expect(batch.completed?).to be_truthy
     end

data/spec/job_status_spec.rb

@@ -1,26 +1,53 @@
 require "spec_helper"
 
 describe ActiveJobStatus::JobStatus do
+  let(:job_status) { described_class.new(status) }
 
-  describe "::get_status" do
+  context 'when queued' do
+    let(:status) { 'queued' }
 
-    describe "for a queued job" do
-      let(:job) { ActiveJobStatus::TrackableJob.new.enqueue }
+    it 'returns the correct state' do
+      expect(job_status.queued?).to eq true
+      expect(job_status.working?).to eq false
+      expect(job_status.completed?).to eq false
+      expect(job_status.empty?).to eq false
+      expect(job_status.status).to eq :queued
+    end
+  end
+
+  context 'when working' do
+    let(:status) { 'working' }
 
-      it "should return :queued" do
-        expect(ActiveJobStatus::JobStatus.get_status(job_id: job.job_id)).to eq :queued
-      end
+    it 'returns the correct state' do
+      expect(job_status.queued?).to eq false
+      expect(job_status.working?).to eq true
+      expect(job_status.completed?).to eq false
+      expect(job_status.empty?).to eq false
+      expect(job_status.status).to eq :working
     end
+  end
 
-    describe "for a complete job" do
+  context 'when completed' do
+    let(:status) { 'completed' }
 
-      let!(:job) { ActiveJobStatus::TrackableJob.perform_later }
-      sleep(10)
-      #clear_performed_jobs
-      it "should return :complete", pending: true do
-        expect(ActiveJobStatus::JobStatus.get_status(job_id: job.job_id)).to be_nil
-      end
+    it 'returns the correct state' do
+      expect(job_status.queued?).to eq false
+      expect(job_status.working?).to eq false
+      expect(job_status.completed?).to eq true
+      expect(job_status.empty?).to eq false
+      expect(job_status.status).to eq :completed
     end
   end
-end
 
+  context 'when nil' do
+    let(:status) { nil }
+
+    it 'returns the correct state' do
+      expect(job_status.queued?).to eq false
+      expect(job_status.working?).to eq false
+      expect(job_status.completed?).to eq false
+      expect(job_status.empty?).to eq true
+      expect(job_status.status).to eq nil
+    end
+  end
+end

data/spec/job_tracker_spec.rb

@@ -1,29 +1,53 @@
 require "spec_helper"
 
 describe ActiveJobStatus::JobTracker do
-
   let!(:store) { ActiveJobStatus.store = new_store }
-  let(:job) { ActiveJobStatus::TrackableJob.new.enqueue }
+  let(:job_id) { 'j0b-1d' }
+  let(:tracker) { described_class.new(job_id: job_id) }
+
+  describe "#enqueued" do
+    it "starts tracking the job" do
+      tracker.enqueued
+      expect(store.fetch(job_id)).to eq "queued"
+    end
 
-  describe "::enqueue" do
-    it "should enqueue a job" do
-      ActiveJobStatus::JobTracker.enqueue(job_id: job.job_id)
-      expect(store.fetch(job.job_id)).to eq "queued"
+    context 'with default expiration period' do
+      before { ActiveJobStatus.expiration = nil }
+
+      it 'expires in 72 hours' do
+        expect(store).to receive(:write).with(job_id, "queued", expires_in: 72.hours)
+        tracker.enqueued
+      end
+    end
+
+    context 'with default expiration period' do
+      before { ActiveJobStatus.expiration = 10.seconds }
+
+      it 'expires in the given period' do
+        expect(store).to receive(:write).with(job_id, "queued", expires_in: 10.seconds)
+        tracker.enqueued
+      end
     end
   end
 
-  describe "::update" do
-    it "should update a job status" do
-      ActiveJobStatus::JobTracker.update(job_id: job.job_id, status: :working)
-      expect(store.fetch(job.job_id)).to eq "working"
+  describe "#performing" do
+    it "updates the job status" do
+      tracker.performing
+      expect(store.fetch(job_id)).to eq "working"
     end
   end
 
-  describe "::remove" do
-    it "should remove the job from the cache store" do
-      ActiveJobStatus::JobTracker.remove(job_id: job.job_id)
-      expect(store.fetch(job.job_id)).to eq nil
+  describe "#completed" do
+    it "updates the job status" do
+      tracker.completed
+      expect(store.fetch(job_id)).to eq "completed"
     end
   end
-end
 
+  describe "#deleted" do
+    it "removes the job from the store" do
+      tracker.deleted
+      expect(store.fetch(job_id)).to eq nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -13,6 +13,6 @@ RSpec.configure do |c|
   c.include Helpers
 end
 
-if defined? ActiveSupport::Cache::RedisStore
+if defined? ActiveSupport::Cache::RedisStore || defined? ActiveSupport::Cache::ReadthisStore
   require "active_job_status/redis"
 end

data/spec/support/helpers.rb

@@ -3,6 +3,9 @@ module Helpers
     if defined? ActiveSupport::Cache::RedisStore
       puts "Using RedisStore"
       ActiveSupport::Cache::RedisStore.new
+    elsif defined? ActiveSupport::Cache::ReadthisStore
+      puts "Using ReadthisStore"
+      ActiveSupport::Cache::ReadthisStore.new
     else
       puts "Using MemoryStore"
       ActiveSupport::Cache::MemoryStore.new

data/spec/support/time_helpers.rb

@@ -1,4 +1,4 @@
-if defined? ActiveSupport::Cache::RedisStore
+if defined? ActiveSupport::Cache::RedisStore || defined? ActiveSupport::Cache::ReadthisStore
   # For redis we need to sleep to test
   def travel(interval)
     sleep interval

data/spec/trackable_job_spec.rb

@@ -1,21 +1,40 @@
 require "spec_helper"
 
 describe ActiveJobStatus::TrackableJob do
+  class DummyJob < ActiveJobStatus::TrackableJob
+    def perform; end;
+  end
 
-  describe "#initialize" do
-
-    let(:trackable_job) { ActiveJobStatus::TrackableJob.new }
+  let(:job) { DummyJob.new }
 
-    it "should create an object" do
-      expect(trackable_job).to be_an_instance_of ActiveJobStatus::TrackableJob
+  describe 'queueing' do
+    it "should have a job id" do
+      expect(job.job_id).to_not be_blank
     end
   end
 
-  describe 'queueing' do
-    let(:trackable_job) { ActiveJobStatus::TrackableJob.new.enqueue }
+  describe 'tracking hooks' do
+    let(:job_tracker) { instance_double(ActiveJobStatus::JobTracker) }
 
-    it "should have a job id" do
-      expect(trackable_job.job_id).to_not be_blank
+    before do
+      allow(job).to receive(:job_id) { 'j0b-1d' }
+    end
+
+    describe 'before enqueue' do
+      it 'starts to track the job with JobTracker' do
+        expect(ActiveJobStatus::JobTracker).to receive(:new).with(job_id: 'j0b-1d') { job_tracker }
+        expect(job_tracker).to receive(:enqueued)
+        job.enqueue
+      end
+    end
+
+    describe 'before/after perform' do
+      it 'updates the job status with JobTracker and then remove it' do
+        expect(ActiveJobStatus::JobTracker).to receive(:new).with(job_id: 'j0b-1d') { job_tracker }
+        expect(job_tracker).to receive(:performing)
+        expect(job_tracker).to receive(:completed)
+        job.perform_now
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_job_status
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Brad Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,28 +70,28 @@ dependencies:
   name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '4.2'
 description: Job status and batches for ActiveJob. Create trackable jobs, check their
@@ -114,6 +114,7 @@ files:
 - gemfiles/redis-activesupport.gemfile
 - lib/active_job_status.rb
 - lib/active_job_status/configure_redis.rb
+- lib/active_job_status/hooks.rb
 - lib/active_job_status/job_batch.rb
 - lib/active_job_status/job_status.rb
 - lib/active_job_status/job_tracker.rb