2018-09-29 22:34:47 +00:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2013-06-06 09:37:51 +00:00
|
|
|
module API
|
2020-10-15 00:08:42 +00:00
|
|
|
class ProjectSnippets < ::API::Base
|
2016-12-04 17:11:19 +00:00
|
|
|
include PaginationParams
|
|
|
|
|
2020-03-03 18:08:16 +00:00
|
|
|
before { check_snippets_enabled }
|
2013-06-06 09:37:51 +00:00
|
|
|
|
2020-10-30 18:08:56 +00:00
|
|
|
feature_category :snippets
|
|
|
|
|
2016-11-21 14:06:32 +00:00
|
|
|
params do
|
2022-11-03 15:11:31 +00:00
|
|
|
requires :id, types: [String, Integer], desc: 'The ID or URL-encoded path of the project'
|
2016-11-21 14:06:32 +00:00
|
|
|
end
|
2018-11-08 12:18:17 +00:00
|
|
|
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
|
2020-04-21 15:21:10 +00:00
|
|
|
helpers Helpers::SnippetsHelpers
|
2022-03-11 03:08:14 +00:00
|
|
|
helpers SpammableActions::CaptchaCheck::RestApiActionsSupport
|
2013-06-06 09:37:51 +00:00
|
|
|
helpers do
|
2020-03-03 18:08:16 +00:00
|
|
|
def check_snippets_enabled
|
|
|
|
forbidden! unless user_project.feature_available?(:snippets, current_user)
|
|
|
|
end
|
|
|
|
|
2013-06-06 09:37:51 +00:00
|
|
|
def handle_project_member_errors(errors)
|
|
|
|
if errors[:project_access].any?
|
|
|
|
error!(errors[:project_access], 422)
|
|
|
|
end
|
2018-01-11 16:34:01 +00:00
|
|
|
|
2013-06-06 09:37:51 +00:00
|
|
|
not_found!
|
|
|
|
end
|
2016-04-25 04:45:26 +00:00
|
|
|
|
|
|
|
def snippets_for_current_user
|
2017-04-28 22:06:27 +00:00
|
|
|
SnippetsFinder.new(current_user, project: user_project).execute
|
2016-04-25 04:45:26 +00:00
|
|
|
end
|
2013-06-06 09:37:51 +00:00
|
|
|
end
|
|
|
|
|
2016-11-21 14:06:32 +00:00
|
|
|
desc 'Get all project snippets' do
|
|
|
|
success Entities::ProjectSnippet
|
2022-11-08 03:10:58 +00:00
|
|
|
failure [
|
|
|
|
{ code: 404, message: 'Not found' }
|
|
|
|
]
|
|
|
|
tags %w[project_snippets]
|
|
|
|
is_array true
|
2016-11-21 14:06:32 +00:00
|
|
|
end
|
2016-12-04 17:11:19 +00:00
|
|
|
params do
|
|
|
|
use :pagination
|
|
|
|
end
|
2022-03-22 18:08:29 +00:00
|
|
|
get ":id/snippets", urgency: :low do
|
2020-10-07 18:08:34 +00:00
|
|
|
authenticate!
|
|
|
|
|
2020-07-01 15:08:45 +00:00
|
|
|
present paginate(snippets_for_current_user), with: Entities::ProjectSnippet, current_user: current_user
|
2013-06-06 09:37:51 +00:00
|
|
|
end
|
|
|
|
|
2016-11-21 14:06:32 +00:00
|
|
|
desc 'Get a single project snippet' do
|
|
|
|
success Entities::ProjectSnippet
|
2022-11-08 03:10:58 +00:00
|
|
|
failure [
|
|
|
|
{ code: 404, message: 'Not found' }
|
|
|
|
]
|
|
|
|
tags %w[project_snippets]
|
2016-11-21 14:06:32 +00:00
|
|
|
end
|
|
|
|
params do
|
|
|
|
requires :snippet_id, type: Integer, desc: 'The ID of a project snippet'
|
|
|
|
end
|
2013-06-06 09:37:51 +00:00
|
|
|
get ":id/snippets/:snippet_id" do
|
2016-11-21 14:06:32 +00:00
|
|
|
snippet = snippets_for_current_user.find(params[:snippet_id])
|
2020-10-07 18:08:34 +00:00
|
|
|
|
|
|
|
not_found!('Snippet') unless snippet
|
|
|
|
|
2020-07-01 15:08:45 +00:00
|
|
|
present snippet, with: Entities::ProjectSnippet, current_user: current_user
|
2016-11-21 14:06:32 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
desc 'Create a new project snippet' do
|
|
|
|
success Entities::ProjectSnippet
|
2022-11-08 03:10:58 +00:00
|
|
|
failure [
|
|
|
|
{ code: 400, message: 'Validation error' },
|
|
|
|
{ code: 404, message: 'Not found' },
|
|
|
|
{ code: 422, message: 'Unprocessable entity' }
|
|
|
|
]
|
|
|
|
tags %w[project_snippets]
|
2016-11-21 14:06:32 +00:00
|
|
|
end
|
|
|
|
params do
|
2020-05-19 12:08:21 +00:00
|
|
|
requires :title, type: String, allow_blank: false, desc: 'The title of the snippet'
|
2017-05-03 15:26:49 +00:00
|
|
|
optional :description, type: String, desc: 'The description of a snippet'
|
2017-03-01 15:16:29 +00:00
|
|
|
requires :visibility, type: String,
|
|
|
|
values: Gitlab::VisibilityLevel.string_values,
|
|
|
|
desc: 'The visibility of the snippet'
|
2020-08-05 15:09:59 +00:00
|
|
|
use :create_file_params
|
2016-11-21 14:06:32 +00:00
|
|
|
end
|
2013-06-06 09:37:51 +00:00
|
|
|
post ":id/snippets" do
|
2020-10-07 18:08:34 +00:00
|
|
|
authenticate!
|
|
|
|
|
2020-01-23 12:08:38 +00:00
|
|
|
authorize! :create_snippet, user_project
|
2020-08-05 15:09:59 +00:00
|
|
|
|
2020-09-02 09:10:23 +00:00
|
|
|
snippet_params = process_create_params(declared_params(include_missing: false))
|
2013-06-06 09:37:51 +00:00
|
|
|
|
2021-06-21 12:07:45 +00:00
|
|
|
spam_params = ::Spam::SpamParams.new_from_request(request: request)
|
|
|
|
service_response = ::Snippets::CreateService.new(project: user_project, current_user: current_user, params: snippet_params, spam_params: spam_params).execute
|
2020-01-17 00:09:00 +00:00
|
|
|
snippet = service_response.payload[:snippet]
|
2013-06-06 09:37:51 +00:00
|
|
|
|
2020-05-18 12:08:08 +00:00
|
|
|
if service_response.success?
|
2020-07-01 15:08:45 +00:00
|
|
|
present snippet, with: Entities::ProjectSnippet, current_user: current_user
|
2015-03-11 00:21:09 +00:00
|
|
|
else
|
2022-03-11 03:08:14 +00:00
|
|
|
with_captcha_check_rest_api(spammable: snippet) do
|
|
|
|
render_api_error!({ error: service_response.message }, service_response.http_status)
|
|
|
|
end
|
2013-06-06 09:37:51 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2016-11-21 14:06:32 +00:00
|
|
|
desc 'Update an existing project snippet' do
|
|
|
|
success Entities::ProjectSnippet
|
2022-11-08 03:10:58 +00:00
|
|
|
failure [
|
|
|
|
{ code: 400, message: 'Validation error' },
|
|
|
|
{ code: 404, message: 'Not found' },
|
|
|
|
{ code: 422, message: 'Unprocessable entity' }
|
|
|
|
]
|
|
|
|
tags %w[project_snippets]
|
2016-11-21 14:06:32 +00:00
|
|
|
end
|
|
|
|
params do
|
|
|
|
requires :snippet_id, type: Integer, desc: 'The ID of a project snippet'
|
2019-08-27 19:52:27 +00:00
|
|
|
optional :content, type: String, allow_blank: false, desc: 'The content of the snippet'
|
2017-05-03 15:26:49 +00:00
|
|
|
optional :description, type: String, desc: 'The description of a snippet'
|
2020-09-08 12:08:41 +00:00
|
|
|
optional :file_name, type: String, desc: 'The file name of the snippet'
|
|
|
|
optional :title, type: String, allow_blank: false, desc: 'The title of the snippet'
|
2017-03-01 15:16:29 +00:00
|
|
|
optional :visibility, type: String,
|
|
|
|
values: Gitlab::VisibilityLevel.string_values,
|
|
|
|
desc: 'The visibility of the snippet'
|
2020-09-08 12:08:41 +00:00
|
|
|
|
|
|
|
use :update_file_params
|
2020-09-09 12:08:22 +00:00
|
|
|
use :minimum_update_params
|
2016-11-21 14:06:32 +00:00
|
|
|
end
|
2018-08-27 15:31:01 +00:00
|
|
|
# rubocop: disable CodeReuse/ActiveRecord
|
2013-06-06 09:37:51 +00:00
|
|
|
put ":id/snippets/:snippet_id" do
|
2020-10-07 18:08:34 +00:00
|
|
|
authenticate!
|
|
|
|
|
2016-11-21 14:06:32 +00:00
|
|
|
snippet = snippets_for_current_user.find_by(id: params.delete(:snippet_id))
|
|
|
|
not_found!('Snippet') unless snippet
|
|
|
|
|
2020-01-23 12:08:38 +00:00
|
|
|
authorize! :update_snippet, snippet
|
2016-11-21 14:06:32 +00:00
|
|
|
|
2020-09-08 12:08:41 +00:00
|
|
|
validate_params_for_multiple_files(snippet)
|
|
|
|
|
|
|
|
snippet_params = process_update_params(declared_params(include_missing: false))
|
2017-02-14 19:07:11 +00:00
|
|
|
|
2021-06-21 12:07:45 +00:00
|
|
|
spam_params = ::Spam::SpamParams.new_from_request(request: request)
|
|
|
|
service_response = ::Snippets::UpdateService.new(project: user_project, current_user: current_user, params: snippet_params, spam_params: spam_params).execute(snippet)
|
2020-01-17 00:09:00 +00:00
|
|
|
snippet = service_response.payload[:snippet]
|
2013-06-06 09:37:51 +00:00
|
|
|
|
2020-05-18 12:08:08 +00:00
|
|
|
if service_response.success?
|
2020-07-01 15:08:45 +00:00
|
|
|
present snippet, with: Entities::ProjectSnippet, current_user: current_user
|
2015-03-07 19:47:06 +00:00
|
|
|
else
|
2022-03-11 03:08:14 +00:00
|
|
|
with_captcha_check_rest_api(spammable: snippet) do
|
|
|
|
render_api_error!({ error: service_response.message }, service_response.http_status)
|
|
|
|
end
|
2013-06-06 09:37:51 +00:00
|
|
|
end
|
|
|
|
end
|
2018-08-27 15:31:01 +00:00
|
|
|
# rubocop: enable CodeReuse/ActiveRecord
|
2013-06-06 09:37:51 +00:00
|
|
|
|
2022-11-08 03:10:58 +00:00
|
|
|
desc 'Delete a project snippet' do
|
|
|
|
success code: 204
|
|
|
|
failure [
|
|
|
|
{ code: 400, message: 'Validation error' },
|
|
|
|
{ code: 404, message: 'Not found' }
|
|
|
|
]
|
|
|
|
tags %w[project_snippets]
|
|
|
|
end
|
2016-11-21 14:06:32 +00:00
|
|
|
params do
|
|
|
|
requires :snippet_id, type: Integer, desc: 'The ID of a project snippet'
|
|
|
|
end
|
2018-08-27 15:31:01 +00:00
|
|
|
# rubocop: disable CodeReuse/ActiveRecord
|
2013-06-06 09:37:51 +00:00
|
|
|
delete ":id/snippets/:snippet_id" do
|
2020-10-07 18:08:34 +00:00
|
|
|
authenticate!
|
|
|
|
|
2016-11-21 14:06:32 +00:00
|
|
|
snippet = snippets_for_current_user.find_by(id: params[:snippet_id])
|
|
|
|
not_found!('Snippet') unless snippet
|
|
|
|
|
2020-01-23 12:08:38 +00:00
|
|
|
authorize! :admin_snippet, snippet
|
2017-03-01 13:35:48 +00:00
|
|
|
|
2020-01-17 00:09:00 +00:00
|
|
|
destroy_conditionally!(snippet) do |snippet|
|
|
|
|
service = ::Snippets::DestroyService.new(current_user, snippet)
|
|
|
|
response = service.execute
|
|
|
|
|
|
|
|
if response.error?
|
|
|
|
render_api_error!({ error: response.message }, response.http_status)
|
|
|
|
end
|
|
|
|
end
|
2013-06-06 09:37:51 +00:00
|
|
|
end
|
2018-08-27 15:31:01 +00:00
|
|
|
# rubocop: enable CodeReuse/ActiveRecord
|
2013-06-06 09:37:51 +00:00
|
|
|
|
2022-11-08 03:10:58 +00:00
|
|
|
desc 'Get a raw project snippet' do
|
|
|
|
success Entities::ProjectSnippet
|
|
|
|
failure [
|
|
|
|
{ code: 404, message: 'Not found' }
|
|
|
|
]
|
|
|
|
tags %w[project_snippets]
|
|
|
|
end
|
2016-11-21 14:06:32 +00:00
|
|
|
params do
|
|
|
|
requires :snippet_id, type: Integer, desc: 'The ID of a project snippet'
|
|
|
|
end
|
2018-08-27 15:31:01 +00:00
|
|
|
# rubocop: disable CodeReuse/ActiveRecord
|
2013-06-06 09:37:51 +00:00
|
|
|
get ":id/snippets/:snippet_id/raw" do
|
2016-11-21 14:06:32 +00:00
|
|
|
snippet = snippets_for_current_user.find_by(id: params[:snippet_id])
|
|
|
|
not_found!('Snippet') unless snippet
|
2013-06-06 13:10:24 +00:00
|
|
|
|
2020-04-21 15:21:10 +00:00
|
|
|
present content_for(snippet)
|
2013-06-06 09:37:51 +00:00
|
|
|
end
|
2020-07-09 12:08:56 +00:00
|
|
|
|
2022-11-08 03:10:58 +00:00
|
|
|
desc 'Get raw project snippet file contents from the repository' do
|
|
|
|
success Entities::ProjectSnippet
|
|
|
|
failure [
|
|
|
|
{ code: 404, message: 'Not found' }
|
|
|
|
]
|
|
|
|
tags %w[project_snippets]
|
|
|
|
end
|
2020-07-09 12:08:56 +00:00
|
|
|
params do
|
|
|
|
use :raw_file_params
|
|
|
|
end
|
|
|
|
get ":id/snippets/:snippet_id/files/:ref/:file_path/raw", requirements: { file_path: API::NO_SLASH_URL_PART_REGEX } do
|
|
|
|
snippet = snippets_for_current_user.find_by(id: params[:snippet_id])
|
|
|
|
not_found!('Snippet') unless snippet&.repo_exists?
|
|
|
|
|
|
|
|
present file_content_for(snippet)
|
|
|
|
end
|
2018-08-27 15:31:01 +00:00
|
|
|
# rubocop: enable CodeReuse/ActiveRecord
|
2017-07-07 13:54:39 +00:00
|
|
|
|
|
|
|
desc 'Get the user agent details for a project snippet' do
|
|
|
|
success Entities::UserAgentDetail
|
2022-11-08 03:10:58 +00:00
|
|
|
failure [
|
|
|
|
{ code: 404, message: 'Not found' }
|
|
|
|
]
|
|
|
|
tags %w[project_snippets]
|
2017-07-07 13:54:39 +00:00
|
|
|
end
|
|
|
|
params do
|
|
|
|
requires :snippet_id, type: Integer, desc: 'The ID of a project snippet'
|
|
|
|
end
|
2018-08-27 15:31:01 +00:00
|
|
|
# rubocop: disable CodeReuse/ActiveRecord
|
2017-07-07 13:54:39 +00:00
|
|
|
get ":id/snippets/:snippet_id/user_agent_detail" do
|
|
|
|
authenticated_as_admin!
|
|
|
|
|
2018-01-17 14:30:07 +00:00
|
|
|
snippet = Snippet.find_by!(id: params[:snippet_id], project_id: params[:id])
|
2017-07-07 13:54:39 +00:00
|
|
|
|
2018-04-18 09:19:40 +00:00
|
|
|
break not_found!('UserAgentDetail') unless snippet.user_agent_detail
|
2017-07-07 13:54:39 +00:00
|
|
|
|
|
|
|
present snippet.user_agent_detail, with: Entities::UserAgentDetail
|
|
|
|
end
|
2018-08-27 15:31:01 +00:00
|
|
|
# rubocop: enable CodeReuse/ActiveRecord
|
2013-06-06 09:37:51 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|