projects.rb 10.7 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
      helpers do
        def handle_project_member_errors(errors)
          if errors[:project_access].any?
            error!(errors[:project_access], 422)
          end
          not_found!
        end
14 15 16 17 18 19 20
        
        def map_public_to_visibility_level(attrs)
          publik = attrs.delete(:public)
          publik = [ true, 1, '1', 't', 'T', 'true', 'TRUE', 'on', 'ON' ].include?(publik)
          attrs[:visibility_level] = Gitlab::VisibilityLevel::PUBLIC if !attrs[:visibility_level].present? && publik == true
          attrs
        end
21 22
      end

N
Nihad Abbasov 已提交
23 24 25 26 27
      # Get a projects list for authenticated user
      #
      # Example Request:
      #   GET /projects
      get do
28
        @projects = paginate current_user.authorized_projects
29
        present @projects, with: Entities::Project
N
Nihad Abbasov 已提交
30 31
      end

32 33 34 35 36 37 38 39 40
      # 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

41 42 43 44 45 46 47 48 49 50
      # 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 已提交
51 52 53
      # Get a single project
      #
      # Parameters:
54
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
55 56 57
      # Example Request:
      #   GET /projects/:id
      get ":id" do
58
        present user_project, with: Entities::Project
N
Nihad Abbasov 已提交
59 60
      end

D
Dmitriy Zaporozhets 已提交
61 62 63 64 65 66 67 68 69 70 71 72 73 74
      # 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

75 76 77 78
      # Create new project
      #
      # Parameters:
      #   name (required) - name for new project
79
      #   description (optional) - short project description
80 81 82 83
      #   issues_enabled (optional)
      #   wall_enabled (optional)
      #   merge_requests_enabled (optional)
      #   wiki_enabled (optional)
84
      #   snippets_enabled (optional)
85
      #   namespace_id (optional) - defaults to user namespace
86 87
      #   public (optional) - if true same as setting visibility_level = 20
      #   visibility_level (optional) - 0 by default
88 89 90
      # Example Request
      #   POST /projects
      post do
91
        required_attributes! [:name]
92
        attrs = attributes_for_keys [:name,
93 94 95 96 97 98 99 100
                                     :path,
                                     :description,
                                     :issues_enabled,
                                     :wall_enabled,
                                     :merge_requests_enabled,
                                     :wiki_enabled,
                                     :snippets_enabled,
                                     :namespace_id,
101
                                     :public,
102 103
                                     :visibility_level,
                                     :import_url]
104
        attrs = map_public_to_visibility_level(attrs)
105
        @project = ::Projects::CreateContext.new(current_user, attrs).execute
106 107 108
        if @project.saved?
          present @project, with: Entities::Project
        else
109 110 111
          if @project.errors[:limit_reached].present?
            error!(@project.errors[:limit_reached], 403)
          end
112
          not_found!
113 114 115
        end
      end

A
Angus MacArthur 已提交
116 117 118 119 120 121 122
      # 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
123 124 125
      #   issues_enabled (optional)
      #   wall_enabled (optional)
      #   merge_requests_enabled (optional)
126 127
      #   wiki_enabled (optional)
      #   snippets_enabled (optional)
128 129
      #   public (optional) - if true same as setting visibility_level = 20
      #   visibility_level (optional)
A
Angus MacArthur 已提交
130 131 132 133 134 135
      # 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,
136 137 138 139 140 141 142
                                     :description,
                                     :default_branch,
                                     :issues_enabled,
                                     :wall_enabled,
                                     :merge_requests_enabled,
                                     :wiki_enabled,
                                     :snippets_enabled,
143 144 145
                                     :public,
                                     :visibility_level]
        attrs = map_public_to_visibility_level(attrs)
A
Angus MacArthur 已提交
146 147 148 149 150 151 152 153
        @project = ::Projects::CreateContext.new(user, attrs).execute
        if @project.saved?
          present @project, with: Entities::Project
        else
          not_found!
        end
      end

154 155 156 157 158 159 160 161 162 163
      # 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 已提交
164

165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
      # 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 已提交
