debian-mirror-gitlab/lib/api/issues.rb

261 lines
10 KiB
Ruby
Raw Normal View History

2014-09-02 18:07:02 +05:30
module API
# Issues API
class Issues < Grape::API
before { authenticate! }
2015-04-26 12:48:37 +05:30
helpers do
def filter_issues_state(issues, state)
case state
when 'opened' then issues.opened
when 'closed' then issues.closed
else issues
end
end
def filter_issues_labels(issues, labels)
issues.includes(:labels).where('labels.title' => labels.split(','))
end
def filter_issues_milestone(issues, milestone)
issues.includes(:milestone).where('milestones.title' => milestone)
end
end
2014-09-02 18:07:02 +05:30
resource :issues do
# Get currently authenticated user's issues
#
2015-04-26 12:48:37 +05:30
# Parameters:
# state (optional) - Return "opened" or "closed" issues
# labels (optional) - Comma-separated list of label names
# order_by (optional) - Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at`
# sort (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
#
# Example Requests:
2014-09-02 18:07:02 +05:30
# GET /issues
2015-04-26 12:48:37 +05:30
# GET /issues?state=opened
# GET /issues?state=closed
# GET /issues?labels=foo
# GET /issues?labels=foo,bar
# GET /issues?labels=foo,bar&state=opened
2014-09-02 18:07:02 +05:30
get do
issues = current_user.issues.inc_notes_with_associations
2015-04-26 12:48:37 +05:30
issues = filter_issues_state(issues, params[:state]) unless params[:state].nil?
issues = filter_issues_labels(issues, params[:labels]) unless params[:labels].nil?
issues.reorder(issuable_order_by => issuable_sort)
2016-06-02 11:05:42 +05:30
present paginate(issues), with: Entities::Issue, current_user: current_user
2014-09-02 18:07:02 +05:30
end
end
2016-08-24 12:49:21 +05:30
resource :groups do
# Get a list of group issues
#
# Parameters:
# id (required) - The ID of a group
# state (optional) - Return "opened" or "closed" issues
# labels (optional) - Comma-separated list of label names
# milestone (optional) - Milestone title
# order_by (optional) - Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at`
# sort (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
#
# Example Requests:
# GET /groups/:id/issues
# GET /groups/:id/issues?state=opened
# GET /groups/:id/issues?state=closed
# GET /groups/:id/issues?labels=foo
# GET /groups/:id/issues?labels=foo,bar
# GET /groups/:id/issues?labels=foo,bar&state=opened
# GET /groups/:id/issues?milestone=1.0.0
# GET /groups/:id/issues?milestone=1.0.0&state=closed
get ":id/issues" do
group = find_group(params[:id])
params[:state] ||= 'opened'
params[:group_id] = group.id
params[:milestone_title] = params.delete(:milestone)
params[:label_name] = params.delete(:labels)
params[:sort] = "#{params.delete(:order_by)}_#{params.delete(:sort)}" if params[:order_by] && params[:sort]
issues = IssuesFinder.new(current_user, params).execute
present paginate(issues), with: Entities::Issue, current_user: current_user
end
end
2014-09-02 18:07:02 +05:30
resource :projects do
# Get a list of project issues
#
# Parameters:
# id (required) - The ID of a project
2015-09-11 14:41:01 +05:30
# iid (optional) - Return the project issue having the given `iid`
2015-04-26 12:48:37 +05:30
# state (optional) - Return "opened" or "closed" issues
# labels (optional) - Comma-separated list of label names
# milestone (optional) - Milestone title
# order_by (optional) - Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at`
# sort (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
#
# Example Requests:
2014-09-02 18:07:02 +05:30
# GET /projects/:id/issues
2015-04-26 12:48:37 +05:30
# GET /projects/:id/issues?state=opened
# GET /projects/:id/issues?state=closed
# GET /projects/:id/issues?labels=foo
# GET /projects/:id/issues?labels=foo,bar
# GET /projects/:id/issues?labels=foo,bar&state=opened
# GET /projects/:id/issues?milestone=1.0.0
# GET /projects/:id/issues?milestone=1.0.0&state=closed
2015-09-11 14:41:01 +05:30
# GET /issues?iid=42
2014-09-02 18:07:02 +05:30
get ":id/issues" do
issues = user_project.issues.inc_notes_with_associations.visible_to_user(current_user)
2015-04-26 12:48:37 +05:30
issues = filter_issues_state(issues, params[:state]) unless params[:state].nil?
issues = filter_issues_labels(issues, params[:labels]) unless params[:labels].nil?
2015-09-11 14:41:01 +05:30
issues = filter_by_iid(issues, params[:iid]) unless params[:iid].nil?
2015-04-26 12:48:37 +05:30
unless params[:milestone].nil?
issues = filter_issues_milestone(issues, params[:milestone])
end
issues.reorder(issuable_order_by => issuable_sort)
2016-06-02 11:05:42 +05:30
present paginate(issues), with: Entities::Issue, current_user: current_user
2014-09-02 18:07:02 +05:30
end
# Get a single project issue
#
# Parameters:
# id (required) - The ID of a project
# issue_id (required) - The ID of a project issue
# Example Request:
# GET /projects/:id/issues/:issue_id
get ":id/issues/:issue_id" do
2016-06-02 11:05:42 +05:30
@issue = find_project_issue(params[:issue_id])
present @issue, with: Entities::Issue, current_user: current_user
2014-09-02 18:07:02 +05:30
end
# Create a new project issue
#
# Parameters:
2016-06-02 11:05:42 +05:30
# id (required) - The ID of a project
# 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
2014-09-02 18:07:02 +05:30
# milestone_id (optional) - The ID of a milestone to assign issue
2016-06-02 11:05:42 +05:30
# labels (optional) - The labels of an issue
# created_at (optional) - Date time string, ISO 8601 formatted
2016-08-24 12:49:21 +05:30
# due_date (optional) - Date time string in the format YEAR-MONTH-DAY
2014-09-02 18:07:02 +05:30
# Example Request:
# POST /projects/:id/issues
2016-08-24 12:49:21 +05:30
post ':id/issues' do
2014-09-02 18:07:02 +05:30
required_attributes! [:title]
2016-06-02 11:05:42 +05:30
2016-08-24 12:49:21 +05:30
keys = [:title, :description, :assignee_id, :milestone_id, :due_date]
2016-06-02 11:05:42 +05:30
keys << :created_at if current_user.admin? || user_project.owner == current_user
attrs = attributes_for_keys(keys)
2014-09-02 18:07:02 +05:30
# Validate label names in advance
if (errors = validate_label_params(params)).any?
render_api_error!({ labels: errors }, 400)
end
2016-04-02 18:10:28 +05:30
project = user_project
2016-09-13 17:45:13 +05:30
issue = ::Issues::CreateService.new(project, current_user, attrs.merge(request: request, api: true)).execute
if issue.spam?
2016-04-02 18:10:28 +05:30
render_api_error!({ error: 'Spam detected' }, 400)
end
2014-09-02 18:07:02 +05:30
if issue.valid?
# 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
if params[:labels].present?
issue.add_labels_by_names(params[:labels].split(','))
end
2016-06-02 11:05:42 +05:30
present issue, with: Entities::Issue, current_user: current_user
2014-09-02 18:07:02 +05:30
else
2015-04-26 12:48:37 +05:30
render_validation_error!(issue)
2014-09-02 18:07:02 +05:30
end
end
# Update an existing issue
#
# Parameters:
# id (required) - The ID of a project
# 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
# state_event (optional) - The state event of an issue (close|reopen)
2016-06-02 11:05:42 +05:30
# updated_at (optional) - Date time string, ISO 8601 formatted
2016-08-24 12:49:21 +05:30
# due_date (optional) - Date time string in the format YEAR-MONTH-DAY
2014-09-02 18:07:02 +05:30
# Example Request:
# PUT /projects/:id/issues/:issue_id
2016-08-24 12:49:21 +05:30
put ':id/issues/:issue_id' do
2014-09-02 18:07:02 +05:30
issue = user_project.issues.find(params[:issue_id])
2015-09-11 14:41:01 +05:30
authorize! :update_issue, issue
2016-08-24 12:49:21 +05:30
keys = [:title, :description, :assignee_id, :milestone_id, :state_event, :due_date]
2016-06-02 11:05:42 +05:30
keys << :updated_at if current_user.admin? || user_project.owner == current_user
attrs = attributes_for_keys(keys)
2014-09-02 18:07:02 +05:30
# Validate label names in advance
if (errors = validate_label_params(params)).any?
render_api_error!({ labels: errors }, 400)
end
issue = ::Issues::UpdateService.new(user_project, current_user, attrs).execute(issue)
if issue.valid?
# 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
2015-09-11 14:41:01 +05:30
if params[:labels] && can?(current_user, :admin_issue, user_project)
2014-09-02 18:07:02 +05:30
issue.remove_labels
# Create and add labels to the new created issue
issue.add_labels_by_names(params[:labels].split(','))
end
2016-06-02 11:05:42 +05:30
present issue, with: Entities::Issue, current_user: current_user
2014-09-02 18:07:02 +05:30
else
2015-04-26 12:48:37 +05:30
render_validation_error!(issue)
2014-09-02 18:07:02 +05:30
end
end
2016-06-02 11:05:42 +05:30
# Move an existing issue
#
# Parameters:
# id (required) - The ID of a project
# issue_id (required) - The ID of a project issue
# to_project_id (required) - The ID of the new project
# Example Request:
# POST /projects/:id/issues/:issue_id/move
post ':id/issues/:issue_id/move' do
required_attributes! [:to_project_id]
issue = user_project.issues.find(params[:issue_id])
new_project = Project.find(params[:to_project_id])
begin
issue = ::Issues::MoveService.new(user_project, current_user).execute(issue, new_project)
present issue, with: Entities::Issue, current_user: current_user
rescue ::Issues::MoveService::MoveError => error
render_api_error!(error.message, 400)
end
end
#
# Delete a project issue
2014-09-02 18:07:02 +05:30
#
# Parameters:
# id (required) - The ID of a project
# issue_id (required) - The ID of a project issue
# Example Request:
# DELETE /projects/:id/issues/:issue_id
delete ":id/issues/:issue_id" do
2016-06-02 11:05:42 +05:30
issue = user_project.issues.find_by(id: params[:issue_id])
authorize!(:destroy_issue, issue)
issue.destroy
2014-09-02 18:07:02 +05:30
end
end
end
end