ngauthier-active-listener 0.2.0

data/README.markdown

@@ -0,0 +1,24 @@
+# Active Listener: Event listening and firing system for ruby
+
+## Description
+This gem allows you to define tasks that can be run at specific time intervals. In the future, we plan to allow event listening and firing.
+
+## Configuration
+
+### Add a config file
+
+### Include in your boot
+
+## Installation
+
+### Latest Stable
+    sudo gem install ngauthier-active-listener
+
+### Cutting Edge
+    git clone git@github.com:ngauthier/active-listener.git active-listener
+    cd active-listener
+    rake gem install
+
+## Other notes
+This gem uses Jeweler.
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 2
+:patch: 0
+:major: 0

data/bin/active-listener

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require 'active-listener'
+
+running = true
+Signal.trap("TERM") do
+  running = false
+end
+
+if ARGV[0].nil? or ARGV[1].nil? or (ARGV[0] != '--stop' and ARGV[2].nil?)
+  puts "USAGE:"
+  puts "\tactive-listener <config_file> <log_file> <rake_root>"
+  puts "\tactive-listener --stop <pid_file>"
+  exit(1)
+end
+
+if ARGV[0] == "--stop"
+  ActiveListener.stop(:pid_file => ARGV[1])
+  exit(0)
+end
+
+@al = ActiveListener.new :config => ARGV[0], :log_file => ARGV[1], :rake_root => ARGV[2]
+
+if @al.events.empty?
+  log = File.new(ARGV[1], 'a')
+  log.write "ActiveListener is very boring without events"
+  log.close
+  running = false
+end
+
+while running
+  @al.fire_events
+  @al.sleep_to_next_event
+end

data/lib/active-listener.rb

@@ -0,0 +1,124 @@
+require 'fileutils'
+require 'yaml'
+
+class ActiveListener
+  attr_reader :events
+
+  def self.autostart(opts = {})
+    begin
+      config_file = File.expand_path(opts[:config])
+      pid_file    = File.expand_path(opts[:pid_file])
+      log_file    = File.expand_path(opts[:log_file])
+      rake_root   = File.expand_path(opts[:rake_root])
+    rescue
+      raise "Need :config :pid_file :log_file :rake_root"
+    end
+    ActiveListener.stop(opts)
+    command = [
+      "start-stop-daemon --start",
+      "--make-pidfile --pidfile #{pid_file}",
+      "--background",
+      "--exec #{File.expand_path(File.join(File.dirname(__FILE__), '..', 'bin', 'active-listener'))}",
+      "--chdir #{File.expand_path(File.dirname(__FILE__))}",
+      "--",
+      "#{config_file}",
+      "#{log_file}",
+      "#{rake_root}"
+    ].join(" ")
+    `#{command}`
+  end
+
+  def self.stop(opts = {})
+    pid_file = opts[:pid_file]
+    `start-stop-daemon --stop --oknodo --quiet --pidfile #{File.expand_path(pid_file)}`
+  end
+
+  def initialize(opts = {})
+    self.events = []
+    self.log_file = opts[:log_file]
+    self.rake_root = opts[:rake_root]
+    clear_log
+    log("ActiveListener Initialized")
+    load_events(opts[:config])
+  end
+
+  def add_event(evt)
+    self.events.push(evt)
+    log("Added Event #{evt.inspect}")
+  end
+
+  def fire_events
+    self.events.select{|e| e.time_to_fire < 0}.each do |evt|
+      log("Firing event: #{evt.inspect}")
+      log(evt.fire(:rake_root => rake_root))
+    end
+  end
+
+  def sleep_to_next_event
+    self.events.sort{|x,y| x.time_to_fire <=> y.time_to_fire}
+    if self.events.first
+      sleep_time = self.events.first.time_to_fire+0.01
+    else
+      sleep_time = 0.5
+    end
+    log("Sleeping for #{sleep_time}")
+    sleep(sleep_time)
+  end
+
+  class Event
+    def initialize(opts = {})
+      self.task = opts[:task] || opts["task"]
+      self.period = opts[:period] || opts["period"]
+      self.last_fire = 0
+    end
+
+    def time_to_fire
+      last_fire + period - Time.now.to_f
+    end
+
+    def fire(opts = {})
+      self.last_fire = Time.now.to_f
+      Dir.chdir(opts[:rake_root]) if opts[:rake_root]
+      `rake #{task}`
+      opts[:rake_root]
+    end
+
+    private
+
+    attr_accessor :task, :period, :last_fire
+
+  end
+
+  private
+
+  attr_writer :events
+  attr_accessor :log_file, :rake_root
+
+  def load_events(config_file)
+    return if config_file.nil?
+    unless File.exists?(config_file)
+      log("Config file not found at #{config_file}")
+      return
+    end
+    log("Loading tasks from #{config_file}")
+    f = File.new(config_file,'r')
+    yml = YAML.load(f)
+    yml["tasks"].each do |task|
+      self.add_event(Event.new(task))
+    end
+  end
+
+  def clear_log
+    return unless log_file
+    FileUtils.rm_f log_file
+  end
+
+  def log(text)
+    return unless log_file
+    f = File.new(log_file, 'a')
+    f.write text
+    f.write "\n"
+    f.close
+  end
+
+end

