projects.rb 8.8 KB
Newer Older
1
module API
N
Nihad Abbasov 已提交
2 3 4 5 6
  # 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
      end

25 26 27 28 29 30 31 32 33
      # Get an owned projects list for authenticated user
      #
      # Example Request:
      #   GET /projects/owned
      get '/owned' do
        @projects = paginate current_user.owned_projects
        present @projects, with: Entities::Project
      end

N
Nihad Abbasov 已提交
34 35 36
      # Get a single project
      #
      # Parameters:
37
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
38 39 40
      # Example Request:
      #   GET /projects/:id
      get ":id" do
41
        present user_project, with: Entities::Project
N
Nihad Abbasov 已提交
42 43
      end

D
Dmitriy Zaporozhets 已提交
44 45 46 47 48 49 50 51 52 53 54 55 56 57
      # Get a single project events
      #
      # Parameters:
      #   id (required) - The ID of a project
      # Example Request:
      #   GET /projects/:id
      get ":id/events" do
        limit = (params[:per_page] || 20).to_i
        offset = (params[:page] || 0).to_i * limit
        events = user_project.events.recent.limit(limit).offset(offset)

        present events, with: Entities::Event
      end

58 59 60 61
      # Create new project
      #
      # Parameters:
      #   name (required) - name for new project
62 63
      #   description (optional) - short project description
      #   default_branch (optional) - 'master' by default
64 65 66 67
      #   issues_enabled (optional)
      #   wall_enabled (optional)
      #   merge_requests_enabled (optional)
      #   wiki_enabled (optional)
68
      #   snippets_enabled (optional)
69
      #   namespace_id (optional) - defaults to user namespace
70
      #   public (optional) - false by default
71 72 73
      # Example Request
      #   POST /projects
      post do
74
        required_attributes! [:name]
75
        attrs = attributes_for_keys [:name,
76
                                    :path,
77 78 79 80 81
                                    :description,
                                    :default_branch,
                                    :issues_enabled,
                                    :wall_enabled,
                                    :merge_requests_enabled,
82
                                    :wiki_enabled,
83
                                    :snippets_enabled,
84 85
                                    :namespace_id,
                                    :public]
86
        @project = ::Projects::CreateContext.new(current_user, attrs).execute
87 88 89
        if @project.saved?
          present @project, with: Entities::Project
        else
90 91 92
          if @project.errors[:limit_reached].present?
            error!(@project.errors[:limit_reached], 403)
          end
93
          not_found!
94 95 96
        end
      end

A
Angus MacArthur 已提交
97 98 99 100 101 102 103
      # 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
104 105 106
      #   issues_enabled (optional)
      #   wall_enabled (optional)
      #   merge_requests_enabled (optional)
107 108
      #   wiki_enabled (optional)
      #   snippets_enabled (optional)
109
      #   public (optional)
A
Angus MacArthur 已提交
110 111 112 113 114 115 116 117 118 119 120
      # 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,
121
                                    :wiki_enabled,
122 123
                                    :snippets_enabled,
                                    :public]
A
Angus MacArthur 已提交
124 125 126 127 128 129 130 131 132
        @project = ::Projects::CreateContext.new(user, attrs).execute
        if @project.saved?
          present @project, with: Entities::Project
        else
          not_found!
        end
      end


133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
      # Mark this project as forked from another
      #
      # Parameters:
      #   id: (required) - The ID of the project being marked as a fork
      #   forked_from_id: (required) - The ID of the project it was forked from
      # Example Request:
      #   POST /projects/:id/fork/:forked_from_id
      post ":id/fork/:forked_from_id" do
        authenticated_as_admin!
        forked_from_project = find_project(params[:forked_from_id])
        unless forked_from_project.nil?
          if user_project.forked_from_project.nil?
            user_project.create_forked_project_link(forked_to_project_id: user_project.id, forked_from_project_id: forked_from_project.id)
          else
            render_api_error!("Project already forked", 409)
          end
        else
          not_found!
        end

      end

      # Remove a forked_from relationship
      #
      # Parameters:
      # id: (required) - The ID of the project being marked as a fork
      # Example Request:
      #  DELETE /projects/:id/fork
      delete ":id/fork" do
        authenticated_as_admin!
        unless user_project.forked_project_link.nil?
          user_project.forked_project_link.destroy
        end
      end


N
Nihad Abbasov 已提交
169
      # Get a project team members
M
miks 已提交
170 171
      #
      # Parameters:
172
      #   id (required) - The ID of a project
V
Valeriy Sizov 已提交
173
      #   query         - Query string
M
miks 已提交
174
      # Example Request:
N
Nihad Abbasov 已提交
175 176
      #   GET /projects/:id/members
      get ":id/members" do
V
Valeriy Sizov 已提交
177 178 179 180 181
        if params[:query].present?
          @members = paginate user_project.users.where("username LIKE ?", "%#{params[:query]}%")
        else
          @members = paginate user_project.users
        end
N
Nihad Abbasov 已提交
182
        present @members, with: Entities::ProjectMember, project: user_project
M
miks 已提交
183 184
      end

N
Nihad Abbasov 已提交
185
      # Get a project team members
186 187
      #
      # Parameters:
188
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
189
      #   user_id (required) - The ID of a user
190
      # Example Request:
N
Nihad Abbasov 已提交
191 192 193 194 195 196 197 198 199
      #   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:
200
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
201 202 203 204 205
      #   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 已提交
206
        authorize! :admin_project, user_project
207
        required_attributes! [:user_id, :access_level]
208 209 210 211 212 213 214 215 216 217 218 219

        # 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 已提交
220 221
          present @member, with: Entities::ProjectMember, project: user_project
        else
222
          handle_project_member_errors team_member.errors
N
Nihad Abbasov 已提交
223
        end
224 225
      end

N
Nihad Abbasov 已提交
226
      # Update project team member
M
miks 已提交
227 228
      #
      # Parameters:
229
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
230 231
      #   user_id (required) - The ID of a team member
      #   access_level (required) - Project access level
M
miks 已提交
232
      # Example Request:
N
Nihad Abbasov 已提交
233 234
      #   PUT /projects/:id/members/:user_id
      put ":id/members/:user_id" do
R
randx 已提交
235
        authorize! :admin_project, user_project
236
        required_attributes! [:access_level]
N
Nihad Abbasov 已提交
237

238
        team_member = user_project.users_projects.find_by_user_id(params[:user_id])
239
        not_found!("User can not be found") if team_member.nil?
240 241 242

        if team_member.update_attributes(project_access: params[:access_level])
          @member = team_member.user
N
Nihad Abbasov 已提交
243 244
          present @member, with: Entities::ProjectMember, project: user_project
        else
245
          handle_project_member_errors team_member.errors
N
Nihad Abbasov 已提交
246
        end
M
miks 已提交
247 248
      end

N
Nihad Abbasov 已提交
249
      # Remove a team member from project
M
miks 已提交
250 251
      #
      # Parameters:
252
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
253
      #   user_id (required) - The ID of a team member
M
miks 已提交
254
      # Example Request:
N
Nihad Abbasov 已提交
255 256
      #   DELETE /projects/:id/members/:user_id
      delete ":id/members/:user_id" do
R
randx 已提交
257
        authorize! :admin_project, user_project
258 259 260
        team_member = user_project.users_projects.find_by_user_id(params[:user_id])
        unless team_member.nil?
          team_member.destroy
261
        else
262
          {message: "Access revoked", id: params[:user_id].to_i}
263
        end
M
miks 已提交
264
      end
N
Nihad Abbasov 已提交
265 266 267
    end
  end
end