progress_job 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fa00d536a7cc9174017b2da5cd5ed5ccd13448d
-  data.tar.gz: e3e0c22864ce39cd6a90a16209d485b1c0c232d0
+  metadata.gz: f2075478f5997a10b069908397644e72d9e0f068
+  data.tar.gz: e1769c55e457629231b824c4536c442b15c1660a
 SHA512:
-  metadata.gz: dc69a0c2796e2842f8704e646cbd8f86924d635407a79ca5ec68740e85b604d09b79ad61e487245a8e95f0611b20bb674528eac895b422765798627cad4392f8
-  data.tar.gz: b7577822a770ee098240046b00b02a04648b47485cfbbab07821abbd2bfb3d6d4826acb78c748aeada9c8b1e3386494667fd70b644176d7a3019b96361575479
+  metadata.gz: beac40fe9872df8871d394a866083cb820736d0ed89ac69e70a276a37463519708f5961db0c7b469ec6ce8956ece435d2580468ebd5cf16878d1b7c0538ca5c9
+  data.tar.gz: 36270aee384016cc3555f94ec2868108ed6c009f1af4e0873dab7b8029f41dc531068d37fe80e0ee5c416c17cd2e4b269e621c0ed9198fd2ab7849f22428be24

data/README.md

@@ -1,9 +1,11 @@
 # ProgressJob
 
-TODO: Write a gem description
+This gem add a couple of colums to delayed job table, and gives u a basic class for working with progress
 
 ## Installation
 
+You need to have https://github.com/collectiveidea/delayed_job in you gem file
+
 Add this line to your application's Gemfile:
 
     gem 'progress_job'
@@ -12,13 +14,34 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Run generator (run delayed job generators first!)
 
-    $ gem install progress_job
+    $ rake progress_job:install
 
 ## Usage
 
-TODO: Write usage instructions here
+Create a new class that extends ProgressJob::Base
+
+    class NewJob < ProgressJob::Base
+
+      def perform
+        10.times do |i|
+          sleep(1.seconds)
+          update_progress(step: 10)
+        end
+      end
+
+    end
+
+Inside perform method you can use 'update_progress(step)' method to update the job progress.
+
+To create a new job use Delayed job enqueue method, and pass the progress_max value
+
+    job = Delayed::Job.enqueue NewJob.new(100)
+
+There is also a controller which returns the delayed job with calculated percentage
+
+    GET 'progress-jobs/:job_id/'
 
 ## Contributing
 

data/app/controllers/progress_job/progress_controller.rb

@@ -1,13 +1,10 @@
 module ProgressJob
   class ProgressController < ActionController::Base
 
-    respond_to :json
-
-    def progress
-      @current_job = Delayed::Job.find(params[:job_id])
-      percentage = current_job.current_progress / current_job.max_progress.to_f * 100
-      @current_job[:percentage] = percentage
-      render json: @current_job
+    def show
+      @delayed_job = Delayed::Job.find(params[:job_id])
+      percentage = !@delayed_job.progress_max.zero? ? @delayed_job.progress_current / @delayed_job.progress_max.to_f * 100 : 0
+      render json: @delayed_job.attributes.merge!(percentage: percentage).to_json
     end
 
   end

data/config/routes.rb

@@ -1,3 +1,3 @@
 Rails.application.routes.draw do
-  get 'progress-job/progress' => 'progress_job/progress#progress'
+  get 'progress-job/:job_id' => 'progress_job/progress#show'
 end

data/lib/generators/progress_job/templates/migration.rb

@@ -2,8 +2,8 @@ class AddProgressToDelayedJobs < ActiveRecord::Migration
   def change
     change_table :delayed_jobs do |t|
       t.string :progress_stage, required: true
-      t.string :progress_current, required: true, default: 0
-      t.string :progress_max, required: true, default: 0
+      t.integer :progress_current, required: true, default: 0
+      t.integer :progress_max, required: true, default: 0
     end
 
   end

data/lib/progress_job/base.rb

@@ -1,17 +1,17 @@
 module ProgressJob
   class Base
-    def initialize(max_progress)
-      @max_progress = max_progress
+    def initialize(progress_max)
+      @progress_max = progress_max
       super()
     end
 
     def before(job)
       @job = job
-      @job.update_column(:max_progress, @max_progress)
+      @job.update_column(:progress_max, @progress_max)
     end
 
     def update_progress(step: 1)
-      @job.update_column(:current_progress, @job.current_progress + step)
+      @job.update_column(:progress_current, @job.progress_current + step)
     end
   end
 end

data/lib/progress_job/version.rb

@@ -1,3 +1,3 @@
 module ProgressJob
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: progress_job
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Stjepan Hadjic