projects.rb 15.6 KB
Newer Older
N
Nihad Abbasov 已提交
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

N
Nihad Abbasov 已提交
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
N
Nihad Abbasov 已提交
23 24 25 26 27
      end

      # Get a single project
      #
      # Parameters:
28
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
29 30 31
      # Example Request:
      #   GET /projects/:id
      get ":id" do
32
        present user_project, with: Entities::Project
N
Nihad Abbasov 已提交
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 46 47
      # Example Request
      #   POST /projects
      post do
48
        bad_request!(:name) if !params.has_key? :name
49
        attrs = attributes_for_keys [:name,
50 51 52 53 54
                                    :description,
                                    :default_branch,
                                    :issues_enabled,
                                    :wall_enabled,
                                    :merge_requests_enabled,
A
Alex Denisov 已提交
55
                                    :wiki_enabled]
56

57
        @project = ::Projects::CreateContext.new(current_user, attrs).execute
58 59 60
        if @project.saved?
          present @project, with: Entities::Project
        else
61 62 63
          if @project.errors[:limit_reached].present?
            error!(@project.errors[:limit_reached], 403)
          end
64
          not_found!
65 66 67
        end
      end

N
Nihad Abbasov 已提交
68
      # Get a project team members
M
miks 已提交
69 70
      #
      # Parameters:
71
      #   id (required) - The ID of a project
V
Valeriy Sizov 已提交
72
      #   query         - Query string
M
miks 已提交
73
      # Example Request:
N
Nihad Abbasov 已提交
74 75
      #   GET /projects/:id/members
      get ":id/members" do
V
Valeriy Sizov 已提交
76 77 78 79 80
        if params[:query].present?
          @members = paginate user_project.users.where("username LIKE ?", "%#{params[:query]}%")
        else
          @members = paginate user_project.users
        end
N
Nihad Abbasov 已提交
81
        present @members, with: Entities::ProjectMember, project: user_project
M
miks 已提交
82 83
      end

N
Nihad Abbasov 已提交
84
      # Get a project team members
85 86
      #
      # Parameters:
87
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
88
      #   user_id (required) - The ID of a user
89
      # Example Request:
N
Nihad Abbasov 已提交
90 91 92 93 94 95 96 97 98
      #   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:
99
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
100 101 102 103 104
      #   user_id (required) - The ID of a user
      #   access_level (required) - Project access level
      # Example Request:
      #   POST /projects/:id/members
      post ":id/members" do
R
randx 已提交
105
        authorize! :admin_project, user_project
N
Nihad Abbasov 已提交
106

107 108
        bad_request!(:user_id) if !params.has_key? :user_id
        bad_request!(:access_level) if !params.has_key? :access_level
109 110 111 112 113 114 115 116 117 118 119 120

        # 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
N
Nihad Abbasov 已提交
121 122
          present @member, with: Entities::ProjectMember, project: user_project
        else
123
          handle_project_member_errors team_member.errors
N
Nihad Abbasov 已提交
124
        end
125 126
      end

N
Nihad Abbasov 已提交
127
      # Update project team member
M
miks 已提交
128 129
      #
      # Parameters:
130
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
131 132
      #   user_id (required) - The ID of a team member
      #   access_level (required) - Project access level
M
miks 已提交
133
      # Example Request:
N
Nihad Abbasov 已提交
134 135
      #   PUT /projects/:id/members/:user_id
      put ":id/members/:user_id" do
R
randx 已提交
136
        authorize! :admin_project, user_project
N
Nihad Abbasov 已提交
137

138
        team_member = user_project.users_projects.find_by_user_id(params[:user_id])
139 140
        bad_request!(:access_level) if !params.has_key? :access_level
        not_found!("User can not be found") if team_member.nil?
141 142 143

        if team_member.update_attributes(project_access: params[:access_level])
          @member = team_member.user
N
Nihad Abbasov 已提交
144 145
          present @member, with: Entities::ProjectMember, project: user_project
        else
146
          handle_project_member_errors team_member.errors
N
Nihad Abbasov 已提交
147
        end
M
miks 已提交
148 149
      end

N
Nihad Abbasov 已提交
150
      # Remove a team member from project
M
miks 已提交
151 152
      #
      # Parameters:
153
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
154
      #   user_id (required) - The ID of a team member
M
miks 已提交
155
      # Example Request:
N
Nihad Abbasov 已提交
156 157
      #   DELETE /projects/:id/members/:user_id
      delete ":id/members/:user_id" do
R
randx 已提交
158
        authorize! :admin_project, user_project
159 160 161
        team_member = user_project.users_projects.find_by_user_id(params[:user_id])
        unless team_member.nil?
          team_member.destroy
162 163 164
        else
          {:message => "Access revoked", :id => params[:user_id].to_i}
        end
M
miks 已提交
165 166
      end

M
miks 已提交
167 168 169
      # Get project hooks
      #
      # Parameters:
170
      #   id (required) - The ID of a project
M
miks 已提交
171 172 173
      # Example Request:
      #   GET /projects/:id/hooks
      get ":id/hooks" do
