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

34 35 36 37 38 39 40 41 42 43
      # Get all projects for admin user
      #
      # Example Request:
      #   GET /projects/all
      get '/all' do
        authenticated_as_admin!
        @projects = paginate Project
        present @projects, with: Entities::Project
      end

N
Nihad Abbasov 已提交
44 45 46
      # Get a single project
      #
      # Parameters:
47
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
48 49 50
      # Example Request:
      #   GET /projects/:id
      get ":id" do
51
        present user_project, with: Entities::Project
N
Nihad Abbasov 已提交
52 53
      end

D
Dmitriy Zaporozhets 已提交
54 55 56 57 58 59 60 61 62 63 64 65 66 67
      # 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

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

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

140 141 142 143 144 145 146 147 148 149
      # Remove project
      #
      # Parameters:
      #   id (required) - The ID of a project
      # Example Request:
      #   DELETE /projects/:id
      delete ":id" do
        authorize! :remove_project, user_project
        user_project.destroy
      end
A
Angus MacArthur 已提交
150

151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
      # 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 已提交
186
      # Get a project team members
M
miks 已提交
187 188
      #
      # Parameters:
189
      #   id (required) - The ID of a project
V
Valeriy Sizov 已提交
190
      #   query         - Query string
M
miks 已提交
191
      # Example Request:
N
Nihad Abbasov 已提交
192 193
      #   GET /projects/:id/members
      get ":id/members" do
V
Valeriy Sizov 已提交
194 195 196 197 198
        if params[:query].present?
          @members = paginate user_project.users.where("username LIKE ?", "%#{params[:query]}%")
        else
          @members = paginate user_project.users
        end
N
Nihad Abbasov 已提交
199
        present @members, with: Entities::ProjectMember, project: user_project
M
miks 已提交
200 201
      end

N
Nihad Abbasov 已提交
202
      # Get a project team members
203 204
      #
      # Parameters:
205
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
206
      #   user_id (required) - The ID of a user
207
      # Example Request:
N
Nihad Abbasov 已提交
208 209 210 211 212 213 214 215 216
      #   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:
217
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
218 219 220 221 222
      #   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 已提交
223
        authorize! :admin_project, user_project
224
        required_attributes! [:user_id, :access_level]
225 226 227 228 229 230 231 232 233 234 235 236

        # 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 已提交
237 238
          present @member, with: Entities::ProjectMember, project: user_project
        else
239
          handle_project_member_errors team_member.errors
N
Nihad Abbasov 已提交
240
        end
241 242
      end

N
Nihad Abbasov 已提交
243
      # Update project team member
M
miks 已提交
244 245
      #
      # Parameters:
246
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
247 248
      #   user_id (required) - The ID of a team member
      #   access_level (required) - Project access level
M
miks 已提交
249
      # Example Request:
N
Nihad Abbasov 已提交
250 251
      #   PUT /projects/:id/members/:user_id
      put ":id/members/:user_id" do
R
randx 已提交
252
        authorize! :admin_project, user_project
253
        required_attributes! [:access_level]
N
Nihad Abbasov 已提交
254

255
        team_member = user_project.users_projects.find_by_user_id(params[:user_id])
256
        not_found!("User can not be found") if team_member.nil?
257 258 259

        if team_member.update_attributes(project_access: params[:access_level])
          @member = team_member.user
N
Nihad Abbasov 已提交
260 261
          present @member, with: Entities::ProjectMember, project: user_project
        else
262
          handle_project_member_errors team_member.errors
N
Nihad Abbasov 已提交
263
        end
M
miks 已提交
264 265
      end

N
Nihad Abbasov 已提交
266
      # Remove a team member from project
M
miks 已提交
267 268
      #
      # Parameters:
269
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
270
      #   user_id (required) - The ID of a team member
M
miks 已提交
271
      # Example Request:
N
Nihad Abbasov 已提交
272 273
      #   DELETE /projects/:id/members/:user_id
      delete ":id/members/:user_id" do
R
randx 已提交
274
        authorize! :admin_project, user_project
275 276 277
        team_member = user_project.users_projects.find_by_user_id(params[:user_id])
        unless team_member.nil?
          team_member.destroy
278
        else
279
          {message: "Access revoked", id: params[:user_id].to_i}
280
        end
M
miks 已提交
281
      end
282 283 284 285 286

      # search for projects current_user has access to
      #
      # Parameters:
      #   query (required) - A string contained in the project name
287 288
      #   per_page (optional) - number of projects to return per page
      #   page (optional) - the page to retrieve
289 290 291 292
      # Example Request:
      #   GET /projects/search/:query
      get "/search/:query" do
        ids = current_user.authorized_projects.map(&:id)
293 294
        projects = Project.where("(id in (?) OR public = true) AND (name LIKE (?))", ids, "%#{params[:query]}%")
        present paginate(projects), with: Entities::Project
295
      end
N
Nihad Abbasov 已提交
296 297 298
    end
  end
end