issues.rb 8.4 KB
Newer Older
1
module API
N
Nihad Abbasov 已提交
2
  class Issues < Grape::API
R
Robert Schilling 已提交
3 4
    include PaginationParams

N
Nihad Abbasov 已提交
5 6
    before { authenticate! }

J
jubianchi 已提交
7
    helpers do
8 9 10 11 12
      def find_issues(args = {})
        args = params.merge(args)

        args.delete(:id)
        args[:milestone_title] = args.delete(:milestone)
13
        args[:label_name] = args.delete(:labels)
14

15
        issues = IssuesFinder.new(current_user, args).execute
16 17

        issues.reorder(args[:order_by] => args[:sort])
J
jubianchi 已提交
18 19
      end

R
Robert Schilling 已提交
20 21
      params :issues_params do
        optional :labels, type: String, desc: 'Comma-separated list of label names'
22
        optional :milestone, type: String, desc: 'Milestone title'
R
Robert Schilling 已提交
23 24 25 26
        optional :order_by, type: String, values: %w[created_at updated_at], default: 'created_at',
                            desc: 'Return issues ordered by `created_at` or `updated_at` fields.'
        optional :sort, type: String, values: %w[asc desc], default: 'desc',
                        desc: 'Return issues sorted in `asc` or `desc` order.'
27
        optional :milestone, type: String, desc: 'Return issues for a specific milestone'
28
        optional :iids, type: Array[Integer], desc: 'The IID array of issues'
R
Robert Schilling 已提交
29 30
        use :pagination
      end
31

R
Robert Schilling 已提交
32 33 34 35 36 37 38
      params :issue_params do
        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: 'Comma-separated list of label names'
        optional :due_date, type: String, desc: 'Date time string in the format YEAR-MONTH-DAY'
        optional :confidential, type: Boolean, desc: 'Boolean parameter if the issue should be confidential'
39
      end
J
jubianchi 已提交
40 41
    end

N
Nihad Abbasov 已提交
42
    resource :issues do
R
Robert Schilling 已提交
43
      desc "Get currently authenticated user's issues" do
44
        success Entities::IssueBasic
R
Robert Schilling 已提交
45 46 47 48 49 50
      end
      params do
        optional :state, type: String, values: %w[opened closed all], default: 'all',
                         desc: 'Return opened, closed, or all issues'
        use :issues_params
      end
N
Nihad Abbasov 已提交
51
      get do
52
        issues = find_issues(scope: 'authored')
S
Sean McGivern 已提交
53

54
        present paginate(issues), with: Entities::IssueBasic, current_user: current_user
N
Nihad Abbasov 已提交
55 56 57
      end
    end

R
Robert Schilling 已提交
58 59 60
    params do
      requires :id, type: String, desc: 'The ID of a group'
    end
61
    resource :groups do
R
Robert Schilling 已提交
62
      desc 'Get a list of group issues' do
63
        success Entities::IssueBasic
R
Robert Schilling 已提交
64 65 66 67 68 69
      end
      params do
        optional :state, type: String, values: %w[opened closed all], default: 'opened',
                         desc: 'Return opened, closed, or all issues'
        use :issues_params
      end
70
      get ":id/issues" do
71
        group = find_group!(params[:id])
72

73
        issues = find_issues(group_id: group.id, state: params[:state] || 'opened')
S
Sean McGivern 已提交
74

75
        present paginate(issues), with: Entities::IssueBasic, current_user: current_user
76 77 78
      end
    end

79 80 81
    params do
      requires :id, type: String, desc: 'The ID of a project'
    end
N
Nihad Abbasov 已提交
82
    resource :projects do
83 84
      include TimeTrackingEndpoints

R
Robert Schilling 已提交
85
      desc 'Get a list of project issues' do
86
        success Entities::IssueBasic
R
Robert Schilling 已提交
87 88 89 90 91 92
      end
      params do
        optional :state, type: String, values: %w[opened closed all], default: 'all',
                         desc: 'Return opened, closed, or all issues'
        use :issues_params
      end
N
Nihad Abbasov 已提交
93
      get ":id/issues" do
94 95
        project = find_project(params[:id])

96
        issues = find_issues(project_id: project.id)
R
Robert Schilling 已提交
97

98
        present paginate(issues), with: Entities::IssueBasic, current_user: current_user, project: user_project
N
Nihad Abbasov 已提交
99 100
      end

R
Robert Schilling 已提交
101 102 103 104
      desc 'Get a single project issue' do
        success Entities::Issue
      end
      params do
105
        requires :issue_iid, type: Integer, desc: 'The internal ID of a project issue'
R
Robert Schilling 已提交
106
      end
107 108
      get ":id/issues/:issue_iid" do
        issue = find_project_issue(params[:issue_iid])
R
Robert Schilling 已提交
109
        present issue, with: Entities::Issue, current_user: current_user, project: user_project
N
Nihad Abbasov 已提交
110 111
      end