M
miks 已提交
174
        authorize! :admin_project, user_project
M
miks 已提交
175 176 177
        @hooks = paginate user_project.hooks
        present @hooks, with: Entities::Hook
      end
S
Saito 已提交
178

J
jozefvaclavik 已提交
179 180 181
      # Get a project hook
      #
      # Parameters:
182
      #   id (required) - The ID of a project
J
jozefvaclavik 已提交
183 184 185 186
      #   hook_id (required) - The ID of a project hook
      # Example Request:
      #   GET /projects/:id/hooks/:hook_id
      get ":id/hooks/:hook_id" do
187
        authorize! :admin_project, user_project
J
jozefvaclavik 已提交
188 189 190
        @hook = user_project.hooks.find(params[:hook_id])
        present @hook, with: Entities::Hook
      end
S
Saito 已提交
191

M
miks 已提交
192 193 194 195

      # Add hook to project
      #
      # Parameters:
196
      #   id (required) - The ID of a project
M
miks 已提交
197 198 199 200
      #   url (required) - The hook URL
      # Example Request:
      #   POST /projects/:id/hooks
      post ":id/hooks" do
M
miks 已提交
201
        authorize! :admin_project, user_project
202

203
        bad_request!(:url) unless params.has_key? :url
204

M
miks 已提交
205 206 207 208
        @hook = user_project.hooks.new({"url" => params[:url]})
        if @hook.save
          present @hook, with: Entities::Hook
        else
209 210 211
          if @hook.errors[:url].present?
            error!("Invalid url given", 422)
          end
212
          not_found!
M
miks 已提交
213 214
        end
      end
S
Saito 已提交
215

J
jozefvaclavik 已提交
216 217 218
      # Update an existing project hook
      #
      # Parameters:
219
      #   id (required) - The ID of a project
J
jozefvaclavik 已提交
220 221 222 223 224 225 226 227
      #   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

228
        bad_request!(:url) unless params.has_key? :url
J
jozefvaclavik 已提交
229

230
        attrs = attributes_for_keys [:url]
J
jozefvaclavik 已提交
231 232 233
        if @hook.update_attributes attrs
          present @hook, with: Entities::Hook
        else
234 235 236
          if @hook.errors[:url].present?
            error!("Invalid url given", 422)
          end
J
jozefvaclavik 已提交
237 238 239
          not_found!
        end
      end
M
miks 已提交
240 241 242 243

      # Delete project hook
      #
      # Parameters:
244
      #   id (required) - The ID of a project
M
miks 已提交
245 246
      #   hook_id (required) - The ID of hook to delete
      # Example Request:
247 248
      #   DELETE /projects/:id/hooks/:hook_id
      delete ":id/hooks/:hook_id" do
M
miks 已提交
249
        authorize! :admin_project, user_project
250
        bad_request!(:hook_id) unless params.has_key? :hook_id
251 252 253 254 255 256

        begin
          @hook = ProjectHook.find(params[:hook_id])
          @hook.destroy
        rescue
        end
M
miks 已提交
257 258
      end

N
Nihad Abbasov 已提交
259 260 261
      # Get a project repository branches
      #
      # Parameters:
262
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
263 264 265
      # Example Request:
      #   GET /projects/:id/repository/branches
      get ":id/repository/branches" do
266
        present user_project.repo.heads.sort_by(&:name), with: Entities::RepoObject, project: user_project
N
Nihad Abbasov 已提交
267 268
      end

269 270 271
      # Get a single branch
      #
      # Parameters:
272
      #   id (required) - The ID of a project
273
      #   branch (required) - The name of the branch
274
      # Example Request:
275 276 277
      #   GET /projects/:id/repository/branches/:branch
      get ":id/repository/branches/:branch" do
        @branch = user_project.repo.heads.find { |item| item.name == params[:branch] }
278
        not_found!("Branch does not exist") if @branch.nil?
279 280 281 282 283 284 285 286 287 288 289 290
        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] }
291
        not_found! unless @branch
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
        protected = user_project.protected_branches.find_by_name(@branch.name)

        unless protected
          user_project.protected_branches.create(:name => @branch.name)
        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] }
310
        not_found! unless @branch
311 312 313 314 315 316 317
        protected = user_project.protected_branches.find_by_name(@branch.name)

        if protected
          protected.destroy
        end

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

N
Nihad Abbasov 已提交
320 321 322
      # Get a project repository tags
      #
      # Parameters:
323
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
324 325 326
      # Example Request:
      #   GET /projects/:id/repository/tags
      get ":id/repository/tags" do
327
        present user_project.repo.tags.sort_by(&:name).reverse, with: Entities::RepoObject
N
Nihad Abbasov 已提交
328
      end
N
Nihad Abbasov 已提交
329

330 331 332
      # Get a project repository commits
      #
      # Parameters:
333
      #   id (required) - The ID of a project
