projects.rb 7.0 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

44 45 46 47
      # Create new project
      #
      # Parameters:
      #   name (required) - name for new project
48 49 50 51 52 53
      #   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
54
      #   namespace_id (optional) - defaults to user namespace
55 56 57
      # Example Request
      #   POST /projects
      post do
58
        required_attributes! [:name]
59
        attrs = attributes_for_keys [:name,
60 61 62 63 64
                                    :description,
                                    :default_branch,
                                    :issues_enabled,
                                    :wall_enabled,
                                    :merge_requests_enabled,
65 66
                                    :wiki_enabled,
                                    :namespace_id]
67
        @project = ::Projects::CreateContext.new(current_user, attrs).execute
68 69 70
        if @project.saved?
          present @project, with: Entities::Project
        else
71 72 73
          if @project.errors[:limit_reached].present?
            error!(@project.errors[:limit_reached], 403)
          end
74
          not_found!
75 76 77
        end
      end

A
Angus MacArthur 已提交
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
      # 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


N
Nihad Abbasov 已提交
110
      # Get a project team members
M
miks 已提交
111 112
      #
      # Parameters:
113
      #   id (required) - The ID of a project
V
Valeriy Sizov 已提交
114
      #   query         - Query string
M
miks 已提交
115
      # Example Request:
N
Nihad Abbasov 已提交
116 117
      #   GET /projects/:id/members
      get ":id/members" do
V
Valeriy Sizov 已提交
118 119 120 121 122
        if params[:query].present?
          @members = paginate user_project.users.where("username LIKE ?", "%#{params[:query]}%")
        else
          @members = paginate user_project.users
        end
N
Nihad Abbasov 已提交
123
        present @members, with: Entities::ProjectMember, project: user_project
M
miks 已提交
124 125
      end

N
Nihad Abbasov 已提交
126
      # Get a project team members
127 128
      #
      # Parameters:
129
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
130
      #   user_id (required) - The ID of a user
131
      # Example Request:
N
Nihad Abbasov 已提交
132 133 134 135 136 137 138 139 140
      #   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:
141
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
142 143 144 145 146
      #   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 已提交
147
        authorize! :admin_project, user_project
148
        required_attributes! [:user_id, :access_level]
149 150 151 152 153 154 155 156 157 158 159 160

        # 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 已提交
161 162
          present @member, with: Entities::ProjectMember, project: user_project
        else
163
          handle_project_member_errors team_member.errors
N
Nihad Abbasov 已提交
164
        end
165 166
      end

N
Nihad Abbasov 已提交
167
      # Update project team member
M
miks 已提交
168 169
      #
      # Parameters:
170
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
171 172
      #   user_id (required) - The ID of a team member
      #   access_level (required) - Project access level
M
miks 已提交
173
      # Example Request:
N
Nihad Abbasov 已提交
174 175
      #   PUT /projects/:id/members/:user_id
      put ":id/members/:user_id" do
R
randx 已提交
176
        authorize! :admin_project, user_project
177
        required_attributes! [:access_level]
N
Nihad Abbasov 已提交
178

179
        team_member = user_project.users_projects.find_by_user_id(params[:user_id])
180
        not_found!("User can not be found") if team_member.nil?
181 182 183

        if team_member.update_attributes(project_access: params[:access_level])
          @member = team_member.user
N
Nihad Abbasov 已提交
184 185
          present @member, with: Entities::ProjectMember, project: user_project
        else
186
          handle_project_member_errors team_member.errors
N
Nihad Abbasov 已提交
187
        end
M
miks 已提交
188 189
      end

N
Nihad Abbasov 已提交
190
      # Remove a team member from project
M
miks 已提交
191 192
      #
      # Parameters:
193
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
194
      #   user_id (required) - The ID of a team member
M
miks 已提交
195
      # Example Request:
N
Nihad Abbasov 已提交
196 197
      #   DELETE /projects/:id/members/:user_id
      delete ":id/members/:user_id" do
R
randx 已提交
198
        authorize! :admin_project, user_project
199 200 201
        team_member = user_project.users_projects.find_by_user_id(params[:user_id])
        unless team_member.nil?
          team_member.destroy
202
        else
203
          {message: "Access revoked", id: params[:user_id].to_i}
204
        end
M
miks 已提交
205
      end
N
Nihad Abbasov 已提交
206 207 208
    end
  end
end