dvdplm-taskr 0.3.1

data/History.txt

@@ -0,0 +1,50 @@
+=== In Progress...
+
+* Log entries in task view can now be filtered by date. By default only entries
+  from the last 24 hours are shown.
+* Added experimental 'dont_wait' parameter to the Taskr4Rails action that 
+  forces the remote code to be forked so that it does not hold up the entire 
+  server. Currently this will only work if the remote Rails server is running 
+  on Mongrel. 
+
+=== 0.3.0 :: 2008-06-19
+
+* Added "Run Now" function allowing a task to be immediately triggered.
+* The Rest action can now take the 'params' parameter as a CGI string
+  (e.g. foo=bar&blah=hello&taskr=awesome). The string does not have
+  to be properly URI-encoded, since the algorithm for parsing it simply
+  splits it based on & and = symbols.
+* Changed Scheduler gem from the old OpenWFE to the new Rufus.
+* Task executions are now logged to the new log_entries table. These
+  log entries are viewable under the task detail page.
+* Exceptions raised when a task is run manually are now handled gracefully
+  (or rather, silently, since they should be logged by the action).
+* Blank parameter values are now correctly stored as NULL rather than 0.
+
+=== 0.2.1 :: 2008-02-28
+
+* Updated for compatibility with picnic 0.6.1.
+
+=== 0.2.0 :: 2008-01-03
+
+* Added Taskr4rails action and accompanying Rails plugin for
+  executing code on a remote Rails server. See
+  http://code.google.com/p/ruby-taskr/wiki/Taskr4rails for
+  details.
+* The Howlr action now takes an optional content_type parameter
+  to allow for sending out HTML-formatted messages.
+* Better error reporting for Restr-based actions. The remote server's
+  response body is now included in Taskr's error report and the 
+  remote output is printed to the log more cleanly.
+* Change to REST API: the 'action(s)' parameter is now a bit looser. 
+  You can use 'action' or 'actions' interchangeably, whether you're 
+  scheduling multiple actions or just one.
+* Fixed some routing problems in the HTML views.
+* The ActiveResource and PHP examples have been updated with
+  some more illustrative code and better explanations.
+* Misc bugs fixed while writing extensive documentation. See
+  wiki pages at http://code.google.com/p/ruby-taskr/w/list.
+
+=== 0.1.0 :: 2007-12-21
+
+* First public release.

data/Manifest.txt

@@ -0,0 +1,34 @@
+CHANGELOG.txt
+GPLv3-LICENSE.txt
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/taskr
+bin/taskr-ctl
+config.example.yml
+examples/active_resource_client_example.rb
+examples/php_client_example.php
+lib/public/prototype.js
+lib/public/taskr.css
+lib/taskr.rb
+lib/taskr/actions.rb
+lib/taskr/controllers.rb
+lib/taskr/environment.rb
+lib/taskr/helpers.rb
+lib/taskr/models.rb
+lib/taskr/version.rb
+lib/taskr/views.rb
+setup.rb
+taskr4rails/LICENSE.txt
+taskr4rails/README
+taskr4rails/Rakefile
+taskr4rails/init.rb
+taskr4rails/install.rb
+taskr4rails/lib/taskr4rails_controller.rb
+taskr4rails/tasks/taskr4rails_tasks.rake
+taskr4rails/test/taskr4rails_test.rb
+taskr4rails/uninstall.rb
+test.rb
+test/taskr_test.rb
+test/test_helper.rb

data/README.txt

@@ -0,0 +1,27 @@
+= Taskr
+
+Taskr is a stand-alone HTTP daemon, providing a cron-like networked scheduling 
+service. Tasks are created and managed via a REST calls over HTTP, allowing 
+other REST-aware services to schedule and manage jobs.
+
+
+Please see Taskr's Google Code site for further information:
+
+http://code.google.com/p/ruby-taskr/
+
+
+
+== LICENSE
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,85 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'taskr', 'version')
+
+AUTHOR = ["Matt Zukowski", "David Palm"]  # can also be an array of Authors
+EMAIL = ["matt at roughest dot net", "dvd plm on googles free email service"]
+DESCRIPTION = "cron-like scheduler service with a RESTful interface"
+GEM_NAME = "taskr" # what ppl will type to install your gem
+RUBYFORGE_PROJECT = "taskr" # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+
+
+NAME = "taskr"
+REV = nil
+VERS = ENV['VERSION'] || (Taskr::VERSION::STRING + (REV ? ".#{REV}" : ""))
+                          CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', "taskr documentation",
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/*_test.rb"]
+  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  #p.changes        - A description of the release's latest changes.
+  #p.extra_deps     - An array of rubygem dependencies.
+  #p.spec_extras    - A hash of extra values to set in the gemspec.
+  
+  p.extra_deps = [
+    ['picnic', '~> 0.6.4'], 
+    ['reststop', '~> 0.3.0'], 
+    ['restr', '~> 0.4.0'], 
+    ['rufus-scheduler', '~> 1.0.7']
+  ]
+  p.spec_extras = {:executables => ['taskr', 'taskr-ctl']}
+end
+
+desc "Generate gemspec"
+task :gemspec do |x|
+  # Check the manifest before generating the gemspec
+  manifest = %x[rake check_manifest]
+  manifest.gsub!(/\(in .{1,}\)\n/, "")
+ 
+  unless manifest.empty?
+    print "\n", "#"*68, "\n"
+    print <<-EOS
+  Manifest.txt is not up-to-date. Please review the changes below.
+  If the changes are correct, run 'rake check_manifest | patch'
+  and then run this command again.
+EOS
+    print "#"*68, "\n\n"
+    puts manifest
+  else
+    gemspec = %x[rake debug_gem]
+    gemspec.gsub!(/\(in .{1,}\)\n/, "")
+    File.open("#{GEM_NAME}.gemspec",'w'){|f| f<<gemspec}
+    # %x[rake debug_gem > #{GEM_NAME}.gemspec]
+  end
+end

data/bin/taskr

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+# ---------------------------------------------------------------------
+# This file is part of Taskr (http://ruby-taskr.googlecode.com/).
+#
+# Taskr is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Taskr is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Taskr.  If not, see <http://www.gnu.org/licenses/>.
+# ---------------------------------------------------------------------
+
+if File.exists?(picnic = File.expand_path(File.dirname(File.expand_path(__FILE__))+'/../vendor/picnic/lib'))
+  $: << picnic
+elsif File.exists?(picnic = File.expand_path(File.dirname(File.expand_path(__FILE__))+'/../../picnic/lib'))
+  $: << picnic
+else
+  require 'rubygems'
+end
+
+require 'picnic/cli'
+
+cli = Picnic::Cli.new(
+  'taskr',
+  :app_path => File.expand_path(File.dirname(File.expand_path(__FILE__)))
+)
+
+cli.handle_cli_input

data/bin/taskr-ctl

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+# ---------------------------------------------------------------------
+# This file is part of Taskr (http://ruby-taskr.googlecode.com/).
+#
+# Taskr is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later verTaskr
+#
+# Taskr is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Taskr.  If not, see <http://www.gnu.org/licenses/>.
+# ---------------------------------------------------------------------
+
+if File.exists?(picnic = File.expand_path(File.dirname(File.expand_path(__FILE__))+'/../vendor/picnic/lib'))
+  $: << picnic
+elsif File.exists?(picnic = File.expand_path(File.dirname(File.expand_path(__FILE__))+'/../../picnic/lib'))
+  $: << picnic
+else
+  require 'rubygems'
+end
+
+require 'picnic/service_control'
+
+ctl = Picnic::ServiceControl.new('taskr')
+
+ctl.handle_cli_input

data/config.example.yml

@@ -0,0 +1,176 @@
+# This is a configuration file for the Taskr RESTful scheduler daemon.
+
+# AN IMPORTANT NOTE ABOUT YAML CONFIGURATION FILES:
+# !!! Be sure to use spaces instead of tabs for indentation, as YAML is very
+# !!! sensitive to white-space inconsistencies!
+
+##### HTTP SERVER ##############################################################
+
+# Under what HTTP environment are you running the Fluxr server? The following 
+# methods are currently supported:
+#
+# webrick -- simple stand-alone HTTP server; this is the default method
+# mongrel -- fast stand-alone HTTP server; much faster than webrick, but 
+#            you'll have to first install the mongrel gem
+# 
+
+### webrick example
+
+server: webrick
+port: 7007
+
+### webrick SSL example
+
+#server: webrick
+#port: 443
+#ssl_cert: /path/to/your/ssl.pem
+
+# if the private key is separate from cert:
+#ssl_key: /path/to/your/private_key.pem
+
+
+### mongrel example
+
+#server: mongrel
+#port: 7007
+
+# It is possible to run mongrel over SSL, but you will need to use a reverse 
+# proxy (try Pound or Apache).
+
+
+##### DATABASE #################################################################
+
+# Taskr needs a database to persist its state between restarts.
+# 
+# By default, we use MySQL, since it is widely used and does not require any 
+# additional ruby libraries besides ActiveRecord.
+#
+# With MySQL, your config would be something like the following:
+# (be sure to create the taskr database in MySQL beforehand,
+#   i.e. `mysqladmin -u root create taskr`)
+
+database:
+  adapter: mysql
+  database: taskr
+  username: root
+  password: 
+  host: localhost
+
+
+# Instead of MySQL you can use SQLite3, PostgreSQL, MSSQL, or anything else 
+# supported by ActiveRecord.
+#
+# If you do not have a database server available, you can try using the SQLite3
+# back-end. SQLite3 does not require it's own server. Instead all data is stored
+# in local files. For SQLite3, your configuration would look something like the
+# following (don't forget to install the 'sqlite3-ruby' gem first!):
+#
+#database:
+#  adapter: sqlite3
+#  dbfile: /var/lib/taskr.db
+
+
+##### AUTHENTICATION ###########################################################
+
+# Taskr supports two methods for authentication: Basic HTTP and CAS. 
+
+### Basic HTTP Example
+# Uset the following if you want Taskr to demand a username and password from 
+# the user using basic HTTP authentication clients. Note that this isn't very 
+# secure unless you run Taskr over HTTPS (see the webrick SSL example above).
+
+#authentication:
+#  method: basic
+#  username: taskr
+#  password: task!
+
+### CAS Example
+# Use the following if you want Taskr to demand a username and password using
+# Single Sign-On CAS (Central Authentication System). For more information on 
+# CAS see http://code.google.com/p/rubycas-server/.
+# The cas_base_url setting should be the URL of your CAS server.
+
+#authenticatoin:
+#  method: cas
+#  cas_base_url: https://login.example.foo/cas
+
+
+##### LOGGING ##################################################################
+
+### System Log
+# This is the general server log where Taskr writes information about web requests.
+# You'll want to look here if you encounter general problems with Taskr's
+# operation. Do not confuse this log with the task log, which records information
+# about the various schedules jobs. The task log is kept in your database and
+# is completely separate (see below). 
+# 
+# By default, we will try to create a log file named 'taskr.log' in the current 
+# directory (the directory where you're running taskr from). A better place to put 
+# the log is in /var/log, but you will have to run taskr as root or otherwise give 
+# it permissions.
+# 
+# Set the level to DEBUG if you want more detailed logging. Other options are
+# INFO, WARN, and ERROR (DEBUG is most verbose, ERROR is least).
+
+log:
+  file: taskr.log
+  level: DEBUG
+#  file: /var/log/taskr.log
+#  level: INFO
+
+### Task Log
+# This is where Taskr records detailed information about your scheduled jobs (tasks).
+# Every time a task is triggered, information about the execution is recorded
+# in this log (i.e. whether the task executed successfuly, its output, etc.)
+# The Task Log is stored in the Taskr database under the log_entries table.
+#
+# Here you can configure the logging level. The "INFO" level is generally a good 
+# choice for production systems, although you may want to keep this at "DEBUG" 
+# if you want to keep a close eye on your tasks -- this is a good idea 
+# especially when setting up a new Taskr system.
+#
+# Note that in order to prevent log data from accumulating indefinitely, you
+# should set up a "RotateTaskLog" action in your Taskr server. This will
+# delete old logs as per the parameters you provide (do this via the
+# normal Taskr web interface as you would to set up any other task -- just
+# select "RotateTaskLog" for the action).
+
+task_log:
+  # ERROR, WARN, INFO, or DEBUG
+  level: DEBUG
+  
+  
+##### MISC #####################################################################
+
+### Custom Task Definitions
+# You can define your own task action behaviour by specifying an external ruby
+# filename. On startup, Taskr will load any action definitions from this file,
+# making them available when scheduling new tasks (you should see your custom
+# task classes listed in the Actions pulldown on the new task page).
+#
+# Custom task definitions must:
+# - be defined under the Taskr::Actions module
+# - extend the Taskr::Actions::Base class
+# - implement a 'execute' method (this is what will be executed when your
+#   action is triggered)
+# - define a 'parameters' class attribute which should be an Array listing
+#   the names of the parameters that your action takes
+# - define a 'description' class attribute which should provide a brief
+#   description for what your action does (this will show up in the web UI) 
+#
+# Here is an example of a trivial custom action:
+#
+#  module Taskr
+#    module Actions
+#      class MyCustomAction < Taskr::Actions::Base
+#        self.parameters = ['alpha', 'beta']
+#        self.description = "Multiplies the given parameters and prints the result to stdout."
+#
+#        def execute
+#          puts parameters['alpha'].to_i * parameters['beta'].to_i
+#        end
+#      end
+#    end
+#  end
+
+#external_actions: /path/to/file.rb

data/examples/active_resource_client_example.rb

@@ -0,0 +1,46 @@
+require 'active_resource'
+
+# Define the proxy class
+class Task < ActiveResource::Base
+  self.site = 'http://taskr.example.com'
+end
+
+# Retrieve a list of all the Tasks
+tasks = Task.find(:all)
+
+# Print each Task's details for debugging
+tasks.each {|t| puts t.inspect}
+
+# Retrieve a specific Task
+task = Task.find(123)
+
+# Print the Task's name
+puts task.name
+
+# Create a new Task with two actions to be executed every 10 seconds
+task = Task.new
+task.name = "My Example Task"
+task.schedule_method = 'every'
+task.schedule_when = '10s'
+task.actions = [
+    {:action_class_name => 'Ruby', :code => "puts 'Sending message through Howlr...'"},
+    {:action_class_name => 'Howlr',
+      :subject => "Testing Howlr",
+      :body => "Just testing! Please ignore this.",
+      :from => "joe@example.foo",
+      :recipients => "sally@example.foo; bob@example.foo",
+      :url => "http://howlr.example.foo/messages.xml",
+      :username => 'howlr',
+      :password => 'howl!'}
+  ]
+  
+# Save the new Task; saving the Task commits it to the Taskr server
+# and schedules it for execution.
+task.save
+
+# Delete the Task we just created
+task.destroy
+
+# Or delete a Task with some arbitrary id
+id = 123
+Task.delete(id)