projects.rb 13.0 KB
Newer Older
N
Nihad Abbasov 已提交
1 2 3 4 5 6 7 8 9 10 11
module Gitlab
  # Projects API
  class Projects < Grape::API
    before { authenticate! }

    resource :projects do
      # Get a projects list for authenticated user
      #
      # Example Request:
      #   GET /projects
      get do
N
Nihad Abbasov 已提交
12
        @projects = paginate current_user.projects
13
        present @projects, with: Entities::Project
N
Nihad Abbasov 已提交
14 15 16 17 18
      end

      # Get a single project
      #
      # Parameters:
N
Nihad Abbasov 已提交
19
      #   id (required) - The ID or code name of a project
N
Nihad Abbasov 已提交
20 21 22
      # Example Request:
      #   GET /projects/:id
      get ":id" do
23
        present user_project, with: Entities::Project
N
Nihad Abbasov 已提交
24 25
      end

26 27 28 29
      # Create new project
      #
      # Parameters:
      #   name (required) - name for new project
A
Alex Denisov 已提交
30 31
      #   code (optional) - code for new project, uses project name if not set
      #   path (optional) - path for new project, uses project name if not set
32 33 34 35 36 37
      #   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
38 39 40
      # Example Request
      #   POST /projects
      post do
A
Alex Denisov 已提交
41 42
        params[:code] ||= params[:name]
        params[:path] ||= params[:name]
43 44 45 46 47 48 49 50
        attrs = attributes_for_keys [:code,
                                    :path,
                                    :name,
                                    :description,
                                    :default_branch,
                                    :issues_enabled,
                                    :wall_enabled,
                                    :merge_requests_enabled,
A
Alex Denisov 已提交
51 52
                                    :wiki_enabled]
        @project = Project.create_by_user(attrs, current_user)
53 54 55
        if @project.saved?
          present @project, with: Entities::Project
        else
56
          not_found!
57 58 59
        end
      end

N
Nihad Abbasov 已提交
60
      # Get a project team members
M
miks 已提交
61 62 63 64
      #
      # Parameters:
      #   id (required) - The ID or code name of a project
      # Example Request:
N
Nihad Abbasov 已提交
65 66 67 68
      #   GET /projects/:id/members
      get ":id/members" do
        @members = paginate user_project.users
        present @members, with: Entities::ProjectMember, project: user_project
M
miks 已提交
69 70
      end

N
Nihad Abbasov 已提交
71
      # Get a project team members
72 73 74
      #
      # Parameters:
      #   id (required) - The ID or code name of a project
N
Nihad Abbasov 已提交
75
      #   user_id (required) - The ID of a user
76
      # Example Request:
N
Nihad Abbasov 已提交
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
      #   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:
      #   id (required) - The ID or code name of a project
      #   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 已提交
92
        authorize! :admin_project, user_project
N
Nihad Abbasov 已提交
93 94 95 96 97 98 99 100 101 102 103
        users_project = user_project.users_projects.new(
          user_id: params[:user_id],
          project_access: params[:access_level]
        )

        if users_project.save
          @member = users_project.user
          present @member, with: Entities::ProjectMember, project: user_project
        else
          not_found!
        end
104 105
      end

N
Nihad Abbasov 已提交
106
      # Update project team member
M
miks 已提交
107 108 109
      #
      # Parameters:
      #   id (required) - The ID or code name of a project
N
Nihad Abbasov 已提交
110 111
      #   user_id (required) - The ID of a team member
      #   access_level (required) - Project access level
M
miks 已提交
112
      # Example Request:
N
Nihad Abbasov 已提交
113 114
      #   PUT /projects/:id/members/:user_id
      put ":id/members/:user_id" do
R
randx 已提交
115
        authorize! :admin_project, user_project
N
Nihad Abbasov 已提交
116 117 118 119 120 121 122 123
        users_project = user_project.users_projects.find_by_user_id params[:user_id]

        if users_project.update_attributes(project_access: params[:access_level])
          @member = users_project.user
          present @member, with: Entities::ProjectMember, project: user_project
        else
          not_found!
        end
M
miks 已提交
124 125
      end

N
Nihad Abbasov 已提交
126
      # Remove a team member from project
M
miks 已提交
127 128 129
      #
      # Parameters:
      #   id (required) - The ID or code name of a project
N
Nihad Abbasov 已提交
130
      #   user_id (required) - The ID of a team member
M
miks 已提交
131
      # Example Request:
