action_event 0.0.1

data/Capfile

@@ -0,0 +1,23 @@
+# after 'deploy:start', 'deploy:appmessaging:start'
+# after 'deploy:stop', 'deploy:appmessaging:stop'
+# after 'deploy:restart', 'deploy:appmessaging:restart'
+# after 'deploy:spinner', 'deploy:appmessaging:start'
+# 
+# namespace :deploy do 
+#   namespace :appmessaging do
+#     desc "app messaging restart"
+#     task :restart, :roles => :messaging do
+#       sudo "/usr/sbin/monit -g appmessaging restart all"
+#     end  
+# 
+#     desc "app messaging stop"
+#     task :stop, :roles => :messaging do
+#       sudo "/usr/sbin/monit -g appmessaging stop all"
+#     end
+# 
+#     desc "app messaging start"
+#     task :start, :roles => :messaging do
+#       sudo "/usr/sbin/monit -g appmessaging start all"
+#     end
+#   end
+# end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Warren Konkel
+
+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

@@ -0,0 +1,102 @@
+Preface
+=======
+
+This is a project that is currently used in production environments but isn't "production ready" unless
+you're adventurous.  Consider this as a "sneak peak" rather than a "first release".
+
+Another thing to note... this has gone through many iterations (MySQL backed, memcached backed,
+rabbitMQ, etc).  At some point, I plan on adding back in support for all of these and allowing users
+to choose which queue backend they want, but right now it's tied directly to rabbitmq.
+
+
+Summary
+=======
+
+ActionEvent lets you "do something later".  Many things can be taken out of the front-end flow and
+moved to an asynchronous task, speeding up the overall user experience.  LivingSocial has over a hundred
+event pollers spread out on five machines processing millions of events a day.
+
+ActionEvent allows you to:
+
+  * Queue an event from within a rails application to be processed asynchronously.
+  * Access your full rails environment from event processor.
+  * Process events across any number of physical machines (there is no master process).
+  * Start/stop processors on the fly without interrupting anything (think: cloud computing).
+  * Events support inheritance and a simple before_filter/skip_before_filter chain as well.
+
+Queueing an Event
+=================
+
+You can queue up as many events you want from within a rails application using the "queue_action_event"
+method available on all objects.  This takes an event name and an optional hash of parameters.  The name
+and parameters are serialized and stored as an active record object. You can also prioritize events (default
+priorities are :high, :medium and :low).  Pollers will always look for events from the highest priority
+first, so all :high messages will be processed before a single :medium message is processed.
+
+Queueing examples:
+
+    queue_action_event(:some_event)
+    queue_action_event(:some_event, :people_ids => [1,2,3])
+    queue_action_event(:send_email, :queue => :high)
+
+
+Pollers: Processing an Event
+============================
+
+You need to have one or more "pollers" which will process events as they come in the queue.  Pollers will
+continuously query the database trying to get another event to process.  If it finds one, it will try to
+take "ownership" of the event so that no other pollers will process the event.  If this fails (meaning
+another poller already took the message), it moves on.  If it succeeds and takes ownership of the message,
+it will process the event through the corresponding app/events/*_event.rb class.
+
+If you have multiple pollers (likely), you can start and stop them as a daemon.  Each poller needs a unique
+ID so it can keep track of their PID file and stop and start gracefully.  After processing every message,
+a daemonized poller will check their PID file to see if it matches their current process id.  If it doesn't
+match, the poller will stop gracefully.  This allows you to start up a new poller on updated code without
+waiting for or interrupting an existing poller if it happens to be in the middle of processing a message.
+
+Poller examples:
+
+    ./script/poller
+    ./script/poller -d start
+    ./script/poller --daemon --id=2 start
+    ./script/poller --daemon --id=2 --queues="high medium" start
+    
+
+Example
+=======
+
+$ ./script/generate event HelloWorld
+      exists  db/migrate
+      create  db/migrate/20090207172934_create_action_event_tables.rb
+      create  script/poller
+      create  app/events
+      create  app/events/application_event.rb
+      exists  app/events/
+      create  app/events/hello_world_event.rb
+
+# NOTE: running this migration is only necessary the very first time you create an action_event
+$ rake db:migrate
+==  CreateActionEventTables: migrating ========================================
+-- create_table(:action_event_messages)
+   -> 0.0844s
+-- create_table(:action_event_statuses)
+   -> 0.0359s
+==  CreateActionEventTables: migrated (0.1212s) ===============================
+
+$ cat > app/events/hello_world_event.rb
+      class HelloWorldEvent < ApplicationEvent
+        def process
+          puts "hello #{params[:name]}"
+        end
+      end
+
+$ ./script/runner "queue_action_event('hello_world', :name => 'world')"
+
+$ ./script/poller
+[Sat Feb 07 12:41:43 -0500 2009] Processing queues: high,medium,low
+[Sat Feb 07 12:44:31 -0500 2009] Processing medium:1 ({:name=>"world", :event=>"hello_world"})
+hello world
+[Sat Feb 07 12:44:31 -0500 2009] Finished processing medium:1 ({:name=>"world", :event=>"hello_world"})
+
+Copyright (c) 2009 Warren Konkel, released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the action_event plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the action_event plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActionEvent'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/action_event.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name     = "action_event"
+  s.version  = "0.0.1"
+  s.date     = "2009-10-06"
+  s.summary  = "A framework for asynchronous message processing in a Rails application."
+  s.email    = "wkonkel@gmail.com"
+  s.homepage = "http://github.com/wkonkel/action_event"
+  s.description = "A framework for asynchronous message processing in a Rails application."
+  s.has_rdoc = false
+  s.authors  = ["Warren Konkel"]
+  s.files    = Dir.glob('**/*') - Dir.glob('test/*.rb')
+  s.test_files = Dir.glob('test/*.rb')
+end

data/generators/event/event_generator.rb

@@ -0,0 +1,18 @@
+class EventGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      # if there's not an app/events directory, do an initial install
+      unless File.exists?("#{RAILS_ROOT}/app/events")
+        #m.migration_template 'migration.rb', "db/migrate", { :migration_file_name => "create_action_event_tables" }
+        m.file 'poller', 'script/poller', :chmod => 0755
+        m.directory 'app/events'
+        m.file 'application_event.rb', 'app/events/application_event.rb'
+      end
+      
+      # generate this event
+      m.class_collisions "#{class_name}Event"
+      m.directory File.join('app/events', class_path)
+      m.template 'event.rb', File.join('app/events', class_path, "#{file_name}_event.rb")
+    end
+  end
+end

data/generators/event/templates/application_event.rb

@@ -0,0 +1,2 @@
+class ApplicationEvent < ActionEvent::Base
+end

data/generators/event/templates/event.rb

@@ -0,0 +1,4 @@
+class <%= class_name %>Event < ApplicationEvent
+  def process
+  end
+end

data/generators/event/templates/migration.rb

@@ -0,0 +1,22 @@
+class CreateActionEventTables < ActiveRecord::Migration
+  def self.up
+    ActionEvent::Message.connection.create_table(:action_event_messages) do |t|
+      t.string :event, :null => false
+      t.text :params
+      t.timestamps
+    end
+    
+    ActionEvent::Message.connection.create_table(:action_event_statuses) do |t|
+      t.integer :last_processed_message_id, :null => false
+      t.string :table_name, :null => false
+      t.timestamps
+    end
+    
+    ActionEvent::Message.connection.add_index :action_event_statuses, :table_name, :unique => true
+  end
+
+  def self.down
+    ActionEvent::Message.connection.drop_table :action_event_messages
+    ActionEvent::Message.connection.drop_table :action_event_statuses
+  end
+end

data/generators/event/templates/poller

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), '/../vendor/plugins/action_event/lib'))
+require 'action_event/commands/poller'

data/init.rb

@@ -0,0 +1 @@
+require 'action_event'

data/lib/action_event.rb

@@ -0,0 +1,5 @@
+require 'action_event/base'
+require 'action_event/object_extensions'
+require 'action_event/message'
+ActiveSupport::Dependencies.load_paths << File.join(RAILS_ROOT, 'app/events')
+

data/lib/action_event/base.rb

@@ -0,0 +1,77 @@
+module ActionEvent
+  class Base
+
+    include ActionController::UrlWriter
+    
+    attr_accessor :params
+    
+    def self.view_paths
+      @view_paths ||= ActionView::Base.process_view_paths(Rails::Configuration.new.view_path)
+    end
+
+    def initialize(params)
+      @params = params.clone
+    end
+
+    def self.process(params={})
+      action_event = new(params)
+      filter_chain.each { |chain| action_event.send(chain) }
+      action_event.process
+    end
+
+    def self.before_filter(method)
+      filter_chain.push(method.to_sym)
+    end
+
+    def self.skip_before_filter(method)
+      filter_chain.delete(method.to_sym)
+    end
+
+    def self.helper(*names)
+      names.each do |name|
+        case name
+          when String, Symbol then helper("#{name.to_s.underscore}_helper".classify.constantize)
+          when Module then master_helper_module.module_eval { include name }
+          else raise
+        end
+      end
+    end
+
+  protected
+
+    def template
+      unless @template
+        @template = ActionView::Base.new(ActionEvent::Base.view_paths, {}, self)
+        @template.extend ApplicationHelper
+        @template.extend self.class.master_helper_module
+        @template.instance_eval { def protect_against_forgery?; false; end }
+      end
+      @template
+    end
+    
+    def method_missing(method, *params, &block)
+      template.send(method, *params, &block)
+    end
+
+    def self.filter_chain
+      unless chain = read_inheritable_attribute('filter_chain')
+        chain = Array.new
+        write_inheritable_attribute('filter_chain', chain)
+      end
+      return chain
+    end
+
+    def self.controller_path
+      @controller_path ||= name.gsub(/Event$/, '').underscore
+    end
+
+    def self.master_helper_module
+      unless mod = read_inheritable_attribute('master_helper_module')
+        mod = Module.new
+        write_inheritable_attribute('master_helper_module', mod)
+      end
+      return mod
+    end
+
+  end
+end

data/lib/action_event/commands/poller.rb

@@ -0,0 +1,237 @@
+require 'fileutils'
+require 'optparse'
+
+module ActionEvent
+  module Commands
+    class Poller
+      def initialize
+        @options = {
+          :id => 1,
+          :queues => %W(high medium low),
+          :command => 'start',
+          :environment => RAILS_ENV,
+          :daemon => false,
+          :max_load_average => 8,
+          :min_instances => 5,
+          :max_instances => 200,
+          :max_adjustment => 5,
+          :min_queue_size => 1000
+        }
+        
+        OptionParser.new do |opts|
+          opts.banner = "Usage: #{$0} [options] <command>"
+          opts.on("-d", "--daemon", "Run as a daemon") { |v| @options[:daemon] = v }
+          opts.on("-i", "--id=N", Integer, "Specify ID used in PID file when running as daemon") { |v| @options[:id] = v }
+          opts.on("-q", "--queues='high medium low'", "Specify queue names in order") { |v| @options[:queues] = v.split(' ') }
+          opts.on("-e", "--environment=development", "Specify which rails environment to run in") { |v| @options[:environment] = v }
+          opts.separator ""
+          opts.separator "Cluster options:"
+          opts.on("-l", "--load-average=8", "Specify what load average to optimize to") { |v| @options[:max_load_average] = v }
+          opts.on("-m", "--min-instances=5", "Specify mimimum number of instances") { |v| @options[:min_instances] = v }
+          opts.on("-x", "--max-instances=200", "Specify maximum number of instances") { |v| @options[:max_instances] = v }
+          opts.on("-a", "--max-adjustment=5", "Specify how many the maximum amount of instances that will be adjusted") { |v| @options[:max_adjustment] = v }
+          opts.on("-s", "--min-queue-size=1000", "Specify how many must be in the queue to adjust instances") { |v| @options[:min_queue_size] = v }
+          opts.separator ""
+          opts.separator "Commands:"
+          opts.separator "    start - starts up the poller"
+          opts.separator "    stop - stops a poller currently running as a daemon"
+          opts.separator "    status - prints the status of the queues"
+          opts.separator ""
+          opts.separator "Examples:"
+          opts.separator "    #{$0} start                       (starts a poller running in the console)"
+          opts.separator "    #{$0} -d -e production start      (starts a poller running as a daemon with ID #1)"
+          opts.separator "    #{$0} --daemon --id=5 start       (starts poller with ID #5)"
+          opts.separator "    #{$0} --daemon --id=5 stop        (stops poller with ID #5)"
+        end.parse!
+
+        @options[:command] = ARGV.pop unless ARGV.empty?
+
+        case
+          when @options[:command] == 'start' && !@options[:daemon] then trap_ctrl_c and load_rails_environment and start_processing_loop
+          when @options[:command] == 'start' && @options[:daemon] then trap_term and start_daemon and load_rails_environment and start_processing_loop and remove_pid
+          when @options[:command] == 'stop' then stop_daemon
+          when @options[:command] == 'cluster' then load_rails_environment and refresh_cluster
+          when @options[:command] == 'status' then load_rails_environment and print_status
+        end
+      end
+
+      def print_status
+        ActionEvent::Message.queue_status(@options[:queues]).to_a.sort { |a,b| a.first <=> b.first }.each do |table,messages_left|
+          log "#{table}:\t\t#{messages_left}"
+        end        
+      end
+      
+      def load_rails_environment
+        ENV['ACTION_EVENT_USE_POLLER_DB'] = 'true'
+        ENV["RAILS_ENV"] = @options[:environment]
+        RAILS_ENV.replace(@options[:environment])
+        log "Loading #{RAILS_ENV} environment..."
+        require "#{RAILS_ROOT}/config/environment"
+        
+        if defined?(NewRelic)
+          NewRelic::Control.instance.instance_eval do
+            @settings['app_name'] = @settings['app_name'] + ' (Poller)'
+          end
+        end
+        
+        true
+      end
+
+      # returns the name of the PID file to use for daemons
+      def pid_filename
+        @pid_filename ||= File.join(RAILS_ROOT, "/log/poller.#{@options[:id]}.pid")
+      end
+
+      # forks from the current process and closes out everything
+      def start_daemon
+        log "Starting daemon ##{@options[:id]}..."
+
+        # some process magic
+        exit if fork                     # Parent exits, child continues.
+        Process.setsid                   # Become session leader.
+        exit if fork                     # Zap session leader. 
+        Dir.chdir "/"                    # Release old working directory.
+        File.umask 0000                  # Ensure sensible umask. Adjust as needed.
+
+        # Free file descriptors and point them somewhere sensible.
+        STDIN.reopen "/dev/null"
+        STDOUT.reopen File.join(RAILS_ROOT, "log/poller.log"), "a"
+        STDERR.reopen STDOUT
+
+        # don't start up until the previous poller is dead
+        while (previous_pid = File.read(pid_filename).to_i rescue nil) do
+          break unless File.exists?("/proc/#{previous_pid}")
+          log "Waiting for previous poller to finish..."
+          Process.kill('TERM', previous_pid) 
+          sleep(5)
+        end
+        
+        # record pid
+        File.open(pid_filename, 'w') { |f| f << Process.pid }
+      end
+
+      def trap_ctrl_c
+        trap("SIGINT") do
+          @stop_processing = true
+          log "Sending stop signal..."
+        end
+      end
+
+      def trap_term
+        trap("SIGTERM") do
+          @stop_processing = true
+          log "Received stop signal..."
+        end
+      end
+
+      def refresh_cluster
+        # gather some current stats
+        current_load = `uptime`.split(' ')[-3..-3][0].to_f
+        current_queue = ActionEvent::Message.queue_status(*@options[:queues]).to_a.map(&:last).sum
+
+        # remove stale pid files
+        current_pids = Dir[File.join(RAILS_ROOT, "log/poller.*.pid")]
+        active_pids, stale_pids = current_pids.partition { |f| (File.read("/proc/#{File.read(f).to_i}/cmdline").include?('poller') rescue false) }
+        stale_pids.each { |f| File.delete(f) }
+
+        # compute adjustment based on current load average and queue size
+        if active_pids.length > 0
+          current_instances = active_pids.length
+          needed_instances = ((current_instances*@options[:max_load_average])/current_load).floor
+
+          if needed_instances > current_instances
+            needed_instances = [needed_instances, current_instances + @options[:max_adjustment]].min
+          elsif needed_instances < current_instances && current_queue > @options[:min_queue_size]
+            needed_instances = [needed_instances, current_instances - @options[:max_adjustment]].max
+          end
+        else
+          current_instances = 0
+          needed_instances = @options[:min_instances]
+        end
+
+        needed_instances = @options[:max_instances] if needed_instances > @options[:max_instances]
+        needed_instances = @options[:min_instances] if needed_instances < @options[:min_instances]
+
+
+        # remove pids if there's too many or spawn new ones if there's not enough
+        if needed_instances < current_instances
+          active_pids.last(current_instances - needed_instances).each { |pid_file| puts "delete #{pid_file}" } #File.delete(pid_file) }
+        elsif needed_instances > current_instances
+          (needed_instances - current_instances).times do
+            next_id = (1..needed_instances).to_a.find { |i| !File.exists?(File.join(RAILS_ROOT, "log/poller.#{i}.pid")) }
+            puts "start at id #{next_id}"
+            # if fork
+            # 
+            # end
+          end
+        end
+      end
+  
+      def should_stop_processing?
+        @stop_processing || (@options[:daemon] && (File.read(pid_filename).to_i rescue 0) != Process.pid)
+      end
+  
+      # finds the already running daemon and stops it...
+      def stop_daemon
+        if previous_pid = File.read(pid_filename).to_i rescue nil
+          log "Sending stop signal to daemon ##{@options[:id]}..."
+          Process.kill('TERM', previous_pid) 
+        end
+      end
+      
+      def remove_pid
+        if Process.pid == (File.read(pid_filename).to_i rescue nil)
+          log "Cleaning up PID file..."
+          FileUtils.rm(pid_filename) 
+        end
+      end
+  
+      # loops until should_stop_processing? set to true... in local mode, this is never set so it will loop forever
+      def start_processing_loop
+        log "Processing queues: #{@options[:queues].join(',')}"
+        next_iteration or sleep(0.5) until should_stop_processing?
+        log "Got signal to stop... exiting."
+      end
+
+      # if we can get a message, process it
+      def next_iteration
+        reload_application if RAILS_ENV == 'development'
+        if message = ActionEvent::Message.try_to_get_next_message(@options[:queues])
+          begin
+            log_text = "#{message[:queue_name]}:#{message[:event]} (#{message[:params].inspect})"
+            log "Processing #{log_text}"
+            "#{message[:event]}_event".camelize.constantize.process(message[:params])
+            log "Finished processing #{log_text}"
+          rescue Exception => e
+            log "Error processing #{log_text}: #{e} #{e.backtrace.join("\n")}"
+          end
+          return true
+        else
+          # return false if we didn't get a message... makes start_processing_loop sleep(1)
+          return false
+        end
+      rescue Exception => e
+        log "Error getting next message (#{e})"
+        ActionEvent::Message.connection.verify! rescue log("Error verifying DB connection... sleeping 5 seconds. (#{$!})") and sleep(5)
+        return true
+      end
+      
+      def reload_application
+        ActionController::Routing::Routes.reload
+        ActionController::Base.view_paths.reload! rescue nil
+        ActionView::Helpers::AssetTagHelper::AssetTag::Cache.clear rescue nil
+
+        ActiveRecord::Base.reset_subclasses
+        ActiveSupport::Dependencies.clear
+        ActiveRecord::Base.clear_reloadable_connections!
+      end
+      
+      def log(message)
+        $stdout.puts "[#{"#{@options[:id]}:#{Process.pid} " if @options[:daemon]}#{Time.now}] #{message}"
+        $stdout.flush
+      end
+    end
+  end
+end
+
+ActionEvent::Commands::Poller.new

data/lib/action_event/message.rb

@@ -0,0 +1,39 @@
+class ActionEvent::Message
+
+  cattr_accessor :default_queue, :instance_writer => false
+  @@default_queue = :medium
+  
+  def self.deliver(queue_name, event, params = {})
+    with_queue(queue_name) { |queue| queue.publish(Marshal.dump({:event => event, :params => params})) }
+  end
+
+  def self.try_to_get_next_message(*queues)
+    queues.flatten.each do |queue_name|
+      if message = with_queue(queue_name) { |queue| m = queue.pop; m ? Marshal.load(m) : nil }
+        return { :queue_name => queue_name, :event => message[:event], :params => message[:params] }
+      end
+    end
+    return nil
+  end
+
+  def self.queue_status(*queues)
+    queues.flatten.inject({}) do |hash, queue_name|
+      hash[queue_name] = with_queue(queue_name) { |queue| queue.status }
+      hash
+    end
+  end
+
+protected
+
+  def self.with_queue(queue_name, &block)
+    queue_name = queue_name.to_s
+    @config ||= YAML.load(File.read(File.join(RAILS_ROOT, 'config', 'rabbitmq.yml')))[RAILS_ENV]
+    @queues ||= {}
+    yield @queues[queue_name] ||= Carrot.new(:host => @config['rabbitmq_server']).queue("#{@config['application_name']}-#{queue_name}")
+  rescue => e
+    @queues[queue_name] = nil
+    puts e
+    RAILS_DEFAULT_LOGGER.error "ERROR: #{e}"
+  end
+
+end

data/lib/action_event/object_extensions.rb

@@ -0,0 +1,6 @@
+Object.class_eval do
+  def queue_action_event(event, options={})
+    queue_name = options.delete(:queue) || ActionEvent::Message.default_queue
+    ActionEvent::Message.deliver(queue_name, event, options)
+  end
+end

data/test/action_event_test.rb

@@ -0,0 +1,99 @@
+require 'test_helper'
+
+class ActionEventTest < ActiveSupport::TestCase
+  test "all objects have queue_action_event" do
+    assert respond_to?(:queue_action_event)
+  end
+  
+  test "queue_action_event create a test message" do
+    assert_nil get_next_message
+    queue_action_event('test')
+    assert_equal get_next_message.event, 'test'
+    assert_nil get_next_message
+  end
+  
+  test "params are serialized" do
+    params = {:a => 1, :b => [1,2,3]}
+    queue_action_event('test', params)
+    assert get_next_message.params == params
+  end
+  
+  test "priority of queues is respected in the same day" do
+    queue_action_event('test_low', :queue => :low)
+    queue_action_event('test_medium', :queue => :medium)
+    queue_action_event('test_high', :queue => :high)
+    assert_equal get_next_message.event, 'test_high'
+    assert_equal get_next_message.event, 'test_medium'
+    assert_equal get_next_message.event, 'test_low'
+  end
+  
+  test "yesterday is processed before today" do
+    override_time_for_queues(1.day) { queue_action_event('test_yesterday') }
+    override_time_for_queues(2.day) { queue_action_event('test_two_days_ago') }
+    queue_action_event('test_today')
+    assert_equal get_next_message.event, 'test_two_days_ago'
+    assert_equal get_next_message.event, 'test_yesterday'
+    assert_equal get_next_message.event, 'test_today'
+  end
+  
+  test "priority is preserved across days" do
+    queue_action_event('test_low', :queue => :low)
+    override_time_for_queues(1.day) { queue_action_event('test_high', :queue => :high) }
+    override_time_for_queues(2.day) { queue_action_event('test_medium', :queue => :medium) }
+    assert_equal get_next_message.event, 'test_high'
+    assert_equal get_next_message.event, 'test_medium'
+    assert_equal get_next_message.event, 'test_low'
+  end
+
+  test "cleanup doesn't delete bad data" do
+    ActionEvent::Message.reset!
+    assert_equal ActionEvent::Message.send(:all_message_tables).length, 0
+    assert_nil get_next_message
+
+    queue_action_event('test1')
+    ActionEvent::Message.cleanup!
+
+    override_time_for_queues(1.day) { queue_action_event('test2') }
+    ActionEvent::Message.cleanup!
+
+    override_time_for_queues(2.day) { queue_action_event('test3') }
+    ActionEvent::Message.cleanup!
+    
+    assert_equal get_next_message.event, 'test3'
+    ActionEvent::Message.cleanup!
+
+    assert_equal get_next_message.event, 'test2'
+    ActionEvent::Message.cleanup!
+
+    assert_equal get_next_message.event, 'test1'
+    ActionEvent::Message.cleanup!
+    
+    assert_nil get_next_message
+  end
+
+protected
+
+  def get_next_message
+    ActionEvent::Message.try_to_get_next_message([:high, :medium, :low])
+  end
+
+  def override_time_for_queues(time_offset, &block)
+    ActionEvent::Message.class_eval %(
+      class << self
+        alias :original_current_table_name_for_queue :current_table_name_for_queue
+        def current_table_name_for_queue(queue_name)
+          original_current_table_name_for_queue(queue_name, Time.now - #{time_offset.to_i})
+        end
+      end
+    )
+    
+    yield block
+
+    ActionEvent::Message.class_eval %(
+      class << self
+        alias :current_table_name_for_queue :original_current_table_name_for_queue
+      end
+    )
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: action_event
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Warren Konkel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-06 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: A framework for asynchronous message processing in a Rails application.
+email: wkonkel@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- action_event.gemspec
+- Capfile
+- generators/event/event_generator.rb
+- generators/event/templates/application_event.rb
+- generators/event/templates/event.rb
+- generators/event/templates/migration.rb
+- generators/event/templates/poller
+- init.rb
+- lib/action_event/base.rb
+- lib/action_event/commands/poller.rb
+- lib/action_event/message.rb
+- lib/action_event/object_extensions.rb
+- lib/action_event.rb
+- MIT-LICENSE
+- Rakefile
+- README
+has_rdoc: true
+homepage: http://github.com/wkonkel/action_event
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A framework for asynchronous message processing in a Rails application.
+test_files: 
+- test/action_event_test.rb
+- test/test_helper.rb