active_job_status 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bacba651822dd7ae2550f7700b4553a05c586f9
-  data.tar.gz: 7e27e7ad71b23346ca96bc5adcabf57dce04c619
+  metadata.gz: 0f5b9c6307f29a9c2f63d672cb9e3df1ebc8803e
+  data.tar.gz: 400d59fc1f9d4b8d850f43e3e1faf7a356784242
 SHA512:
-  metadata.gz: 8111412adf2087716c7e6844b55e40f465d884ecdbad0f03ab54765a1bbdddc1ec5babb076ea74d490b6e8866cdbd6e041a0c364d938e63d422c60396d35298c
-  data.tar.gz: 7b9ec2dcd014c181d9e2035b21b7ac9cf798f7dde6458fee093c0879547875afec56aa57c10a8f99a7e040cc421cbf6df10ddf986db01495c3b471fb1213b5cf
+  metadata.gz: ebde3b55fb024aa7663618ae10602e174ff548edb8917aa20af92ebd933147fb9faca42612556b727aa95f050e194c0db57f6732a5d7a7124db4fa21690cd721
+  data.tar.gz: 65b0f469ebb6c015cb5f7683e28b9c55fab8cdcc2fc1ffa1f0da70e84b34e5f6315c8e04118d995267623aac38845141a949e31260b9a7e7059c23926f0fefea

data/README.md

@@ -4,7 +4,14 @@
 
 # ActiveJobStatus
 
-Uses Redis to provide simple job status information for ActiveJob.
+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
+and batch tracking information expires in 72 hours. Currently you can set
+batches to expire at a different interval, but not jobs. 
 
 ## Installation
 
@@ -29,34 +36,49 @@ Have your jobs descend from TrackableJob instead of ActiveJob::Base
     class MyJob < TrackableJob
     end
 
-Check the status of a job using the ActiveJob job_id
+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
 
     my_job = MyJob.perform_later
     ActiveJobStatus::JobStatus.get_status(job_id: my_job.job_id)
     # => :queued, :working, :complete
 
-Add jobs to batches. You an use any key you want (for example, you might use a 
-primary key or UUID from your database).
+Create 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.
 
     my_key = "230923asdlkj230923"
-    my_batch = ActiveJobStatus::JobBatch.new(batch_key: my_key)
+    my_jobs = [my_first_job.job_id, my_second_job.job_id]
+    my_batch = ActiveJobStatus::JobBatch.new(batch_key: my_key, job_ids: my_jobs)
 
-If you'd like you can pass an initial array of ActiveJob job_ids:
+Batches expire after 72 hours (259200 seconds).
+You can change that by passing the initalizer an integer value (in seconds).
 
     my_key = "230923asdlkj230923"
     my_jobs = [my_first_job.job_id, my_second_job.job_id]