N
Nihad Abbasov 已提交
132 133
      #   DELETE /projects/:id/members/:user_id
      delete ":id/members/:user_id" do
R
randx 已提交
134
        authorize! :admin_project, user_project
N
Nihad Abbasov 已提交
135 136
        users_project = user_project.users_projects.find_by_user_id params[:user_id]
        users_project.destroy
M
miks 已提交
137 138
      end

M
miks 已提交
139 140 141 142 143 144 145
      # Get project hooks
      #
      # Parameters:
      #   id (required) - The ID or code name of a project
      # Example Request:
      #   GET /projects/:id/hooks
      get ":id/hooks" do
M
miks 已提交
146
        authorize! :admin_project, user_project
M
miks 已提交
147 148 149
        @hooks = paginate user_project.hooks
        present @hooks, with: Entities::Hook
      end
J
jozefvaclavik 已提交
150 151 152 153 154 155 156 157 158 159 160 161 162
      
      # Get a project hook
      #
      # Parameters:
      #   id (required) - The ID or code name of a project
      #   hook_id (required) - The ID of a project hook
      # Example Request:
      #   GET /projects/:id/hooks/:hook_id
      get ":id/hooks/:hook_id" do
        @hook = user_project.hooks.find(params[:hook_id])
        present @hook, with: Entities::Hook
      end
      
M
miks 已提交
163 164 165 166 167 168 169 170 171

      # Add hook to project
      #
      # Parameters:
      #   id (required) - The ID or code name of a project
      #   url (required) - The hook URL
      # Example Request:
      #   POST /projects/:id/hooks
      post ":id/hooks" do
M
miks 已提交
172
        authorize! :admin_project, user_project
M
miks 已提交
173 174 175 176 177 178 179
        @hook = user_project.hooks.new({"url" => params[:url]})
        if @hook.save
          present @hook, with: Entities::Hook
        else
          error!({'message' => '404 Not found'}, 404)
        end
      end
J
jozefvaclavik 已提交
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
      
      # Update an existing project hook
      #
      # Parameters:
      #   id (required) - The ID or code name of a project
      #   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

        attrs = attributes_for_keys [:url]

        if @hook.update_attributes attrs
          present @hook, with: Entities::Hook
        else
          not_found!
        end
      end
M
miks 已提交
201 202 203 204 205 206 207 208 209

      # Delete project hook
      #
      # Parameters:
      #   id (required) - The ID or code name of a project
      #   hook_id (required) - The ID of hook to delete
      # Example Request:
      #   DELETE /projects/:id/hooks
      delete ":id/hooks" do
M
miks 已提交
210
        authorize! :admin_project, user_project
M
miks 已提交
211 212 213 214
        @hook = user_project.hooks.find(params[:hook_id])
        @hook.destroy
      end

N
Nihad Abbasov 已提交
215 216 217
      # Get a project repository branches
      #
      # Parameters:
N
Nihad Abbasov 已提交
218
      #   id (required) - The ID or code name of a project
N
Nihad Abbasov 已提交
219 220 221
      # Example Request:
      #   GET /projects/:id/repository/branches
      get ":id/repository/branches" do
222
        present user_project.repo.heads.sort_by(&:name), with: Entities::RepoObject
N
Nihad Abbasov 已提交
223 224
      end

225 226 227 228
      # Get a single branch
      #
      # Parameters:
      #   id (required) - The ID or code name of a project
229
      #   branch (required) - The name of the branch
230
      # Example Request:
231 232 233
      #   GET /projects/:id/repository/branches/:branch
      get ":id/repository/branches/:branch" do
        @branch = user_project.repo.heads.find { |item| item.name == params[:branch] }
234
        present @branch, with: Entities::RepoObject
235 236
      end

N
Nihad Abbasov 已提交
237 238 239
      # Get a project repository tags
      #
      # Parameters:
N
Nihad Abbasov 已提交
240
      #   id (required) - The ID or code name of a project
N
Nihad Abbasov 已提交
241 242 243
      # Example Request:
      #   GET /projects/:id/repository/tags
      get ":id/repository/tags" do
244
        present user_project.repo.tags.sort_by(&:name).reverse, with: Entities::RepoObject
N
Nihad Abbasov 已提交
245
      end
N
Nihad Abbasov 已提交
246

247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
      # Get a project repository commits
      #
      # Parameters:
      #   id (required) - The ID or code name of a project
      #   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'

        commits = user_project.commits(ref, nil, per_page, page * per_page)
        present CommitDecorator.decorate(commits), with: Entities::RepoCommit
      end

N
Nihad Abbasov 已提交
265 266 267 268 269 270 271 272 273 274
      # Get a project snippets
      #
      # Parameters:
      #   id (required) - The ID or code name of a project
      # Example Request:
      #   GET /projects/:id/snippets
      get ":id/snippets" do
        present paginate(user_project.snippets), with: Entities::ProjectSnippet
      end

N
Nihad Abbasov 已提交
275 276 277
      # Get a project snippet
      #
      # Parameters:
N
Nihad Abbasov 已提交
278
      #   id (required) - The ID or code name of a project
N
Nihad Abbasov 已提交
279 280 281 282
      #   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 已提交
283
        @snippet = user_project.snippets.find(params[:snippet_id])
284
        present @snippet, with: Entities::ProjectSnippet
N
Nihad Abbasov 已提交
285 286 287 288 289
      end

      # Create a new project snippet
      #
      # Parameters:
N
Nihad Abbasov 已提交
290
      #   id (required) - The ID or code name of a project
N
Nihad Abbasov 已提交
291 292 293 294 295 296 297
      #   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
298 299
        authorize! :write_snippet, user_project

A
Alex Denisov 已提交
300
        attrs = attributes_for_keys [:title, :file_name]
A
Alex Denisov 已提交
301 302 303
        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 已提交
304 305 306
        @snippet.author = current_user

        if @snippet.save
307
          present @snippet, with: Entities::ProjectSnippet
N
Nihad Abbasov 已提交
308
        else
309
          not_found!
N
Nihad Abbasov 已提交
310 311 312
        end
      end

313 314 315
      # Update an existing project snippet
      #
      # Parameters:
N
Nihad Abbasov 已提交
316
      #   id (required) - The ID or code name of a project
317 318 319 320 321 322 323 324
      #   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 已提交
325
        @snippet = user_project.snippets.find(params[:snippet_id])
R
randx 已提交
326 327
        authorize! :modify_snippet, @snippet

A
Alex Denisov 已提交
328
        attrs = attributes_for_keys [:title, :file_name]
A
Alex Denisov 已提交
329 330
        attrs[:expires_at] = params[:lifetime] if params[:lifetime].present?
        attrs[:content] = params[:code] if params[:code].present?
331

A
Alex Denisov 已提交
332
        if @snippet.update_attributes attrs
333
          present @snippet, with: Entities::ProjectSnippet
334
        else
335
          not_found!
336 337 338
        end
      end

N
Nihad Abbasov 已提交
339 340 341
      # Delete a project snippet
      #
      # Parameters:
N
Nihad Abbasov 已提交
342
      #   id (required) - The ID or code name of a project
N
Nihad Abbasov 已提交
343 344 345 346
      #   snippet_id (required) - The ID of a project snippet
      # Example Request:
      #   DELETE /projects/:id/snippets/:snippet_id
      delete ":id/snippets/:snippet_id" do
N
Nihad Abbasov 已提交
347
        @snippet = user_project.snippets.find(params[:snippet_id])
R
randx 已提交
348 349
        authorize! :modify_snippet, @snippet

N
Nihad Abbasov 已提交
350 351
        @snippet.destroy
      end
352 353 354 355

      # Get a raw project snippet
      #
      # Parameters:
N
Nihad Abbasov 已提交
356
      #   id (required) - The ID or code name of a project
357 358 359 360
      #   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 已提交
361
        @snippet = user_project.snippets.find(params[:snippet_id])
362
        content_type 'text/plain'
363 364
        present @snippet.content
      end
365 366 367 368 369

      # Get a raw file contents
      #
      # Parameters:
      #   id (required) - The ID or code name of a project
370
      #   sha (required) - The commit or branch name
371 372 373 374
      #   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
375 376
        authorize! :download_code, user_project

377 378 379
        ref = params[:sha]

        commit = user_project.commit ref
380
        not_found! "Commit" unless commit
381

382
        tree = Tree.new commit.tree, user_project, ref, params[:filepath]
383
        not_found! "File" unless tree.try(:tree)
384

385 386 387 388 389 390 391 392 393 394
        if tree.text?
          encoding = Gitlab::Encode.detect_encoding(tree.data)
          content_type encoding ? "text/plain; charset=#{encoding}" : "text/plain"
        else
          content_type tree.mime_type
        end

        present tree.data
      end

N
Nihad Abbasov 已提交
395 396 397
    end
  end
end