task-manager 0.1.1

data/app/controllers/task_manager/api/v1/plans_controller.rb

@@ -0,0 +1,251 @@
+# -*- encoding: utf-8 -*-
+module TaskManager
+  module Api
+    module V1
+      class PlansController < TaskManager::ApplicationController
+        respond_to :json
+
+        # 查询计划
+        #
+        # 支持的查询属性有：
+        #   name                      计划名
+        #   plan_type                 计划类型
+        #   autocompletable           是否自动完成
+        #   last_task_created_at      最后任务生成时间
+        #   enabled_at                生效时间
+        #
+        # 支持的查询操作参见 https://github.com/ernie/ransack/wiki/Basic-Searching
+        #
+        # 分页查询参数：
+        #   page    请求的页码，缺省值1
+        #   limit   每页记录数，缺省值25
+        #
+        # @example
+        #   # 请求
+        #   GET /api/plans?q[name_cont]=... HTTP/1.1
+        #   Accept: application/vnd.menglifang.com.cn; version=1
+        #
+        #   # 响应
+        #   HTTP/1.1 200 OK
+        #   {
+        #     "total": ...,
+        #     "plans": [{
+        #       "id": ...,
+        #       "name": ...,
+        #       "data": ...,
+        #       "plan_type": ...,
+        #       "enabled_at": ...,
+        #       "last_task_created_at": ...,
+        #       "begin_to_remind": ...,
+        #       "autocompletable": ...,
+        #       "created_at": ...,
+        #       "updated_at": ...,
+        #       "assignees": [{
+        #         "id": ...,
+        #         "name": ...
+        #       }, ...]
+        #     }, ...]
+        #   }
+        def index
+          plans = TaskManager::Plan.search(params[:q]).result
+          result = {
+            total: plans.count,
+            plans: ActiveModel::ArraySerializer.new(
+              plans.page(params[:page]).per(params[:limit])
+            ).as_json
+          }
+
+          render json: result, status: :ok
+        end
+
+        # 创建计划
+        #
+        # @example
+        #   # 请求
+        #   POST /api/plans HTTP/1.1
+        #   Accept: application/vnd.menglifang.com.cn; version=1
+        #
+        #   {
+        #     "plan": {
+        #       "name": ...,                     # 必填且唯一
+        #       "plan_type": ...,                # 必填，有效取值：'daily',
+        #                                        # 'weekly', 'monthly',
+        #                                        # 'quarterly', 'yearly'
+        #       "data": {
+        #         "x": ...,                      # 可选
+        #         "y": ...,                      # 可选
+        #         "deadline_month": ...,         # 当"plan_type"为'yearly'或
+        #                                        #  'quarterly'时，为必填项；
+        #                                        #  否则，为null
+        #         "deadline_day": ...,           # 当"plan_type"为'monthly'或
+        #                                        #  'weekly'时，为必填项；
+        #                                        #  否则，为null
+        #         "deadline_hour": ...,          # 必填
+        #         "deadline_minute": ...         # 必填
+        #       },
+        #       "enabled_at": ...,               # 必填
+        #       "begin_to_remind": ...,          # 必填且小于等于0
+        #       "autocompletable": ...,          # 必填，缺省值为false
+        #       "assignables_attributes": [{     # 至少需要一个assignable
+        #         "assignee_id": ...,
+        #         "assignee_type": ...
+        #       }, ...],
+        #
+        #       "callables_attributes": [{       # 可选
+        #         "callback_id": ...,
+        #         "callback_type": ...
+        #       }]
+        #     }
+        #   }
+        #
+        #   # 响应
+        #   ## 成功
+        #   HTTP/1.1 201 Created
+        #   {
+        #     "plan": {
+        #       "id": ...,
+        #       "name": ...,
+        #       "plan_type": ...,
+        #       "data": ...,
+        #       "enabled_at": ...,
+        #       "begin_to_remind": ...,
+        #       "autocompletable": ...,
+        #       "created_at": ...,
+        #       "updated_at": ...,
+        #       "assignees": [{
+        #         "id": ...,
+        #         "name": ...
+        #       }, ...]
+        #     }
+        #   }
+        #   ## 失败
+        #   HTTP/1.1 422 Unprocessable Entity
+        #   {
+        #     "errors": {
+        #       "name": [...],
+        #       ...
+        #     }
+        #   }
+        def create
+          plan = TaskManager::Plan.new(params[:plan])
+
+          if plan.save
+            render json: plan, status: :created
+          else
+            render json: { errors: plan.errors }, status: :unprocessable_entity
+          end
+        end
+
+        # 更新计划
+        #
+        # @example
+        #   # 请求
+        #   PUT /api/plans/... HTTP/1.1
+        #   Accept: application/vnd.menglifang.com.cn; version=1
+        #
+        #   {
+        #     "plan": {
+        #       "name": ...,                     # 必填且唯一
+        #       "plan_type": ...,                # 必填，有效取值：'daily',
+        #                                        # 'weekly', 'monthly',
+        #                                        # 'quarterly', 'yearly'
+        #       "data": {
+        #         "x": ...,                      # 可选
+        #         "y": ...,                      # 可选
+        #         "deadline_month": ...,         # 当"plan_type"为'yearly'或
+        #                                        #  'quarterly'时，为必填项；
+        #                                        #  否则，为null
+        #         "deadline_day": ...,           # 当"plan_type"为'monthly'或
+        #                                        #  'weekly'时，为必填项；
+        #                                        #  否则，为null
+        #         "deadline_hour": ...,          # 必填
+        #         "deadline_minute": ...         # 必填
+        #       },
+        #       "enabled_at": ...,               # 必填
+        #       "begin_to_remind": ...,          # 必填且小于等于0
+        #       "autocompletable": ...,          # 必填，缺省值为false
+        #
+        #       "assignables_attributes": [{
+        #         "id": ...,                     ## 可选，
+        #                                        ## 如果有，则更新，否则创建
+        #         "assignee_id": ...,          ## 必填
+        #         "assignee_type": ...,        ## 必填
+        #         "_destroy": "1"                ## 可选，
+        #                                        ## 如果设置，存在则删除，
+        #                                        ## 不存在则忽略
+        #       }, ...],
+        #
+        #       "callables_attributes": [{       # 可选
+        #         "id": ...,                     ## 可选，
+        #                                        ## 如果有，则更新，否则创建
+        #         "callback_id": ...,            ## 必填
+        #         "callback_type": ...,          ## 必填
+        #         "_destroy": "1"                ## 可选，
+        #                                        ## 如果设置，存在则删除，
+        #                                        ## 不存在则忽略
+        #       }]
+        #     }
+        #   }
+        #
+        #   # 响应
+        #   ## 成功
+        #   HTTP/1.1 202 Accepted
+        #   {
+        #     "plan": {
+        #       "id": ...,
+        #       "name": ...,
+        #       "plan_type": ...,
+        #       "data": ...,
+        #       "enabled_at": ...,
+        #       "begin_to_remind": ...,
+        #       "autocompletable": ...,
+        #       "created_at": ...,
+        #       "updated_at": ...,
+        #       "assignees": [{
+        #         "id": ...,
+        #         "name": ...
+        #       }, ...]
+        #     }
+        #   }
+        #   ## 失败
+        #   HTTP/1.1 422 Unprocessable Entity
+        #   {
+        #     "errors": {
+        #       "name": [...],
+        #       ...
+        #     }
+        #   }
+        def update
+          plan.assignables.destroy_all
+
+          if plan.update_attributes(params[:plan])
+            render json: plan, status: :ok
+          else
+            render json: { errors: plan.errors }, status: :unprocessable_entity
+          end
+        end
+
+        # 删除计划
+        #
+        # @example
+        #   # 请求
+        #   DELETE /api/plans/... HTTP/1.1
+        #   Accept: application/vnd.menglifang.com.cn; version=1
+        #
+        #   # 响应
+        #   ## 成功
+        #   HTTP/1.1 204 No Content
+        def destroy
+          plan.destroy
+
+          head :no_content
+        end
+
+        private
+        def plan
+          TaskManager::Plan.find(params[:id])
+        end
+      end
+    end
+  end
+end

