active_job_status 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5bacba651822dd7ae2550f7700b4553a05c586f9
+  data.tar.gz: 7e27e7ad71b23346ca96bc5adcabf57dce04c619
+SHA512:
+  metadata.gz: 8111412adf2087716c7e6844b55e40f465d884ecdbad0f03ab54765a1bbdddc1ec5babb076ea74d490b6e8866cdbd6e041a0c364d938e63d422c60396d35298c
+  data.tar.gz: 7b9ec2dcd014c181d9e2035b21b7ac9cf798f7dde6458fee093c0879547875afec56aa57c10a8f99a7e040cc421cbf6df10ddf986db01495c3b471fb1213b5cf

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store
+*.swp

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+cache: bundler
+rvm:
+- 2.2.0
+script: bundle exec rake
+notifications:
+  email:
+    recipients:
+    - cdale77@gmail.com
+    on_failure: change
+    on_success: never
+env:
+  global:
+    secure: MK+CWQzMGTGzDRGfwtkJoAySnjcmmbEF4Fl9DDRaUD0q/LGTEV3TrOo+/QAeT945Vbs+CRnSMdGmVdBsLLiGlU56SrLQs8cEI/m7KyDcMjHJfuSkV5hdoUxSGgvvDlhLAZHBhmBnDnuIB7s0ExCyyJGamPOoZbVNgLYpF0XnxsY=

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_job_status.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Brad Johnson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+[![Code Climate](https://codeclimate.com/github/cdale77/active_job_status/badges/gpa.svg)](https://codeclimate.com/github/cdale77/active_job_status)
+[![Test Coverage](https://codeclimate.com/github/cdale77/active_job_status/badges/coverage.svg)](https://codeclimate.com/github/cdale77/active_job_status)
+[![Build Status](https://travis-ci.org/cdale77/active_job_status.svg?branch=master)](https://travis-ci.org/cdale77/active_job_status)
+
+# ActiveJobStatus
+
+Uses Redis to provide simple job status information for ActiveJob.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_job_status'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_job_status
+
+## Usage
+
+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
+
+    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).
+
+    my_key = "230923asdlkj230923"
+    my_batch = ActiveJobStatus::JobBatch.new(batch_key: my_key)
+
+If you'd like you can pass an initial array of ActiveJob job_ids:
+
+    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)
+
+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
+
+    my_batch.completed?
+    # => true, false
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/active_job_status/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color']
+end
+
+task :default => :spec

data/active_job_status.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_job_status/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_job_status"
+  spec.version       = ActiveJobStatus::VERSION
+  spec.authors       = ["Brad Johnson"]
+  spec.email         = ["cdale77@gmail.com"]
+  spec.summary       = "Job status and batches for ActiveJob"
+  spec.description   = "Job status and batches for ActiveJob. Create trackable jobs, check their status, and batch them together."
+  spec.homepage      = "https://github.com/cdale77/active_job_status"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  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"
+end

data/lib/active_job_status.rb

@@ -0,0 +1,20 @@
+require "active_job_status/trackable_job"
+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
+  end
+end
+

data/lib/active_job_status/job_batch.rb

@@ -0,0 +1,25 @@
+module ActiveJobStatus
+  class JobBatch
+
+    def initialize(batch_key:, job_ids: [])
+      @batch_key = batch_key
+      @job_ids = job_ids
+
+      add_jobs(job_ids: @job_ids)
+    end
+
+    def add_jobs(job_ids: [])
+      @job_ids = @job_ids | job_ids
+      ActiveJobStatus.redis.sadd(@batch_key, @job_ids)
+    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?
+    end
+  end
+end
+

data/lib/active_job_status/job_status.rb

@@ -0,0 +1,11 @@
+module ActiveJobStatus
+  module JobStatus
+    # 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 ? status.to_sym : nil
+    end
+  end
+end
+

data/lib/active_job_status/job_tracker.rb

@@ -0,0 +1,18 @@
+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")
+    end
+
+    def self.update(job_id:, status:)
+      ActiveJobStatus.redis.set(job_id, status.to_s)
+    end
+
+    def self.remove(job_id:)
+      ActiveJobStatus.redis.del(job_id)
+    end
+  end
+end

data/lib/active_job_status/trackable_job.rb

@@ -0,0 +1,11 @@
+require "active_job"
+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) }
+end
+
+

data/lib/active_job_status/version.rb

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

data/spec/job_batch_spec.rb

@@ -0,0 +1,68 @@
+require "spec_helper"
+
+describe ActiveJobStatus::JobBatch do
+
+  let!(:batch_key) { "mykey" }
+
+  let!(:redis) { ActiveJobStatus.redis }
+
+  let!(:job1) { TrackableJob.perform_later }
+  let!(:job2) { TrackableJob.perform_later }
+  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!(:job_id_array) { [job1.job_id, job2.job_id, job3.job_id, job4.job_id] }
+
+  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|
+        expect(redis.smembers(batch_key)).to include job_id
+      end
+    end
+  end
+
+  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
+      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)
+      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)
+      expect(batch.completed?).to be_falsey
+    end
+    it "should be true when jobs are completed" do
+      clear_redis(id_array: job_id_array)
+      expect(batch.completed?).to be_truthy
+    end
+  end
+
+  ##### HELPERS
+
+  def update_redis(id_array: [], job_status: :queued)
+    id_array.each do |id|
+      redis.set(id, job_status.to_s)
+    end
+  end
+
+  def clear_redis(id_array: [])
+    id_array.each do |id|
+      redis.del(id)
+    end
+  end
+end
+

data/spec/job_status_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+describe ActiveJobStatus::JobStatus do
+
+  describe "::get_status" do
+
+    describe "for a queued job" do
+      let(:job) { TrackableJob.new.enqueue }
+
+      it "should return :queued" do
+        expect(ActiveJobStatus::JobStatus.get_status(job_id: job.job_id)).to eq :queued
+      end
+    end
+
+    describe "for a complete job" do
+
+      let!(:job) { 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
+    end
+  end
+end
+

data/spec/job_tracker_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe ActiveJobStatus::JobTracker do
+
+  let!(:redis) { ActiveJobStatus.redis }
+  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"
+    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"
+    end
+  end
+
+  describe "::remove" do
+    it "should remove the redis key" do
+      ActiveJobStatus::JobTracker.remove(job_id: job.job_id)
+      expect(redis.get(job.job_id)).to eq nil
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+require "active_job_status"
+include ActiveJob::TestHelper
+ActiveJob::Base.queue_adapter = :test
+require "mock_redis"
+ActiveJobStatus.redis = MockRedis.new
+

data/spec/trackable_job_spec.rb

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

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: active_job_status
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Brad Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    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: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Job status and batches for ActiveJob. Create trackable jobs, check their
+  status, and batch them together.
+email:
+- cdale77@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_job_status.gemspec
+- lib/active_job_status.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/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/trackable_job_spec.rb
+homepage: https://github.com/cdale77/active_job_status
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Job status and batches for ActiveJob
+test_files:
+- spec/job_batch_spec.rb
+- spec/job_status_spec.rb
+- spec/job_tracker_spec.rb
+- spec/spec_helper.rb
+- spec/trackable_job_spec.rb