cronjobber 1.0.1

data/CHANGELOG

@@ -0,0 +1 @@
+1.0.0 - Initial implementation

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rails", ">= 3.0.0"
+  gem "jeweler"
+end
+
+group :test do
+  gem "sqlite3"
+  gem "rspec-rails", ">= 2.0.0"
+end

data/Gemfile.lock

@@ -0,0 +1,98 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.11)
+      actionpack (= 3.0.11)
+      mail (~> 2.2.19)
+    actionpack (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+    activesupport (3.0.11)
+    arel (2.0.10)
+    builder (2.1.2)
+    diff-lcs (1.1.3)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.4)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.17.2)
+    polyglot (0.3.3)
+    rack (1.2.5)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.11)
+      actionmailer (= 3.0.11)
+      actionpack (= 3.0.11)
+      activerecord (= 3.0.11)
+      activeresource (= 3.0.11)
+      activesupport (= 3.0.11)
+      bundler (~> 1.0)
+      railties (= 3.0.11)
+    railties (3.0.11)
+      actionpack (= 3.0.11)
+      activesupport (= 3.0.11)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.4)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    rspec-rails (2.0.1)
+      rspec (~> 2.0.0)
+    sqlite3 (1.3.5)
+    thor (0.14.6)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  rails (>= 3.0.0)
+  rspec-rails (>= 2.0.0)
+  sqlite3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Alexander Gräfenstein
+
+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.rdoc

@@ -0,0 +1,81 @@
+= Cronjobber
+Allows to define cronjobs programmatically.
+
+== Installation
+In your gemfile
+    gem 'cronjobber', :git => 'git://github.com/giniedp/cronjobber.git'
+    
+Run
+    bundle install
+    
+Cronjobber expects that your Database has a table named 'cronjobs'. Just use the following migration snippet to create the required fields. No, there is no generator for this... don't ask.
+    create_table(:cronjobs) do |t|
+      t.string :name
+      t.datetime :run_at
+      t.datetime :locked_at
+      t.string :locking_key
+      t.integer :duration
+      t.text :last_error
+      t.integer :total_runs
+      t.integer :total_failures
+    end
+    
+    
+== Define a cronjob
+In your models directory create one file for each task that you want to perform. I prefer to collect them in an extra directory.
+
+  # app/models/cronjobs/my_task.rb
+  class Cronjob::MyTask < Cronjobber::Task
+    # initialize the task
+    run_task :every => 5.minutes
+    
+    def run
+      # task implementation goes here
+    end
+  end
+
+=== Options
+
+[every]  The time between executions. Default is <tt>0.minutes</tt>.
+
+[at]  An array with time of day strings when the task should be executed e.g. ["12:00", "20:00"]. Default is <tt>[]</tt>
+
+[in_background]  Tells the plugin to run this task in background or not. Default is <tt>false</tt>. Cronjobber uses delayed_job to delay the execution.
+
+[method]  The method to use to run the task. Default is <tt>:run</tt>
+
+=== Examples
+Keep in mind that the exact execution time of a task always depends on how often the Cronjobber is triggered
+
+  run_task
+Will use the default settings. The cronjob will be executed every time the Cronjobber is triggered
+
+  run_task :every => 5.minutes
+Will execute the task only if 5 minutes are left since the last execution. 
+
+  run_task :at => %w(12:00 15:00 20:00)
+Will execute the task once between the given times.
+  
+  run_task :every => 30.minutes, :at => "12:00"
+Will execute the task every 30 minutes starting at 12:00.
+
+  run_task :every => 30.minutes, :at => %w(12:00 15:00 20:00)
+Same as above. Only the first value of the <tt>at</tt> array is respected.
+
+== Trigger task execution
+Inside any Controller use the method <tt>execute_cronjob_tasks</tt> to trigger the Cronjobber. For example in your application controller:
+
+  class ApplicationController < ActionController::Base
+    def cronjobs
+      tasks, log = execute_cronjob_tasks %w(cronjobs/my_task)
+      render :text => log.join("\n")
+    end
+  end
+  
+The first returning value is an array of all tasks. The second is an array of status messages for each task.
+In order to activate a cronjob task, you have to list it in the first argument of the <tt>execute_cronjob_tasks</tt> method, 
+or in the config.cronjobber.tasks configuration setting in your config/application.rb.
+
+Now you have to make sure that the action is visited periodically. For example with a Unix crontab entry:
+
+  */1 * * * * curl http://your-app.com/cronjobs # visits http://your-app.com/cronjobs every minute

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cronjobber"
+    gem.summary = %Q{Cronjob for Rails}
+    gem.description = %Q{Enables simple cronjobs for rails}
+    gem.email = "giniedp@online.de"
+    gem.homepage = "http://github.com/giniedp/cronjob"
+    gem.authors = ["Alexander Gräfenstein"]
+    # gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cronjobber #{version}"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/app/models/cronjobber/task.rb

@@ -0,0 +1,170 @@
+class Cronjobber::Task < ActiveRecord::Base
+  set_table_name "cronjobs"  
+  attr_accessor :status
+  
+  def initialize options={}
+    raise "#{self.class.name} is abstract" if self.class == Cronjobber::Task
+    super options
+  end
+
+  def self.cronjob_name
+    self.name.underscore
+  end
+
+  def self.cronjob
+    @cronjob ||= self.find_by_name(self.cronjob_name)
+    @cronjob ||= self.create!(:name => self.cronjob_name)
+    @cronjob
+  end
+  
+  def self.cronjob_enqueue(key=nil)
+    self.delay.cronjob_perform_delayed(key)
+  end
+  
+  def self.cronjob_perform
+    unless cronjob.lock!
+      cronjob.status = "locked"
+      return cronjob
+    end
+    
+    unless cronjob.should_run?
+      cronjob.status = "skipped"
+      cronjob.unlock!
+      return cronjob
+    end
+    
+    if self.cronjob_delayed
+      self.cronjob_enqueue(cronjob.locking_key)
+      cronjob.status = "enqueued"
+      cronjob.last_error = nil
+      cronjob.save!
+    else
+      cronjob.send(self.cronjob_method)
+      cronjob.status = "performed"
+      cronjob.unlock!
+    end
+    
+    return cronjob
+  rescue Exception => exception
+    cronjob.status = "exception"
+    cronjob.unlock!(exception)
+    return cronjob
+  end
+  
+  def self.cronjob_perform_delayed(key)
+    if cronjob.locked?(key)
+      cronjob.status = "locked"
+    else
+      cronjob.send(self.cronjob_method)
+      cronjob.status = "performed"
+      cronjob.unlock!
+    end
+  rescue Exception => exception
+    cronjob.status = "exception"
+    cronjob.unlock!(exception)
+  end
+  
+  def locked?(key=nil)
+    if key && self.locking_key.to_s == key.to_s
+      false
+    else
+      !self.locked_at.nil?
+    end
+  end
+  
+  def lock!(key=nil)
+    return false if self.locked?
+    return self.update_attributes!(:locked_at => DateTime.now, :locking_key => Time.now.to_i)
+  end
+  
+  def unlock! exception=nil
+    return true unless self.locked?
+    if exception
+      self.last_error = [exception.message, exception.backtrace].flatten.join("\n")
+      self.total_failures = self.total_failures.to_i + 1
+    else
+      self.last_error = nil
+    end
+    
+    self.update_attributes!({
+      :total_runs => self.total_runs.to_i + 1,
+      :locked_at => nil, 
+      :locking_key => nil,
+      :run_at => Time.now, 
+      :duration => (Time.now - self.locked_at.to_time) * 1000
+    })
+  end
+  
+  def self.cronjob_timepoint t1, t2
+    result = []
+    t1.to_date.upto(t2.to_date) do |date|
+      self.cronjob_timesteps.each do |time|
+        result << Time.parse([date.year, date.month, date.day].join("-") + " " + time.to_s) 
+      end
+    end
+    result.sort.uniq.select { |time| (time > t1 && time < t2) }.first
+  end
+  
+  def should_run?(run_at=nil)
+    run_at ||= Time.now
+    t1, t2 = (self.run_at || run_at), run_at
+
+    if self.class.cronjob_frequency.to_i == 0
+      if self.class.cronjob_timesteps.empty?
+        true
+      else
+        self.class.cronjob_timepoint(t1, t2 + 1.day).present?
+      end
+    else
+      if self.class.cronjob_timesteps.empty?
+        (t2 - self.class.cronjob_frequency.to_i.seconds) >= t1
+      else
+        t3 = Time.parse("#{t1.year}-#{t1.month}-#{t1.day} #{self.class.cronjob_timesteps.first}")
+        until t3 > t2 do
+          t3 += self.class.cronjob_frequency
+          return true if t3 > t1 && t3 <= t2
+        end
+        false
+      end
+    end
+  end
+  
+  def run
+    
+  end
+  
+  def format
+    "#{self.class.cronjob_name} # #{self.status} # #{self.duration}ms # #{self.last_error.to_s[0..64]}"
+  end
+  
+  protected
+  def self.run_task *arg
+    options = arg.extract_options!
+    options = { :every => 0.minutes, :in_background => false, :method => :run }.merge(options)
+    options[:method] = arg.first if arg.first.is_a?(Symbol)
+    
+    timesteps = Array(options[:at]).compact
+    if !timesteps.empty? && timesteps.any? { |time| !time.to_s.match(/\d\d:\d\d/) }
+      raise "Invalid cronjob definition. Only 'hh:mm' is supported"
+    end
+    
+    class_eval %{
+      def self.cronjob_frequency
+        #{options[:every].to_i}.seconds
+      end
+      
+      def self.cronjob_timesteps
+        '#{timesteps.join(',')}'.split(',')
+      end
+      
+      def self.cronjob_delayed
+        '#{options[:in_background].to_s}' == 'true'
+      end
+      
+      def self.cronjob_method
+        method = '#{options[:method].to_s}'
+        method.blank? ? :run : method
+      end
+    }
+  end
+end

data/cronjobber.gemspec

@@ -0,0 +1,88 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "cronjobber"
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alexander Gr\303\244fenstein"]
+  s.date = "2012-01-11"
+  s.description = "Enables simple cronjobs for rails"
+  s.email = "giniedp@online.de"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    "CHANGELOG",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "app/models/cronjobber/task.rb",
+    "cronjobber.gemspec",
+    "init.rb",
+    "lib/cronjobber.rb",
+    "lib/cronjobber/tasks_helper.rb",
+    "spec/cronjobber_spec.rb",
+    "spec/dummy/Rakefile",
+    "spec/dummy/app/controllers/application_controller.rb",
+    "spec/dummy/app/helpers/application_helper.rb",
+    "spec/dummy/app/views/layouts/application.html.erb",
+    "spec/dummy/config.ru",
+    "spec/dummy/config/application.rb",
+    "spec/dummy/config/boot.rb",
+    "spec/dummy/config/database.yml",
+    "spec/dummy/config/environment.rb",
+    "spec/dummy/config/environments/development.rb",
+    "spec/dummy/config/environments/production.rb",
+    "spec/dummy/config/environments/test.rb",
+    "spec/dummy/config/initializers/backtrace_silencers.rb",
+    "spec/dummy/config/initializers/inflections.rb",
+    "spec/dummy/config/initializers/mime_types.rb",
+    "spec/dummy/config/initializers/secret_token.rb",
+    "spec/dummy/config/initializers/session_store.rb",
+    "spec/dummy/config/locales/en.yml",
+    "spec/dummy/config/routes.rb",
+    "spec/dummy/db/migrate/20110112183948_create_cronjobs.rb",
+    "spec/dummy/db/schema.rb",
+    "spec/dummy/public/404.html",
+    "spec/dummy/public/422.html",
+    "spec/dummy/public/500.html",
+    "spec/dummy/public/favicon.ico",
+    "spec/dummy/public/javascripts/application.js",
+    "spec/dummy/public/javascripts/controls.js",
+    "spec/dummy/public/javascripts/dragdrop.js",
+    "spec/dummy/public/javascripts/effects.js",
+    "spec/dummy/public/javascripts/prototype.js",
+    "spec/dummy/public/javascripts/rails.js",
+    "spec/dummy/public/stylesheets/.gitkeep",
+    "spec/dummy/script/rails",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/giniedp/cronjob"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "Cronjob for Rails"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rails>, [">= 3.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, [">= 3.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 3.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+