active_job_status 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ea8bac2bfeb93d6844f4771f4bf9706735831ce
-  data.tar.gz: 176590db71f11445b8fc2a82b9b2ff53af8fc65e
+  metadata.gz: 0b846ef69f7e610e0606b9bce25fb64edc49f1aa
+  data.tar.gz: bd3674f5d7c02c2d7ff7b2a935c3dc2920333bdc
 SHA512:
-  metadata.gz: 8baecc6e6ab0a989125c51c35aa1c17fd0a4de621b1263e7b2bf8f5f8e03b5717732e3745878c72c8b1380990ab1f29e8fb0197d40e75cb5f9861c08fba2b952
-  data.tar.gz: e3a0a23cc6dd05e7c2be3175f521c4d71abe39e3f182577e55089d0801c5c61e11c9574c882e54d65f0aa8ec4727b979517a1bac5e2698ce5df7437174516273
+  metadata.gz: de63ad633ce940138e4255fd0484c7025d5e14034df2398f81f0202429a38e8a9fb1f2b4a432a4251a49aa6dfa772a06e696df5100bb47116bb370a805781be4
+  data.tar.gz: 385e25254035bfd3f95d7652ac730df93427655b1d8a27dc896646121b7c835e6eed520bcee180619d9147a1642cd3663522375d62c6639be2a105214a4a164f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # ActiveJobStatus
 
+## 0.0.5
+- Use ActiveSupport::Cache instead of Redis, reducing dependencies. Changes
+  from Gabe Kopley.
+
 ## 0.0.4
 - Change name of JobStatus::get_status argument batch_key to be batch_id
 - Add changelog

data/README.md

@@ -8,10 +8,11 @@ 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).
 
-This gem uses ActiveJob callbacks to set simple Redis values to track job status
-and batches of jobs. To prevent it from taking over all of your Redis, both jobs
+This gem uses ActiveJob callbacks to set simple ActiveSupport::Cache
+values to track job status
+and batches of jobs. To prevent it from taking over all of your memory, both jobs
 and batch tracking information expires in 72 hours. Currently you can set
-batches to expire at a different interval, but not jobs. 
+batches to expire at a different interval, but not jobs.
 
 ## Installation
 
@@ -29,6 +30,15 @@ Or install it yourself as:
 
     $ gem install active_job_status
 
+## 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
+
+    ActiveJobStatus.store = ActiveSupport::Cache::MemoryStore.new
+
 ## Usage
 
 Have your jobs descend from TrackableJob instead of ActiveJob::Base

data/active_job_status.gemspec

@@ -22,8 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
-  spec.add_development_dependency "mock_redis", "~>0.14"
 
   spec.add_runtime_dependency "activejob", "~>4.2"
-  spec.add_runtime_dependency "redis", "~> 3.2"
+  spec.add_runtime_dependency "activesupport", "~>4.2"
 end

data/lib/active_job_status.rb

@@ -3,18 +3,10 @@ require "active_job_status/job_tracker"
 require "active_job_status/job_status"
 require "active_job_status/job_batch"
 require "active_job_status/version"
-require "redis"
 
 module ActiveJobStatus
-
-  @@redis = Redis.new
-
-  def self.redis= (redis)
-    @@redis = redis
-  end
-
-  def self.redis
-    @@redis
+  class << self
+    attr_accessor :store
   end
 end
 

data/lib/active_job_status/job_batch.rb

@@ -9,14 +9,15 @@ module ActiveJobStatus
       @batch_id = batch_id
       @job_ids = job_ids
       @expire_in = expire_in
-      ActiveJobStatus.redis.del(@batch_id) # delete any old batches
-      ActiveJobStatus.redis.sadd(@batch_id, @job_ids)
-      ActiveJobStatus.redis.expire(@batch_id, @expire_in)
+      ActiveJobStatus.store.delete(@batch_id) # delete any old batches
+      ActiveJobStatus.store.write(@batch_id, @job_ids, expires_in: @expire_in)
     end
 
     def add_jobs(job_ids:)
       @job_ids = @job_ids + job_ids
-      ActiveJobStatus.redis.sadd(@batch_id, 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)
     end
 
     def completed?
@@ -28,7 +29,7 @@ module ActiveJobStatus
     end
 
     def self.find(batch_id:)
-      ActiveJobStatus.redis.smembers(batch_id)
+      ActiveJobStatus.store.fetch(batch_id).to_a
     end
   end
 end

data/lib/active_job_status/job_status.rb

@@ -3,7 +3,7 @@ module ActiveJobStatus
     # Provides a way to check on the status of a given job
 
     def self.get_status(job_id:)
-      status = ActiveJobStatus.redis.get(job_id)
+      status = ActiveJobStatus.store.fetch(job_id)
       status ? status.to_sym : nil
     end
   end

data/lib/active_job_status/job_tracker.rb

@@ -1,19 +1,17 @@
 module ActiveJobStatus
   module JobTracker
     # Provides methods to CRUD job status records in Redis
-    require "redis"
 
     def self.enqueue(job_id:)
-      ActiveJobStatus.redis.set(job_id, "queued")
-      ActiveJobStatus.redis.expire(job_id, 259200)
+      ActiveJobStatus.store.write(job_id, "queued", expires_in: 259200)
     end
 
     def self.update(job_id:, status:)
-      ActiveJobStatus.redis.set(job_id, status.to_s)
+      ActiveJobStatus.store.write(job_id, status.to_s)
     end
 
     def self.remove(job_id:)
-      ActiveJobStatus.redis.del(job_id)
+      ActiveJobStatus.store.delete(job_id)
     end
   end
 end

data/lib/active_job_status/version.rb

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

data/spec/job_batch_spec.rb

@@ -4,7 +4,9 @@ describe ActiveJobStatus::JobBatch do
 
   let!(:batch_id) { Time.now }
 
-  let!(:redis) { ActiveJobStatus.redis }
+  let!(:store) {
+    ActiveJobStatus.store = ActiveSupport::Cache::MemoryStore.new
+  }
 
   let!(:job1) { TrackableJob.perform_later }
   let!(:job2) { TrackableJob.perform_later }
@@ -22,9 +24,9 @@ describe ActiveJobStatus::JobBatch do
     it "should create an object" do
       expect(batch).to be_an_instance_of ActiveJobStatus::JobBatch
     end
-    it "should create a redis set" do
+    it "should write to the cache store" do
       first_jobs.each do |job_id|
-        expect(redis.smembers(batch_id)).to include job_id
+        expect(store.fetch(batch_id)).to include job_id
       end
     end
   end
@@ -41,15 +43,15 @@ describe ActiveJobStatus::JobBatch do
 
   describe "#completed?" do
     it "should be false when jobs are queued" do
-      update_redis(id_array: total_jobs, job_status: :queued)
+      update_store(id_array: total_jobs, job_status: :queued)
       expect(batch.completed?).to be_falsey
     end
     it "should be false when jobs are working" do
-      update_redis(id_array: total_jobs, job_status: :working)
+      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
-      clear_redis(id_array: total_jobs)
+      clear_store(id_array: total_jobs)
       expect(batch.completed?).to be_truthy
     end
   end
@@ -79,7 +81,7 @@ describe ActiveJobStatus::JobBatch do
       ActiveJobStatus::JobBatch.new(batch_id: "expiry",
                                     job_ids: first_jobs,
                                     expire_in: 1)
-      sleep 2
+      sleep 1 # TODO replace with timecop, if possible
       expect(ActiveJobStatus::JobBatch.find(batch_id: "expiry")).to be_empty
 
     end
@@ -87,15 +89,15 @@ describe ActiveJobStatus::JobBatch do
 
   ##### HELPERS
 
-  def update_redis(id_array: [], job_status: :queued)
+  def update_store(id_array: [], job_status: :queued)
     id_array.each do |id|
-      redis.set(id, job_status.to_s)
+      store.write(id, job_status.to_s)
     end
   end
 
-  def clear_redis(id_array: [])
+  def clear_store(id_array: [])
     id_array.each do |id|
-      redis.del(id)
+      store.delete(id)
     end
   end
 end

data/spec/job_tracker_spec.rb

@@ -2,27 +2,29 @@ require "spec_helper"
 
 describe ActiveJobStatus::JobTracker do
 
-  let!(:redis) { ActiveJobStatus.redis }
+  let!(:store) {
+    ActiveJobStatus.store = ActiveSupport::Cache::MemoryStore.new
+  }
   let(:job) { TrackableJob.new.enqueue }
 
   describe "::enqueue" do
     it "should enqueue a job" do
       ActiveJobStatus::JobTracker.enqueue(job_id: job.job_id)
-      expect(redis.get(job.job_id)).to eq "queued"
+      expect(store.fetch(job.job_id)).to eq "queued"
     end
   end
 
   describe "::update" do
     it "should update a job status" do
       ActiveJobStatus::JobTracker.update(job_id: job.job_id, status: :working)
-      expect(redis.get(job.job_id)).to eq "working"
+      expect(store.fetch(job.job_id)).to eq "working"
     end
   end
 
   describe "::remove" do
-    it "should remove the redis key" do
+    it "should remove the job from the cache store" do
       ActiveJobStatus::JobTracker.remove(job_id: job.job_id)
-      expect(redis.get(job.job_id)).to eq nil
+      expect(store.fetch(job.job_id)).to eq nil
     end
   end
 end

data/spec/spec_helper.rb

@@ -3,6 +3,3 @@ CodeClimate::TestReporter.start
 require "active_job_status"
 include ActiveJob::TestHelper
 ActiveJob::Base.queue_adapter = :test
-require "mock_redis"
-ActiveJobStatus.redis = MockRedis.new
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_job_status
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Brad Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: mock_redis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement
@@ -95,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
 description: Job status and batches for ActiveJob. Create trackable jobs, check their
   status, and batch them together.
 email: