projects.rb 17.9 KB
Newer Older
1 2 3 4 5 6
module Gitlab
  # Projects API
  class Projects < Grape::API
    before { authenticate! }

    resource :projects do
7 8 9 10 11 12 13 14 15
      helpers do
        def handle_project_member_errors(errors)
          if errors[:project_access].any?
            error!(errors[:project_access], 422)
          end
          not_found!
        end
      end

16 17 18 19 20
      # Get a projects list for authenticated user
      #
      # Example Request:
      #   GET /projects
      get do
21
        @projects = paginate current_user.authorized_projects
22
        present @projects, with: Entities::Project
23 24 25 26 27
      end

      # Get a single project
      #
      # Parameters:
28
      #   id (required) - The ID of a project
29 30 31
      # Example Request:
      #   GET /projects/:id
      get ":id" do
32
        present user_project, with: Entities::Project
33 34
      end

35 36 37 38
      # Create new project
      #
      # Parameters:
      #   name (required) - name for new project
39 40 41 42 43 44
      #   description (optional) - short project description
      #   default_branch (optional) - 'master' by default
      #   issues_enabled (optional) - enabled by default
      #   wall_enabled (optional) - enabled by default
      #   merge_requests_enabled (optional) - enabled by default
      #   wiki_enabled (optional) - enabled by default
45
      #   namespace_id (optional) - defaults to user namespace
46 47 48
      # Example Request
      #   POST /projects
      post do
49
        required_attributes! [:name]
50
        attrs = attributes_for_keys [:name,
51 52 53 54 55
                                    :description,
                                    :default_branch,
                                    :issues_enabled,
                                    :wall_enabled,
                                    :merge_requests_enabled,
56 57
                                    :wiki_enabled,
                                    :namespace_id]
58
        @project = ::Projects::CreateContext.new(current_user, attrs).execute
59 60 61
        if @project.saved?
          present @project, with: Entities::Project
        else
62 63 64
          if @project.errors[:limit_reached].present?
            error!(@project.errors[:limit_reached], 403)
          end
65
          not_found!
66 67 68
        end
      end

Angus MacArthur's avatar
Angus MacArthur committed
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
      # Create new project for a specified user.  Only available to admin users.
      #
      # Parameters:
      #   user_id (required) - The ID of a user
      #   name (required) - name for new project
      #   description (optional) - short project description
      #   default_branch (optional) - 'master' by default
      #   issues_enabled (optional) - enabled by default
      #   wall_enabled (optional) - enabled by default
      #   merge_requests_enabled (optional) - enabled by default
      #   wiki_enabled (optional) - enabled by default
      # Example Request
      #   POST /projects/user/:user_id
      post "user/:user_id" do
        authenticated_as_admin!
        user = User.find(params[:user_id])
        attrs = attributes_for_keys [:name,
                                    :description,
                                    :default_branch,
                                    :issues_enabled,
                                    :wall_enabled,
                                    :merge_requests_enabled,
                                    :wiki_enabled]
        @project = ::Projects::CreateContext.new(user, attrs).execute
        if @project.saved?
          present @project, with: Entities::Project
        else
          not_found!
        end
      end


101
      # Get a project team members
miks's avatar
miks committed
102 103
      #
      # Parameters:
104
      #   id (required) - The ID of a project
Valeriy Sizov's avatar
Valeriy Sizov committed
105
      #   query         - Query string
miks's avatar
miks committed
106
      # Example Request:
107 108
      #   GET /projects/:id/members
      get ":id/members" do
Valeriy Sizov's avatar
Valeriy Sizov committed
109 110 111 112 113
        if params[:query].present?
          @members = paginate user_project.users.where("username LIKE ?", "%#{params[:query]}%")
        else
          @members = paginate user_project.users
        end
114
        present @members, with: Entities::ProjectMember, project: user_project
miks's avatar
miks committed
115 116
      end

117
      # Get a project team members
118 119
      #
      # Parameters:
120
      #   id (required) - The ID of a project
121
      #   user_id (required) - The ID of a user
122
      # Example Request:
123 124 125 126 127 128 129 130 131
      #   GET /projects/:id/members/:user_id
      get ":id/members/:user_id" do
        @member = user_project.users.find params[:user_id]
        present @member, with: Entities::ProjectMember, project: user_project
      end

      # Add a new project team member
      #
      # Parameters:
132
      #   id (required) - The ID of a project
133 134 135 136 137
      #   user_id (required) - The ID of a user
      #   access_level (required) - Project access level
      # Example Request:
      #   POST /projects/:id/members
      post ":id/members" do
randx's avatar
randx committed
138
        authorize! :admin_project, user_project
139
        required_attributes! [:user_id, :access_level]
140 141 142 143 144 145 146 147 148 149 150 151

        # either the user is already a team member or a new one
        team_member = user_project.team_member_by_id(params[:user_id])
        if team_member.nil?
          team_member = user_project.users_projects.new(
            user_id: params[:user_id],
            project_access: params[:access_level]
          )
        end

        if team_member.save
          @member = team_member.user
152 153
          present @member, with: Entities::ProjectMember, project: user_project
        else
154
          handle_project_member_errors team_member.errors
155
        end
156 157
      end

158
      # Update project team member
miks's avatar
miks committed
159 160
      #
      # Parameters:
161
      #   id (required) - The ID of a project
162 163
      #   user_id (required) - The ID of a team member
      #   access_level (required) - Project access level
miks's avatar
miks committed
164
      # Example Request:
165 166
      #   PUT /projects/:id/members/:user_id
      put ":id/members/:user_id" do
randx's avatar
randx committed
167
        authorize! :admin_project, user_project
168
        required_attributes! [:access_level]
169

170
        team_member = user_project.users_projects.find_by_user_id(params[:user_id])
171
        not_found!("User can not be found") if team_member.nil?
172 173 174

        if team_member.update_attributes(project_access: params[:access_level])
          @member = team_member.user
175 176
          present @member, with: Entities::ProjectMember, project: user_project
        else
177
          handle_project_member_errors team_member.errors
178
        end
miks's avatar
miks committed
179 180
      end

181
      # Remove a team member from project
miks's avatar
miks committed
182 183
      #
      # Parameters:
184
      #   id (required) - The ID of a project
185
      #   user_id (required) - The ID of a team member
miks's avatar
miks committed
186
      # Example Request:
187 188
      #   DELETE /projects/:id/members/:user_id
      delete ":id/members/:user_id" do
randx's avatar
randx committed
189
        authorize! :admin_project, user_project
190 191 192
        team_member = user_project.users_projects.find_by_user_id(params[:user_id])
        unless team_member.nil?
          team_member.destroy
193
        else
194
          {message: "Access revoked", id: params[:user_id].to_i}
195
        end
miks's avatar
miks committed
196 197
      end

miks's avatar
miks committed
198 199 200
      # Get project hooks
      #
      # Parameters:
201
      #   id (required) - The ID of a project
miks's avatar
miks committed
202 203 204
      # Example Request:
      #   GET /projects/:id/hooks
      get ":id/hooks" do
miks's avatar
miks committed
205
        authorize! :admin_project, user_project
miks's avatar
miks committed
206 207 208
        @hooks = paginate user_project.hooks
        present @hooks, with: Entities::Hook
      end
Saito's avatar
Saito committed
209

jozefvaclavik's avatar
jozefvaclavik committed
210 211 212
      # Get a project hook
      #
      # Parameters:
213
      #   id (required) - The ID of a project
jozefvaclavik's avatar
jozefvaclavik committed
214 215 216 217
      #   hook_id (required) - The ID of a project hook
      # Example Request:
      #   GET /projects/:id/hooks/:hook_id
      get ":id/hooks/:hook_id" do
218
        authorize! :admin_project, user_project
jozefvaclavik's avatar
jozefvaclavik committed
219 220 221
        @hook = user_project.hooks.find(params[:hook_id])
        present @hook, with: Entities::Hook
      end
Saito's avatar
Saito committed
222

miks's avatar
miks committed
223 224 225 226

      # Add hook to project
      #
      # Parameters:
227
      #   id (required) - The ID of a project
miks's avatar
miks committed
228 229 230 231
      #   url (required) - The hook URL
      # Example Request:
      #   POST /projects/:id/hooks
      post ":id/hooks" do
miks's avatar
miks committed
232
        authorize! :admin_project, user_project
233
        required_attributes! [:url]
234

miks's avatar
miks committed
235 236 237 238
        @hook = user_project.hooks.new({"url" => params[:url]})
        if @hook.save
          present @hook, with: Entities::Hook
        else
239 240 241
          if @hook.errors[:url].present?
            error!("Invalid url given", 422)
          end
242
          not_found!
miks's avatar
miks committed
243 244
        end
      end
Saito's avatar
Saito committed
245

jozefvaclavik's avatar
jozefvaclavik committed
246 247 248
      # Update an existing project hook
      #
      # Parameters:
249
      #   id (required) - The ID of a project
jozefvaclavik's avatar
jozefvaclavik committed
250 251 252 253 254 255 256
      #   hook_id (required) - The ID of a project hook
      #   url (required) - The hook URL
      # Example Request:
      #   PUT /projects/:id/hooks/:hook_id
      put ":id/hooks/:hook_id" do
        @hook = user_project.hooks.find(params[:hook_id])
        authorize! :admin_project, user_project
257
        required_attributes! [:url]
jozefvaclavik's avatar
jozefvaclavik committed
258

259
        attrs = attributes_for_keys [:url]
jozefvaclavik's avatar
jozefvaclavik committed
260 261 262
        if @hook.update_attributes attrs
          present @hook, with: Entities::Hook
        else
263 264 265
          if @hook.errors[:url].present?
            error!("Invalid url given", 422)
          end
jozefvaclavik's avatar
jozefvaclavik committed
266 267 268
          not_found!
        end
      end
miks's avatar
miks committed
269

270
      # Deletes project hook. This is an idempotent function.
miks's avatar
miks committed
271 272
      #
      # Parameters:
273
      #   id (required) - The ID of a project
miks's avatar
miks committed
274 275
      #   hook_id (required) - The ID of hook to delete
      # Example Request:
276
      #   DELETE /projects/:id/hooks/:hook_id
277
      delete ":id/hooks" do
miks's avatar
miks committed
278
        authorize! :admin_project, user_project
279
        required_attributes! [:hook_id]
280 281 282 283 284

        begin
          @hook = ProjectHook.find(params[:hook_id])
          @hook.destroy
        rescue
285
          # ProjectHook can raise Error if hook_id not found
286
        end
miks's avatar
miks committed
287 288
      end

289 290 291
      # Get a project repository branches
      #
      # Parameters:
292
      #   id (required) - The ID of a project
293 294 295
      # Example Request:
      #   GET /projects/:id/repository/branches
      get ":id/repository/branches" do
296
        present user_project.repo.heads.sort_by(&:name), with: Entities::RepoObject, project: user_project
297 298
      end

299 300 301
      # Get a single branch
      #
      # Parameters:
302
      #   id (required) - The ID of a project
303
      #   branch (required) - The name of the branch
304
      # Example Request:
305 306 307
      #   GET /projects/:id/repository/branches/:branch
      get ":id/repository/branches/:branch" do
        @branch = user_project.repo.heads.find { |item| item.name == params[:branch] }
308
        not_found!("Branch does not exist") if @branch.nil?
309 310 311 312 313 314 315 316 317 318 319 320
        present @branch, with: Entities::RepoObject, project: user_project
      end

      # Protect a single branch
      #
      # Parameters:
      #   id (required) - The ID of a project
      #   branch (required) - The name of the branch
      # Example Request:
      #   PUT /projects/:id/repository/branches/:branch/protect
      put ":id/repository/branches/:branch/protect" do
        @branch = user_project.repo.heads.find { |item| item.name == params[:branch] }
321
        not_found! unless @branch
322 323 324
        protected = user_project.protected_branches.find_by_name(@branch.name)

        unless protected
325
          user_project.protected_branches.create(name: @branch.name)
326 327 328 329 330 331 332 333 334 335 336 337 338 339
        end

        present @branch, with: Entities::RepoObject, project: user_project
      end

      # Unprotect a single branch
      #
      # Parameters:
      #   id (required) - The ID of a project
      #   branch (required) - The name of the branch
      # Example Request:
      #   PUT /projects/:id/repository/branches/:branch/unprotect
      put ":id/repository/branches/:branch/unprotect" do
        @branch = user_project.repo.heads.find { |item| item.name == params[:branch] }
340
        not_found! unless @branch
341 342 343 344 345 346 347
        protected = user_project.protected_branches.find_by_name(@branch.name)

        if protected
          protected.destroy
        end

        present @branch, with: Entities::RepoObject, project: user_project
348 349
      end

350 351 352
      # Get a project repository tags
      #
      # Parameters:
353
      #   id (required) - The ID of a project
354 355 356
      # Example Request:
      #   GET /projects/:id/repository/tags
      get ":id/repository/tags" do
357
        present user_project.repo.tags.sort_by(&:name).reverse, with: Entities::RepoObject
358
      end
Nihad Abbasov's avatar
Nihad Abbasov committed
359

360 361 362
      # Get a project repository commits
      #
      # Parameters:
363
      #   id (required) - The ID of a project
364
      #   ref_name (optional) - The name of a repository branch or tag, if not given the default branch is used
365 366 367 368 369 370
      # Example Request:
      #   GET /projects/:id/repository/commits
      get ":id/repository/commits" do
        authorize! :download_code, user_project

        page = params[:page] || 0
Nihad Abbasov's avatar
Nihad Abbasov committed
371
        per_page = (params[:per_page] || 20).to_i
372 373
        ref = params[:ref_name] || user_project.try(:default_branch) || 'master'

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
374
        commits = user_project.repository.commits(ref, nil, per_page, page * per_page)
375
        present commits, with: Entities::RepoCommit
376 377
      end

378 379 380
      # Get a project snippets
      #
      # Parameters:
381
      #   id (required) - The ID of a project
382 383 384 385 386 387
      # Example Request:
      #   GET /projects/:id/snippets
      get ":id/snippets" do
        present paginate(user_project.snippets), with: Entities::ProjectSnippet
      end

Nihad Abbasov's avatar
Nihad Abbasov committed
388 389 390
      # Get a project snippet
      #
      # Parameters:
391
      #   id (required) - The ID of a project
Nihad Abbasov's avatar
Nihad Abbasov committed
392 393 394 395
      #   snippet_id (required) - The ID of a project snippet
      # Example Request:
      #   GET /projects/:id/snippets/:snippet_id
      get ":id/snippets/:snippet_id" do
Nihad Abbasov's avatar
Nihad Abbasov committed
396
        @snippet = user_project.snippets.find(params[:snippet_id])
397
        present @snippet, with: Entities::ProjectSnippet
Nihad Abbasov's avatar
Nihad Abbasov committed
398 399 400 401 402
      end

      # Create a new project snippet
      #
      # Parameters:
403
      #   id (required) - The ID of a project
Nihad Abbasov's avatar
Nihad Abbasov committed
404 405 406 407 408 409 410
      #   title (required) - The title of a snippet
      #   file_name (required) - The name of a snippet file
      #   lifetime (optional) - The expiration date of a snippet
      #   code (required) - The content of a snippet
      # Example Request:
      #   POST /projects/:id/snippets
      post ":id/snippets" do
411
        authorize! :write_snippet, user_project
412
        required_attributes! [:title, :file_name, :code]
413

Alex Denisov's avatar
Alex Denisov committed
414
        attrs = attributes_for_keys [:title, :file_name]
Alex Denisov's avatar
Alex Denisov committed
415 416 417
        attrs[:expires_at] = params[:lifetime] if params[:lifetime].present?
        attrs[:content] = params[:code] if params[:code].present?
        @snippet = user_project.snippets.new attrs
Nihad Abbasov's avatar
Nihad Abbasov committed
418 419 420
        @snippet.author = current_user

        if @snippet.save
421
          present @snippet, with: Entities::ProjectSnippet
Nihad Abbasov's avatar
Nihad Abbasov committed
422
        else
423
          not_found!
Nihad Abbasov's avatar
Nihad Abbasov committed
424 425 426
        end
      end

427 428 429
      # Update an existing project snippet
      #
      # Parameters:
430
      #   id (required) - The ID of a project
431 432 433 434 435 436 437 438
      #   snippet_id (required) - The ID of a project snippet
      #   title (optional) - The title of a snippet
      #   file_name (optional) - The name of a snippet file
      #   lifetime (optional) - The expiration date of a snippet
      #   code (optional) - The content of a snippet
      # Example Request:
      #   PUT /projects/:id/snippets/:snippet_id
      put ":id/snippets/:snippet_id" do
Nihad Abbasov's avatar
Nihad Abbasov committed
439
        @snippet = user_project.snippets.find(params[:snippet_id])
randx's avatar
randx committed
440 441
        authorize! :modify_snippet, @snippet

Alex Denisov's avatar
Alex Denisov committed
442
        attrs = attributes_for_keys [:title, :file_name]
Alex Denisov's avatar
Alex Denisov committed
443 444
        attrs[:expires_at] = params[:lifetime] if params[:lifetime].present?
        attrs[:content] = params[:code] if params[:code].present?
445

Alex Denisov's avatar
Alex Denisov committed
446
        if @snippet.update_attributes attrs
447
          present @snippet, with: Entities::ProjectSnippet
448
        else
449
          not_found!
450 451 452
        end
      end

Nihad Abbasov's avatar
Nihad Abbasov committed
453 454 455
      # Delete a project snippet
      #
      # Parameters:
456
      #   id (required) - The ID of a project
Nihad Abbasov's avatar
Nihad Abbasov committed
457 458 459 460
      #   snippet_id (required) - The ID of a project snippet
      # Example Request:
      #   DELETE /projects/:id/snippets/:snippet_id
      delete ":id/snippets/:snippet_id" do
461 462 463 464 465 466
        begin
          @snippet = user_project.snippets.find(params[:snippet_id])
          authorize! :modify_snippet, user_project
          @snippet.destroy
        rescue
        end
Nihad Abbasov's avatar
Nihad Abbasov committed
467
      end
468 469 470 471

      # Get a raw project snippet
      #
      # Parameters:
472
      #   id (required) - The ID of a project
473 474 475 476
      #   snippet_id (required) - The ID of a project snippet
      # Example Request:
      #   GET /projects/:id/snippets/:snippet_id/raw
      get ":id/snippets/:snippet_id/raw" do
Nihad Abbasov's avatar
Nihad Abbasov committed
477
        @snippet = user_project.snippets.find(params[:snippet_id])
478
        content_type 'text/plain'
479 480
        present @snippet.content
      end
481 482 483 484

      # Get a raw file contents
      #
      # Parameters:
485
      #   id (required) - The ID of a project
486
      #   sha (required) - The commit or branch name
487 488 489 490
      #   filepath (required) - The path to the file to display
      # Example Request:
      #   GET /projects/:id/repository/commits/:sha/blob
      get ":id/repository/commits/:sha/blob" do
491
        authorize! :download_code, user_project
492
        required_attributes! [:filepath]
493

494 495
        ref = params[:sha]

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
496
        commit = user_project.repository.commit ref
497
        not_found! "Commit" unless commit
498

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
499
        tree = Tree.new commit.tree, ref, params[:filepath]
500
        not_found! "File" unless tree.try(:tree)
501

Saito's avatar
Saito committed
502
        content_type tree.mime_type
503 504 505
        present tree.data
      end

Matt Humphrey's avatar
Matt Humphrey committed
506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
      # Get a specific project's keys
      #
      # Example Request:
      #   GET /projects/:id/keys
      get ":id/keys" do
        present user_project.deploy_keys, with: Entities::SSHKey
      end

      # Get single key owned by currently authenticated user
      #
      # Example Request:
      #   GET /projects/:id/keys/:id
      get ":id/keys/:key_id" do
        key = user_project.deploy_keys.find params[:key_id]
        present key, with: Entities::SSHKey
      end

      # Add new ssh key to currently authenticated user
      #
      # Parameters:
      #   key (required) - New SSH Key
      #   title (required) - New SSH Key's title
      # Example Request:
      #   POST /projects/:id/keys
      post ":id/keys" do
        attrs = attributes_for_keys [:title, :key]
        key = user_project.deploy_keys.new attrs
        if key.save
          present key, with: Entities::SSHKey
        else
          not_found!
        end
      end

      # Delete existed ssh key of currently authenticated user
      #
      # Example Request:
      #   DELETE /projects/:id/keys/:id
      delete ":id/keys/:key_id" do
        key = user_project.deploy_keys.find params[:key_id]
        key.delete
      end

549 550 551
    end
  end
end