data/app/controllers/task_manager/api/v1/tasks_controller.rb

@@ -0,0 +1,82 @@
+# -*- encoding: utf-8 -*-
+module TaskManager
+  module Api
+    module V1
+      class TasksController < TaskManager::ApplicationController
+        respond_to :json
+
+        # 查询任务
+        #
+        # 支持的查询属性有：
+        #   name                      任务名
+        #   task_type                 任务类型
+        #   deadline                  截止时间
+        #   status                    状态
+        #   updated_at                完成时间
+        #
+        # 支持的查询操作参见 https://github.com/ernie/ransack/wiki/Basic-Searching
+        #
+        # 分页查询参数：
+        #   page    请求的页码，缺省值1
+        #   limit   每页记录数，缺省值25
+        #
+        # @example
+        #   # 请求
+        #   GET /api/tasks?q[name_cont]=... HTTP/1.1
+        #   Accept: application/vnd.menglifang.com.cn; version=1
+        #
+        #   # 响应
+        #   HTTP/1.1 200 OK
+        #   {
+        #     "total": ...,
+        #     "tasks": [{
+        #       "id": ...,
+        #       "name": ...,
+        #       "data": ...,
+        #       "task_type": ...,
+        #       "deadline": ...,
+        #       "status": ...,
+        #       "created_at": ...,
+        #       "updated_at": ...,
+        #       "assignee": {
+        #         "id": ...,
+        #         "name": ...
+        #       }
+        #     }, ...]
+        #   }
+        def index
+          tasks = TaskManager::Task.search(params[:q]).result
+          result = {
+            total: tasks.count,
+            tasks: ActiveModel::ArraySerializer.new(
+              tasks.page(params[:page]).per(params[:limit])
+            ).as_json
+          }
+
+          render json: result, status: :ok
+        end
+
+        # 删除任务
+        #
+        # @example
+        #   # 请求
+        #   DELETE /api/tasks/... HTTP/1.1
+        #   Accept: application/vnd.menglifang.com.cn; version=1
+        #
+        #   # 响应
+        #   ## 成功
+        #   HTTP/1.1 204 No Content
+        def destroy
+          task.destroy
+
+          head :no_content
+        end
+
+        private
+        def task
+          TaskManager::Task.find(params[:id])
+        end
+      end
+    end
+  end
+end

data/app/controllers/task_manager/application_controller.rb

@@ -0,0 +1,4 @@
+module TaskManager
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/task_manager/application_helper.rb

@@ -0,0 +1,4 @@
+module TaskManager
+  module ApplicationHelper
+  end
+end

data/app/models/task_manager/assignable.rb

@@ -0,0 +1,10 @@
+module TaskManager
+  class Assignable < ActiveRecord::Base
+    belongs_to :target, polymorphic: true
+    belongs_to :assignee, polymorphic: true
+
+    validates_presence_of :assignee_id, :assignee_type
+
+    attr_accessible :assignee_id, :assignee_type
+  end
+end

data/app/models/task_manager/callable.rb

@@ -0,0 +1,10 @@
+module TaskManager
+  class Callable < ActiveRecord::Base
+    belongs_to :callback, polymorphic: true
+    belongs_to :target, polymorphic: true
+
+    validates_presence_of :callback_id, :callback_type
+
+    attr_accessible :callback_id, :callback_type
+  end
+end

data/app/models/task_manager/plan.rb

@@ -0,0 +1,114 @@
+# -*- encoding: utf-8 -*-
+module TaskManager
+  # TODO 验证data的合法性
+  class Plan < ActiveRecord::Base
+    include TaskManager::DeadlineCalculator
+    extend Enumerize
+
+    has_many :assignables, as: :target
+    has_many :callables, as: :target
+
+    enumerize :plan_type, in: [:daily, :weekly, :monthly, :quarterly, :yearly]
+
+    serialize :data, ActiveRecord::Coders::Hstore
+
+    accepts_nested_attributes_for :assignables, :callables
+
+    attr_accessible :autocompletable, :data, :last_task_created_at,
+      :name, :plan_type, :begin_to_remind, :enabled_at,
+      :assignables_attributes, :callables_attributes
+
+    validates_presence_of :name, :plan_type, :begin_to_remind,
+      :enabled_at, :assignables
+    validates_uniqueness_of :name
+    validates_numericality_of :begin_to_remind, greater_than_or_equal_to: 0
+
+    # validate the deadline
+    validates :data, deadline: true
+
+    def assignees
+      assignables.collect(&:assignee)
+    end
+
+    def callbacks
+      callables.collect(&:callback)
+    end
+
+    # 生成计划任务
+    #
+    # 为每一个计划的执行者创建一个计划任务。
+    def generate_tasks
+      now = Time.now
+      default_deadline = case plan_type.to_sym
+                 when :daily then now.end_of_day
+                 when :weekly then now.end_of_week
+                 when :monthly then now.end_of_month
+                 when :quarterly then now.end_of_quarter
+                 when :yearly then now.end_of_year
+                 end
+
+      #reminding_at = default_deadline.ago(-(begin_to_remind * 60))
+      reminding_at = default_deadline.ago(begin_to_remind * 60)
+      status = autocompletable ? :finished : :new
+      finished_at = autocompletable ? Time.now : nil
+
+      tasks = []
+      data.symbolize_keys!
+
+      Plan.transaction do
+        assignables.each do |a|
+          tasks << Task.create! do |t|
+            t.name = name
+            t.data = { x: data[:x], y: data[:y] }
+            t.task_type = plan_type
+            t.deadline = calculate_deadline(plan_type, data)
+            t.reminding_at = reminding_at
+            t.status = status
+            t.finished_at = finished_at
+            t.create_assignable(
+              assignee_id: a.assignee_id,
+              assignee_type: a.assignee_type,
+            )
+            t.callables = callables
+          end
+        end
+      end
+
+      update_attributes(last_task_created_at: Time.now)
+
+      tasks
+    end
+
+    class << self
+      # 返回所有需要创建新任务的计划
+      #
+      # 判断条件：
+      # 1) `enabled_at`在当前时间之前；
+      # 2) `last_task_created_at`在周期内。
+      #   2.1) 日计划：`Time.now.beginning_of_day <= last_task_created_at <= Time.now.end_of_day`
+      #   2.2) 周计划：`Time.now.beginning_of_week <= last_task_created_at <= Time.now.end_of_week`
+      #   2.3) 月计划：`Time.now.beginning_of_month <= last_task_created_at <= Time.now.end_of_month`
+      #   2.4) 季计划：`Time.now.beginning_of_quarter <= last_task_created_at <= Time.now.end_of_quarter`
+      #   2.5) 年计划：`Time.now.beginning_of_year <= last_task_created_at <= Time.now.end_of_year`
+      def active
+        active_by_type(:daily) | active_by_type(:weekly) |
+          active_by_type(:monthly) | active_by_type(:quarterly) |
+          active_by_type(:yearly)
+      end
+
+      def active_by_type(type)
+        now = Time.now
+        beginning_at = case type.to_sym
+                       when :daily then now.beginning_of_day
+                       when :weekly then now.beginning_of_week
+                       when :monthly then now.beginning_of_month
+                       when :quarterly then now.beginning_of_quarter
+                       when :yearly then now.beginning_of_year
+                       end
+
+        where("plan_type = ? AND last_task_created_at <= ?",
+              type, beginning_at).where("enabled_at <= ?", now)
+      end
+    end
+  end
+end