delayed_job_progress 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e03469840f266c87523e59b5c4232263b804b3b9
+  data.tar.gz: ba20030273160732952acb77144983b63dee21b2
+SHA512:
+  metadata.gz: 7e1b6d70e4f6e11c4d05cf2883c2433b9e5254843c72ae49bd6877d3eaed719504a8956e6e9990cd0cb02957359861ec0efa2a25dc9ed79c970308d424cbd903
+  data.tar.gz: f54c79cf7c973d2678e9c386c6696b814c6a64204e4b19eb2ec98f6031c79fe6d3f76c5fa137c6c2be2f0dccc353c8e97ab395ae91670bbf2696098a787621c8

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+tmp/

data/.travis.yml

@@ -0,0 +1,2 @@
+language: ruby
+rvm: 2.2.1

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in delayed_job_progress.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]
+

data/Gemfile.lock

@@ -0,0 +1,113 @@
+PATH
+  remote: .
+  specs:
+    delayed_job_progress (0.0.0)
+      delayed_job (>= 4.0)
+      delayed_job_active_record (>= 4.0)
+      rails (>= 4.0.0, < 5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.4)
+      actionpack (= 4.2.4)
+      actionview (= 4.2.4)
+      activejob (= 4.2.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.4)
+      actionview (= 4.2.4)
+      activesupport (= 4.2.4)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.4)
+      activesupport (= 4.2.4)
+      globalid (>= 0.3.0)
+    activemodel (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+    activerecord (4.2.4)
+      activemodel (= 4.2.4)
+      activesupport (= 4.2.4)
+      arel (~> 6.0)
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    delayed_job (4.0.6)
+      activesupport (>= 3.0, < 5.0)
+    delayed_job_active_record (4.0.3)
+      activerecord (>= 3.0, < 5.0)
+      delayed_job (>= 3.0, < 4.1)
+    erubis (2.7.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.6.1)
+    mini_portile (0.6.2)
+    minitest (5.8.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.4)
+      actionmailer (= 4.2.4)
+      actionpack (= 4.2.4)
+      actionview (= 4.2.4)
+      activejob (= 4.2.4)
+      activemodel (= 4.2.4)
+      activerecord (= 4.2.4)
+      activesupport (= 4.2.4)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.4)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.4)
+      actionpack (= 4.2.4)
+      activesupport (= 4.2.4)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    sprockets (3.3.3)
+      rack (~> 1.0)
+    sprockets-rails (2.3.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.10)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  delayed_job_progress!
+  sqlite3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Oleg
+
+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,87 @@
+# DelayedJobProgress
+[![Gem Version](https://img.shields.io/gem/v/delayed_job_progress.svg?style=flat)](http://rubygems.org/gems/delayed_job_progress) [![Gem Downloads](https://img.shields.io/gem/dt/delayed_job_progress.svg?style=flat)](http://rubygems.org/gems/delayed_job_progress) [![Build Status](https://img.shields.io/travis/GBH/delayed_job_progress.svg?style=flat)](https://travis-ci.org/GBH/delayed_job_progress)
+
+Extension for `Delayed::Job` that allows better tracking of jobs!
+
+## Setup
+
+* add to Gemfile: `gem 'delayed_job_progress'`
+* `bundle install`
+* `rails g delayed_job:progress`
+* `rake db:migrate`
+
+## Configuration and Usage
+
+Consider this:
+
+```ruby
+class User < ActiveRecord::Base
+  # convenient relationship to grab associated jobs
+  has_many :jobs, :as => :record, :class_name => 'DelayedJob'
+end
+```
+
+Creating a delayed job:
+```ruby
+user = User.find(123)
+user.delay.do_things!
+```
+
+If you're using custom jobs you'll need to do something like this:
+```ruby
+class CustomUserJob < Struct.new(:user_id)
+  def enqueue(job)
+    job.record            = User.find(user_id)
+    job.identifier        = 'unique_identifier'
+    job.progress_max      = 100
+    job.progress_current  = 0
+  end
+
+  def before(job)
+    @job  = job
+    @user = job.record
+  end
+
+  def perform
+    @job.update_column(:progress_state, 'working')
+    (0..100).each do |i|
+      @user.do_a_thing(i)
+      @job.update_column(:progress_current, i)
+    end
+    @job.update_column(:progress_state, 'complete')
+  end
+end
+
+Delayed::Job.enqueue CustomUserJob.new(123)
+```
+
+This will create a Delayed::Job record:
+```ruby
+-> user.jobs
+=> [#<Delayed::Job>]
+```
+
+That job knows about object that spawned it:
+```ruby
+-> Delayed::Job.last.record
+=> #<User>
+```
+
+`Delayed::Job` records now have new attributes:
+* `progress_max` - default is `100`. You can change it to whatever during `enqueue`.
+* `progress_current` - default is `0`. You can manually increment it while job is running. Will be set to `process_max` when job completes.
+* `progress_state` - default is `nil`. Optional informational string.
+* `completed_at` - when job is done this timestamp is recorded.
+
+This extension also introduces worker setting that keeps completed jobs around. This way you can keep list of completed jobs for a while. If you want to remove them, you need to `.destroy(:force)` them.
+```
+Delayed::Worker.destroy_completed_jobs = false
+```
+
+## Jobs Controller
+
+- `GET /jobs` - List all jobs. Can filter based on associated record via `record_type` and `record_id` parameters. `identifier` parameter can be used as well
+- `GET /jobs/<id>` - Status of a job. Will see all the Delayed::Job attributes including things like progress
+- `DELETE /jobs/<id>` - If job is stuck/failed, we can remove it
+- `POST /jobs/<id>/reload` - Restart failed job
+

data/Rakefile

@@ -0,0 +1,24 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/delayed_job_progress/jobs_controller.rb

@@ -0,0 +1,49 @@
+module DelayedJobProgress
+  class JobsController < ActionController::Base
+
+    before_action :load_job, :only => [:show, :destroy, :reload]
+
+    def index
+      jobs = Delayed::Job
+      if params[:record_type].present? && params[:record_id].present?
+        jobs = jobs.where(:record_type => params[:record_type], :record_id => params[:record_id])
+      end
+      if params[:identifier].present?
+        jobs = jobs.where(:identifier => params[:identifier])
+      end
+
+      render :json => jobs.all
+    end
+
+    def show
+      render :json => @job
+    end
+
+    def destroy
+      @job.destroy(:force)
+      head :no_content
+    end
+
+    def reload
+      @job.update_columns(
+        :run_at       => Time.now,
+        :failed_at    => nil,
+        :completed_at => nil,
+        :locked_by    => nil,
+        :locked_at    => nil,
+        :last_error   => nil,
+        :attempts     => 0
+      )
+      render :json => @job
+    end
+
+  protected
+
+    def load_job
+      @job = Delayed::Job.find(params[:id])
+    rescue ActiveRecord::RecordNotFound
+      render :json => {:error => 'Job not found'}, :status => :not_found
+    end
+
+  end
+end

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/delayed_job_progress/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/routes.rb

@@ -0,0 +1,5 @@
+DelayedJobProgress::Engine.routes.draw do
+  resources :jobs do
+    post :reload, :on => :member
+  end
+end

data/delayed_job_progress.gemspec

@@ -0,0 +1,25 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "delayed_job_progress/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = 'delayed_job_progress'
+  s.version     = DelayedJobProgress::VERSION
+  s.authors     = ["Oleg Khabarov"]
+  s.email       = ["oleg@khabarov.ca"]
+  s.homepage    = "http://github.com/GBH/delayed_job_progress"
+  s.summary     = "DelayedJob Progress extension"
+  s.description = "Ability to track jobs against ActiveRecord objects"
+  s.license     = 'MIT'
+
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = Dir["test/**/*"]
+
+  s.add_dependency 'rails',                     '>= 4.0.0', '< 5'
+  s.add_dependency 'delayed_job',               '>= 4.0'
+  s.add_dependency 'delayed_job_active_record', '>= 4.0'
+
+  s.add_development_dependency 'sqlite3'
+end

data/lib/delayed_job_progress.rb

@@ -0,0 +1,7 @@
+require_relative 'delayed_job_progress/version'
+require_relative 'delayed_job_progress/engine'
+require_relative 'delayed_job_progress/error'
+
+module DelayedJobProgress
+
+end

data/lib/delayed_job_progress/engine.rb

@@ -0,0 +1,13 @@
+require 'delayed_job'
+require 'delayed_job_active_record'
+
+module DelayedJobProgress
+  class Engine < ::Rails::Engine
+    isolate_namespace DelayedJobProgress
+
+    config.to_prepare do
+      require_relative 'extensions/job'
+      require_relative 'extensions/worker'
+    end
+  end
+end

data/lib/delayed_job_progress/error.rb

@@ -0,0 +1,4 @@
+module DelayedJobProgress
+  class DuplicateJobError < StandardError
+  end
+end

data/lib/delayed_job_progress/extensions/job.rb

@@ -0,0 +1,42 @@
+Delayed::Backend::ActiveRecord::Job.class_eval do
+
+  belongs_to :record, :polymorphic => true
+
+  # When enqueue hook is executed, we need to look if there's an identifier provided
+  # If there's another Delayed::Job out there with same identifier we need to bail
+  def hook(name, *args)
+    super
+
+    if name == :enqueue && self.identifier.present?
+      if Delayed::Job.where(:identifier => self.identifier, :completed_at => nil, :failed_at => nil).any?
+        raise DelayedJobProgress::DuplicateJobError, "Delayed::Job with identifier: #{self.identifier} already present"
+      end
+    end
+  end
+
+  # Associating AR record with Delayed::Job. Generally when doing: `something.delay.method`
+  def payload_object=(object)
+    if object.respond_to?(:object) && object.object.is_a?(ActiveRecord::Base)
+      self.record = object.object
+    end
+
+    super
+  end
+
+  def destroy_completed_jobs?
+    payload_object.respond_to?(:destroy_completed_jobs?) ?
+      payload_object.destroy_completed_jobs? :
+      Delayed::Worker.destroy_completed_jobs
+  end
+
+  def destroy(force_destroy = false)
+    if destroy_completed_jobs? || force_destroy
+      super()
+    else
+      update_columns(
+        :completed_at     => Time.zone.now,
+        :progress_current => self.progress_max
+      )
+    end
+  end
+end