jobbr 1.0.1 → 1.0.2

data/.travis.yml

@@ -0,0 +1 @@
+services: mongodb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jobbr (1.0.1)
+    jobbr (1.0.2)
       chronic_duration
       mongoid (~> 3.0)
       rails (~> 3.2)

data/README.rdoc

@@ -1,3 +1,79 @@
 = Jobbr
 
-This project rocks and uses MIT-LICENSE.
+Jobbr is a Rails engine for supervising your delayed jobs and scheduled jobs (think Cron).
+
+It provides a framework to abstract creation and execution of such jobs and a user interface to supervise jobs and read their logs.
+
+{<img src="https://secure.travis-ci.org/cblavier/jobbr.png?branch=master" />}[http://travis-ci.org/cblavier/jobbr]
+
+== Screenshots
+
+{<img src="http://f.cl.ly/items/0N0G3A3c2A1X2l2s3b3p/Capture%20d%E2%80%99%C3%A9cran%202013-02-12%20%C3%A0%2010.52.05.png" width='400'>}[http://cl.ly/image/3r320L101c3h]
+{<img src="http://cl.ly/image/21433N411G01/Capture%20d%E2%80%99%C3%A9cran%202013-02-12%20%C3%A0%2010.55.13.png" width='400'>}[http://cl.ly/image/21433N411G01]
+
+== Dependencies
+
+Jobbr has strong dependencies on following components:
+
+* *Mongoid*: all jobs are stored in MongoDB for supervision. May be abstracted out later for ActiveRecord compatibility.
+* *Whenever*: Jobbr uses {Whenever}[https://github.com/javan/whenever] gem to automatically updates Crontab during a Capistrano deployment.
+
+== Setup
+
+Start by adding Jobbr to your Gemfile:
+
+    gem 'jobbr'
+
+=== User interface
+
+Then mount Jobbr engine to your `routes.rb` file.
+
+    mount Jobbr::Engine => "/jobbr"
+
+=== Scheduled Jobs
+
+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. 
+
+Provided you fill in description and scheduling attributes in the model, you will be able to see it in rake tasks:
+
+    $> rake -T | grep jobbr
+    rake jobbr:dummy_job  # A dummy Job
+
+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'
+
+=== Delayed Jobs
+
+Use generators to get a new job model:
+
+    $> rails g jobbr:delayed_job dummy
+
+You will get a new model with a perform method. Perform parameters are:
+
+* params: is a hash of parameters for your job.
+* run: is the object that will be persisted (and polled) for this job execution. Your delayed job can use it to provide progress information (to display a progress bar) and a final result.
+
+    run.progress = 100
+    run.result = 'my job result'
+
+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 :
+
+* Post on following url to run your job: <tt>delayed_job_creation_path(DelayedJobs::DummyJob, { some_param: 37 })</tt>
+
+* And then poll this url (using the id returned in previous post) to get your job status: <tt>delayed_job_polling_path(run_id)</tt>
+
+This project rocks and uses MIT-LICENSE.

data/app/helpers/jobbr/application_helper.rb

@@ -2,11 +2,11 @@ module Jobbr
   module ApplicationHelper
 
     def delayed_job_creation_path(delayed_job_class, params = {})
-      delayed_jobs_path(params.merge(job_name: delayed_job_class.name.underscore))
+      jobbr.delayed_jobs_path(params.merge(job_name: delayed_job_class.name.underscore))
     end
 
     def delayed_job_polling_path(id = ':job_id')
-      delayed_job_path(id)
+      jobbr.delayed_job_path(id)
     end
 
     def status_icon_class(job_status)

data/config/locales/jobbr.en.yml

@@ -1,5 +1,9 @@
 en:
 
+  time:
+    formats:
+      default: "%d %b %Y %H:%M:%S"
+
   layouts:
     jobbr:
       application:

data/lib/generators/jobbr/delayed_job/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a new delayed job in DelayedJobs namespace.
+
+Example:
+    rails generate delayed_job MySample
+
+    This will create:
+        Model: app/models/delayed_jobs/my_sample_job.rb

data/lib/generators/jobbr/delayed_job/delayed_job_generator.rb

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

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

@@ -0,0 +1,11 @@
+module DelayedJobs
+
+  class <%=name.camelize%>Job < Jobbr::DelayedJob
+
+    def perform(params, run)
+      # put your job code here
+    end
+
+  end
+
+end

data/lib/generators/jobbr/scheduled_job/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Generates a new scheduled job in ScheduledJobs namespace.
+    Will also create a Whenever configuration file.
+
+Example:
+    rails generate scheduled_job MySample
+
+    This will create:
+        Model: app/models/scheduled_jobs/my_sample_job.rb
+        Config: config/schedule.rb

data/lib/generators/jobbr/scheduled_job/scheduled_job_generator.rb

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

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

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

data/lib/generators/jobbr/scheduled_job_config/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generate Whenever schedule.rb config file
+
+Example:
+    rails generate scheduled_job_config
+
+    This will create:
+        Config: config/schedule.rb

data/lib/generators/jobbr/scheduled_job_config/scheduled_job_config_generator.rb

@@ -0,0 +1,8 @@
+class Jobbr::ScheduledJobConfigGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_config_file
+    copy_file "schedule.rb", "config/schedule.rb"
+  end
+
+end

data/lib/generators/jobbr/scheduled_job_config/templates/schedule.rb

@@ -0,0 +1,8 @@
+ENV['RAILS_ENV'] = ARGV.first || ENV['RAILS_ENV'] || 'development'
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require "jobbr/whenever"
+
+set :output, "#{path}/log/cron.log"
+job_type :rake, "cd :path && RAILS_ENV=:environment bundle exec rake :task :output"
+
+Jobbr::Whenever.schedule_jobs(self)

data/lib/jobbr/engine.rb

@@ -3,5 +3,11 @@ module Jobbr
 
     isolate_namespace Jobbr
 
+    initializer 'jobbr.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        helper Jobbr::ApplicationHelper
+      end
+    end
+
   end
 end

data/lib/jobbr/version.rb

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

data/spec/dummy/app/controllers/home_controller.rb

@@ -0,0 +1,3 @@
+class HomeController < ApplicationController
+
+end

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

@@ -0,0 +1,11 @@
+module DelayedJobs
+
+  class DummyJob < Jobbr::DelayedJob
+
+    def perform(params, run)
+      # put your job code here
+    end
+
+  end
+
+end

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

@@ -0,0 +1,15 @@
+module ScheduledJobs
+
+  class DummyJob < Jobbr::ScheduledJob
+
+    # description 'Describe your job here'
+
+    # every 1.day, at: '5am'
+
+    def perform
+      # put your job code here
+    end
+
+  end
+
+end

data/spec/dummy/app/views/home/index.html.haml

@@ -0,0 +1 @@
+= delayed_job_polling_path

data/spec/dummy/config/environments/development.rb

@@ -23,11 +23,11 @@ Dummy::Application.configure do
   config.action_dispatch.best_standards_support = :builtin
 
   # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
+  # config.active_record.mass_assignment_sanitizer = :strict
 
   # Log the query plan for queries taking more than this (works
   # with SQLite, MySQL, and PostgreSQL)
-  config.active_record.auto_explain_threshold_in_seconds = 0.5
+  # config.active_record.auto_explain_threshold_in_seconds = 0.5
 
   # Do not compress assets
   config.assets.compress = false

data/spec/dummy/config/routes.rb

@@ -1,4 +1,9 @@
 Rails.application.routes.draw do
 
+  resource :home
+
+  root to: 'home#index'
+
   mount Jobbr::Engine => "/jobbr"
+
 end

data/spec/dummy/config/schedule.rb

@@ -1,7 +1,5 @@
-# loading Rails environment
 ENV['RAILS_ENV'] = ARGV.first || ENV['RAILS_ENV'] || 'development'
 require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
-
 require "jobbr/whenever"
 
 set :output, "#{path}/log/cron.log"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jobbr
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-11 00:00:00.000000000 Z
+date: 2013-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -117,6 +117,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
@@ -145,6 +146,15 @@ files:
 - config/locales/jobbr.en.yml
 - config/routes.rb
 - jobbr.gemspec
+- 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/scheduled_job/USAGE
+- lib/generators/jobbr/scheduled_job/scheduled_job_generator.rb
+- lib/generators/jobbr/scheduled_job/templates/scheduled_job.erb
+- lib/generators/jobbr/scheduled_job_config/USAGE
+- lib/generators/jobbr/scheduled_job_config/scheduled_job_config_generator.rb
+- lib/generators/jobbr/scheduled_job_config/templates/schedule.rb
 - lib/jobbr.rb
 - lib/jobbr/engine.rb
 - lib/jobbr/logger.rb
@@ -158,10 +168,14 @@ files:
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/home_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - 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_job.rb
 - spec/dummy/app/models/scheduled_jobs/dummy_scheduled_job.rb
+- spec/dummy/app/views/home/index.html.haml
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
@@ -216,7 +230,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4397243311957353951
+      hash: -3816807039260850445
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -225,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4397243311957353951
+      hash: -3816807039260850445
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -238,10 +252,14 @@ test_files:
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/home_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - 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_job.rb
 - spec/dummy/app/models/scheduled_jobs/dummy_scheduled_job.rb
+- spec/dummy/app/views/home/index.html.haml
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb