scheduler_daemon 0.5.1 → 1.1.1

data/lib/scheduler_daemon/command_line_args_to_hash.rb

@@ -0,0 +1,47 @@
+begin
+  require 'active_support/hash_with_indifferent_access'
+rescue LoadError
+  begin
+    require 'active_support/core_ext/hash'
+  rescue LoadError
+    puts "can't load activesupport gem not loaded"
+    raise $!
+  end
+end
+
+class CommandLineArgsToHash
+  def self.parse(args, options = {})
+    new(args, options).parse
+  end
+  
+  def initialize(args, options = {})
+    @args = args
+    @options = options
+  end
+  
+  def parse
+    hash = ::HashWithIndifferentAccess.new
+    @args.each{|arg|
+      k, v = read_argument(arg)
+      hash[k] = v
+    }
+    hash
+  end
+  
+  def read_argument(arg)
+    k, v = arg.sub(/^\-\-/, '').split('=')
+    k = k.gsub(/-/, '_') # replace - to _ so that --skip-init becomes options[:skip_init]
+    v = true if v.nil? # default passed in args to true.
+    v = format_value(k, v)
+    [k, v]
+  end
+  
+  def format_value(k, v)
+    if @options[:array_args] && @options[:array_args].include?(k)
+      v = v.split(/,\s*/) if v.respond_to?(:split)
+    end
+    v = false if v == 'false'
+    v = true if v == 'true'
+    v
+  end
+end

data/lib/scheduler_daemon/exception_handler.rb

@@ -0,0 +1,30 @@
+# override this in your app to do something meaningful,
+# like post to campfire or hoptoad.
+# 
+# Example campfire code below, using 'tinder' gem:
+module Scheduler
+  class ExceptionHandler
+    # @@campfire_subdomain = ''
+    # @@campfire_username = ''
+    # @@campfire_password = ''
+    # @@campfire_room_name = ''
+    # @@campfire_room = nil
+
+    def self.handle_exception(exception, job, message)
+      # If your team all hangs out in Campfire, you might want to try
+      # something like Tinder here to write these messages out to campfire,
+      # Such as:
+      # 
+      # if Rails.env.production? || Rails.env.staging?
+      #   msg = "#{message}, see log for backtrace"
+      # 
+      #   unless @@campfire_room
+      #     campfire = Tinder::Campfire.new(@@campfire_subdomain, :ssl => true)
+      #     campfire.login(@@campfire_username, @@campfire_password)
+      #     @@campfire_room = campfire.find_room_by_name(@@campfire_room_name)
+      #   end
+      #   @@campfire_room.speak(msg)
+      # end
+    end
+  end
+end

data/lib/scheduler_daemon/rails/generators/scheduler/scheduler_generator.rb

@@ -0,0 +1,16 @@
+class SchedulerGenerator < Rails::Generator::Base
+  def banner
+    "Usage: #{$0} #{spec.name}"
+  end
+
+  def manifest
+    record do |m|
+      m.directory File.join('lib', 'scheduled_tasks')
+
+      m.template 'lib/scheduled_tasks/session_cleaner_task.rb',
+        'lib/scheduled_tasks/session_cleaner_task.rb'
+      
+      m.readme('README')
+    end
+  end
+end

data/lib/scheduler_daemon/rails/generators/scheduler/templates/README

@@ -0,0 +1,11 @@
+
+GREAT!
+
+Now that you've generated the scheduler daemon and a default task, 
+you can take a look at the new task:
+
+  lib/scheduled_tasks/session_cleaner_task.rb
+
+or make your own:
+
+  script/generate scheduler_task MyTaskName

data/lib/scheduler_daemon/rails/generators/scheduler/templates/lib/scheduled_tasks/session_cleaner_task.rb

@@ -0,0 +1,29 @@
+class SessionCleanerTask < Scheduler::SchedulerTask
+  environments :all
+  
+  every '1d', :first_at => Chronic.parse('next 2 am')
+  
+  def run
+    remove_old_sessions
+  end
+  
+  def remove_old_sessions
+    log "running the session cleaner"
+    if ActionController::Base.session_store == session_store_class
+      ActiveRecord::Base.connection.execute("DELETE FROM #{session_table_name} WHERE updated_at < '#{7.days.ago.to_s(:db)}'")
+      log "old sessions are gone!"
+    else
+      log "sessions are not stored in the database; nothing to do."
+    end
+  end
+
+  def session_store_class
+    return ActiveRecord::SessionStore if defined?(ActiveRecord::SessionStore)
+    # pre rails 2.3 support...
+    return CGI::Session::ActiveRecordStore if defined?(CGI::Session::ActiveRecordStore)
+  end
+
+  def session_table_name
+    ActiveRecord::Base.pluralize_table_names ? :sessions : :session
+  end
+end

