debian-mirror-gitlab/lib/api/access_requests.rb

132 lines
4.5 KiB
Ruby
Raw Normal View History

2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2016-09-13 17:45:13 +05:30
module API
2021-01-03 14:25:43 +05:30
class AccessRequests < ::API::Base
2017-08-17 22:00:37 +05:30
include PaginationParams
2016-09-13 17:45:13 +05:30
before { authenticate! }
helpers ::API::Helpers::MembersHelpers
2023-05-27 22:25:52 +05:30
feature_category :system_access
2021-01-29 00:20:46 +05:30
2016-09-13 17:45:13 +05:30
%w[group project].each do |source_type|
2016-11-03 12:29:30 +05:30
params do
2022-11-25 23:54:43 +05:30
requires :id, type: String,
desc: "The ID or URL-encoded path of the #{source_type} owned by the authenticated user"
2016-11-03 12:29:30 +05:30
end
2019-02-15 15:39:39 +05:30
resource source_type.pluralize, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
2016-11-03 12:29:30 +05:30
desc "Gets a list of access requests for a #{source_type}." do
detail 'This feature was introduced in GitLab 8.11.'
success Entities::AccessRequester
2023-01-13 00:05:48 +05:30
tags %w[access_requests]
2016-11-03 12:29:30 +05:30
end
2017-08-17 22:00:37 +05:30
params do
use :pagination
end
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2016-09-13 17:45:13 +05:30
get ":id/access_requests" do
source = find_source(source_type, params[:id])
2016-11-03 12:29:30 +05:30
access_requesters = AccessRequestsFinder.new(source).execute!(current_user)
access_requesters = paginate(access_requesters.includes(:user))
2016-09-13 17:45:13 +05:30
2018-03-17 18:26:18 +05:30
present access_requesters, with: Entities::AccessRequester
2016-09-13 17:45:13 +05:30
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2016-09-13 17:45:13 +05:30
2016-11-03 12:29:30 +05:30
desc "Requests access for the authenticated user to a #{source_type}." do
detail 'This feature was introduced in GitLab 8.11.'
success Entities::AccessRequester
2023-01-13 00:05:48 +05:30
success [
{
code: 200,
model: Entities::AccessRequester,
message: 'successful operation',
examples: {
successfull_response: {
"id" => 1,
"username" => "raymond_smith",
"name" => "Raymond Smith",
"state" => "active",
"created_at" => "2012-10-22T14:13:35Z",
"access_level" => 20
}
}
}
]
tags %w[access_requests]
2016-11-03 12:29:30 +05:30
end
2016-09-13 17:45:13 +05:30
post ":id/access_requests" do
source = find_source(source_type, params[:id])
access_requester = source.request_access(current_user)
if access_requester.persisted?
2018-03-17 18:26:18 +05:30
present access_requester, with: Entities::AccessRequester
2016-09-13 17:45:13 +05:30
else
render_validation_error!(access_requester)
end
end
2016-11-03 12:29:30 +05:30
desc 'Approves an access request for the given user.' do
detail 'This feature was introduced in GitLab 8.11.'
2023-01-13 00:05:48 +05:30
success [
{
code: 200,
model: Entities::AccessRequester,
message: 'successful operation',
examples: {
successfull_response: {
"id" => 1,
"username" => "raymond_smith",
"name" => "Raymond Smith",
"state" => "active",
"created_at" => "2012-10-22T14:13:35Z",
"access_level" => 20
}
}
}
]
tags %w[access_requests]
2016-11-03 12:29:30 +05:30
end
params do
requires :user_id, type: Integer, desc: 'The user ID of the access requester'
2022-11-25 23:54:43 +05:30
optional :access_level, type: Integer, desc: 'A valid access level (defaults: `30`, the Developer role)',
default: 30
2016-11-03 12:29:30 +05:30
end
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2016-09-13 17:45:13 +05:30
put ':id/access_requests/:user_id/approve' do
source = find_source(source_type, params[:id])
2018-03-27 19:54:05 +05:30
access_requester = source.requesters.find_by!(user_id: params[:user_id])
member = ::Members::ApproveAccessRequestService
.new(current_user, declared_params)
.execute(access_requester)
2016-09-13 17:45:13 +05:30
status :created
2018-03-17 18:26:18 +05:30
present member, with: Entities::Member
2016-09-13 17:45:13 +05:30
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2016-09-13 17:45:13 +05:30
2016-11-03 12:29:30 +05:30
desc 'Denies an access request for the given user.' do
detail 'This feature was introduced in GitLab 8.11.'
2023-01-13 00:05:48 +05:30
tags %w[access_requests]
2016-11-03 12:29:30 +05:30
end
params do
requires :user_id, type: Integer, desc: 'The user ID of the access requester'
end
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2016-09-13 17:45:13 +05:30
delete ":id/access_requests/:user_id" do
source = find_source(source_type, params[:id])
2018-03-17 18:26:18 +05:30
member = source.requesters.find_by!(user_id: params[:user_id])
2016-09-13 17:45:13 +05:30
2018-03-17 18:26:18 +05:30
destroy_conditionally!(member) do
2018-03-27 19:54:05 +05:30
::Members::DestroyService.new(current_user).execute(member)
2018-03-17 18:26:18 +05:30
end
2016-09-13 17:45:13 +05:30
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2016-09-13 17:45:13 +05:30
end
end
end
end