2013-05-14 08:33:31 -04:00
|
|
|
module API
|
2013-01-08 16:05:00 -05:00
|
|
|
# groups API
|
|
|
|
class Groups < Grape::API
|
|
|
|
before { authenticate! }
|
|
|
|
|
2013-02-01 09:00:12 -05:00
|
|
|
resource :groups do
|
2013-09-04 11:19:03 -04:00
|
|
|
helpers do
|
|
|
|
def find_group(id)
|
|
|
|
group = Group.find(id)
|
2013-10-07 06:10:01 -04:00
|
|
|
|
|
|
|
if can?(current_user, :read_group, group)
|
2013-09-04 11:19:03 -04:00
|
|
|
group
|
|
|
|
else
|
|
|
|
render_api_error!("403 Forbidden - #{current_user.username} lacks sufficient access to #{group.name}", 403)
|
|
|
|
end
|
|
|
|
end
|
2013-10-07 06:10:01 -04:00
|
|
|
|
2013-09-04 11:19:03 -04:00
|
|
|
def validate_access_level?(level)
|
2013-09-05 10:17:40 -04:00
|
|
|
Gitlab::Access.options_with_owner.values.include? level.to_i
|
2013-09-04 11:19:03 -04:00
|
|
|
end
|
|
|
|
end
|
2013-09-05 10:17:40 -04:00
|
|
|
|
2013-02-01 09:00:12 -05:00
|
|
|
# Get a groups list
|
|
|
|
#
|
|
|
|
# Example Request:
|
|
|
|
# GET /groups
|
|
|
|
get do
|
2014-12-30 04:30:56 -05:00
|
|
|
@groups = if current_user.admin
|
|
|
|
Group.all
|
|
|
|
else
|
|
|
|
current_user.groups
|
|
|
|
end
|
|
|
|
|
|
|
|
@groups = @groups.search(params[:search]) if params[:search].present?
|
|
|
|
@groups = paginate @groups
|
2013-02-01 09:00:12 -05:00
|
|
|
present @groups, with: Entities::Group
|
|
|
|
end
|
|
|
|
|
|
|
|
# Create group. Available only for admin
|
|
|
|
#
|
|
|
|
# Parameters:
|
2013-02-27 06:34:45 -05:00
|
|
|
# name (required) - The name of the group
|
|
|
|
# path (required) - The path of the group
|
2013-02-01 09:00:12 -05:00
|
|
|
# Example Request:
|
|
|
|
# POST /groups
|
|
|
|
post do
|
|
|
|
authenticated_as_admin!
|
2013-02-27 11:50:30 -05:00
|
|
|
required_attributes! [:name, :path]
|
2013-02-27 06:34:45 -05:00
|
|
|
|
2014-12-16 17:03:28 -05:00
|
|
|
attrs = attributes_for_keys [:name, :path, :description]
|
2013-02-01 09:00:12 -05:00
|
|
|
@group = Group.new(attrs)
|
|
|
|
@group.owner = current_user
|
|
|
|
|
|
|
|
if @group.save
|
|
|
|
present @group, with: Entities::Group
|
|
|
|
else
|
2015-01-07 04:46:00 -05:00
|
|
|
render_api_error!("Failed to save group #{@group.errors.messages}", 400)
|
2013-02-01 09:00:12 -05:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# Get a single group, with containing projects
|
|
|
|
#
|
|
|
|
# Parameters:
|
|
|
|
# id (required) - The ID of a group
|
|
|
|
# Example Request:
|
|
|
|
# GET /groups/:id
|
|
|
|
get ":id" do
|
2013-09-04 11:19:03 -04:00
|
|
|
group = find_group(params[:id])
|
|
|
|
present group, with: Entities::GroupDetail
|
2013-02-01 09:00:12 -05:00
|
|
|
end
|
2012-11-14 15:37:52 -05:00
|
|
|
|
2013-10-07 06:10:01 -04:00
|
|
|
# Remove group
|
|
|
|
#
|
|
|
|
# Parameters:
|
|
|
|
# id (required) - The ID of a group
|
|
|
|
# Example Request:
|
|
|
|
# DELETE /groups/:id
|
|
|
|
delete ":id" do
|
|
|
|
group = find_group(params[:id])
|
|
|
|
authorize! :manage_group, group
|
|
|
|
group.destroy
|
|
|
|
end
|
|
|
|
|
2012-11-14 15:37:52 -05:00
|
|
|
# Transfer a project to the Group namespace
|
|
|
|
#
|
|
|
|
# Parameters:
|
|
|
|
# id - group id
|
|
|
|
# project_id - project id
|
|
|
|
# Example Request:
|
|
|
|
# POST /groups/:id/projects/:project_id
|
|
|
|
post ":id/projects/:project_id" do
|
|
|
|
authenticated_as_admin!
|
2014-05-28 12:03:45 -04:00
|
|
|
group = Group.find(params[:id])
|
2012-11-14 15:37:52 -05:00
|
|
|
project = Project.find(params[:project_id])
|
2014-05-28 12:03:45 -04:00
|
|
|
result = ::Projects::TransferService.new(project, current_user, namespace_id: group.id).execute
|
|
|
|
|
|
|
|
if result
|
|
|
|
present group
|
2012-11-14 15:37:52 -05:00
|
|
|
else
|
2015-01-07 04:46:00 -05:00
|
|
|
render_api_error!("Failed to transfer project #{project.errors.messages}", 400)
|
2012-11-14 15:37:52 -05:00
|
|
|
end
|
2013-03-20 17:46:30 -04:00
|
|
|
end
|
2013-02-01 09:00:12 -05:00
|
|
|
end
|
2013-01-08 16:05:00 -05:00
|
|
|
end
|
|
|
|
end
|