data/lib/scheduler_daemon/rails/generators/scheduler_task/scheduler_task_generator.rb

@@ -0,0 +1,17 @@
+class SchedulerTaskGenerator < Rails::Generators::NamedBase
+  check_class_collision :suffix => 'Task'
+  
+  def create_task
+    template File.join(source_dir, 'example_task.rb'), "scheduled_tasks/#{file_name}_task.rb"
+    readme(File.join(template_dir, 'README'))
+  end
+  
+  private
+    def source_dir
+      File.join(template_dir, 'scheduled_tasks')
+    end
+    
+    def template_dir
+      File.join(File.dirname(__FILE__), 'templates')
+    end
+end

data/{generators → lib/scheduler_daemon/rails/generators}/scheduler_task/templates/README

@@ -11,4 +11,4 @@ to run it in the background (a la system start-up):
 You'll probably want to add tests or specs for your new task.
 You can find existing specs for plugin in the scheduler_daemon/spec folder.
 
-Be sure to copy them to your spec folder if you're using rspec.
+Be sure to copy them to your spec folder if you're using rspec.

data/lib/scheduler_daemon/rails/generators/scheduler_task/templates/scheduled_tasks/example_task.rb

@@ -0,0 +1,19 @@
+class <%= class_name %>Task < Scheduler::SchedulerTask
+  environments :all
+  # environments :staging, :production
+  
+  every '10s'
+  # other examples:
+  # every '24h', :first_at => Chronic.parse('next midnight')
+  # cron '* 4 * * *'  # cron style
+  # in '30s'          # run once, 30 seconds from scheduler start/restart
+  
+  
+  def run
+    # Your code here, eg: 
+    # User.send_due_invoices!
+    
+    # use log() for writing to scheduler daemon log
+    log("I've sent invoices!")
+  end
+end

data/lib/scheduler_daemon/rails/railtie.rb

@@ -0,0 +1,9 @@
+module Scheduler
+  module Rails
+    class Railtie < ::Rails::Railtie
+      generators do
+        require 'scheduler_daemon/rails/generators/scheduler_task/scheduler_task_generator'
+      end
+    end
+  end
+end

data/{generators/scheduler/templates/lib/scheduler → lib/scheduler_daemon}/scheduler_task.rb

@@ -1,18 +1,21 @@
 module Scheduler
   class SchedulerTask
+    attr_accessor :daemon_scheduler, :rufus_scheduler
     class <<self
       def add_to(schedule)
-        %w(every in at cron).each{|time|
-          if args = self.instance_variable_get("@#{time}")
+        %w(every in at cron).each{|time_cmd|
+          if args = self.instance_variable_get("@#{time_cmd}")
             # add a default tag to the arguments so we know which task was running
             options = args.extract_options!
             options.merge!(:tags => [name])
-            # args = ['5s'] if Rails.env.development? # just for testing. :)
             args << options
 
-            schedule.send(time, *args) do
+            schedule.send(time_cmd, *args) do
               begin
-                new.run
+                a_task = new
+                a_task.daemon_scheduler = schedule.daemon_scheduler
+                a_task.rufus_scheduler = schedule
+                a_task.run
               ensure
                 # Note: AR's ActiveRecord::Base.connection_pool.with_connection(&block) seems broken;
                 # it doesn't release the connection properly.
@@ -55,8 +58,8 @@ module Scheduler
         @environments = args.map{|arg| arg.to_sym }
       end
 
-      def should_run_in_current_environment?
-        @environments.nil? || @environments == [:all] || @environments.include?(RAILS_ENV.to_sym)
+      def should_run_in_current_environment?(env)
+        @environments.nil? || @environments == [:all] || @environments.include?(env.to_sym)
       end
     end
 
@@ -64,6 +67,12 @@ module Scheduler
     def run
       nil
     end
+    
+    def log(*args)
+      daemon_scheduler.log(*args)
+    end
+    alias :puts :log
   end
 end
-SchedulerTask = Scheduler::SchedulerTask # alias this for backwards compatability
+# alias this for backwards compatability
+# SchedulerTask = Scheduler::SchedulerTask unless defined?(::SchedulerTask)

data/scheduler_daemon.gemspec

@@ -1,74 +1,97 @@
+# 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 = %q{scheduler_daemon}
-  s.version = "0.5.1"
+  s.version = "1.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Steven Soroka"]
-  s.date = %q{2009-10-16}
+  s.date = %q{2011-04-14}
+  s.description = %q{a Rails 2.3, Rails 3, and Ruby compatible scheduler daemon.  Replaces cron/rake pattern of periodically running rake tasks to perform maintenance tasks, only loading the environment ONCE.}
   s.email = %q{ssoroka78@gmail.com}
+  s.executables = ["scheduler_daemon"]
   s.extra_rdoc_files = [
     "README.markdown"
   ]
   s.files = [
-    ".gitignore",
-     "CHANGES",
-     "MIT-LICENSE",
-     "README.markdown",
-     "Rakefile",
-     "VERSION",
-     "generators/scheduler/USAGE",
-     "generators/scheduler/scheduler_generator.rb",
-     "generators/scheduler/templates/README",
-     "generators/scheduler/templates/bin/boot.rb",
-     "generators/scheduler/templates/bin/scheduler_daemon.rb",
-     "generators/scheduler/templates/lib/scheduled_tasks/session_cleaner_task.rb",
-     "generators/scheduler/templates/lib/scheduler.rb",
-     "generators/scheduler/templates/lib/scheduler/exception_handler.rb",
-     "generators/scheduler/templates/lib/scheduler/hijack_puts.rb",
-     "generators/scheduler/templates/lib/scheduler/scheduler_task.rb",
-     "generators/scheduler_task/scheduler_task_generator.rb",
-     "generators/scheduler_task/templates/README",
-     "generators/scheduler_task/templates/scheduled_tasks/example_task.rb",
-     "init.rb",
-     "install.rb",
-     "lib/scheduler.rb",
-     "scheduler_daemon.gemspec",
-     "spec/README",
-     "spec/scheduled_tasks/session_cleaner_task_spec.rb",
-     "spec/scheduler_spec.rb",
-     "uninstall.rb"
+    "Gemfile",
+    "Gemfile.lock",
+    "MIT-LICENSE",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "bin/scheduler_daemon",
+    "lib/loader/scheduler_loader.rb",
+    "lib/scheduler_daemon.rb",
+    "lib/scheduler_daemon/base.rb",
+    "lib/scheduler_daemon/command_line_args_to_hash.rb",
+    "lib/scheduler_daemon/exception_handler.rb",
+    "lib/scheduler_daemon/rails/generators/scheduler/USAGE",
+    "lib/scheduler_daemon/rails/generators/scheduler/scheduler_generator.rb",
+    "lib/scheduler_daemon/rails/generators/scheduler/templates/README",
+    "lib/scheduler_daemon/rails/generators/scheduler/templates/lib/scheduled_tasks/session_cleaner_task.rb",
+    "lib/scheduler_daemon/rails/generators/scheduler_task/scheduler_task_generator.rb",
+    "lib/scheduler_daemon/rails/generators/scheduler_task/templates/README",
+    "lib/scheduler_daemon/rails/generators/scheduler_task/templates/scheduled_tasks/example_task.rb",
+    "lib/scheduler_daemon/rails/railtie.rb",
+    "lib/scheduler_daemon/scheduler_task.rb",
+    "scheduler_daemon.gemspec",
+    "spec/command_line_args_to_hash_spec.rb",
+    "spec/scheduled_tasks/session_cleaner_task_spec.rb",
+    "spec/scheduler_spec.rb",
+    "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/ssoroka/scheduler_daemon}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Rails 2.3.2 compatible scheduler daemon.  Replaces cron/rake pattern of periodically running rake tasks  to perform maintenance tasks in Rails apps. Scheduler Daemon is made specifically for your Rails app,  and only loads the environment once, no matter how many tasks run.  What's so great about it?  Well, I'm glad you asked!  - Only loads your Rails environment once on daemon start, not every time a task is run - Allows you to easily deploy the scheduled tasks with your Rails app instead of depending on an administrator to update crontab - It doesn't use rake or cron! - Gets you up and running with your own daemon in under 2 minutes}
+  s.rubygems_version = %q{1.7.2}
+  s.summary = %q{Rails 3 compatible scheduler daemon.  Replaces cron/rake pattern of periodically running rake tasks  to perform maintenance tasks in Rails apps. Scheduler Daemon is made specifically for your Rails app,  and only loads the environment once, no matter how many tasks run.  What's so great about it?  Well, I'm glad you asked!  - Only loads your Rails environment once on daemon start, not every time a task is run - Allows you to easily deploy the scheduled tasks with your Rails app instead of depending on an administrator to update crontab - It doesn't use rake or cron! - Gets you up and running with your own daemon in under 2 minutes}
   s.test_files = [
+    "spec/command_line_args_to_hash_spec.rb",
     "spec/scheduled_tasks/session_cleaner_task_spec.rb",
-     "spec/scheduler_spec.rb"
+    "spec/scheduler_spec.rb",
+    "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<scheduler_daemon>, [">= 0"])
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0.12.8"])
+      s.add_runtime_dependency(%q<daemons>, [">= 1.0.10"])
+      s.add_runtime_dependency(%q<rufus-scheduler>, [">= 2.0.1"])
+      s.add_runtime_dependency(%q<chronic>, [">= 0.2.0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
       s.add_runtime_dependency(%q<eventmachine>, [">= 0.12.8"])
       s.add_runtime_dependency(%q<daemons>, [">= 1.0.10"])
       s.add_runtime_dependency(%q<rufus-scheduler>, [">= 2.0.1"])
       s.add_runtime_dependency(%q<chronic>, [">= 0.2.0"])
     else
+      s.add_dependency(%q<scheduler_daemon>, [">= 0"])
+      s.add_dependency(%q<eventmachine>, [">= 0.12.8"])
+      s.add_dependency(%q<daemons>, [">= 1.0.10"])
+      s.add_dependency(%q<rufus-scheduler>, [">= 2.0.1"])
+      s.add_dependency(%q<chronic>, [">= 0.2.0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<eventmachine>, [">= 0.12.8"])
       s.add_dependency(%q<daemons>, [">= 1.0.10"])
       s.add_dependency(%q<rufus-scheduler>, [">= 2.0.1"])
       s.add_dependency(%q<chronic>, [">= 0.2.0"])
     end
   else
+    s.add_dependency(%q<scheduler_daemon>, [">= 0"])
+    s.add_dependency(%q<eventmachine>, [">= 0.12.8"])
+    s.add_dependency(%q<daemons>, [">= 1.0.10"])
+    s.add_dependency(%q<rufus-scheduler>, [">= 2.0.1"])
+    s.add_dependency(%q<chronic>, [">= 0.2.0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<eventmachine>, [">= 0.12.8"])
     s.add_dependency(%q<daemons>, [">= 1.0.10"])
     s.add_dependency(%q<rufus-scheduler>, [">= 2.0.1"])
     s.add_dependency(%q<chronic>, [">= 0.2.0"])
   end
 end
+

data/spec/command_line_args_to_hash_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'scheduler_daemon/command_line_args_to_hash'
+
+describe CommandLineArgsToHash do
+  it 'should process arguments' do
+    h = CommandLineArgsToHash.parse('--hello')
+    h['hello'].should == true
+  end
+  
+  it 'should change key names with - to _' do
+    h = CommandLineArgsToHash.parse(['--hi-there'])
+    h['hi_there'].should == true
+  end
+  
+  it 'should play nice with array args' do
+    h = CommandLineArgsToHash.parse(['--only=one,two,three'], :array_args => 'only')
+    h['only'].should == %w(one two three)
+  end
+  
+  it 'should handle multiple args ok' do
+    h = CommandLineArgsToHash.parse(['--one', '--two=three'])
+    h['one'].should == true
+    h['two'].should == 'three'
+  end
+  
+end

data/spec/scheduled_tasks/session_cleaner_task_spec.rb

@@ -1,19 +1,21 @@
 # copy this spec to your project after installing the plugin if you want to run the specs.
 # suggested file name for this file: spec/scheduler_daemon/scheduled_tasks/session_cleaner_task_spec.rb
 
-require File.dirname(__FILE__) + '/../../spec_helper'
-require 'daemons/lib/scheduler_task'
-require 'daemons/lib/scheduled_tasks/remove_old_sessions_task'
+# require File.join(File.dirname(__FILE__), %w(.. spec_helper))
+require 'spec_helper'
+require 'scheduler_daemon/scheduler_task'
+require 'scheduler_daemon/rails/generators/scheduler/templates/lib/scheduled_tasks/session_cleaner_task'
 
-describe RemoveOldSessionsTask do
+describe SessionCleanerTask do
   before(:each) do
-    @task = RemoveOldSessionsTask.new
-    @task.stub!(:puts)
+    @task = SessionCleanerTask.new
+    @task.stub!(:log)
   end
 
   it "should remove old sessions" do
     # this test only matters if we're using AR's session store.
-    if ActionController::Base.session_store == ActiveRecord::SessionStore
+    if defined?(ActionController) && defined?(ActiveRecord) && 
+        ActionController::Base.session_store == ActiveRecord::SessionStore
 
       # insert old session
       ActiveRecord::Base.connection.execute(%(delete from #{@task.session_table_name} where session_id = 'abc123'))
@@ -26,6 +28,8 @@ describe RemoveOldSessionsTask do
       lambda {
         @task.run
       }.should change(get_session_count, :call).by_at_most(-1)
+    else
+      pending 'skipping SessionCleanerTask test since it depends on rails and ActiveRecord::SessionStore; try copying this spec to your rails application.'
     end
   end
 end