issues.rb 8.8 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
R
Robert Schilling 已提交
8
      # TODO: Remove in 9.0 and switch to IssueFinder-based label filtering
J
jubianchi 已提交
9
      def filter_issues_labels(issues, labels)
J
jubianchi 已提交
10 11 12
        issues.includes(:labels).where('labels.title' => labels.split(','))
      end

R
Robert Schilling 已提交
13 14 15 16 17 18
      params :issues_params do
        optional :labels, type: String, desc: 'Comma-separated list of label names'
        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.'
19
        optional :milestone, type: String, desc: 'Return issues for a specific milestone'
R
Robert Schilling 已提交
20 21
        use :pagination
      end
22

R
Robert Schilling 已提交
23 24 25 26 27 28 29
      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'
30
      end
J
jubianchi 已提交
31 32
    end

N
Nihad Abbasov 已提交
33
    resource :issues do
R
Robert Schilling 已提交
34 35 36 37 38 39 40 41
      desc "Get currently authenticated user's issues" do
        success Entities::Issue
      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 已提交
42
      get do
R
Robert Schilling 已提交
43
        issues = IssuesFinder.new(current_user, scope: 'all', author_id: current_user.id, state: params[:state]).execute.inc_notes_with_associations
J
jubianchi 已提交
44
        issues = filter_issues_labels(issues, params[:labels]) unless params[:labels].nil?
R
Robert Schilling 已提交
45
        issues = issues.reorder(params[:order_by] => params[:sort])
S
Sean McGivern 已提交
46

47
        present paginate(issues), with: Entities::Issue, current_user: current_user
N
Nihad Abbasov 已提交
48 49 50
      end
    end

R
Robert Schilling 已提交
51 52 53
    params do
      requires :id, type: String, desc: 'The ID of a group'
    end
54
    resource :groups do
R
Robert Schilling 已提交
55 56 57 58 59 60 61 62
      desc 'Get a list of group issues' do
        success Entities::Issue
      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
63
      get ":id/issues" do
R
Robert Schilling 已提交
64
        group = find_group!(params.delete(:id))
65 66 67 68

        params[:group_id] = group.id
        params[:milestone_title] = params.delete(:milestone)
        params[:label_name] = params.delete(:labels)
S
Sean McGivern 已提交
69

70 71
        issues = IssuesFinder.new(current_user, params).execute

R
Robert Schilling 已提交
72
        issues = issues.reorder(params[:order_by] => params[:sort])
73 74 75 76
        present paginate(issues), with: Entities::Issue, current_user: current_user
      end
    end

77 78 79
    params do
      requires :id, type: String, desc: 'The ID of a project'
    end
N
Nihad Abbasov 已提交
80
    resource :projects do
R
Robert Schilling 已提交
81 82 83 84 85 86 87 88 89
      desc 'Get a list of project issues' do
        success Entities::Issue
      end
      params do
        optional :state, type: String, values: %w[opened closed all], default: 'all',
                         desc: 'Return opened, closed, or all issues'
        optional :iid, type: Integer, desc: 'The IID of the issue'
        use :issues_params
      end
N
Nihad Abbasov 已提交
90
      get ":id/issues" do
R
Robert Schilling 已提交
91 92 93 94
        issues = IssuesFinder.new(current_user,
                                  project_id: user_project.id,
                                  state: params[:state],
                                  milestone_title: params[:milestone]).execute.inc_notes_with_associations
J
jubianchi 已提交
95
        issues = filter_issues_labels(issues, params[:labels]) unless params[:labels].nil?
96
        issues = filter_by_iid(issues, params[:iid]) unless params[:iid].nil?
R
Robert Schilling 已提交
97
        issues = issues.reorder(params[:order_by] => params[:sort])
R
Robert Schilling 已提交
98

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

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

R
Robert Schilling 已提交
113 114 115 116 117 118 119 120 121 122 123
      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
124
      post ':id/issues' do
R
Robert Schilling 已提交
125 126 127 128
        # 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
129

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

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

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

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

152 153 154 155
      desc 'Update an existing issue' do
        success Entities::Issue
      end
      params do
R
Robert Schilling 已提交
156 157 158 159
        requires :issue_id, type: Integer, desc: 'The ID of a project issue'
        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.'
160
        optional :state_event, type: String, values: %w[reopen close], desc: 'State of the issue'
R
Robert Schilling 已提交
161 162 163
        use :issue_params
        at_least_one_of :title, :description, :assignee_id, :milestone_id,
                        :labels, :created_at, :due_date, :confidential, :state_event
164
      end
165
      put ':id/issues/:issue_id' do
R
Robert Schilling 已提交
166
        issue = user_project.issues.find(params.delete(:issue_id))
167
        authorize! :update_issue, issue
168

R
Robert Schilling 已提交
169 170 171 172
        # 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
173

R
Robert Schilling 已提交
174 175 176
        issue = ::Issues::UpdateService.new(user_project,
                                            current_user,
                                            declared_params(include_missing: false)).execute(issue)
177

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

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

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

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

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

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