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

265 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
2017-01-15 13:20:01 +05:30
def issue_params
new_params = declared(params, include_parent_namespace: false, include_missing: false).to_h
new_params = new_params.with_indifferent_access
new_params.delete(:id)
new_params.delete(:issue_id)
new_params
end
2015-04-26 12:48:37 +05:30
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?
2016-09-29 09:46:39 +05:30
issues = 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)
2016-09-29 09:46:39 +05:30
if params[:order_by] || params[:sort]
# The Sortable concern takes 'created_desc', not 'created_at_desc' (for example)
params[:sort] = "#{issuable_order_by.sub('_at', '')}_#{issuable_sort}"
end
2016-08-24 12:49:21 +05:30
issues = IssuesFinder.new(current_user, params).execute
present paginate(issues), with: Entities::Issue, current_user: current_user
end
end
2017-01-15 13:20:01 +05:30
params do
requires :id, type: String, desc: 'The ID of a project'
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
2017-01-15 13:20:01 +05:30
issues = IssuesFinder.new(current_user, project_id: user_project.id).execute.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?
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
2016-09-29 09:46:39 +05:30
issues = 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
2016-09-29 09:46:39 +05:30
# confidential (optional) - Boolean parameter if the issue should be confidential
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
2017-01-15 13:20:01 +05:30
keys = [:title, :description, :assignee_id, :milestone_id, :due_date, :confidential, :labels]
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
2016-09-29 09:46:39 +05:30
# Convert and filter out invalid confidential flags
attrs['confidential'] = to_boolean(attrs['confidential'])
attrs.delete('confidential') if attrs['confidential'].nil?
2016-04-02 18:10:28 +05:30
2016-09-29 09:46:39 +05:30
issue = ::Issues::CreateService.new(user_project, current_user, attrs.merge(request: request, api: true)).execute
2016-09-13 17:45:13 +05:30
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?
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
2017-01-15 13:20:01 +05:30
desc 'Update an existing issue' do
success Entities::Issue
end
params do
requires :id, type: String, desc: 'The ID of a project'
requires :issue_id, type: Integer, desc: "The ID of a project issue"
optional :title, type: String, desc: 'The new title of the issue'
optional :description, type: String, desc: 'The description of an issue'
optional :assignee_id, type: Integer, desc: 'The ID of a user to assign issue'
optional :milestone_id, type: Integer, desc: 'The ID of a milestone to assign issue'
optional :labels, type: String, desc: 'The labels of an issue'
optional :state_event, type: String, values: ['close', 'reopen'], desc: 'The state event of an issue'
# TODO 9.0, use the Grape DateTime type here
optional :updated_at, type: String, desc: 'Date time string, ISO 8601 formatted'
optional :due_date, type: String, desc: 'Date time string in the format YEAR-MONTH-DAY'
# TODO 9.0, use the Grape boolean type here
optional :confidential, type: String, desc: 'Boolean parameter if the issue should be confidential'
end
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-09-29 09:46:39 +05:30
# Convert and filter out invalid confidential flags
2017-01-15 13:20:01 +05:30
params[:confidential] = to_boolean(params[:confidential])
params.delete(:confidential) if params[:confidential].nil?
params.delete(:updated_at) unless current_user.admin? || user_project.owner == current_user
2016-09-29 09:46:39 +05:30
2017-01-15 13:20:01 +05:30
issue = ::Issues::UpdateService.new(user_project, current_user, issue_params).execute(issue)
2014-09-02 18:07:02 +05:30
if issue.valid?
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