job_status 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37af72829cb512c9afb5f3219acdbca2bfb0de16
+  data.tar.gz: 23e586a7d4077ff2f080578db7e18fd4ab3b6322
+SHA512:
+  metadata.gz: 7a9b0936d76c9829b6632edccc3344a73bffbd512b70ba016c491cc46d7da6853ef43d1479f3948d0cecc0fe92339dddfa1520ecd5643c94e4d7fc488cc13be9
+  data.tar.gz: 71b93c5aa0130bfd66a9ee847605658854e7ee01a4f0ef9df6687e8a826790eaa9b687fc663f48954e2a360f252f04e7c5889f1299d50bf70eabfac471fa87b9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/README.md

@@ -0,0 +1,80 @@
+# ActiveJob Status
+
+Provides interface for ActiveJob to allow the passing of status information for running jobs.
+
+This gem uses callbacks implemented within ActiveJob and ActiveSupport::Cache to values to track job status and allow the passing of job completion information.
+
+Cached information is set to expire after 72 hours to prevent memory exhaustion issues.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'job_status'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install job_status
+
+## Configuration
+
+JobStatus needs to have a store configured to be used for the cache. Any ActiveSupport::Cache store is acceptable. The simplest to use is `ActiveSupport::Cache::MemoryStore`, to use the store configure an initializer within you application to set the store.
+
+```ruby
+# config/initializers/active_job_status.rb
+JobStatus.store = ActiveSupport::Cache::MemoryStore.new
+```
+
+Other memory stores are available, for example it is possible to use the Redis based store or MemCache based store.
+
+## Usage
+
+Create ActiveJob worker as normal and add the callback handlers and class methods for reporting status.
+
+```ruby
+class MyJob < ActiveJob::Base
+  include JobStatus::TrackedJob
+
+  queue_as :urgent
+
+  def perform(*args)
+    # Set the total for a percentage
+    total(job_id: @job_id, total: 100)
+
+    # Do Stuff...
+    # Set current status through
+    at(job_id: @job_id, at: 95)
+
+    # Store data to be retrieved
+    store(job_id: @job_id, store: [{test: 1, name: "test"},{test: 2, name: "test 2"}])
+  end
+end
+```
+
+### Job Status
+
+You can check the status of the job using the ActiveJob job_id.
+
+```ruby
+my_job = MyJob.perform_later
+JobStatus::Status.get_status(job_id: my_job.job_id)
+# => :queued, :working, :completed
+```
+
+More information can be found in the docs.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/job_status.

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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "job_status"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,9 @@
+machine:
+  ruby:
+    version: 2.1.5
+database:
+  override:
+    - echo 'no database'
+dependencies:
+  pre:
+    - gem install bundler

data/job_status.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'job_status/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "job_status"
+  spec.version       = JobStatus::VERSION
+  spec.authors       = ["Stephen Kapp"]
+  spec.email         = ["mort666@virus.org"]
+
+  spec.summary       = %q{ActiveJob Status Extension}
+  spec.description   = %q{Provide an interactive status interface for ActiveJob, uses ActiveSupport::Cache to provide store for status information}
+  spec.homepage      = "http://github.com/mort666/job_status"
+  spec.license       = "Apache-2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activejob'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

data/lib/job_status/status.rb

@@ -0,0 +1,62 @@
+module JobStatus
+  #
+  # Status Module, retrieve the status information from the store
+  #
+  module Status
+    #
+    # Get the Status from the store
+    #
+    # @param job_id [String] ActiveJob ID to query the store for
+    # @return [Symbol] status Returns status possible valuds
+    #   :queued, :working, :completed
+    #
+    def self.get_status(job_id:)
+      status = JobStatus.store.fetch(job_id)
+      status ? status[:status] : nil
+    end
+
+    #
+    # Get the current progress from the store
+    #
+    # @param job_id [String] ActiveJob ID to query the store for
+    # @return [Integer] at Value stored by the work for the progress
+    #
+    def self.at(job_id:)
+      status = JobStatus.store.fetch(job_id)
+      status ? status[:at] : nil
+    end
+
+    #
+    # Get the stored data from the store
+    #
+    # @param job_id [String] ActiveJob ID to query the store for
+    # @return returns the stored data, could be any serializable object
+    #
+    def self.store(job_id:)
+      status = JobStatus.store.fetch(job_id)
+      status ? status[:store] : nil
+    end
+
+    #
+    # Get the Total from the store
+    #
+    # @param job_id [String] ActiveJob ID to query the store for
+    # @return [Integer] total Returns total used for the percentage
+    #
+    def self.total(job_id:)
+      status = JobStatus.store.fetch(job_id)
+      status ? status[:total] : nil
+    end
+
+    #
+    # Get the All Data from the store
+    #
+    # @param job_id [String] ActiveJob ID to query the store for
+    # @return returns all information held in the store for the job_id
+    #
+    def self.get_all(job_id:)
+      status = JobStatus.store.fetch(job_id)
+      status ? status : nil
+    end
+  end
+end

