125 lines
3.7 KiB
Ruby
125 lines
3.7 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module API
|
|
class Todos < ::API::Base
|
|
include PaginationParams
|
|
|
|
before { authenticate! }
|
|
|
|
feature_category :team_planning
|
|
urgency :low
|
|
|
|
ISSUABLE_TYPES = {
|
|
'merge_requests' => ->(iid) { find_merge_request_with_access(iid) },
|
|
'issues' => ->(iid) { find_project_issue(iid) }
|
|
}.freeze
|
|
|
|
params do
|
|
requires :id, type: String, desc: 'The ID of a project'
|
|
end
|
|
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
|
|
ISSUABLE_TYPES.each do |type, finder|
|
|
type_id_str = "#{type.singularize}_iid".to_sym
|
|
|
|
desc 'Create a todo on an issuable' do
|
|
success Entities::Todo
|
|
end
|
|
params do
|
|
requires type_id_str, type: Integer, desc: 'The IID of an issuable'
|
|
end
|
|
post ":id/#{type}/:#{type_id_str}/todo" do
|
|
issuable = instance_exec(params[type_id_str], &finder)
|
|
|
|
todo = TodoService.new.mark_todo(issuable, current_user).first
|
|
|
|
if todo
|
|
present todo, with: Entities::Todo, current_user: current_user
|
|
else
|
|
not_modified!
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
resource :todos do
|
|
helpers do
|
|
params :todo_filters do
|
|
optional :action, String, values: Todo::ACTION_NAMES.values.map(&:to_s)
|
|
optional :author_id, Integer
|
|
optional :state, String, values: Todo.state_machine.states.map(&:name).map(&:to_s)
|
|
optional :type, String, values: TodosFinder.todo_types
|
|
optional :project_id, Integer
|
|
optional :group_id, Integer
|
|
end
|
|
|
|
def find_todos
|
|
TodosFinder.new(current_user, declared_params(include_missing: false)).execute
|
|
end
|
|
|
|
def issuable_and_awardable?(type)
|
|
obj_type = Object.const_get(type, false)
|
|
|
|
(obj_type < Issuable) && (obj_type < Awardable)
|
|
rescue NameError
|
|
false
|
|
end
|
|
|
|
def batch_load_issuable_metadata(todos, options)
|
|
# This should be paginated and will cause Rails to SELECT for all the Todos
|
|
todos_by_type = todos.group_by(&:target_type)
|
|
|
|
todos_by_type.keys.each do |type|
|
|
next unless issuable_and_awardable?(type)
|
|
|
|
collection = todos_by_type[type]
|
|
|
|
next unless collection
|
|
|
|
targets = collection.map(&:target)
|
|
options[type] = { issuable_metadata: Gitlab::IssuableMetadata.new(current_user, targets).data, include_subscribed: false }
|
|
end
|
|
end
|
|
end
|
|
|
|
desc 'Get a todo list' do
|
|
success Entities::Todo
|
|
end
|
|
params do
|
|
use :pagination, :todo_filters
|
|
end
|
|
get do
|
|
todos = paginate(find_todos.with_entity_associations)
|
|
todos = ::Todos::AllowedTargetFilterService.new(todos, current_user).execute
|
|
options = { with: Entities::Todo, current_user: current_user }
|
|
batch_load_issuable_metadata(todos, options)
|
|
|
|
present todos, options
|
|
end
|
|
|
|
desc 'Mark a todo as done' do
|
|
success Entities::Todo
|
|
end
|
|
params do
|
|
requires :id, type: Integer, desc: 'The ID of the todo being marked as done'
|
|
end
|
|
post ':id/mark_as_done' do
|
|
todo = current_user.todos.find(params[:id])
|
|
|
|
TodoService.new.resolve_todo(todo, current_user, resolved_by_action: :api_done)
|
|
|
|
present todo, with: Entities::Todo, current_user: current_user
|
|
end
|
|
|
|
desc 'Mark all todos as done'
|
|
post '/mark_as_done' do
|
|
todos = find_todos
|
|
|
|
TodoService.new.resolve_todos(todos, current_user, resolved_by_action: :api_all_done)
|
|
|
|
no_content!
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
API::Todos.prepend_mod_with('API::Todos')
|