-    my_batch = ActiveJobStatus::JobBatch.new(batch_key: my_key, job_ids: my_jobs)
+    my_batch = ActiveJobStatus::JobBatch.new(batch_key: my_key,
+                                             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.
+
+    batch.batch_key
+    # => "230923asdlkj230923"
+    batch.job_ids
+    # => ["b67af7a0-3ed2-4661-a2d5-ff6b6a254886", "6c0216b9-ea0c-4ee9-a3b2-501faa919a66"]
+    batch.expire_in
+    # => 259200
 
 ## Contributing
 

data/lib/active_job_status/job_batch.rb

@@ -1,16 +1,22 @@
 module ActiveJobStatus
   class JobBatch
 
-    def initialize(batch_key:, job_ids: [])
+    attr_reader :batch_key
+    attr_reader :job_ids
+    attr_reader :expire_in
+
+    def initialize(batch_key:, job_ids:, expire_in: 259200)
       @batch_key = batch_key
       @job_ids = job_ids
-
-      add_jobs(job_ids: @job_ids)
+      @expire_in = expire_in
+      ActiveJobStatus.redis.del(@batch_key) # delete any old batches
+      ActiveJobStatus.redis.sadd(@batch_key, @job_ids)
+      ActiveJobStatus.redis.expire(@batch_key, @expire_in)
     end
 
-    def add_jobs(job_ids: [])
-      @job_ids = @job_ids | job_ids
-      ActiveJobStatus.redis.sadd(@batch_key, @job_ids)
+    def add_jobs(job_ids:)
+      @job_ids = @job_ids + job_ids
+      ActiveJobStatus.redis.sadd(@batch_key, job_ids)
     end
 
     def completed?
@@ -20,6 +26,10 @@ module ActiveJobStatus
       end
       !job_statuses.any?
     end
+
+    def self.find(batch_key:)
+      ActiveJobStatus.redis.smembers(batch_key)
+    end
   end
 end
 

data/lib/active_job_status/job_tracker.rb

@@ -5,6 +5,7 @@ module ActiveJobStatus
 
     def self.enqueue(job_id:)
       ActiveJobStatus.redis.set(job_id, "queued")
+      ActiveJobStatus.redis.expire(job_id, 259200)
     end
 
     def self.update(job_id:, status:)

data/lib/active_job_status/version.rb

@@ -1,3 +1,3 @@
 module ActiveJobStatus
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/job_batch_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 describe ActiveJobStatus::JobBatch do
 
-  let!(:batch_key) { "mykey" }
+  let!(:batch_key) { Time.now }
 
   let!(:redis) { ActiveJobStatus.redis }
 
@@ -11,17 +11,19 @@ describe ActiveJobStatus::JobBatch do
   let!(:job3) { TrackableJob.perform_later }
   let!(:job4) { TrackableJob.perform_later }
 
-  let!(:batch) { ActiveJobStatus::JobBatch.new(batch_key: batch_key, 
-                                              job_ids: [job1.job_id, job2.job_id]) }
+  let!(:first_jobs) { [job1.job_id, job2.job_id] }
+  let!(:addl_jobs) { [job3.job_id, job4.job_id] }
+  let!(:total_jobs) { first_jobs + addl_jobs }
 
-  let!(:job_id_array) { [job1.job_id, job2.job_id, job3.job_id, job4.job_id] }
+  let!(:batch) { ActiveJobStatus::JobBatch.new(batch_key: batch_key,
+                                              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 create a redis set" do
-      [job1.job_id, job2.job_id].each do |job_id|
+      first_jobs.each do |job_id|
         expect(redis.smembers(batch_key)).to include job_id
       end
     end
@@ -29,28 +31,60 @@ describe ActiveJobStatus::JobBatch do
 
   describe "#add_jobs" do
     it "should add jobs to the set" do
-      batch.add_jobs(job_ids: [job3.job_id, job4.job_id])
-      job_id_array.each do |job_id|
-        expect(redis.smembers(batch_key)).to include job_id
+      batch.add_jobs(job_ids: addl_jobs)
+      total_jobs.each do |job_id|
+        expect(ActiveJobStatus::JobBatch.find(batch_key: batch_key)).to \
+          include job_id
       end
     end
   end
 
   describe "#completed?" do
     it "should be false when jobs are queued" do
-      update_redis(id_array: job_id_array, job_status: :queued)
+      update_redis(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: job_id_array, job_status: :working)
+      update_redis(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: job_id_array)
+      clear_redis(id_array: total_jobs)
       expect(batch.completed?).to be_truthy
     end
   end
 
+  describe "::find" do
+    it "should return an array of jobs when a batch exists" do
+      expect(ActiveJobStatus::JobBatch.find(batch_key: batch_key)).to \
+        be_an_instance_of Array
+    end
+    it "should return the correct jobs" do
+      expect(ActiveJobStatus::JobBatch.find(batch_key: batch_key)).to \
+        eq first_jobs
+    end
+    it "should return nil when no batch exists" do
+      expect(ActiveJobStatus::JobBatch.find(batch_key: "45")).to eq []
+    end
+  end
+
+  describe "expiring job" do
+    it "should allow the expiration time to be set in seconds" do
+      expect(ActiveJobStatus::JobBatch.new(batch_key: "newkey",
+                                            job_ids: first_jobs,
+                                            expire_in: 200000)).to \
+            be_an_instance_of ActiveJobStatus::JobBatch
+    end
+    it "should expire" do
+      ActiveJobStatus::JobBatch.new(batch_key: "expiry",
+                                    job_ids: first_jobs,
+                                    expire_in: 1)
+      sleep 2
+      expect(ActiveJobStatus::JobBatch.find(batch_key: "expiry")).to be_empty
+
+    end
+  end
+
   ##### HELPERS
 
   def update_redis(id_array: [], job_status: :queued)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_job_status
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Brad Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-04 00:00:00.000000000 Z
+date: 2015-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler