active_job_status 0.0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b846ef69f7e610e0606b9bce25fb64edc49f1aa
-  data.tar.gz: bd3674f5d7c02c2d7ff7b2a935c3dc2920333bdc
+  metadata.gz: cc15ebe7a3c29ec3e37308d2e83d7c4689af9a0f
+  data.tar.gz: a2e70829324e590e583c1a41c8da55407d2ad243
 SHA512:
-  metadata.gz: de63ad633ce940138e4255fd0484c7025d5e14034df2398f81f0202429a38e8a9fb1f2b4a432a4251a49aa6dfa772a06e696df5100bb47116bb370a805781be4
-  data.tar.gz: 385e25254035bfd3f95d7652ac730df93427655b1d8a27dc896646121b7c835e6eed520bcee180619d9147a1642cd3663522375d62c6639be2a105214a4a164f
+  metadata.gz: 9f9a7e772e739f48e83a783a5b820963de6a16657f96f4617608c9ffbe3abc58e5ba1f0b92c9aa9521fe7d483dcb0dd2fc653bc578a5ce238757c60e12a32dc7
+  data.tar.gz: ab0a3f2f6d4abe1ab96a07376bae8aa7919733926dea32cb890d330eb7ff77386711402a71186cdef450c89a78bb3a2df90a8195dd6961a2222cf3831fb8bac7

data/.gitignore

@@ -1,6 +1,7 @@
 /.bundle/
 /.yardoc
 /Gemfile.lock
+/gemfiles/*.lock
 /_yardoc/
 /coverage/
 /doc/

data/.travis.yml

@@ -3,6 +3,11 @@ cache: bundler
 rvm:
 - 2.2.0
 script: bundle exec rake
+services:
+  - redis
+gemfile:
+  - Gemfile
+  - gemfiles/redis-activesupport.gemfile
 notifications:
   email:
     recipients:

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # ActiveJobStatus
 
+## 1.0.0
+- Move TrackableJob inside ActiveJobStatus namespace. Bump version to 1.0.0, as
+  this may be a breaking change for some users. 
+
 ## 0.0.5
 - Use ActiveSupport::Cache instead of Redis, reducing dependencies. Changes
   from Gabe Kopley.

data/README.md

@@ -4,9 +4,7 @@
 
 # ActiveJobStatus
 
-Uses Redis to provide simple job status information for ActiveJob. This is a
-work in progress! Version 0.1.0 will probably be the first usable version. Until
-then please expect frequent breaking changes, chaos, etc (Jan. 2015).
+Provides simple job status information for ActiveJob. 
 
 This gem uses ActiveJob callbacks to set simple ActiveSupport::Cache
 values to track job status
@@ -32,29 +30,46 @@ Or install it yourself as:
 
 ## Configuration
 
-You need to tell ActiveJobStatus about your memory store. This is because
-we anticipate including options to use different key value stores. For now
-we only support ActiveSupport::Cache, so put this in an inializer. If you are
-using Rails, you could put this in config/initializers/active_job_status.rb
+You need to tell ActiveJobStatus about your memory store. By default, tell
+ActiveJobStatus to use Rails' built in memory store:
 
+    # config/initializers/active_job_status.rb
     ActiveJobStatus.store = ActiveSupport::Cache::MemoryStore.new
 
+If you are using Resque or Sidekiq, or have Redis in your stack already for 
+another reason, it's a good idea to tell ActiveJobStatus to use Redis for 
+storing job metadata. To do so, you'll first need to configure
+ActiveSupport::Cache to use Redis for it's store 
+(perhaps by using [this gem](https://github.com/redis-store/redis-rails)). Then
+use the following initializer to tell ActiveJob to use the proper store.
+ActiveJob status will detect Redis and use some nice optimizations.
+
+    # config/initializers/active_job_status.rb
+    ActiveJobStatus.store = ActiveSupport::Cache::RedisStore.new
+
 ## Usage
 
-Have your jobs descend from TrackableJob instead of ActiveJob::Base
+Have your jobs inheret from ActiveJobStatus::TrackableJob instead of ActiveJob::Base:
+
+*Note! Previous versions of this gem did not namespace TrackableJob inside of
+ActiveJob Status -- it was in the global namespace. If
+upgrading from versions < 1.0, you may need to update your code.*
 
-    class MyJob < TrackableJob
+    class MyJob < ActiveJobStatus::TrackableJob
     end
 
+### Job Status
+
 Check the status of a job using the ActiveJob job_id. Status of a job will only
 be available for 72 hours after the job is queued. For right now you can't
-change that
+change that.
 
     my_job = MyJob.perform_later
     ActiveJobStatus::JobStatus.get_status(job_id: my_job.job_id)
     # => :queued, :working, :complete
 
-Create job batches You an use any key you want (for example, you might use a 
+### Job Batches
+For job batches you an use any key you want (for example, you might use a 
 primary key or UUID from your database). If another batch with the same key
 exists, its jobs will be overwritten with the supplied list.
 
@@ -71,24 +86,28 @@ You can change that by passing the initalizer an integer value (in seconds).
                                              job_ids: my_jobs,
                                              expire_in: 500000)
 
-You can easily add jobs to the batch.
+You can easily add jobs to the batch:
 
     new_jobs = [some_new_job.job_id, another_new_job.job_id]
     my_batch.add_jobs(job_ids: new_jobs)
 
-And you can ask the batch if all the jobs are completed or not.
+And you can ask the batch if all the jobs are completed or not:
 
     my_batch.completed?
     # => true, false
 
-You can ask the batch for other bits of information.
+You can ask the batch for other bits of information:
 
     batch.batch_id
     # => "230923asdlkj230923"
     batch.job_ids
     # => ["b67af7a0-3ed2-4661-a2d5-ff6b6a254886", "6c0216b9-ea0c-4ee9-a3b2-501faa919a66"]
-    batch.expire_in
-    # => 259200
+
+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 
+return an ActiveJobStatus::JobBatch object.
 
 ## Contributing
 

data/active_job_status.gemspec

@@ -25,4 +25,8 @@ Gem::Specification.new do |spec|
 
   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. " \
+                              "You will need update your code."
 end

data/gemfiles/redis-activesupport.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: "#{__dir__}/.."
+
+gem "redis-activesupport"

data/lib/active_job_status/configure_redis.rb

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

data/lib/active_job_status/job_batch.rb

@@ -3,21 +3,34 @@ module ActiveJobStatus
 
     attr_reader :batch_id
     attr_reader :job_ids
-    attr_reader :expire_in
 
-    def initialize(batch_id:, job_ids:, expire_in: 259200)
+    def initialize(batch_id:, job_ids:, expire_in: 259200, store_data: true)
       @batch_id = batch_id
       @job_ids = job_ids
-      @expire_in = expire_in
+      # the store_data flag is used by the ::find method return a JobBatch
+      # object without re-saving the data
+      self.store_data(expire_in: expire_in) if store_data
+    end
+
+    def store_data(expire_in:)
       ActiveJobStatus.store.delete(@batch_id) # delete any old batches
-      ActiveJobStatus.store.write(@batch_id, @job_ids, expires_in: @expire_in)
+      if ActiveJobStatus.store.class.to_s == "ActiveSupport::Cache::RedisStore"
+        ActiveJobStatus.store.sadd(@batch_id, @job_ids)
+        ActiveJobStatus.store.expire(@batch_id, expire_in)
+      else
+        ActiveJobStatus.store.write(@batch_id, @job_ids, expires_in: expire_in)
+      end
     end
 
     def add_jobs(job_ids:)
       @job_ids = @job_ids + job_ids
-      # TODO re-optimize for redis store with sadd
-      existing_job_ids = ActiveJobStatus.store.fetch(@batch_id)
-      ActiveJobStatus.store.write(@batch_id, existing_job_ids.to_a | job_ids)
+      if ActiveJobStatus.store.class.to_s == "ActiveSupport::Cache::RedisStore"
+        # Save an extra redis query and perform atomic operation
+        ActiveJobStatus.store.sadd(@batch_id, job_ids)
+      else
+        existing_job_ids = ActiveJobStatus.store.fetch(@batch_id)
+        ActiveJobStatus.store.write(@batch_id, existing_job_ids.to_a | job_ids)
+      end
     end
 
     def completed?
@@ -29,7 +42,23 @@ module ActiveJobStatus
     end
 
     def self.find(batch_id:)
-      ActiveJobStatus.store.fetch(batch_id).to_a
+      if ActiveJobStatus.store.class.to_s == "ActiveSupport::Cache::RedisStore"
+        job_ids = ActiveJobStatus.store.smembers(batch_id)
+      else
+        job_ids = ActiveJobStatus.store.fetch(batch_id).to_a
+      end
+
+      if job_ids.any?
+        ActiveJobStatus::JobBatch.new(batch_id: batch_id,
+                                      job_ids: job_ids,
+                                      store_data: false)
+      end
+    end
+
+    private
+
+
+    def write(key, job_ids, expire_in=nil)
     end
   end
 end

data/lib/active_job_status/redis.rb

@@ -0,0 +1,20 @@
+module ActiveJobStatus
+  module Redis
+    def sadd(key, elements)
+      instrument(:sadd, key, elements: elements) do
+        @data.sadd key, elements
+      end
+    end
+
+    def smembers(key)
+      instrument(:smembers, key) do
+        @data.smembers key
+      end
+    end
+  end
+end
+
+ActiveSupport::Cache::RedisStore.include(
+  ActiveJobStatus::Redis
+)
+

data/lib/active_job_status/trackable_job.rb

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

data/lib/active_job_status/version.rb

@@ -1,3 +1,3 @@
 module ActiveJobStatus
-  VERSION = "0.0.5"
+  VERSION = "1.0.0"
 end

data/lib/active_job_status.rb

@@ -3,6 +3,7 @@ require "active_job_status/job_tracker"
 require "active_job_status/job_status"
 require "active_job_status/job_batch"
 require "active_job_status/version"
+require "active_job_status/configure_redis" if defined? Rails
 
 module ActiveJobStatus
   class << self

data/spec/job_batch_spec.rb

@@ -4,14 +4,12 @@ describe ActiveJobStatus::JobBatch do
 
   let!(:batch_id) { Time.now }
 
-  let!(:store) {
-    ActiveJobStatus.store = ActiveSupport::Cache::MemoryStore.new
-  }
+  let!(:store) { ActiveJobStatus.store = new_store }
 
-  let!(:job1) { TrackableJob.perform_later }
-  let!(:job2) { TrackableJob.perform_later }
-  let!(:job3) { TrackableJob.perform_later }
-  let!(:job4) { TrackableJob.perform_later }
+  let!(:job1) { ActiveJobStatus::TrackableJob.perform_later }
+  let!(:job2) { ActiveJobStatus::TrackableJob.perform_later }
+  let!(:job3) { ActiveJobStatus::TrackableJob.perform_later }
+  let!(:job4) { ActiveJobStatus::TrackableJob.perform_later }
 
   let!(:first_jobs) { [job1.job_id, job2.job_id] }
   let!(:addl_jobs) { [job3.job_id, job4.job_id] }
@@ -20,13 +18,22 @@ describe ActiveJobStatus::JobBatch do
   let!(:batch) { ActiveJobStatus::JobBatch.new(batch_id: batch_id,
                                               job_ids: first_jobs) }
 
+
   describe "#initialize" do
     it "should create an object" do
       expect(batch).to be_an_instance_of ActiveJobStatus::JobBatch
     end
     it "should write to the cache store" do
-      first_jobs.each do |job_id|
-        expect(store.fetch(batch_id)).to include job_id
+      expect(
+        ActiveJobStatus::JobBatch.find(batch_id: batch_id).job_ids
+      ).to match_array(first_jobs)
+    end
+  end
+
+  describe "#job_ids" do
+    describe "when jobs are present" do
+      it "should return an array of job ids" do
+        expect(batch.job_ids).to match_array(first_jobs)
       end
     end
   end
@@ -35,7 +42,7 @@ describe ActiveJobStatus::JobBatch do
     it "should add jobs to the set" do
       batch.add_jobs(job_ids: addl_jobs)
       total_jobs.each do |job_id|
-        expect(ActiveJobStatus::JobBatch.find(batch_id: batch_id)).to \
+        expect(ActiveJobStatus::JobBatch.find(batch_id: batch_id).job_ids).to \
           include job_id
       end
     end
@@ -57,16 +64,17 @@ describe ActiveJobStatus::JobBatch do
   end
 
   describe "::find" do
-    it "should return an array of jobs when a batch exists" do
-      expect(ActiveJobStatus::JobBatch.find(batch_id: batch_id)).to \
-        be_an_instance_of Array
-    end
-    it "should return the correct jobs" do
-      expect(ActiveJobStatus::JobBatch.find(batch_id: batch_id)).to \
-        eq first_jobs
+    describe "when a batch is present" do
+      it "should return a JobBatch object" do
+        expect(ActiveJobStatus::JobBatch.find(batch_id: batch_id)).to \
+          be_an_instance_of ActiveJobStatus::JobBatch
+      end
     end
-    it "should return nil when no batch exists" do
-      expect(ActiveJobStatus::JobBatch.find(batch_id: "45")).to eq []
+
+    describe "when no batch is present" do
+      it "should return nil" do
+        expect(ActiveJobStatus::JobBatch.find(batch_id: "baz")).to be_nil
+      end
     end
   end
 
@@ -81,9 +89,11 @@ describe ActiveJobStatus::JobBatch do
       ActiveJobStatus::JobBatch.new(batch_id: "expiry",
                                     job_ids: first_jobs,
                                     expire_in: 1)
-      sleep 1 # TODO replace with timecop, if possible
-      expect(ActiveJobStatus::JobBatch.find(batch_id: "expiry")).to be_empty
-
+      travel(2.seconds) do
+        expect(
+          ActiveJobStatus::JobBatch.find(batch_id: "expiry")
+        ).to be_nil
+      end
     end
   end
 
@@ -101,4 +111,3 @@ describe ActiveJobStatus::JobBatch do
     end
   end
 end
-

data/spec/job_status_spec.rb

@@ -5,7 +5,7 @@ describe ActiveJobStatus::JobStatus do
   describe "::get_status" do
 
     describe "for a queued job" do
-      let(:job) { TrackableJob.new.enqueue }
+      let(:job) { ActiveJobStatus::TrackableJob.new.enqueue }
 
       it "should return :queued" do
         expect(ActiveJobStatus::JobStatus.get_status(job_id: job.job_id)).to eq :queued
@@ -14,7 +14,7 @@ describe ActiveJobStatus::JobStatus do
 
     describe "for a complete job" do
 
-      let!(:job) { TrackableJob.perform_later }
+      let!(:job) { ActiveJobStatus::TrackableJob.perform_later }
       sleep(10)
       #clear_performed_jobs
       it "should return :complete", pending: true do

data/spec/job_tracker_spec.rb

@@ -2,10 +2,8 @@ require "spec_helper"
 
 describe ActiveJobStatus::JobTracker do
 
-  let!(:store) {
-    ActiveJobStatus.store = ActiveSupport::Cache::MemoryStore.new
-  }
-  let(:job) { TrackableJob.new.enqueue }
+  let!(:store) { ActiveJobStatus.store = new_store }
+  let(:job) { ActiveJobStatus::TrackableJob.new.enqueue }
 
   describe "::enqueue" do
     it "should enqueue a job" do

data/spec/spec_helper.rb

@@ -1,5 +1,18 @@
-require "codeclimate-test-reporter"
+require 'bundler'
+
+Bundler.require(:default, :development)
+
 CodeClimate::TestReporter.start
-require "active_job_status"
+Dir["#{__dir__}/support/*.rb"].each {|file| require file }
+
 include ActiveJob::TestHelper
+
 ActiveJob::Base.queue_adapter = :test
+
+RSpec.configure do |c|
+  c.include Helpers
+end
+
+if defined? ActiveSupport::Cache::RedisStore
+  require "active_job_status/redis"
+end

data/spec/support/helpers.rb

@@ -0,0 +1,11 @@
+module Helpers
+  def new_store
+    if defined? ActiveSupport::Cache::RedisStore
+      puts "Using RedisStore"
+      ActiveSupport::Cache::RedisStore.new
+    else
+      puts "Using MemoryStore"
+      ActiveSupport::Cache::MemoryStore.new
+    end
+  end
+end

data/spec/support/time_helpers.rb

@@ -0,0 +1,10 @@
+if defined? ActiveSupport::Cache::RedisStore
+  # For redis we need to sleep to test
+  def travel(interval)
+    sleep interval
+    yield
+  end
+else
+  require "active_support/testing/time_helpers"
+  include ActiveSupport::Testing::TimeHelpers
+end

data/spec/trackable_job_spec.rb

@@ -1,18 +1,18 @@
 require "spec_helper"
 
-describe TrackableJob do
+describe ActiveJobStatus::TrackableJob do
 
   describe "#initialize" do
 
-    let(:trackable_job) { TrackableJob.new }
+    let(:trackable_job) { ActiveJobStatus::TrackableJob.new }
 
     it "should create an object" do
-      expect(trackable_job).to be_an_instance_of TrackableJob
+      expect(trackable_job).to be_an_instance_of ActiveJobStatus::TrackableJob
     end
   end
 
   describe 'queueing' do
-    let(:trackable_job) { TrackableJob.new.enqueue }
+    let(:trackable_job) { ActiveJobStatus::TrackableJob.new.enqueue }
 
     it "should have a job id" do
       expect(trackable_job.job_id).to_not be_blank

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_job_status
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Brad Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2016-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,22 +110,28 @@ files:
 - README.md
 - Rakefile
 - active_job_status.gemspec
+- gemfiles/redis-activesupport.gemfile
 - lib/active_job_status.rb
+- lib/active_job_status/configure_redis.rb
 - lib/active_job_status/job_batch.rb
 - lib/active_job_status/job_status.rb
 - lib/active_job_status/job_tracker.rb
+- lib/active_job_status/redis.rb
 - lib/active_job_status/trackable_job.rb
 - lib/active_job_status/version.rb
 - spec/job_batch_spec.rb
 - spec/job_status_spec.rb
 - spec/job_tracker_spec.rb
 - spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/support/time_helpers.rb
 - spec/trackable_job_spec.rb
 homepage: https://github.com/cdale77/active_job_status
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: If updating from a version below 1.0, please note TrackabeJob
+  is now namespaced inside of ActiveJob. You will need update your code.
 rdoc_options: []
 require_paths:
 - lib
@@ -141,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Job status and batches for ActiveJob
@@ -150,4 +156,6 @@ test_files:
 - spec/job_status_spec.rb
 - spec/job_tracker_spec.rb
 - spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/support/time_helpers.rb
 - spec/trackable_job_spec.rb