200
      # Get a project team members
M
miks 已提交
201 202
      #
      # Parameters:
203
      #   id (required) - The ID of a project
V
Valeriy Sizov 已提交
204
      #   query         - Query string
M
miks 已提交
205
      # Example Request:
N
Nihad Abbasov 已提交
206 207
      #   GET /projects/:id/members
      get ":id/members" do
V
Valeriy Sizov 已提交
208 209 210 211 212
        if params[:query].present?
          @members = paginate user_project.users.where("username LIKE ?", "%#{params[:query]}%")
        else
          @members = paginate user_project.users
        end
N
Nihad Abbasov 已提交
213
        present @members, with: Entities::ProjectMember, project: user_project
M
miks 已提交
214 215
      end

N
Nihad Abbasov 已提交
216
      # Get a project team members
217 218
      #
      # Parameters:
219
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
220
      #   user_id (required) - The ID of a user
221
      # Example Request:
N
Nihad Abbasov 已提交
222 223 224 225 226 227 228 229 230
      #   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:
231
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
232 233 234 235 236
      #   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 已提交
237
        authorize! :admin_project, user_project
238
        required_attributes! [:user_id, :access_level]
239 240 241 242 243 244 245 246 247 248 249 250

        # 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 已提交
251 252
          present @member, with: Entities::ProjectMember, project: user_project
        else
253
          handle_project_member_errors team_member.errors
N
Nihad Abbasov 已提交
254
        end
255 256
      end

N
Nihad Abbasov 已提交
257
      # Update project team member
M
miks 已提交
258 259
      #
      # Parameters:
260
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
261 262
      #   user_id (required) - The ID of a team member
      #   access_level (required) - Project access level
M
miks 已提交
263
      # Example Request:
N
Nihad Abbasov 已提交
264 265
      #   PUT /projects/:id/members/:user_id
      put ":id/members/:user_id" do
R
randx 已提交
266
        authorize! :admin_project, user_project
267
        required_attributes! [:access_level]
N
Nihad Abbasov 已提交
268

269
        team_member = user_project.users_projects.find_by_user_id(params[:user_id])
270
        not_found!("User can not be found") if team_member.nil?
271 272 273

        if team_member.update_attributes(project_access: params[:access_level])
          @member = team_member.user
N
Nihad Abbasov 已提交
274 275
          present @member, with: Entities::ProjectMember, project: user_project
        else
276
          handle_project_member_errors team_member.errors
N
Nihad Abbasov 已提交
277
        end
M
miks 已提交
278 279
      end

N
Nihad Abbasov 已提交
280
      # Remove a team member from project
M
miks 已提交
281 282
      #
      # Parameters:
283
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
284
      #   user_id (required) - The ID of a team member
M
miks 已提交
285
      # Example Request:
N
Nihad Abbasov 已提交
286 287
      #   DELETE /projects/:id/members/:user_id
      delete ":id/members/:user_id" do
R
randx 已提交
288
        authorize! :admin_project, user_project
289 290 291
        team_member = user_project.users_projects.find_by_user_id(params[:user_id])
        unless team_member.nil?
          team_member.destroy
292
        else
293
          {message: "Access revoked", id: params[:user_id].to_i}
294
        end
M
miks 已提交
295
      end
296 297 298 299 300

      # search for projects current_user has access to
      #
      # Parameters:
      #   query (required) - A string contained in the project name
301 302
      #   per_page (optional) - number of projects to return per page
      #   page (optional) - the page to retrieve
303 304 305 306
      # Example Request:
      #   GET /projects/search/:query
      get "/search/:query" do
        ids = current_user.authorized_projects.map(&:id)
307 308
        visibility_levels = [ Gitlab::VisibilityLevel::INTERNAL, Gitlab::VisibilityLevel::PUBLIC ]
        projects = Project.where("(id in (?) OR visibility_level in (?)) AND (name LIKE (?))", ids, visibility_levels, "%#{params[:query]}%")
309
        present paginate(projects), with: Entities::Project
310
      end
N
Nihad Abbasov 已提交
311 312 313
    end
  end
end