projects.rb 4.4 KB
Newer Older
N
Nihad Abbasov 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
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
        @projects = current_user.projects
        present @projects, :with => Entities::Project
      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
N
Nihad Abbasov 已提交
23
        present user_project, :with => Entities::Project
N
Nihad Abbasov 已提交
24 25 26 27 28
      end

      # Get a project repository branches
      #
      # Parameters:
N
Nihad Abbasov 已提交
29
      #   id (required) - The ID or code name of a project
N
Nihad Abbasov 已提交
30 31 32
      # Example Request:
      #   GET /projects/:id/repository/branches
      get ":id/repository/branches" do
N
Nihad Abbasov 已提交
33
        present user_project.repo.heads.sort_by(&:name), :with => Entities::RepoObject
N
Nihad Abbasov 已提交
34 35 36 37 38
      end

      # Get a project repository tags
      #
      # Parameters:
N
Nihad Abbasov 已提交
39
      #   id (required) - The ID or code name of a project
N
Nihad Abbasov 已提交
40 41 42
      # Example Request:
      #   GET /projects/:id/repository/tags
      get ":id/repository/tags" do
N
Nihad Abbasov 已提交
43
        present user_project.repo.tags.sort_by(&:name).reverse, :with => Entities::RepoObject
N
Nihad Abbasov 已提交
44
      end
N
Nihad Abbasov 已提交
45 46 47 48

      # Get a project snippet
      #
      # Parameters:
N
Nihad Abbasov 已提交
49
      #   id (required) - The ID or code name of a project
N
Nihad Abbasov 已提交
50 51 52 53
      #   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 已提交
54
        @snippet = user_project.snippets.find(params[:snippet_id])
N
Nihad Abbasov 已提交
55 56 57 58 59 60
        present @snippet, :with => Entities::ProjectSnippet
      end

      # Create a new project snippet
      #
      # Parameters:
N
Nihad Abbasov 已提交
61
      #   id (required) - The ID or code name of a project
N
Nihad Abbasov 已提交
62 63 64 65 66 67 68
      #   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
N
Nihad Abbasov 已提交
69
        @snippet = user_project.snippets.new(
N
Nihad Abbasov 已提交
70 71 72 73 74 75 76 77 78 79 80 81 82 83
          :title      => params[:title],
          :file_name  => params[:file_name],
          :expires_at => params[:lifetime],
          :content    => params[:code]
        )
        @snippet.author = current_user

        if @snippet.save
          present @snippet, :with => Entities::ProjectSnippet
        else
          error!({'message' => '404 Not found'}, 404)
        end
      end

84 85 86
      # Update an existing project snippet
      #
      # Parameters:
N
Nihad Abbasov 已提交
87
      #   id (required) - The ID or code name of a project
88 89 90 91 92 93 94 95
      #   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 已提交
96
        @snippet = user_project.snippets.find(params[:snippet_id])
97 98 99 100 101 102 103 104 105 106 107 108 109 110
        parameters = {
          :title      => (params[:title] || @snippet.title),
          :file_name  => (params[:file_name] || @snippet.file_name),
          :expires_at => (params[:lifetime] || @snippet.expires_at),
          :content    => (params[:code] || @snippet.content)
        }

        if @snippet.update_attributes(parameters)
          present @snippet, :with => Entities::ProjectSnippet
        else
          error!({'message' => '404 Not found'}, 404)
        end
      end

N
Nihad Abbasov 已提交
111 112 113
      # Delete a project snippet
      #
      # Parameters:
N
Nihad Abbasov 已提交
114
      #   id (required) - The ID or code name of a project
N
Nihad Abbasov 已提交
115 116 117 118
      #   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 已提交
119
        @snippet = user_project.snippets.find(params[:snippet_id])
N
Nihad Abbasov 已提交
120 121
        @snippet.destroy
      end
122 123 124 125

      # Get a raw project snippet
      #
      # Parameters:
N
Nihad Abbasov 已提交
126
      #   id (required) - The ID or code name of a project
127 128 129 130
      #   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 已提交
131
        @snippet = user_project.snippets.find(params[:snippet_id])
132 133
        present @snippet.content
      end
N
Nihad Abbasov 已提交
134 135 136
    end
  end
end