R
Robert Schilling 已提交
112 113 114 115 116 117 118 119 120 121 122
      desc 'Create a new project issue' do
        success Entities::Issue
      end
      params do
        requires :title, type: String, desc: 'The title of an issue'
        optional :created_at, type: DateTime,
                              desc: 'Date time when the issue was created. Available only for admins and project owners.'
        optional :merge_request_for_resolving_discussions, type: Integer,
                                                           desc: 'The IID of a merge request for which to resolve discussions'
        use :issue_params
      end
123
      post ':id/issues' do
R
Robert Schilling 已提交
124 125 126 127
        # Setting created_at time only allowed for admins and project owners
        unless current_user.admin? || user_project.owner == current_user
          params.delete(:created_at)
        end
128

R
Robert Schilling 已提交
129
        issue_params = declared_params(include_missing: false)
130 131

        if merge_request_iid = params[:merge_request_for_resolving_discussions]
R
Robert Schilling 已提交
132
          issue_params[:merge_request_for_resolving_discussions] = MergeRequestsFinder.new(current_user, project_id: user_project.id).
133 134 135
            execute.
            find_by(iid: merge_request_iid)
        end
136

R
Robert Schilling 已提交
137 138 139
        issue = ::Issues::CreateService.new(user_project,
                                            current_user,
                                            issue_params.merge(request: request, api: true)).execute
140
        if issue.spam?
141 142
          render_api_error!({ error: 'Spam detected' }, 400)
        end
143

144
        if issue.valid?
145
          present issue, with: Entities::Issue, current_user: current_user, project: user_project
146
        else
J
jubianchi 已提交
147
          render_validation_error!(issue)
N
Nihad Abbasov 已提交
148 149 150
        end
      end

151 152 153 154
      desc 'Update an existing issue' do
        success Entities::Issue
      end
      params do
155
        requires :issue_iid, type: Integer, desc: 'The internal ID of a project issue'
R
Robert Schilling 已提交
156 157 158
        optional :title, type: String, desc: 'The title of an issue'
        optional :updated_at, type: DateTime,
                              desc: 'Date time when the issue was updated. Available only for admins and project owners.'
159
        optional :state_event, type: String, values: %w[reopen close], desc: 'State of the issue'
R
Robert Schilling 已提交
160 161 162
        use :issue_params
        at_least_one_of :title, :description, :assignee_id, :milestone_id,
                        :labels, :created_at, :due_date, :confidential, :state_event
163
      end
164 165
      put ':id/issues/:issue_iid' do
        issue = user_project.issues.find_by!(iid: params.delete(:issue_iid))
166
        authorize! :update_issue, issue
167

R
Robert Schilling 已提交
168 169 170 171
        # Setting created_at time only allowed for admins and project owners
        unless current_user.admin? || user_project.owner == current_user
          params.delete(:updated_at)
        end
172

173 174
        update_params = declared_params(include_missing: false).merge(request: request, api: true)

R
Robert Schilling 已提交
175 176
        issue = ::Issues::UpdateService.new(user_project,
                                            current_user,
177 178 179
                                            update_params).execute(issue)

        render_spam_error! if issue.spam?
180

181
        if issue.valid?
182
          present issue, with: Entities::Issue, current_user: current_user, project: user_project
183
        else
J
jubianchi 已提交
184
          render_validation_error!(issue)
N
Nihad Abbasov 已提交
185 186 187
        end
      end

R
Robert Schilling 已提交
188 189 190 191
      desc 'Move an existing issue' do
        success Entities::Issue
      end
      params do
192
        requires :issue_iid, type: Integer, desc: 'The internal ID of a project issue'
R
Robert Schilling 已提交
193 194
        requires :to_project_id, type: Integer, desc: 'The ID of the new project'
      end
195 196
      post ':id/issues/:issue_iid/move' do
        issue = user_project.issues.find_by(iid: params[:issue_iid])
R
Robert Schilling 已提交
197
        not_found!('Issue') unless issue
R
Robert Schilling 已提交
198

R
Robert Schilling 已提交
199 200
        new_project = Project.find_by(id: params[:to_project_id])
        not_found!('Project') unless new_project
R
Robert Schilling 已提交
201 202 203

        begin
          issue = ::Issues::MoveService.new(user_project, current_user).execute(issue, new_project)
204
          present issue, with: Entities::Issue, current_user: current_user, project: user_project
R
Robert Schilling 已提交
205 206 207 208 209
        rescue ::Issues::MoveService::MoveError => error
          render_api_error!(error.message, 400)
        end
      end

R
Robert Schilling 已提交
210 211
      desc 'Delete a project issue'
      params do
212
        requires :issue_iid, type: Integer, desc: 'The internal ID of a project issue'
R
Robert Schilling 已提交
213
      end
214 215
      delete ":id/issues/:issue_iid" do
        issue = user_project.issues.find_by(iid: params[:issue_iid])
R
Robert Schilling 已提交
216
        not_found!('Issue') unless issue
Z
Zeger-Jan van de Weg 已提交
217

218
        authorize!(:destroy_issue, issue)
Z
Zeger-Jan van de Weg 已提交
219
        issue.destroy
N
Nihad Abbasov 已提交
220 221 222 223
      end
    end
  end
end