data/lib/job_status/tracked_job.rb

@@ -0,0 +1,67 @@
+module JobStatus
+  #
+  # Methods to be included within a worker when this module is used with the
+  # include keyword
+  #
+  module TrackedJob
+    #
+    # Setup the callbacks within the worker class
+    #
+    # @param base base class which will be extended by this module
+    #
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval do
+        before_enqueue { JobStatus::Tracker.enqueue(job_id: @job_id) }
+
+        before_perform { JobStatus::Tracker.update(job_id: @job_id, status: :working ) }
+
+        after_perform { JobStatus::Tracker.update(job_id: @job_id, status: :completed ) }
+      end
+    end
+
+    #
+    # Store the current position
+    #
+    # @param job_id [String] ActiveJob job_id to attach information to in storage
+    # @param at [Integer] Value to store for the current position
+    #
+    def at(job_id:, at:)
+      storage(job_id, :at, at)
+    end
+
+    #
+    # Store the the total for the job
+    #
+    # @param job_id [String] ActiveJob job_id to attach information to in storage
+    # @param total [Integer] Value to store for the total positions
+    #
+    def total(job_id:, total:)
+      storage(job_id, :total, total)
+    end
+
+    #
+    # Store data for the provided job_id
+    #
+    # @param job_id [String] ActiveJob job_id to attach information to in storage
+    # @param store [Object] Data to be save within the storage, can be any serializable object
+    #
+    def store(job_id:, store:)
+      storage(job_id, :store, store)
+    end
+
+    private
+    #
+    # Interact with the storage to make the save while preserving previous contents
+    #
+    def storage(job_id, type, value)
+      cache = JobStatus.store.fetch(job_id)
+      cache[type] = value
+      JobStatus.store.write(job_id, cache)
+    end
+
+    # Class Methods to be included
+    module ClassMethods
+    end
+  end
+end

data/lib/job_status/tracker.rb

@@ -0,0 +1,35 @@
+module JobStatus
+  #
+  # Tracking routines used by the callbacks
+  #
+  module Tracker
+    #
+    # Sets the initial queued worker status and sets the expiry
+    #
+    # @param job_id [String] ActiveJob ID to use as the key in storage
+    #
+    def self.enqueue(job_id:)
+      JobStatus.store.write(job_id, {status: :queued, at: 0, total: 100}, expires_in: 259200)
+    end
+
+    #
+    # Stores the current status within the storage
+    #
+    # @param job_id [String] ActiveJob ID to use as the key in storage
+    #
+    def self.update(job_id:, status:)
+      cache = JobStatus.store.fetch(job_id)
+      cache[:status] = status
+      JobStatus.store.write(job_id, cache)
+    end
+
+    #
+    # Removes any information from the cache for the given job_id
+    #
+    # @param job_id [String] ActiveJob ID to use as the key in storage
+    #
+    def self.remove(job_id:)
+      JobStatus.store.delete(job_id)
+    end
+  end
+end

data/lib/job_status/version.rb

@@ -0,0 +1,7 @@
+#
+# ActiveJob Status Module Top Level Namespace
+#
+module JobStatus
+  # Version Number
+  VERSION = "0.1.0"
+end

data/lib/job_status.rb

@@ -0,0 +1,22 @@
+require 'active_job'
+
+require 'job_status/tracker'
+require 'job_status/tracked_job'
+require 'job_status/status'
+
+require "job_status/version"
+
+#
+# ActiveJob Status Module Top Level Namespace
+#
+module JobStatus
+  #
+  # Adds the storage for the Cache
+  #
+  # @attr store storage for the ActiveSupport::Cache cache handler
+  #   Options include ActiveSupport::Cache::MemoryStore
+  #                   ActiveSupport::Cache::RedisStore
+  class << self
+    attr_accessor :store
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: job_status
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Kapp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provide an interactive status interface for ActiveJob, uses ActiveSupport::Cache
+  to provide store for status information
+email:
+- mort666@virus.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- job_status.gemspec
+- lib/job_status.rb
+- lib/job_status/status.rb
+- lib/job_status/tracked_job.rb
+- lib/job_status/tracker.rb
+- lib/job_status/version.rb
+homepage: http://github.com/mort666/job_status
+licenses:
+- Apache-2.0
+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.3
+signing_key: 
+specification_version: 4
+summary: ActiveJob Status Extension
+test_files: []
+has_rdoc: