taskr 0.1.0

data/lib/taskr/environment.rb

@@ -0,0 +1,48 @@
+# This file is part of Taskr.
+#
+# 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/>.
+
+$: << File.dirname(File.expand_path(__FILE__))
+
+# Try to load local versions of Picnic and Reststop if possible...
+$: << File.dirname(File.expand_path(__FILE__))+"/../../../picnic/lib"
+$: << File.dirname(File.expand_path(__FILE__))+"/../../vendor/picnic/lib"
+$: << File.dirname(File.expand_path(__FILE__))+"/../../../reststop/lib"
+$: << File.dirname(File.expand_path(__FILE__))+"/../../vendor/reststop/lib"
+
+# active_resource needs newer versions of active_support, but this conflicts
+# with active_record, so we need a newer version of that as well (yes, it's a mess) 
+#$: << File.dirname(File.expand_path(__FILE__))+"/../../vendor/activeresource/lib"
+#$: << File.dirname(File.expand_path(__FILE__))+"/../../vendor/activesupport/lib"
+#$: << File.dirname(File.expand_path(__FILE__))+"/../../vendor/activerecord/lib"
+
+require 'rubygems'
+
+require 'active_support'
+#require 'active_resource'
+require 'active_record'
+
+
+# make things backwards-compatible for rubygems < 0.9.0
+unless Object.method_defined? :gem
+  alias gem require_gem
+end
+
+require 'picnic.rb'
+require 'camping/db'
+
+require 'reststop'
+
+gem 'openwferu-scheduler', '~> 0.9.16'
+require 'openwfe/util/scheduler'

data/lib/taskr/helpers.rb

@@ -0,0 +1,79 @@
+# This file is part of Taskr.
+#
+# 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/>.
+
+module Taskr::Helpers
+  def taskr_response_xml(result, &block)
+    instruct!
+    tag!("response", 'result' => result, 'xmlns:taskr' => "http://taskr.googlecode.com") do
+      yield
+    end
+  end
+  
+  def html_task_action_li(ta)
+    li ta.action_class_name
+    ul do
+      ta.action_parameters.each do |ap|
+        li do 
+          label "#{ap.name}:"
+          pre ap.value
+        end
+      end
+    end
+  end
+  
+  def html_scaffold
+    html do
+      head do
+        title "Taskr"
+        link(:rel => 'stylesheet', :type => 'text/css', :href => '/public/taskr.css')
+        script(:type => 'text/javascript', :src => '/public/prototype.js')
+      end
+      body do
+        yield
+      end
+    end
+  end
+  
+  # Taken from Rails
+  def distance_of_time_in_words(from_time, to_time = 0, include_seconds = false)
+     from_time = from_time.to_time if from_time.respond_to?(:to_time)
+     to_time = to_time.to_time if to_time.respond_to?(:to_time)
+     distance_in_minutes = (((to_time - from_time).abs)/60).round
+     distance_in_seconds = ((to_time - from_time).abs).round
+ 
+     case distance_in_minutes
+       when 0..1
+         return (distance_in_minutes == 0) ? 'less than a minute' : '1 minute' unless include_seconds
+         case distance_in_seconds
+           when 0..4   then 'less than 5 seconds'
+           when 5..9   then 'less than 10 seconds'
+           when 10..19 then 'less than 20 seconds'
+           when 20..39 then 'half a minute'
+           when 40..59 then 'less than a minute'
+           else             '1 minute'
+         end
+ 
+       when 2..44           then "#{distance_in_minutes} minutes"
+       when 45..89          then 'about 1 hour'
+       when 90..1439        then "about #{(distance_in_minutes.to_f / 60.0).round} hours"
+       when 1440..2879      then '1 day'
+       when 2880..43199     then "#{(distance_in_minutes / 1440).round} days"
+       when 43200..86399    then 'about 1 month'
+       when 86400..525959   then "#{(distance_in_minutes / 43200).round} months"
+       when 525960..1051919 then 'about 1 year'
+       else                      "over #{(distance_in_minutes / 525960).round} years"
+     end
+   end
+end

data/lib/taskr/models.rb

@@ -0,0 +1,238 @@
+# This file is part of Taskr.
+#
+# 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/>.
+
+require 'camping/db'
+require 'openwfe/util/scheduler'
+require 'date'
+
+class OpenWFE::Scheduler
+  public :duration_to_f
+end
+
+
+module Taskr::Models
+
+  class Task < Base
+    has_many :task_actions, 
+      :include => :action_parameters, 
+      :dependent => :destroy
+    
+    serialize :schedule_options
+    serialize :last_triggered_error
+    
+    validates_presence_of :schedule_method
+    validates_presence_of :schedule_when
+    validates_presence_of :name
+    validates_uniqueness_of :name
+    validates_presence_of :task_actions
+    validates_associated :task_actions
+    
+    def schedule!(scheduler)
+      case schedule_method
+      when 'cron'
+        method = :schedule
+      when 'at'
+        method = :schedule_at
+      when 'in'
+        method = :schedule_in
+      when 'every'
+        method = :schedule_every
+      end
+      
+      if method == :schedule_at || method == :schedule_in
+        t = next_trigger_time
+        method = :schedule_at
+        if t < Time.now
+          $LOG.warn "Task #{name.inspect} will not be scheduled because its trigger time is in the past (#{t.inspect})."
+          return nil
+        end
+      end
+      
+      $LOG.debug "Scheduling task #{name.inspect}: #{self.inspect}"
+      
+      if task_actions.length == 1
+        ta = task_actions.first
+        
+        parameters = {}
+        ta.action_parameters.each{|p| parameters[p.name] = p.value}
+        
+        action = (ta.action_class.kind_of?(Class) ? ta.action_class : ta.action_class.constantize).new(parameters)
+        action.task = self
+      elsif task_actions.length > 1
+        action = Taskr::Actions::Multi.new
+        task_actions.each do |ta|
+          parameters = {}
+          ta.action_parameters.each{|p| parameters[p.name] = p.value}
+          
+          a = (ta.action_class.kind_of?(Class) ? ta.action_class : ta.action_class.constantize).new(parameters)
+          a.task = self
+          
+          action.actions << a 
+        end
+        action.task = self
+      else
+        $LOG.warn "Task #{name.inspect} has no actions and as a result will not be scheduled!"
+        return false
+      end
+      
+      job_id = scheduler.send(method, t || schedule_when, :schedulable => action)
+      
+      if job_id
+        $LOG.debug "Task #{name.inspect} scheduled with job id #{job_id}"
+      else
+        $LOG.error "Task #{name.inspect} was NOT scheduled!"
+        return nil
+      end
+      
+      self.update_attribute(:scheduler_job_id, job_id)
+      if method == :schedule_at || method == :schedule_in
+        job = scheduler.get_job(job_id)
+        at = job.schedule_info
+        self.update_attribute(:schedule_when, at)
+        self.update_attribute(:schedule_method, 'at')
+      end
+      
+      return job_id
+    end
+    
+    def next_trigger_time
+      # TODO: need to figure out how to calulate trigger_time for these.. for now return :unknown
+      return :unknown unless schedule_method == 'at' || schedule_method == 'in'
+          
+      if schedule_method == 'in'
+        return (created_on || Time.now) + Taskr.scheduler.duration_to_f(schedule_when)
+      end
+      
+      # Time parsing code from Rails
+      time_hash = Date._parse(schedule_when)
+      time_hash[:sec_fraction] = ((time_hash[:sec_fraction].to_f % 1) * 1_000_000).to_i
+      time_array = time_hash.values_at(:year, :mon, :mday, :hour, :min, :sec, :sec_fraction)
+      # treat 0000-00-00 00:00:00 as nil
+      Time.send(Base.default_timezone, *time_array) rescue DateTime.new(*time_array[0..5]) rescue nil
+    end
+    
+    def to_s
+      "#<#{self.class}:#{self.id}>"
+    end
+  end
+  
+  class TaskAction < Base
+    belongs_to :task
+    
+    has_many :action_parameters, 
+      :class_name => 'TaskActionParameter', 
+      :foreign_key => :task_action_id,
+      :dependent => :destroy
+    
+    validates_associated :action_parameters
+    
+    def action_class=(class_name)
+      if class_name.kind_of? Class
+        self[:action_class_name] = class_name.to_s
+      else
+        self[:action_class_name] = class_name
+      end
+    end
+    
+    def action_class
+      self[:action_class_name].constantize
+    end
+    
+    def to_xml(options = {})
+      options[:indent] ||= 2
+      xml = options[:builder] ||= Builder::XmlMarkup.new(:indent => options[:indent])
+      xml.instruct! unless options[:skip_instruct]
+      xml.tag!('task-action', :type => self.class) do
+        xml.tag!('id', {:type => 'integer'}, id)
+        xml.tag!('action-class-name', action_class_name)
+        xml.tag!('order', {:type => 'integer'}, order) unless order.blank?
+        xml.tag!('task-id', {:type => 'integer'}, task_id)
+        xml.tag!('action-parameters', {:type => 'array'}) do
+          action_parameters.each {|ap| ap.to_xml(options)}
+        end
+      end
+    end
+    
+    def to_s
+      "#<#{self.class}:#{self.id}>"
+    end
+  end
+
+  class TaskActionParameter < Base
+    belongs_to :task_action
+    serialize :value
+    
+    def to_xml(options = {})
+      options[:indent] ||= 2
+      xml = options[:builder] ||= Builder::XmlMarkup.new(:indent => options[:indent])
+      xml.instruct! unless options[:skip_instruct]
+      xml.tag!('action-parameter', :type => self.class) do
+        xml.tag!('id', {:type => 'integer'}, id)
+        xml.tag!('name', name)
+        xml.tag!('value') do
+          xml.cdata!(value)
+        end
+      end
+    end
+    
+    def to_s
+      "#<#{self.class}:#{self.id}>"
+    end
+  end
+
+  class CreateTaskr < V 0.01
+    def self.up
+      $LOG.info("Migrating database")
+      
+      create_table :taskr_tasks, :force => true do |t|
+        t.column :name, :string, :null => false
+        t.column :created_on, :timestamp, :null => false
+        t.column :created_by, :string
+        
+        t.column :schedule_method, :string, :null => false
+        t.column :schedule_when, :string, :null => false
+        t.column :schedule_options, :text
+        
+        t.column :scheduler_job_id, :integer
+        t.column :last_triggered, :datetime
+        t.column :last_triggered_error, :text
+      end
+      
+      add_index :taskr_tasks, [:name], :unique => true
+      
+      create_table :taskr_task_actions, :force => true do |t|
+        t.column :task_id, :integer, :null => false
+        t.column :action_class_name, :string, :null => false
+        t.column :order, :integer
+      end
+      
+      add_index :taskr_task_actions, [:task_id]
+      
+      create_table :taskr_task_action_parameters, :force => true do |t|
+        t.column :task_action_id, :integer, :null => false
+        t.column :name, :string, :null => false
+        t.column :value, :text
+      end
+      
+      add_index :taskr_task_action_parameters, [:task_action_id]
+      add_index :taskr_task_action_parameters, [:task_action_id, :name]
+    end
+    
+    def self.down
+      drop_table :taskr_task_action_parameters
+      drop_table :taskr_tasks
+    end
+  end
+end

