task_manager 0.0.1

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm use ruby-1.8.7-p334
+rvm gemset use 'task_manager'

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development do
+  gem 'gem-release'
+end

data/README

@@ -0,0 +1,38 @@
+= task_manager
+
+A simple wrapper around the Rufus::Scheduler to have a more configurable setup.
+
+== Installation
+
+  gem install task_manager
+
+== Usage
+
+== Development
+
+If you want to develop it further, patch something or are just plain curious:
+you're welcome.  This should get you started:
+
+  $ git clone git://github.com/kronn/task_manager.git
+  $ bundle install
+  $ ruby test/task_manager_test.rb
+
+Bundler is only used for installing dependencies. 
+
+The usual pattern for github-projects applies:
+
+* Fork the project.
+* Add failing tests.
+* Improve the code.
+* Send me a pull request.
+
+I'll take a look at it and try to integrate it. If I cannot apply your changes
+or don't want to, I'll let you know.
+
+== Documentation
+
+see doc/*
+
+== Copyright
+
+Copyright (c) 2010-2011 Matthias Viehweger. See doc/LICENSE for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/task_manager.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+# vim:ft=ruby:fileencoding=utf8
+
+# read environment variables or use default values
+# RAILS_ENV=${RAILS_ENV:-"staging"}
+# RUBY_BIN=${RUBY_BIN:-"ruby"}
+# BASEPATH=${BASEPATH:-"/home/application/projects/rails/$RAILS_ENV/current"}
+rails_env = Rails.env
+ruby_bin  = 'ruby'
+base_path = Rails.root
+
+
+# variables that should only be changed if you REALLY know what you're doing
+# e.g. the log-filename is hardcoded in the scheduling-script
+# LOG="$BASEPATH/log/$RAILS_ENV.scheduler.log"
+# SCHEDULER_FILENAME='tasks.rb'
+# SCHEDULER="$BASEPATH/config/$SCHEDULER_FILENAME"
+log = base_path.join('log').join("#{rails_env}.scheduler.log")
+scheduler_fn = 'tasks.rb'
+scheduler = basepath.join('config').join(scheduler_fn)
+
+# PID=`ps aux | grep -v 'grep' | egrep "$RAILS_ENV.*$SCHEDULER_FILENAME" | head -n1 | sed 's/^!gw*\W\+\(\w\+\).*$/\1/'`
+pid = `ps aux | grep -v 'grep' | egrep "$RAILS_ENV.*$SCHEDULER_FILENAME" | head -n1 | sed 's/^\w*\W\+\(\w\+\).*$/\1/'`
+
+# # start scheduler in the background
+# function start_scheduler() {
+#   if [ -z "$PID" ]; then
+#     $RUBY_BIN $SCHEDULER >>$LOG 2>&1 &
+#     disown -a -h
+#   fi
+# }
+#
+# # kill the scheduler if it's running
+# function kill_scheduler() {
+#   if [ -n "$PID" ]; then
+#     kill $PID
+#   fi;
+# }
+#
+# # actual "init.d"-like interface
+# case "$1" in
+#   start)
+#     start_scheduler
+#     ;;
+#   stop)
+#     kill_scheduler
+#     ;;
+#   restart)
+#     kill_scheduler
+#     start_scheduler
+#     ;;
+#   status)
+#     if [ -n "$PID" ]; then
+#       echo "Scheduling is active ($PID)"
+#     else
+#       echo "Scheduling is inactive"
+#     fi
+#     ;;
+#   pid)
+#     echo $PID
+#     ;;
+#   *)
+#     echo "Usage: $0 {start|stop|restart|status|pid}"
+#     echo ""
+#     echo "recognized environment variables with default in parentheses:"
+#     echo ""
+#     echo "  variables which should be given"
+#     echo "    BASEPATH  ($BASEPATH)"
+#     echo "    RAILS_ENV ($RAILS_ENV)"
+#     echo ""
+#     echo "  variables which can be given for optimization reasons"
+#     echo "    RUBY_BIN  ($RUBY_BIN)"
+#     ;;
+# esac
+#
+# # for the lack of a better return value, exit successfully
+# exit 0

data/bin/task_manager.sh

@@ -0,0 +1,67 @@
+#!/bin/bash
+
+# read environment variables or use default values
+RAILS_ENV=${RAILS_ENV:-"staging"}
+RUBY_BIN=${RUBY_BIN:-"ruby"}
+BASEPATH=${BASEPATH:-"/home/application/projects/rails/$RAILS_ENV/current"}
+
+# variables that should only be changed if you REALLY know what you're doing
+# e.g. the log-filename is hardcoded in the scheduling-script
+LOG="$BASEPATH/log/$RAILS_ENV.scheduler.log"
+SCHEDULER_FILENAME='tasks.rb'
+SCHEDULER="$BASEPATH/config/$SCHEDULER_FILENAME"
+PID=`ps aux | grep -v 'grep' | egrep "$RAILS_ENV.*$SCHEDULER_FILENAME" | head -n1 | sed 's/^\w*\W\+\(\w\+\).*$/\1/'`
+
+# start scheduler in the background
+function start_scheduler() {
+  if [ -z "$PID" ]; then
+    $RUBY_BIN $SCHEDULER >>$LOG 2>&1 &
+    disown -a -h
+  fi
+}
+
+# kill the scheduler if it's running
+function kill_scheduler() {
+  if [ -n "$PID" ]; then
+    kill $PID
+  fi;
+}
+
+# actual "init.d"-like interface
+case "$1" in
+  start)
+    start_scheduler
+    ;;
+  stop)
+    kill_scheduler
+    ;;
+  restart)
+    kill_scheduler
+    start_scheduler
+    ;;
+  status)
+    if [ -n "$PID" ]; then
+      echo "Scheduling is active ($PID)"
+    else
+      echo "Scheduling is inactive"
+    fi
+    ;;
+  pid)
+    echo $PID
+    ;;
+  *)
+    echo "Usage: $0 {start|stop|restart|status|pid}"
+    echo ""
+    echo "recognized environment variables with default in parentheses:"
+    echo ""
+    echo "  variables which should be given"
+    echo "    BASEPATH  ($BASEPATH)"
+    echo "    RAILS_ENV ($RAILS_ENV)"
+    echo ""
+    echo "  variables which can be given for optimization reasons"
+    echo "    RUBY_BIN  ($RUBY_BIN)"
+    ;;
+esac
+
+# for the lack of a better return value, exit successfully
+exit 0

data/doc/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2011 Matthias Viehweger
+
+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/lib/task_manager.rb

@@ -0,0 +1,50 @@
+# needs rufus-scheduler
+require 'rufus/scheduler'
+require 'pathname'
+
+class TaskManager
+  attr_accessor :jobs
+  attr_reader :env, :path
+
+  # create the necessary scheduler/job-storages and store a basepath and a environment
+  def initialize(env = 'staging', path = '.')
+    @path = Pathname.new(path)
+    @env = env.to_sym
+    @jobs = {}
+    @schedulers = {}
+  end
+
+  # return a named scheduler
+  def scheduler(key)
+    @schedulers[key] ||= Rufus::Scheduler.start_new
+  end
+
+  # prevent RubyVM from quitting
+  def persist
+    say "Scheduler wird persistiert, alle Definitionen sollten geladen sein."
+    scheduler(:internal).join
+  end
+
+  # unschedule/stop a job
+  def unschedule(key)
+    jobs[key].unschedule
+    jobs[key] = nil
+    say "Job #{key} stopped"
+  end
+
+  # system-call
+  def execute_task(cmd_string)
+    shortened_cmd = cmd_string.gsub(/--trace/, '').strip
+    say   "starting #{shortened_cmd}"
+    if system("cd #{path}; RAILS_ENV=#{env} #{cmd_string} >/dev/null 2>>#{path}/log/#{env}.scheduler.log")
+      say "finished #{shortened_cmd}"
+    else
+      say "ERROR in #{shortened_cmd}"
+    end
+  end
+
+  # output a message with Time
+  def say(msg)
+    puts "#{Time.now} - #{msg}"
+  end
+end

data/lib/task_manager/version.rb

@@ -0,0 +1,14 @@
+# vim:ft=ruby:fileencoding=utf-8
+
+unless defined?(TaskManager::VERSION)
+  module TaskManager
+    VERSION = "0.0.1"
+    DATE = File.mtime(__FILE__)
+    SUMMARY = 'A simple wrapper around the Rufus::Scheduler to have a more configurable setup.'
+    DESCRIPTION = <<-EOT
+      A simple wrapper around the Rufus::Scheduler to have a more configurable setup.
+
+      The Task to be scheduled should be defined in a subclass.
+    EOT
+  end
+end

data/test/task_manager_test.rb

@@ -0,0 +1,46 @@
+require 'rubygems'
+
+require 'more_unit_test/assert_stdout'
+require 'test/unit'
+
+require 'task_manager'
+
+class TaskManagerTest < Test::Unit::TestCase
+  # remember to clean up after each test-run
+  def teardown
+    # @sut.unschedule(:internal)
+    @sut = nil
+  end
+
+  # lets start by trying to create a taskmanager
+  def test_creating_a_blank_taskmanager
+    assert_nothing_raised do
+      TaskManager.new
+      TaskManager.new('staging', '/path/to/project')
+    end
+  end
+
+  # now that thats out of the way, define some helper methods
+  def tm
+    @sut ||= TaskManager.new
+  end
+
+  # assert_stdout_block does Expected==Actual internally, therefore I give a more flexbile expectation
+  class MatchableString < String
+    def initialize(string)
+      @data = string
+    end
+
+    def ==(other)
+      /#{Regexp.escape(@data)}/.match(other)
+    end
+  end
+
+  # on to the show
+
+  def test_taskmanager_can_output_messages
+    assert_stdout_block MatchableString.new('testing') do
+      TaskManager.new.say('testing')
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: task_manager
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mattthias Viehweger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-13 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rufus-scheduler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        - 6
+        version: 2.0.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: more_unit_test
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: "      A simple wrapper around the Rufus::Scheduler to have a more configurable setup.\n\n      The Task to be scheduled should be defined in a subclass.\n"
+email: 
+- kronn@kronn.de
+executables: 
+- task_manager.rb
+- task_manager.sh
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .rvmrc
+- Gemfile
+- README
+- Rakefile
+- bin/task_manager.rb
+- bin/task_manager.sh
+- doc/LICENSE
+- lib/task_manager.rb
+- lib/task_manager/version.rb
+- test/task_manager_test.rb
+has_rdoc: true
+homepage: http://github.com/kronn/task_manager
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: task_manager
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple wrapper around the Rufus::Scheduler to have a more configurable setup.
+test_files: 
+- test/task_manager_test.rb