data/test/active_listener.yml

@@ -0,0 +1,6 @@
+---
+  tasks:
+  - task: test:touch_file
+    period: 1
+  - task: test:touch_file
+    period: 3

data/test/active_listener_test.rb

@@ -0,0 +1,118 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'active-listener'
+
+class ActiveListenerTest < Test::Unit::TestCase
+  context "A new listener" do
+
+    setup do
+      @al = ActiveListener.new({})
+    end
+
+    should "have an empty events list" do
+      assert @al.events.empty?
+    end
+
+    should "be able to add an event" do
+      @al.add_event(
+        ActiveListener::Event.new(
+          :task => "meh", 
+          :period => 5
+        )
+      )
+      assert !@al.events.empty?
+    end
+
+    should "sleep when it has no events" do
+      @al.sleep_to_next_event
+    end
+
+    context "with a file timer" do
+      setup do
+        @al.add_event(
+          ActiveListener::Event.new(
+            :task => "test:touch_file",
+            :period => 1
+          )
+        )
+        @sample_file = File.join(File.dirname(__FILE__),'sample.txt')
+        FileUtils.rm_f(@sample_file)
+      end
+
+      teardown do
+        FileUtils.rm_f(File.join(File.dirname(__FILE__),'sample.txt'))
+      end
+
+      should "touch a file" do
+        assert !File.exists?(@sample_file)
+        @al.fire_events
+        assert File.exists?(@sample_file)
+      end
+
+      should "need to be fired when added" do
+        assert @al.events[0].time_to_fire < 0
+      end
+
+      should "need to be fired 1 second after being fired" do
+        @al.fire_events
+        assert @al.events[0].time_to_fire > 0
+        FileUtils.rm_f(@sample_file)
+        @al.fire_events
+        assert !File.exists?(@sample_file)
+        @al.sleep_to_next_event
+        assert @al.events[0].time_to_fire < 0
+        assert !File.exists?(@sample_file)
+        @al.fire_events
+        assert File.exists?(@sample_file)
+        assert @al.events[0].time_to_fire > 0
+      end
+
+    end
+  end
+
+  context "A listener" do
+    setup do
+      @config_path = File.join(File.dirname(__FILE__), 'active_listener.yml')
+      @sample_file = File.join(File.dirname(__FILE__),'sample.txt')
+      FileUtils.rm_f @sample_file
+    end
+
+    should "be able to read events from yaml" do
+      @al = ActiveListener.new(:config => @config_path)
+      assert @al.events.size > 0
+      assert !File.exists?(@sample_file)
+      @al.fire_events
+      assert File.exists?(@sample_file)
+    end
+
+  end
+
+  context "An autostarted listener" do
+
+    setup do
+      ActiveListener.autostart(
+        :config => File.join(File.dirname(__FILE__), 'active_listener.yml'),
+        :pid_file => File.join(File.dirname(__FILE__), 'active_listener.pid'),
+        :log_file => File.join(File.dirname(__FILE__), 'active_listener.log'),
+        :rake_root => File.join(File.dirname(__FILE__), '..')
+      )
+      @sample_file = File.join(File.dirname(__FILE__),'sample.txt')
+    end
+
+    teardown do
+      ActiveListener.stop(
+        :pid_file => File.join(File.dirname(__FILE__), 'active_listener.pid')
+      )
+      FileUtils.rm_f(File.join(File.dirname(__FILE__),'sample.txt'))
+    end
+
+    should "load events from the config file" do
+      sleep(1)
+      assert File.exists?(@sample_file)
+      FileUtils.rm_f(@sample_file)
+      assert !File.exists?(@sample_file)
+      sleep(1)
+      assert File.exists?(@sample_file)
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: ngauthier-active-listener
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Nick Gauthier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-29 00:00:00 -08:00
+default_executable: active-listener
+dependencies: []
+
+description: TODO
+email: nick@smartlogicsolutions.com
+executables: 
+- active-listener
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- VERSION.yml
+- README.markdown
+- bin/active-listener
+- lib/activelistener
+- lib/active-listener.rb
+- test/test_helper.rb
+- test/active_listener.log
+- test/active_listener.pid
+- test/active_listener.yml
+- test/active_listener_test.rb
+has_rdoc: true
+homepage: http://github.com/ngauthier/active-listener
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+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.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: []
+