dj_progress_job 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 069b1d899806fd431596f3db8fe30b70ba605d68
+  data.tar.gz: b2ac6fb875d58c6e173179184db52834d9976aff
+SHA512:
+  metadata.gz: 4f8aa14dfad472a6f2497521988ea10e67ab8352185ebb48c9f004f57fffb03c137a43140fa2d89cb857fbb57cf77811b4c076f82e855f97c592771d401b5fae
+  data.tar.gz: 556f320a83acfdd5f28004f2f2d5b4257ec8e5b1d29b138bc696958f6980a073764c0316e61eeafd62199f043d1ff7bb02f9d6b48f3c263482cf78c30d942c02

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Stjepan Hadjic
+
+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,174 @@
+# ProgressJob
+
+This gem add a couple of colums to delayed job table, and gives u a basic class for working with progress
+
+
+## Requirements
+
+Ruby 2.0.0 (as the methods are using keyword arguments.)
+
+## Installation
+
+You need to have https://github.com/collectiveidea/delayed_job in you gem file
+
+Add this line to your application's Gemfile:
+
+    gem 'dj_progress_job'
+
+And then execute:
+
+    $ bundle
+
+Run generator (run delayed job generators first!)
+
+    $ rails generate dj_progress_job:install
+
+## Usage
+
+Create a new class that extends ProgressJob::Base
+
+    class NewJob < DjProgressJob::Base
+
+      def perform
+        # some actions
+      end
+
+    end
+
+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(progress_max: 100) # default progress_max is 100
+
+There is also a controller which returns the delayed job with calculated percentage
+
+    GET 'dj_progress-jobs/:job_id/'
+
+
+### Progress job class
+
+``` ruby
+  class NewJob < DjProgressJob::Base
+
+    def perform
+      handler = Handler.new
+
+      update_stage('Handling ports')
+      handler.handle_ports
+
+      update_stage_progress('Handling cruise', step: 10)
+      handler.handle_cruise
+
+      update_stage_progress('Handling days', step: 10)
+      handler.handle_days
+
+      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 
+
+``` ruby
+  = 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):
+
+``` javascript
+  var interval;
+  $('.hermes-import .well').show();
+  interval = setInterval(function(){
+    $.ajax({
+      url: '/progress-job/' + #{@job.id},
+      success: function(job){
+        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
+
+1. Fork it ( http://github.com/<my-github-username>/progress_job/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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/controllers/dj_progress_job/progress_controller.rb

@@ -0,0 +1,11 @@
+module DjProgressJob
+  class ProgressController < ActionController::Base
+
+    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
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dj_progress_job"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/routes.rb

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

data/dj_progress_job.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dj_progress_job/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dj_progress_job"
+  spec.version       = DjProgressJob::VERSION
+  spec.authors       = ["vk"]
+  spec.email         = ["gvenki911@gmail.com"]
+  spec.summary       = %q{Delayed jobs with progress.}
+  spec.description   = %q{Add progress feature to delayed jobs}
+  spec.homepage      = "https://github.com/venki911/dj_progress_job.git"
+  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.5"
+  spec.add_development_dependency "rake"
+  spec.add_dependency 'delayed_job'
+end

data/lib/dj_progress_bar.rb

@@ -0,0 +1,5 @@
+require "dj_progress_job/version"
+
+module DjProgressBar
+  # Your code goes here...
+end

data/lib/dj_progress_job.rb

@@ -0,0 +1,3 @@
+require "dj_progress_job/base"
+require "dj_progress_job/engine"
+require "dj_progress_job/version"

data/lib/dj_progress_job/base.rb

@@ -0,0 +1,34 @@
+module DjProgressJob
+  class Base
+    def initialize(progress_max = 100)
+      @progress_max = progress_max
+    end
+
+    def before(job)
+      @job = job
+      job.update_column(:progress_max, @progress_max)
+      job.update_column(:progress_current, 0)
+    end
+
+    def update_progress(step = 1)
+      @job.update_column(:progress_current, @job.progress_current + step)
+    end
+
+    def update_stage(stage)
+      @job.update_column(:progress_stage, stage)
+    end
+
+    def update_stage_progress(stage, step = 1)
+      update_stage(stage)
+      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

data/lib/dj_progress_job/engine.rb

@@ -0,0 +1,3 @@
+module DjProgressJob
+  class Engine < Rails::Engine; end
+end

data/lib/dj_progress_job/version.rb

@@ -0,0 +1,3 @@
+module DjProgressJob
+  VERSION = "0.1.0"
+end

data/lib/generators/dj_progress_job/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generates migration for acts_as_simple_translatable.
+
+Example:
+    rails generate acts_as_simple_translatable en category name description
+
+    This will create a migration to translate the name and description fields in the categories table.
+    It will insert the existing category and description values in the record_translations table using the 'en' (English) locale.
+    Note: You cannot roll back this migration.

data/lib/generators/dj_progress_job/install_generator.rb

@@ -0,0 +1,20 @@
+require "rails/generators"
+
+module DjProgressJob
+
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def install
+        migration_template "migration.rb", "db/migrate/add_progress_to_delayed_jobs.rb"
+      end
+
+      def self.next_migration_number(path)
+        @migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i.to_s
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: dj_progress_job
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- vk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: delayed_job
+  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'
+description: Add progress feature to delayed jobs
+email:
+- gvenki911@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/dj_progress_job/progress_controller.rb
+- bin/console
+- bin/setup
+- config/routes.rb
+- dj_progress_job.gemspec
+- lib/dj_progress_bar.rb
+- lib/dj_progress_job.rb
+- lib/dj_progress_job/base.rb
+- lib/dj_progress_job/engine.rb
+- lib/dj_progress_job/version.rb
+- lib/generators/dj_progress_job/USAGE
+- lib/generators/dj_progress_job/install_generator.rb
+- lib/generators/dj_progress_job/templates/migration.rb
+homepage: https://github.com/venki911/dj_progress_job.git
+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.2.5
+signing_key: 
+specification_version: 4
+summary: Delayed jobs with progress.
+test_files: []