data/lib/taskr/version.rb

@@ -0,0 +1,9 @@
+module Taskr #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/taskr/views.rb

@@ -0,0 +1,276 @@
+# This file is part of Taskr.
+#
+# 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/>.
+
+# need auto_validation off to render non-XHTML XML
+Markaby::Builder.set(:auto_validation, false)
+Markaby::Builder.set(:indent, 2)
+
+module Taskr::Views
+  module XML
+    include Taskr::Models
+    
+    CONTENT_TYPE = 'text/xml'
+    
+    def tasks_list
+      @tasks.to_xml(:root => 'tasks', :include => [:task_actions])
+    end
+    
+    def view_task
+      @task.to_xml(:root => 'task', :include => [:task_actions])
+    end
+    
+    def create_task_result
+      taskr_response_xml(@task.valid? ? 'success' : 'failure') do
+        text @task.to_xml
+        text @task.errors.to_xml unless @task.valid?
+      end
+    end
+  end
+  
+  module HTML
+    CONTENT_TYPE = 'text/html'
+    
+    def tasks_list
+      html_scaffold do
+        h1 {"Tasks"}
+        
+        p{a(:href => R(Taskr::Controllers::Tasks, 'new')) {"Schedule New Task"}}
+        
+        table do
+          thead do
+            tr do
+              th "Name"
+              th "Schedule"
+              th "Last Triggered"
+              th "Job ID"
+              th "Created On"
+              th "Created By"
+            end
+          end
+          tbody do
+            @tasks.each do |t|
+              tr_css = []
+              tr_css << "error" if t.last_triggered_error
+              tr_css << "expired" if t.next_trigger_time != :unknown && t.next_trigger_time < Time.now
+              
+              tr(:class => tr_css.join(" ")) do
+                td {a(:href => R(t)) {strong{t.name}}}
+                td "#{t.schedule_method} #{t.schedule_when}"
+                td do
+                  if t.last_triggered
+                    "#{distance_of_time_in_words(t.last_triggered, Time.now, true)} ago"
+                  else
+                    em "Not yet triggered"
+                  end
+                end
+                td(:class => "job-id") {t.scheduler_job_id}
+                td t.created_on
+                td t.created_by
+              end
+            end
+          end
+        end
+        
+        br
+        div {scheduler_status}
+      end
+    end
+    
+    def new_task
+      html_scaffold do
+        script(:type => 'text/javascript') do
+          %{
+            function show_action_parameters(num) {
+              new Ajax.Updater('parameters_'+num, '/actions', {
+                  method: 'get',
+                  parameters: { 
+                    id: $F('action_class_name_'+num), 
+                    action: 'parameters_form',
+                    num: num
+                  }
+              });
+            }
+          }
+        end
+        
+        form :method => 'post', :action => self/"/tasks?format=#{@format}" do
+          h1 "New Task"
+          input :type => 'hidden', :name => '_method', :value => 'post'
+          
+          p do
+            label 'name' 
+            br
+            input :type => 'text', :name => 'name', :size => 40
+          end
+          
+          p do
+            label 'schedule'
+            br
+            select(:name => 'schedule_method') do
+              ['every','at','in','cron'].each do |method|
+                option(:value => method) {method}
+              end
+            end
+            input :type => 'text', :name => 'schedule_when', :size => 30
+          end
+          
+          action_form
+          
+          p do
+            a(:id => 'add_action', :href => '#'){'Add another action'}
+          end
+          script(:type => 'text/javascript') do
+            %{
+              Event.observe('add_action', 'click', function() {
+                new Ajax.Updater('add_action', '#{self/'/actions'}', {
+                    method: 'get',
+                    parameters: { action: 'new', num: $$('select.action_class_name').size() },
+                    insertion: Insertion.Before
+                });
+                return false;
+              })
+            }
+          end
+          
+          button(:type => 'submit') {"submit"}
+        end
+      end
+    end
+    
+    def view_task
+      html_scaffold do
+        form(:method => 'delete', :style => 'display: inline') do
+          button(:type => 'submit', :value => 'delete') {"Delete"}
+        end
+        br
+        a(:href => self/'tasks') {"Back to Task List"}
+        
+        h1 "Task #{@task.id}"
+        table do
+          tr do
+            th "Name:"
+            td @task.name
+          end
+          tr do
+            th "Schedule:"
+            td "#{@task.schedule_method} #{@task.schedule_when}"
+          end
+          tr do
+            th "Triggered:"
+            td do
+              if @task.last_triggered
+                span "#{distance_of_time_in_words(@task.last_triggered, Time.now, true)} ago"
+                span(:style => 'font-size: 8pt; color: #bbb'){"(#{@task.last_triggered})"}
+              else
+                em "Not yet triggered"
+              end
+            end 
+          end
+          if @task.last_triggered_error
+            th "Error:"
+            td(:style => 'color: #e00;') do
+              strong "#{@task.last_triggered_error[:type]}"
+              br
+              span @task.last_triggered_error[:message]
+            end
+          end
+          tr do
+            th "Actions:"
+            td do 
+              if @task.task_actions.length > 1
+                ol(:style => 'padding-left: 20px') do
+                  @task.task_actions.each do |ta|
+                    html_task_action_li(ta)
+                  end
+                end
+              else
+                html_task_action_li(@task.task_actions.first)
+              end
+            end
+          end
+          tr do
+            th "Created By:"
+            td @task.created_by
+          end
+          tr do
+            th "Created On:"
+            td @task.created_on
+          end
+        end
+      end
+    end
+    
+    def scheduler_status
+      s = Taskr.scheduler
+      h3(:style => "margin-bottom: 8px;") {"Scheduler Status"}
+      strong "Running?"
+      span(:style => 'margin-right: 10px') {s.instance_variable_get(:@stopped) ? "NO" : "Yes"}
+      strong "Precision:"
+      span(:style => 'margin-right: 10px') {"#{s.instance_variable_get(:@precision)}s"}
+      strong "Pending Jobs:"
+      span(:style => 'margin-right: 10px') {s.instance_variable_get(:@pending_jobs).size}
+      strong "Thread Status:"
+      span(:style => 'margin-right: 10px') {s.instance_variable_get(:@scheduler_thread).status}
+    end
+    
+    def action_list
+      h1 "Actions"
+      ul do
+        @actions.each do |a|
+          li a
+        end
+      end
+    end
+    
+    def action_parameters_form
+      @num ||= 0
+      
+      p {em @action.description}
+      
+      @action.parameters.each do |param|
+        p do
+          label param
+          br
+          input :type => 'textarea', :name => "action[#{@num}][#{param}]", :size => 40
+        end
+      end
+    end
+    
+    def action_form
+      @num ||= 0
+      
+      p do
+        label 'action_class_name'
+        br
+        select(:name => "action[#{@num}][action_class_name]", 
+            :id => "action_class_name_#{@num}", 
+            :class => "action_class_name",
+            :onchange => "show_action_parameters(#{@num})") do
+          option(:value => "")
+          @actions.each do |a|
+            a.to_s =~ /Taskr::Actions::([^:]*?)$/
+            option(:value => $~[1]) {$~[1]}
+          end
+        end
+      end
+    
+      div(:id => "parameters_#{@num}")
+      
+    end
+   
+  end
+  
+  default_format :HTML
+end