progress_job 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cc32459446aa8a5db2648427b7491dd70a84a1e
-  data.tar.gz: edfb357081f7a956b8b7b35977024ae2c07d4a14
+  metadata.gz: 95e2d424d4fd78ff6b26586fd61e50dd7059f3c3
+  data.tar.gz: c3584f41f002dbc03af02c789f4df633a153b773
 SHA512:
-  metadata.gz: c7c85d6a4c09a49671a0f7e418690b5eb734ced0556cc9b02a41d20c4c029dd1445c20764e1075003ec2b2c54346d2d65496fc5eecceffa0c8ed511f494596a2
-  data.tar.gz: d4d02f82ca6d8251db750102edceafe1c3ab7f3e80b8fbd8433fc922a4105d4c4737195d8447dff553cc0f101aec77cfd6775f1b0fb4ac5b7d58dfee0a6c19ce
+  metadata.gz: 8f030db9cf0f21d62e9ff37a38d660db4c6a63e2320efc6e4204ef4951917782538681dd8c39b71fffcb6ec336bea57e7eb4660111680350cc15e37c72fab6c7
+  data.tar.gz: f39df1dea7ee77e722674f748af57f6ad94c8ca02dfb72eaec886f9c84fb4a1dc18aa296012171581437c0e1e4702953ecbbf52988bf87bedccb95969bb4ec59

data/README.md

@@ -2,6 +2,8 @@
 
 This gem add a couple of colums to delayed job table, and gives u a basic class for working with progress
 
+![progress_job](https://s3.amazonaws.com/infinum.web.production/repository_items/files/000/000/435/original/progress_job.gif?1414140810)
+
 ## Installation
 
 You need to have https://github.com/collectiveidea/delayed_job in you gem file
@@ -16,7 +18,7 @@ And then execute:
 
 Run generator (run delayed job generators first!)
 
-    $ rake progress_job:install
+    $ rails generate progress_job:install
 
 ## Usage
 
@@ -25,50 +27,135 @@ 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
+        # some actions
       end
 
     end
 
-Inside perform method you can use 'update_progress(step)' method to update the job progress.
+Inside perform method you can use:
+
+    update_progress(step: 10) # default step is 1
+    update_stage('name of stage')
+    update_stage_progress('name of stage', step: 11)
+    update_progress_max(progress_max)
+
+methods 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)
+    job = Delayed::Job.enqueue NewJob.new(progress_max: 100) # default progress_max is 100
 
 There is also a controller which returns the delayed job with calculated percentage
 
     GET 'progress-jobs/:job_id/'
 
-## Ajax usage
+## Examples
+
+### Progress job class
+
+    class NewJob < ProgressJob::Base
+
+      def perform
+        handler = Handler.new
+
+        update_stage('Handling ports')
+        handler.handle_ports
 
-Example of ajax calls:
+        update_stage_progress('Handling cruise', step: 10)
+        handler.handle_cruise
 
-    $('.button').click(function(){
+        update_stage_progress('Handling days', step: 10)
+        handler.handle_days
 
-      var interval;
+        update_stage_progress('Handling pick up times', step: 10)
+        handler.handle_pick_up_times
+
+        update_stage_progress('Handling users', step: 10)
+        handler.handle_users
+
+        update_stage_progress('Handling item categories', step: 10)
+        handler.handle_item_categories
+
+        update_stage_progress('Handling items', step: 10)
+        handler.handle_items
+        handler.handle_other_items
+
+        update_stage_progress('Handling event types', step: 10)
+        handler.handle_event_types
+
+        update_stage_progress('Handling events', step: 10)
+        handler.handle_events
+      end
+
+    end
+
+### HAML 
+
+    = simple_form_for :import, url: [:import], remote: true do |f|
+      .row
+        .col-xs-10
+          = f.input :file, as: :file
+        .col-xs-2
+          = f.button :submit, "Import", class: "btn btn-success"
+
+      %br
+      .well{style: "display:none"}
+        .row
+          .col-xs-12
+            .progress-status.text-primary
+        .row
+          .col-xs-12
+            .progress.progress-striped.active
+              .progress-bar
+                .text-primary
+                  0%
+
+### Ajax usage
+
+Example of ajax call (this is a .html.haml remote: true response):
+
+    var interval;
+    $('.hermes-import .well').show();
+    interval = setInterval(function(){
       $.ajax({
-        url: '/start',
+        url: '/progress-job/' + #{@job.id},
         success: function(job){
-          interval = setInterval(function(){
-            $.ajax({
-              url: '/progress-jobs/' + job.id,
-              success: function(job){
-                $('.progress-bar').css('width', job.progress + '%').text(job.progress + '%')
-              },
-              error: function(){
-                $('.progress-bar').css('width', '100%').text('100%')
-                clearInterval(interval);
-              }
-            })
-          },1000)
+          var stage, progress;
+
+          // If there are errors
+          if (job.last_error != null) {
+            $('.progress-status').addClass('text-danger').text(job.progress_stage);
+            $('.progress-bar').addClass('progress-bar-danger');
+            $('.progress').removeClass('active');
+            clearInterval(interval);
+          }
+
+          // Upload stage
+          if (job.progress_stage != null){
+            stage = job.progress_stage;
+            progress = job.progress_current / job.progress_max * 100;
+          } else {
+            progress = 0;
+            stage = 'Uploading file';
+          }
+
+          // In job stage
+          if (progress !== 0){
+            $('.progress-bar').css('width', progress + '%').text(progress + '%');
+          }
+
+          $('.progress-status').text(stage);
+        },
+        error: function(){
+          // Job is no loger in database which means it finished successfuly
+          $('.progress').removeClass('active');
+          $('.progress-bar').css('width', '100%').text('100%');
+          $('.progress-status').text('Successfully imported!');
+          clearInterval(interval);
         }
-      });
-    });
-
+      })
+    },100);
 
 ## Contributing
 

data/lib/progress_job/base.rb

@@ -1,7 +1,6 @@
 module ProgressJob
   class Base
-
-    def initialize(progress_max)
+    def initialize(progress_max: 100)
       @progress_max = progress_max
     end
 
@@ -24,8 +23,12 @@ module ProgressJob
       update_progress(step: step)
     end
 
+    def update_progress_max(progress_max)
+      @job.update_column(:progress_max, progress_max)
+    end
+
     def error(job, exception)
       job.update_column(:progress_stage, exception.message)
     end
   end
-end
+end

data/lib/progress_job/version.rb

@@ -1,3 +1,3 @@
 module ProgressJob
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: progress_job
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Stjepan Hadjic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-16 00:00:00.000000000 Z
+date: 2014-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler