jobbr 1.0.2 → 1.1.0

data/Gemfile

@@ -5,6 +5,7 @@ gemspec
 gem 'jquery-rails'
 gem 'whenever'
 gem 'mongoid', '~> 3.0'
+gem 'delayed_job_mongoid', github: 'asavartsov/delayed_job_mongoid'
 gem 'haml'
 gem 'chronic_duration'
 

data/Gemfile.lock

@@ -1,8 +1,17 @@
+GIT
+  remote: git://github.com/asavartsov/delayed_job_mongoid.git
+  revision: b4a040d82436ddc7e4a10715e739a50bee7b807a
+  specs:
+    delayed_job_mongoid (2.0.0)
+      delayed_job (~> 3.0)
+      mongoid (~> 3.0)
+
 PATH
   remote: .
   specs:
-    jobbr (1.0.2)
+    jobbr (1.1.0)
       chronic_duration
+      delayed_job_mongoid
       mongoid (~> 3.0)
       rails (~> 3.2)
       whenever
@@ -10,37 +19,37 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.2.11)
-      actionpack (= 3.2.11)
-      mail (~> 2.4.4)
-    actionpack (3.2.11)
-      activemodel (= 3.2.11)
-      activesupport (= 3.2.11)
+    actionmailer (3.2.13)
+      actionpack (= 3.2.13)
+      mail (~> 2.5.3)
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       journey (~> 1.0.4)
-      rack (~> 1.4.0)
+      rack (~> 1.4.5)
       rack-cache (~> 1.2)
       rack-test (~> 0.6.1)
       sprockets (~> 2.2.1)
-    activemodel (3.2.11)
-      activesupport (= 3.2.11)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
       builder (~> 3.0.0)
-    activerecord (3.2.11)
-      activemodel (= 3.2.11)
-      activesupport (= 3.2.11)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activeresource (3.2.11)
-      activemodel (= 3.2.11)
-      activesupport (= 3.2.11)
-    activesupport (3.2.11)
-      i18n (~> 0.6)
+    activeresource (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
       multi_json (~> 1.0)
     arel (3.0.2)
     builder (3.0.4)
-    chronic (0.9.0)
-    chronic_duration (0.9.6)
+    chronic (0.9.1)
+    chronic_duration (0.10.2)
       numerizer (~> 0.1.1)
     coffee-rails (3.2.2)
       coffee-script (>= 2.2.0)
@@ -48,39 +57,43 @@ GEM
     coffee-script (2.2.0)
       coffee-script-source
       execjs
-    coffee-script-source (1.4.0)
+    coffee-script-source (1.6.3)
     combustion (0.3.3)
       rails (>= 3.0.0)
       thor (>= 0.14.6)
-    database_cleaner (0.9.1)
-    diff-lcs (1.1.3)
+    database_cleaner (1.0.1)
+    delayed_job (3.0.5)
+      activesupport (~> 3.0)
+    diff-lcs (1.2.4)
     erubis (2.7.0)
     execjs (1.4.0)
       multi_json (~> 1.0)
-    haml (3.1.7)
-    hike (1.2.1)
+    haml (4.0.3)
+      tilt
+    hike (1.2.3)
     i18n (0.6.1)
     journey (1.0.4)
-    jquery-rails (2.2.1)
+    jquery-rails (3.0.2)
       railties (>= 3.0, < 5.0)
       thor (>= 0.14, < 2.0)
-    json (1.7.6)
+    json (1.8.0)
     kgio (2.8.0)
-    mail (2.4.4)
-      i18n (>= 0.4.0)
+    mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.20.1)
-    mocha (0.9.12)
-    mongoid (3.0.19)
-      activemodel (~> 3.1)
-      moped (~> 1.2)
+    metaclass (0.0.1)
+    mime-types (1.23)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    mongoid (3.1.4)
+      activemodel (~> 3.2)
+      moped (~> 1.4)
       origin (~> 1.0)
       tzinfo (~> 0.3.22)
-    moped (1.3.2)
-    multi_json (1.5.0)
+    moped (1.5.0)
+    multi_json (1.7.7)
     numerizer (0.1.1)
-    origin (1.0.11)
+    origin (1.1.0)
     polyglot (0.3.3)
     rack (1.4.5)
     rack-cache (1.2)
@@ -89,37 +102,37 @@ GEM
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
-    rails (3.2.11)
-      actionmailer (= 3.2.11)
-      actionpack (= 3.2.11)
-      activerecord (= 3.2.11)
-      activeresource (= 3.2.11)
-      activesupport (= 3.2.11)
+    rails (3.2.13)
+      actionmailer (= 3.2.13)
+      actionpack (= 3.2.13)
+      activerecord (= 3.2.13)
+      activeresource (= 3.2.13)
+      activesupport (= 3.2.13)
       bundler (~> 1.0)
-      railties (= 3.2.11)
-    railties (3.2.11)
-      actionpack (= 3.2.11)
-      activesupport (= 3.2.11)
+      railties (= 3.2.13)
+    railties (3.2.13)
+      actionpack (= 3.2.13)
+      activesupport (= 3.2.13)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (>= 0.14.6, < 2.0)
-    raindrops (0.10.0)
-    rake (10.0.3)
-    rdoc (3.12.1)
+    raindrops (0.11.0)
+    rake (10.1.0)
+    rdoc (3.12.2)
       json (~> 1.4)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.2)
-    rspec-rails (2.12.2)
+    rspec-core (2.14.1)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    rspec-rails (2.14.0)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    sass (3.2.5)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    sass (3.2.9)
     sass-rails (3.2.6)
       railties (~> 3.2.0)
       sass (>= 3.1.10)
@@ -130,13 +143,13 @@ GEM
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
     sqlite3 (1.3.7)
-    thor (0.17.0)
-    tilt (1.3.3)
-    treetop (1.4.12)
+    thor (0.18.1)
+    tilt (1.4.1)
+    treetop (1.4.14)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.35)
-    unicorn (4.5.0)
+    tzinfo (0.3.37)
+    unicorn (4.6.3)
       kgio (~> 2.6)
       rack
       raindrops (~> 0.7)
@@ -152,6 +165,7 @@ DEPENDENCIES
   coffee-rails
   combustion (~> 0.3.1)
   database_cleaner
+  delayed_job_mongoid!
   haml
   jobbr!
   jquery-rails

data/README.rdoc

@@ -36,7 +36,7 @@ Use provided generators to create a first scheduled job
 
     $> rails g jobbr:scheduled_job dummy
 
-It will create a namespaced model as a well as a Whenever configuration file. 
+It will create a namespaced model as a well as a Whenever configuration file.
 
 Provided you fill in description and scheduling attributes in the model, you will be able to see it in rake tasks:
 
@@ -48,6 +48,20 @@ And to see it in your crontab preview:
     $> whenever
     30 5 * * * /bin/bash -l -c 'cd /Users/cblavier/code/my_app && RAILS_ENV=production bundle exec rake jobbr:dummy_job >> /Users/cblavier/code/my_app/log/cron.log 2>&1'
 
+=== Heroku Scheduled Jobs
+
+You can also use Heroku Scheduler to run jobs. Unfortunately Heroku does not provide Cron-scheduling, but let you run jobs every 10 minutes, every hour or every day.
+
+Jobbr provides you with 3 tasks `jobbr:heroku:minutely`, `jobbr:heroku:hourly` and `jobbr:heroku:daily`, that will run any ScheduledJob with `heroku_run` directive.
+
+Run following generator to create an heroku scheduled job
+
+    $> rails g jobbr:heroku_scheduled_job dummy_heroku
+
+Then you will need to manually add jobs to the Heroku scheduler console
+
+{<img src="http://cl.ly/image/2N1T1l1w2c28/Capture%20d%E2%80%99%C3%A9cran%202013-07-09%20%C3%A0%2022.18.40.png" width='400'>}[http://cl.ly/image/2N1T1l1w2c28]
+
 === Delayed Jobs
 
 Use generators to get a new job model:
@@ -67,7 +81,7 @@ You can now run your delayed job as following:
     run_id = DelayedJobs::DummyJob.run_delayed(some_param: 37)
 
 And then get job status like this:
-    
+
     Jobbr::Run.find(run_id).status # returns :waiting / :running / :failure / :success
 
 Jobbr also provides a controller to run and poll delayed_jobs :

data/app/controllers/jobbr/delayed_jobs_controller.rb

@@ -1,6 +1,6 @@
 module Jobbr
 
-  class DelayedJobsController < ApplicationController
+  class DelayedJobsController < Jobbr::ApplicationController
 
     def create
       @job = DelayedJob.run_delayed_by_name(params[:job_name], params)

data/app/controllers/jobbr/jobs_controller.rb

@@ -1,6 +1,6 @@
 module Jobbr
 
-  class JobsController < ApplicationController
+  class JobsController < Jobbr::ApplicationController
 
     def index
       @scheduled_jobs = Jobbr::ScheduledJob.all
@@ -10,6 +10,7 @@ module Jobbr
     def show
       @job = Job.by_name(params[:id]).first
       @runs = Run.for_job(@job)
+      @last_run = Run.unscoped.for_job(@job).first
     end
 
   end

data/app/controllers/jobbr/runs_controller.rb

@@ -1,10 +1,10 @@
 module Jobbr
 
-  class RunsController < ApplicationController
+  class RunsController < Jobbr::ApplicationController
 
     def show
       @job = Job.by_name(params[:job_id]).first
-      @run = @job.runs.where(id: params[:id]).first
+      @run = @job.runs.unscoped.where(id: params[:id]).first
     end
 
   end

data/app/models/jobbr/delayed_job.rb

@@ -12,6 +12,7 @@ module Jobbr
     end
 
     def self.run_delayed(params, delayed = true)
+      delayed = delayed && !Rails.env.test?
       job = instance
       job_run = Run.create(status: :waiting, started_at: Time.now, job: job)
       if delayed
@@ -23,6 +24,7 @@ module Jobbr
     end
 
     def self.run_delayed_by_name(job_class_name, params, delayed = true)
+      delayed = delayed && !Rails.env.test?
       job = instance(job_class_name)
       job_run = Run.create(status: :waiting, started_at: Time.now, job: job)
       if delayed
@@ -33,6 +35,15 @@ module Jobbr
       job_run
     end
 
+    ## Delayed Job callbacks
+    def error(job, exception)
+      puts 'JOBBR ERROR'
+    end
+
+    def failure
+      puts 'JOBBR FAILURE'
+    end
+
   end
 
 end

data/app/models/jobbr/job.rb

@@ -34,6 +34,7 @@ module Jobbr
     def run(job_run = nil, params = {})
       if job_run
         job_run.status = :running
+        job_run.started_at = Time.now
         job_run.save!
       else
         job_run = Run.create(status: :running, started_at: Time.now, job: self)
@@ -50,6 +51,9 @@ module Jobbr
       old_logger = Rails.logger
       Rails.logger = Jobbr::Logger.new(Rails.logger, job_run)
 
+      handle_process_interruption(job_run, 'TERM')
+      handle_process_interruption(job_run, 'INT')
+
       begin
         if self.delayed?
           perform(params, job_run)
@@ -57,6 +61,7 @@ module Jobbr
           perform
         end
         job_run.status = :success
+        job_run.write_attribute(:progress, 100)
       rescue Exception => e
         job_run.status = :failure
         logger.error(e.message)
@@ -69,6 +74,15 @@ module Jobbr
       end
     end
 
+    def handle_process_interruption(job_run, signal)
+      Signal.trap(signal) do
+        job_run.status = :failure
+        Rails.logger.error("Job interrupted by a #{signal} signal")
+        job_run.finished_at = Time.now
+        job_run.save!
+      end
+    end
+
     def last_run
       @last_run ||= Run.for_job(self).first
     end

data/app/models/jobbr/run.rb

@@ -14,9 +14,12 @@ module Jobbr
     belongs_to   :job
     embeds_many  :log_messages, class_name: 'Jobbr::LogMessage'
 
+    index(job_id: 1)
     index(job_id: 1, started_at: -1)
 
-    scope :for_job, ->(job) { Run.where(job_id: job.id).order_by(started_at: -1) }
+    scope :for_job, ->(job) { Jobbr::Run.where(job_id: job.id).order_by(started_at: -1) }
+
+    default_scope -> { without(:log_messages)}
 
     def run_time
       @run_time ||= if finished_at && started_at

data/app/models/jobbr/scheduled_job.rb

@@ -15,6 +15,20 @@ module Jobbr
       @every
     end
 
+    # heroku frequency can be :minutely, :hourly or :daily
+    def self.heroku_run(frequency, options = {})
+      @heroku_frequency = frequency
+      @heroku_priority = options[:priority] || 0
+    end
+
+    def self.heroku_frequency
+      @heroku_frequency
+    end
+
+    def self.heroku_priority
+      @heroku_priority
+    end
+
     def self.task_name(with_namespace = false)
       task_name = name.demodulize.underscore
       if with_namespace

data/app/views/jobbr/jobs/show.html.haml

@@ -9,7 +9,7 @@
     %p= raw t('.scheduling', scheduling: display_scheduling(@job))
   = raw t('.average_run_time', run_time: ChronicDuration.output(@job.average_run_time, format: :long))
 
-= render 'jobbr/runs/logs', run: @job.last_run, title: t('.last_run_logs'), size: 'small'
+= render 'jobbr/runs/logs', run: @last_run, title: t('.last_run_logs'), size: 'small'
 
 %table.table.table-striped.table-hover
   %thead

data/config/locales/jobbr.en.yml

@@ -22,7 +22,7 @@ en:
       job_list:
         status: Status
         job_name: Name
-        last_run: Last runned at
+        last_run: Last ran at
         average_run_time: Average run time
         see_all_runs: See all runs
         see_last_run: See last run

data/jobbr.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "rails", "~> 3.2"
   s.add_dependency "mongoid", "~> 3.0"
+  s.add_dependency "delayed_job_mongoid"
   s.add_dependency "whenever"
   s.add_dependency "chronic_duration"
 

data/lib/generators/jobbr/heroku_scheduled_job/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a new Heroku scheduled job in ScheduledJobs namespace.
+
+Example:
+    rails generate heroku_scheduled_job MySample
+
+    This will create:
+        Model: app/models/scheduled_jobs/my_sample_job.rb

data/lib/generators/jobbr/heroku_scheduled_job/heroku_scheduled_job_generator.rb

@@ -0,0 +1,10 @@
+class Jobbr::HerokuScheduledJobGenerator < Rails::Generators::NamedBase
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_scheduled_job
+    empty_directory "app/models/scheduled_jobs"
+    template "heroku_scheduled_job.erb", "app/models/scheduled_jobs/#{file_name}_job.rb", name: file_name
+  end
+
+end

data/lib/generators/jobbr/heroku_scheduled_job/templates/heroku_scheduled_job.erb

@@ -0,0 +1,15 @@
+module ScheduledJobs
+
+  class <%=name.camelize%>Job < Jobbr::ScheduledJob
+
+    # description 'Describe your job here'
+
+    # heroku_run :daily, priority: 0
+
+    def perform
+      # put your job code here
+    end
+
+  end
+
+end

data/lib/jobbr/engine.rb

@@ -1,3 +1,5 @@
+require 'jobbr/logger'
+
 module Jobbr
   class Engine < ::Rails::Engine
 

data/lib/jobbr/version.rb

@@ -1,3 +1,3 @@
 module Jobbr
-  VERSION = "1.0.2"
+  VERSION = '1.1.0'
 end

data/lib/tasks/jobbr_tasks.rake

@@ -1,5 +1,6 @@
 models_root = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'app', 'models'))
 require File.join(models_root, 'jobbr', 'standalone_tasks')
+require "jobbr/mongoid.rb"
 
 namespace :jobbr do
 
@@ -11,4 +12,30 @@ namespace :jobbr do
       info[:klass_name].constantize.run
     end
   end
+
+  desc 'Mark all running job as failed.'
+  task :sweep_running_jobs => :environment do
+    Jobbr::Run.where(status: :running).update_all(status: :failure)
+  end
+
+  namespace :heroku do
+
+    task :minutely => :environment do
+      heroku_scheduled_classes(:minutely).each(&:run)
+    end
+
+    task :hourly => :environment do
+      heroku_scheduled_classes(:hourly).each(&:run)
+    end
+
+    task :daily => :environment do
+      heroku_scheduled_classes(:daily).each(&:run)
+    end
+
+    def heroku_scheduled_classes(frequency)
+      Jobbr::Mongoid.models(Jobbr::ScheduledJob).select{|c| c.heroku_frequency == frequency }.sort{|a,b| b.heroku_priority <=> a.heroku_priority}
+    end
+
+  end
+
 end

data/spec/dummy/app/models/delayed_jobs/dummy_job.rb

@@ -3,7 +3,7 @@ module DelayedJobs
   class DummyJob < Jobbr::DelayedJob
 
     def perform(params, run)
-      # put your job code here
+      logger.debug 'job is running'
     end
 
   end

data/spec/dummy/app/models/scheduled_jobs/dummy_heroku_job.rb

@@ -0,0 +1,15 @@
+module ScheduledJobs
+
+  class DummyHerokuJob < Jobbr::ScheduledJob
+
+    description 'Describe your job here'
+
+    heroku_run :daily, priority: 0
+
+    def perform
+      Rails.logger.debug 'heroku :)'
+    end
+
+  end
+
+end

data/spec/models/scheduled_job_spec.rb

@@ -74,6 +74,11 @@ module Jobbr
       job_run.finished_at.should_not be_nil
     end
 
+    it 'sets the progress to 100% at the end' do
+      TestJob.run
+      TestJob.last.runs.last.progress.should be 100
+    end
+
     it 'creates log messages when logging' do
       class LoggingJob < ScheduledJob
         def perform
@@ -83,7 +88,7 @@ module Jobbr
       end
 
       LoggingJob.run
-      last_job_run = ScheduledJob.last.runs.last
+      last_job_run = ScheduledJob.last.runs.unscoped.last
       last_job_run.should have(2).log_messages
       last_job_run.log_messages.first.kind.should be :debug
       last_job_run.log_messages.first.message.should == 'foo'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jobbr
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-12 00:00:00.000000000 Z
+date: 2013-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -43,6 +43,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: delayed_job_mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: whenever
   requirement: !ruby/object:Gem::Requirement
@@ -149,6 +165,9 @@ files:
 - lib/generators/jobbr/delayed_job/USAGE
 - lib/generators/jobbr/delayed_job/delayed_job_generator.rb
 - lib/generators/jobbr/delayed_job/templates/delayed_job.erb
+- lib/generators/jobbr/heroku_scheduled_job/USAGE
+- lib/generators/jobbr/heroku_scheduled_job/heroku_scheduled_job_generator.rb
+- lib/generators/jobbr/heroku_scheduled_job/templates/heroku_scheduled_job.erb
 - lib/generators/jobbr/scheduled_job/USAGE
 - lib/generators/jobbr/scheduled_job/scheduled_job_generator.rb
 - lib/generators/jobbr/scheduled_job/templates/scheduled_job.erb
@@ -173,6 +192,7 @@ files:
 - spec/dummy/app/mailers/.gitkeep
 - spec/dummy/app/models/.gitkeep
 - spec/dummy/app/models/delayed_jobs/dummy_job.rb
+- spec/dummy/app/models/scheduled_jobs/dummy_heroku_job.rb
 - spec/dummy/app/models/scheduled_jobs/dummy_job.rb
 - spec/dummy/app/models/scheduled_jobs/dummy_scheduled_job.rb
 - spec/dummy/app/views/home/index.html.haml
@@ -230,7 +250,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3816807039260850445
+      hash: 1087904321549229692
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -239,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3816807039260850445
+      hash: 1087904321549229692
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -257,6 +277,7 @@ test_files:
 - spec/dummy/app/mailers/.gitkeep
 - spec/dummy/app/models/.gitkeep
 - spec/dummy/app/models/delayed_jobs/dummy_job.rb
+- spec/dummy/app/models/scheduled_jobs/dummy_heroku_job.rb
 - spec/dummy/app/models/scheduled_jobs/dummy_job.rb
 - spec/dummy/app/models/scheduled_jobs/dummy_scheduled_job.rb
 - spec/dummy/app/views/home/index.html.haml