2013-05-14 12:33:31 +00:00
|
|
|
module API
|
2012-07-24 12:19:51 +00:00
|
|
|
# Issues API
|
|
|
|
class Issues < Grape::API
|
|
|
|
before { authenticate! }
|
|
|
|
|
2014-08-14 10:41:16 +00:00
|
|
|
helpers do
|
|
|
|
def filter_issues_state(issues, state = nil)
|
|
|
|
case state
|
|
|
|
when 'opened' then issues.opened
|
|
|
|
when 'closed' then issues.closed
|
|
|
|
else issues
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2012-07-24 12:19:51 +00:00
|
|
|
resource :issues do
|
|
|
|
# Get currently authenticated user's issues
|
|
|
|
#
|
2014-08-14 10:41:16 +00:00
|
|
|
# Parameters:
|
|
|
|
# state (optional) - Return "opened" or "closed" issues
|
|
|
|
#
|
|
|
|
# Example Requests:
|
2012-07-24 12:19:51 +00:00
|
|
|
# GET /issues
|
2014-08-14 10:41:16 +00:00
|
|
|
# GET /issues?state=opened
|
|
|
|
# GET /issues?state=closed
|
2012-07-24 12:19:51 +00:00
|
|
|
get do
|
2014-08-14 10:41:16 +00:00
|
|
|
present paginate(filter_issues_state(current_user.issues, params['state'])), with: Entities::Issue
|
2012-07-24 12:19:51 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
resource :projects do
|
|
|
|
# Get a list of project issues
|
|
|
|
#
|
|
|
|
# Parameters:
|
2012-12-21 17:47:04 +00:00
|
|
|
# id (required) - The ID of a project
|
2014-08-14 10:41:16 +00:00
|
|
|
# state (optional) - Return "opened" or "closed" issues
|
|
|
|
#
|
|
|
|
# Example Requests:
|
2012-07-24 12:19:51 +00:00
|
|
|
# GET /projects/:id/issues
|
2014-08-14 10:41:16 +00:00
|
|
|
# GET /projects/:id/issues?state=opened
|
|
|
|
# GET /projects/:id/issues?state=closed
|
2012-07-24 12:19:51 +00:00
|
|
|
get ":id/issues" do
|
2014-08-14 10:41:16 +00:00
|
|
|
present paginate(filter_issues_state(user_project.issues, params['state'])), with: Entities::Issue
|
2012-07-24 12:19:51 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
# Get a single project issue
|
|
|
|
#
|
|
|
|
# Parameters:
|
2012-12-21 17:47:04 +00:00
|
|
|
# id (required) - The ID of a project
|
2012-07-24 12:19:51 +00:00
|
|
|
# issue_id (required) - The ID of a project issue
|
|
|
|
# Example Request:
|
|
|
|
# GET /projects/:id/issues/:issue_id
|
|
|
|
get ":id/issues/:issue_id" do
|
|
|
|
@issue = user_project.issues.find(params[:issue_id])
|
2012-08-10 22:07:50 +00:00
|
|
|
present @issue, with: Entities::Issue
|
2012-07-24 12:19:51 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
# Create a new project issue
|
|
|
|
#
|
|
|
|
# Parameters:
|
2012-12-21 17:47:04 +00:00
|
|
|
# id (required) - The ID of a project
|
2012-07-24 12:19:51 +00:00
|
|
|
# title (required) - The title of an issue
|
|
|
|
# description (optional) - The description of an issue
|
|
|
|
# assignee_id (optional) - The ID of a user to assign issue
|
|
|
|
# milestone_id (optional) - The ID of a milestone to assign issue
|
|
|
|
# labels (optional) - The labels of an issue
|
|
|
|
# Example Request:
|
|
|
|
# POST /projects/:id/issues
|
|
|
|
post ":id/issues" do
|
2014-04-02 10:38:35 +00:00
|
|
|
required_attributes! [:title]
|
|
|
|
attrs = attributes_for_keys [:title, :description, :assignee_id, :milestone_id]
|
2014-07-30 14:17:29 +00:00
|
|
|
|
2014-08-14 08:17:52 +00:00
|
|
|
# Validate label names in advance
|
2014-08-17 20:22:01 +00:00
|
|
|
if (errors = validate_label_params(params)).any?
|
|
|
|
render_api_error!({ labels: errors }, 400)
|
2014-08-14 08:17:52 +00:00
|
|
|
end
|
|
|
|
|
2014-04-02 10:38:35 +00:00
|
|
|
issue = ::Issues::CreateService.new(user_project, current_user, attrs).execute
|
|
|
|
|
|
|
|
if issue.valid?
|
2014-08-14 08:17:52 +00:00
|
|
|
# Find or create labels and attach to issue. Labels are valid because
|
|
|
|
# we already checked its name, so there can't be an error here
|
2014-07-30 14:17:29 +00:00
|
|
|
if params[:labels].present?
|
2014-08-14 08:17:52 +00:00
|
|
|
issue.add_labels_by_names(params[:labels].split(','))
|
2014-07-30 14:17:29 +00:00
|
|
|
end
|
|
|
|
|
2014-04-02 10:38:35 +00:00
|
|
|
present issue, with: Entities::Issue
|
|
|
|
else
|
|
|
|
not_found!
|
2012-07-24 12:19:51 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# Update an existing issue
|
|
|
|
#
|
|
|
|
# Parameters:
|
2012-12-21 17:47:04 +00:00
|
|
|
# id (required) - The ID of a project
|
2012-07-24 12:19:51 +00:00
|
|
|
# issue_id (required) - The ID of a project issue
|
|
|
|
# title (optional) - The title of an issue
|
|
|
|
# description (optional) - The description of an issue
|
|
|
|
# assignee_id (optional) - The ID of a user to assign issue
|
|
|
|
# milestone_id (optional) - The ID of a milestone to assign issue
|
|
|
|
# labels (optional) - The labels of an issue
|
2013-06-06 08:31:40 +00:00
|
|
|
# state_event (optional) - The state event of an issue (close|reopen)
|
2012-07-24 12:19:51 +00:00
|
|
|
# Example Request:
|
|
|
|
# PUT /projects/:id/issues/:issue_id
|
|
|
|
put ":id/issues/:issue_id" do
|
2014-04-02 10:54:41 +00:00
|
|
|
issue = user_project.issues.find(params[:issue_id])
|
|
|
|
authorize! :modify_issue, issue
|
|
|
|
attrs = attributes_for_keys [:title, :description, :assignee_id, :milestone_id, :state_event]
|
|
|
|
|
2014-08-14 08:17:52 +00:00
|
|
|
# Validate label names in advance
|
2014-08-17 20:22:01 +00:00
|
|
|
if (errors = validate_label_params(params)).any?
|
|
|
|
render_api_error!({ labels: errors }, 400)
|
2014-08-14 08:17:52 +00:00
|
|
|
end
|
|
|
|
|
2014-04-02 10:54:41 +00:00
|
|
|
issue = ::Issues::UpdateService.new(user_project, current_user, attrs).execute(issue)
|
2013-06-11 15:15:18 +00:00
|
|
|
|
2014-04-02 10:54:41 +00:00
|
|
|
if issue.valid?
|
2014-08-14 08:17:52 +00:00
|
|
|
# Find or create labels and attach to issue. Labels are valid because
|
|
|
|
# we already checked its name, so there can't be an error here
|
2014-08-17 20:22:01 +00:00
|
|
|
unless params[:labels].nil?
|
|
|
|
issue.remove_labels
|
2014-08-14 08:17:52 +00:00
|
|
|
# Create and add labels to the new created issue
|
|
|
|
issue.add_labels_by_names(params[:labels].split(','))
|
2014-07-30 14:17:29 +00:00
|
|
|
end
|
|
|
|
|
2014-04-02 10:54:41 +00:00
|
|
|
present issue, with: Entities::Issue
|
|
|
|
else
|
|
|
|
not_found!
|
2012-07-24 12:19:51 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2012-08-22 17:26:09 +00:00
|
|
|
# Delete a project issue (deprecated)
|
2012-07-24 12:19:51 +00:00
|
|
|
#
|
|
|
|
# Parameters:
|
2012-12-21 17:47:04 +00:00
|
|
|
# id (required) - The ID of a project
|
2012-07-24 12:19:51 +00:00
|
|
|
# issue_id (required) - The ID of a project issue
|
|
|
|
# Example Request:
|
|
|
|
# DELETE /projects/:id/issues/:issue_id
|
|
|
|
delete ":id/issues/:issue_id" do
|
2012-09-10 07:41:46 +00:00
|
|
|
not_allowed!
|
2012-07-24 12:19:51 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|