dvdplm-taskr 0.3.1

data/lib/taskr/controllers.rb

@@ -0,0 +1,338 @@
+# 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::Controllers
+  
+  class ActionTypes < REST 'action_types'
+    def list
+      @actions = Taskr::Actions.list
+      
+      render :action_list
+    end
+  end
+  
+  class Actions < REST 'actions'
+    def parameters_form(id)
+      @num = @input[:num] || 0
+      @action = Taskr::Actions.list.find {|a| a.to_s =~ Regexp.new("#{id}$")}
+      if @action
+        render :action_parameters_form
+      else
+        @status = 404
+        "Action #{id.inspect} not defined"
+      end
+    end
+    
+    def new
+      @num = @input[:num] || 0
+      @actions = Taskr::Actions.list
+      render :action_form
+    end
+  end
+  
+  class Tasks < REST 'tasks'
+    include Taskr::Models
+    
+    # List of tasks.
+    def list
+      @tasks = Task.find(:all, :include => [:task_actions])
+      
+      render :tasks_list
+    end
+    
+    # Input for a new task.
+    def new
+      @actions = Taskr::Actions.list
+      
+      render :new_task
+    end
+    
+    # Retrieve details for an existing task.
+    def read(id)
+      @task = Task.find(id, :include => [:task_actions])
+      
+      render :view_task
+    end
+    
+    def edit(task_id)
+      @task = Task.find(task_id, :include => [:task_actions])
+      @actions = Taskr::Actions.list
+      render :edit_task
+    end
+    
+    def update(task_id)
+      $LOG.debug "Update Input params: #{@input.inspect}"
+      @task = Task.find(task_id, :include => [:task_actions])
+      params = normalize_input(@input)
+      @task.attributes= {
+        :name             => params[:name],
+        :schedule_method  => params[:schedule_method],
+        :schedule_when    => params[:schedule_when],
+        :memo             => params[:memo]
+      }
+
+      @task.task_actions.each do |action|
+        $LOG.debug("Updating parameters for #{action.inspect}")
+        action_params = params[:action].delete("action_id_#{action.id}")
+        $LOG.debug("Using values #{action_params.inspect}")
+        next unless action_params
+        action_params.each do |param_name, value|
+          $LOG.debug("Looking up \"#{param_name}\". Setting value to \"#{value}\"")
+          action.parameters.find_by_name(param_name).update_attribute(:value, value)
+        end
+      end
+      
+      # Create new actions/action_parameters for the remaining params
+      unless params[:action].empty?
+        params[:action].map do |num, params|
+          $LOG.debug "Looping remaining action_parameters: #{params.inspect} (num: #{num})"
+          action_class = get_action_class(params[:action_class_name])
+          action = TaskAction.new(:order => params[:order] || (@task.task_actions.maximum(:order)+1) || num, :action_class_name => action_class.to_s)
+
+          action_class.parameters.each do |p|
+            value = params[p]
+            value = nil if value.blank?
+            action.action_parameters << TaskActionParameter.new(:name => p, :value => value)
+          end
+          @task.task_actions << action
+        end
+      end
+      
+      unless @task.valid?
+        @status = 500
+        @actions = Taskr::Actions.list
+      else
+        @task.save!
+        @status = 200
+      end
+      
+      @task.reload # Ensure any updates to the record goes in
+      
+      Taskr.scheduler.unschedule(@task.scheduler_job_id)
+      @task.schedule! Taskr.scheduler
+      
+      $LOG.info "Task \"#{@task.name}\" (ID: #{@task.id}) updated sucessfully."
+      redirect R(@task)
+    end
+    
+    def normalize_input(hsh)
+      hsh[:task] || hsh["0"] || hsh
+    end
+    
+    def normalize_actions_params(input_params)
+      $LOG.debug "normalize_actions_params Normalizing: #{input_params.inspect}"
+      # some gymnastics here to provide compatibility for the way various
+      # REST client libraries submit data
+      actions_data = input_params[:actions] || input_params[:action]
+      
+      raise ArgumentError, "Missing action(s) parameter." if actions_data.blank?
+      actions = case actions_data
+                when Array 
+                  $LOG.debug "normalize_actions_params Plain Array. Returning as-is."
+                  actions_data
+                when Hash
+                  $LOG.debug "normalize_actions_params Some weird Hash. Injecting."
+                  actions_data.inject([]) do |acc,(i,a)|
+                    $LOG.debug "normalize_actions_params acc: #{acc.inspect} index: #{i.inspect} array: #{a.inspect}."
+                    acc << a
+                    acc
+                  end
+                else
+                  $LOG.debug "normalize_actions_params Not a weird hash.\n\tactions_data[:action]: #{actions_data[:action].inspect}\n\tactions_data[:actions]: #{actions_data[:actions].inspect}\n\tactions_data: #{actions_data.inspect}\n\n"
+                  actions_data[:action] || actions_data[:actions] || actions_data
+                end
+      actions = [actions] unless actions.kind_of? Array
+      $LOG.debug "normalize_actions_params DONE. Returning: #{actions.inspect}"
+      actions
+    end
+    
+    def get_action_class(class_name)
+      action_class_name = "Taskr::Actions::#{class_name}" unless class_name =~ /^Taskr::Actions::/
+      
+      begin
+        action_class = action_class_name.constantize
+        unless action_class.include? Rufus::Schedulable
+          raise ArgumentError, 
+            "#{a[:action_class_name].inspect} cannot be used as an action because it does not include the Rufus::Schedulable module."
+        end
+      rescue NameError
+        raise ArgumentError, 
+          "#{a[:action_class_name].inspect} is not defined (i.e. there is no such action class)."
+      end
+      action_class
+    end
+    
+    # Create and schedule a new task.
+    def create
+      puts @input.inspect
+      begin
+        # the "0" is for compatibility with PHP's Zend_Rest_Client
+        task_data = @input[:task] || @input["0"] || @input
+          
+        name            = task_data[:name]
+        created_by      = @env['REMOTE_HOST']
+        schedule_method = task_data[:schedule_method]
+        schedule_when   = task_data[:schedule_when]
+        memo            = task_data[:memo]
+        
+        @task = Task.new(
+          :name => name,
+          :created_by => created_by,
+          :schedule_method => schedule_method,
+          :schedule_when => schedule_when,
+          :memo => memo
+        )
+        
+        # some gymnastics here to provide compatibility for the way various
+        # REST client libraries submit data
+        actions_data = task_data[:actions] || task_data[:action]
+        
+        raise ArgumentError, "Missing action(s) parameter." if actions_data.blank?
+
+        if actions_data.kind_of?(Array)
+          actions = actions_data
+        elsif actions_data["0"]
+          actions = []
+          actions_data.each do |i,a|
+            actions << a
+          end
+        else
+          actions = actions_data[:action] || actions_data[:actions] || actions_data
+        end
+        
+        actions = [actions] unless actions.kind_of? Array
+        #puts actions.inspect
+        
+        i = 0
+        actions.each do |a|
+          #puts a.inspect
+          action_class_name = a[:action_class_name]
+          action_class_name = "Taskr::Actions::#{action_class_name}" unless action_class_name =~ /^Taskr::Actions::/
+          
+          begin
+            action_class = action_class_name.constantize
+            unless action_class.include? Rufus::Schedulable
+              raise ArgumentError, 
+                "#{a[:action_class_name].inspect} cannot be used as an action because it does not include the Rufus::Schedulable module."
+            end
+          rescue NameError
+            raise ArgumentError, 
+              "#{a[:action_class_name].inspect} is not defined (i.e. there is no such action class)."
+          end
+          
+          action = TaskAction.new(:order => a[:order] || i, :action_class_name => action_class_name)
+          
+          
+          action_class.parameters.each do |p|
+            value = a[p]
+            value = nil if value.blank?
+            action.action_parameters << TaskActionParameter.new(:name => p, :value => value)
+          end
+          
+          @task.task_actions << action
+          i += 1
+        end
+        
+        
+        unless @task.valid?
+          @status = 500
+          @actions = Taskr::Actions.list
+          return render(:new_task)
+        end
+      
+        
+        @task.schedule! Taskr.scheduler
+        
+        if @task.save
+          location = "/tasks/#{@task.id}?format=#{@format}"
+          $LOG.debug "#{@task} saved successfuly. Setting Location header to #{location.inspect}."
+          @headers['Location'] = location
+        end
+        
+        return render(:view_task)
+      rescue => e
+        puts e.inspect
+        puts e.backtrace
+        raise e
+      end
+    end
+
+    def run(id)
+      @task = Task.find(id, :include => [:task_actions])
+      
+      action = @task.prepare_action
+      
+      LogEntry.info(@task, "Manually executing task #{@task}.")
+      
+      begin
+        action.trigger
+      rescue
+        # ok to catch exception silently. it should have gotten logged by the action
+      end
+      
+      redirect R(@task)
+    end
+    
+    # Unschedule and delete an existing task.
+    def destroy(id)
+      @task = Task.find(id)
+      if @task.scheduler_job_id
+        $LOG.debug "Unscheduling task #{@task}..."
+        Taskr.scheduler.unschedule(@task.scheduler_job_id)
+      end
+      @task.destroy
+      
+      if @task.frozen?
+        @status = 200
+        if @format == :XML
+          ""
+        else
+          return redirect(R(Tasks, :list))
+        end
+      else
+        _error("Task #{id} was not destroyed.", 500)
+      end
+    end
+    
+    # Reload a task
+    def reload(id)
+      @task = Task.find(id)
+      $LOG.debug "Re-scheduling task #{@task}..."
+      if @task.scheduler_job_id
+        Taskr.scheduler.unschedule(@task.scheduler_job_id)
+        $LOG.debug "\t...unscheduled task #{@task}..."
+      end
+      @task.schedule! Taskr.scheduler
+      $LOG.debug "\t...scheduled task #{@task}...\n"
+      redirect R(@task)
+    end
+  end
+  
+  class LogEntries < REST 'log_entries'
+    def list
+      @since = @input[:since]
+      
+      @level = ['DEBUG', 'INFO', 'WARN', 'ERROR']
+      @level.index(@input[:level]).times {@level.shift} if @input[:level]
+      
+      @log_entries = LogEntry.find(:all, 
+        :conditions => ['task_id = ? AND IF(?,timestamp > ?,1) AND level IN (?)', 
+                        @input[:task_id], !@since.blank?, @since, @level],
+        :order => 'timestamp DESC, id DESC')
+      
+      render :log_entries_list
+    end
+  end
+end

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'
+require 'camping/db'
+
+require 'reststop'
+
+gem 'rufus-scheduler', '~> 1.0.7'
+require 'rufus/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