334 335 336 337 338 339 340 341 342 343
      #   ref_name (optional) - The name of a repository branch or tag
      # Example Request:
      #   GET /projects/:id/repository/commits
      get ":id/repository/commits" do
        authorize! :download_code, user_project

        page = params[:page] || 0
        per_page = params[:per_page] || 20
        ref = params[:ref_name] || user_project.try(:default_branch) || 'master'

D
Dmitriy Zaporozhets 已提交
344
        commits = user_project.repository.commits(ref, nil, per_page, page * per_page)
345 346 347
        present CommitDecorator.decorate(commits), with: Entities::RepoCommit
      end

N
Nihad Abbasov 已提交
348 349 350
      # Get a project snippets
      #
      # Parameters:
351
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
352 353 354 355 356 357
      # Example Request:
      #   GET /projects/:id/snippets
      get ":id/snippets" do
        present paginate(user_project.snippets), with: Entities::ProjectSnippet
      end

N
Nihad Abbasov 已提交
358 359 360
      # Get a project snippet
      #
      # Parameters:
361
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
362 363 364 365
      #   snippet_id (required) - The ID of a project snippet
      # Example Request:
      #   GET /projects/:id/snippets/:snippet_id
      get ":id/snippets/:snippet_id" do
N
Nihad Abbasov 已提交
366
        @snippet = user_project.snippets.find(params[:snippet_id])
367
        present @snippet, with: Entities::ProjectSnippet
N
Nihad Abbasov 已提交
368 369 370 371 372
      end

      # Create a new project snippet
      #
      # Parameters:
373
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
374 375 376 377 378 379 380
      #   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
381 382
        authorize! :write_snippet, user_project

383 384 385
        bad_request!(:title) if !params[:title].present?
        bad_request!(:file_name) if !params[:file_name].present?
        bad_request!(:code) if !params[:code].present?
386

A
Alex Denisov 已提交
387
        attrs = attributes_for_keys [:title, :file_name]
A
Alex Denisov 已提交
388 389 390
        attrs[:expires_at] = params[:lifetime] if params[:lifetime].present?
        attrs[:content] = params[:code] if params[:code].present?
        @snippet = user_project.snippets.new attrs
N
Nihad Abbasov 已提交
391 392 393
        @snippet.author = current_user

        if @snippet.save
394
          present @snippet, with: Entities::ProjectSnippet
N
Nihad Abbasov 已提交
395
        else
396
          not_found!
N
Nihad Abbasov 已提交
397 398 399
        end
      end

400 401 402
      # Update an existing project snippet
      #
      # Parameters:
403
      #   id (required) - The ID of a project
404 405 406 407 408 409 410 411
      #   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
N
Nihad Abbasov 已提交
412
        @snippet = user_project.snippets.find(params[:snippet_id])
R
randx 已提交
413 414
        authorize! :modify_snippet, @snippet

A
Alex Denisov 已提交
415
        attrs = attributes_for_keys [:title, :file_name]
A
Alex Denisov 已提交
416 417
        attrs[:expires_at] = params[:lifetime] if params[:lifetime].present?
        attrs[:content] = params[:code] if params[:code].present?
418

A
Alex Denisov 已提交
419
        if @snippet.update_attributes attrs
420
          present @snippet, with: Entities::ProjectSnippet
421
        else
422
          not_found!
423 424 425
        end
      end

N
Nihad Abbasov 已提交
426 427 428
      # Delete a project snippet
      #
      # Parameters:
429
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
430 431 432 433
      #   snippet_id (required) - The ID of a project snippet
      # Example Request:
      #   DELETE /projects/:id/snippets/:snippet_id
      delete ":id/snippets/:snippet_id" do
434 435 436 437 438 439
        begin
          @snippet = user_project.snippets.find(params[:snippet_id])
          authorize! :modify_snippet, user_project
          @snippet.destroy
        rescue
        end
N
Nihad Abbasov 已提交
440
      end
441 442 443 444

      # Get a raw project snippet
      #
      # Parameters:
445
      #   id (required) - The ID of a project
446 447 448 449
      #   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
N
Nihad Abbasov 已提交
450
        @snippet = user_project.snippets.find(params[:snippet_id])
451
        content_type 'text/plain'
452 453
        present @snippet.content
      end
454 455 456 457

      # Get a raw file contents
      #
      # Parameters:
458
      #   id (required) - The ID of a project
459
      #   sha (required) - The commit or branch name
460 461 462 463
      #   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
464 465
        authorize! :download_code, user_project

466
        bad_request!(:filepath) if !params.has_key? :filepath
467

468 469
        ref = params[:sha]

D
Dmitriy Zaporozhets 已提交
470
        commit = user_project.repository.commit ref
471
        not_found! "Commit" unless commit
472

D
Dmitriy Zaporozhets 已提交
473
        tree = Tree.new commit.tree, ref, params[:filepath]
474
        not_found! "File" unless tree.try(:tree)
475

S
Saito 已提交
476
        content_type tree.mime_type
477 478 479
        present tree.data
      end

N
Nihad Abbasov 已提交
480 481 482
    end
  end
end