2018-09-29 18:34:47 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2016-11-26 10:37:26 -05:00
|
|
|
module API
|
|
|
|
# Snippets API
|
2020-10-14 20:08:42 -04:00
|
|
|
class Snippets < ::API::Base
|
2016-11-26 10:37:26 -05:00
|
|
|
include PaginationParams
|
|
|
|
|
2020-10-30 14:08:56 -04:00
|
|
|
feature_category :snippets
|
|
|
|
|
2016-11-26 10:37:26 -05:00
|
|
|
resource :snippets do
|
2020-04-21 11:21:10 -04:00
|
|
|
helpers Helpers::SnippetsHelpers
|
2016-11-26 10:37:26 -05:00
|
|
|
helpers do
|
|
|
|
def snippets_for_current_user
|
2017-04-28 18:06:27 -04:00
|
|
|
SnippetsFinder.new(current_user, author: current_user).execute
|
2016-11-26 10:37:26 -05:00
|
|
|
end
|
|
|
|
|
|
|
|
def public_snippets
|
2019-11-22 01:06:20 -05:00
|
|
|
Snippet.only_personal_snippets.are_public.fresh
|
2016-11-26 10:37:26 -05:00
|
|
|
end
|
2019-03-05 11:12:27 -05:00
|
|
|
|
|
|
|
def snippets
|
|
|
|
SnippetsFinder.new(current_user).execute
|
|
|
|
end
|
2016-11-26 10:37:26 -05:00
|
|
|
end
|
|
|
|
|
2020-10-06 05:08:32 -04:00
|
|
|
desc 'Get a snippets list for an authenticated user' do
|
2016-11-26 10:37:26 -05:00
|
|
|
detail 'This feature was introduced in GitLab 8.15.'
|
2020-04-21 11:21:10 -04:00
|
|
|
success Entities::Snippet
|
2016-11-26 10:37:26 -05:00
|
|
|
end
|
|
|
|
params do
|
|
|
|
use :pagination
|
|
|
|
end
|
|
|
|
get do
|
2020-10-06 05:08:32 -04:00
|
|
|
authenticate!
|
|
|
|
|
2020-07-01 11:08:45 -04:00
|
|
|
present paginate(snippets_for_current_user), with: Entities::Snippet, current_user: current_user
|
2016-11-26 10:37:26 -05:00
|
|
|
end
|
|
|
|
|
2019-11-22 01:06:20 -05:00
|
|
|
desc 'List all public personal snippets current_user has access to' do
|
2016-11-26 10:37:26 -05:00
|
|
|
detail 'This feature was introduced in GitLab 8.15.'
|
|
|
|
success Entities::PersonalSnippet
|
|
|
|
end
|
|
|
|
params do
|
|
|
|
use :pagination
|
|
|
|
end
|
|
|
|
get 'public' do
|
2020-10-06 05:08:32 -04:00
|
|
|
authenticate!
|
|
|
|
|
2020-07-01 11:08:45 -04:00
|
|
|
present paginate(public_snippets), with: Entities::PersonalSnippet, current_user: current_user
|
2016-11-26 10:37:26 -05:00
|
|
|
end
|
|
|
|
|
|
|
|
desc 'Get a single snippet' do
|
|
|
|
detail 'This feature was introduced in GitLab 8.15.'
|
|
|
|
success Entities::PersonalSnippet
|
|
|
|
end
|
|
|
|
params do
|
|
|
|
requires :id, type: Integer, desc: 'The ID of a snippet'
|
|
|
|
end
|
|
|
|
get ':id' do
|
2019-03-05 11:12:27 -05:00
|
|
|
snippet = snippets.find_by_id(params[:id])
|
|
|
|
|
|
|
|
break not_found!('Snippet') unless snippet
|
|
|
|
|
2020-07-01 11:08:45 -04:00
|
|
|
present snippet, with: Entities::PersonalSnippet, current_user: current_user
|
2016-11-26 10:37:26 -05:00
|
|
|
end
|
|
|
|
|
|
|
|
desc 'Create new snippet' do
|
|
|
|
detail 'This feature was introduced in GitLab 8.15.'
|
|
|
|
success Entities::PersonalSnippet
|
|
|
|
end
|
|
|
|
params do
|
2020-05-19 08:08:21 -04:00
|
|
|
requires :title, type: String, allow_blank: false, desc: 'The title of a snippet'
|
2017-05-03 11:26:49 -04:00
|
|
|
optional :description, type: String, desc: 'The description of a snippet'
|
2017-02-16 10:42:17 -05:00
|
|
|
optional :visibility, type: String,
|
|
|
|
values: Gitlab::VisibilityLevel.string_values,
|
|
|
|
default: 'internal',
|
|
|
|
desc: 'The visibility of the snippet'
|
2020-08-03 08:09:47 -04:00
|
|
|
use :create_file_params
|
2016-11-26 10:37:26 -05:00
|
|
|
end
|
|
|
|
post do
|
2020-10-06 05:08:32 -04:00
|
|
|
authenticate!
|
|
|
|
|
2020-03-26 14:08:03 -04:00
|
|
|
authorize! :create_snippet
|
|
|
|
|
2020-09-02 05:10:23 -04:00
|
|
|
attrs = process_create_params(declared_params(include_missing: false))
|
2020-08-03 08:09:47 -04:00
|
|
|
|
2021-06-21 08:07:45 -04:00
|
|
|
spam_params = ::Spam::SpamParams.new_from_request(request: request)
|
|
|
|
service_response = ::Snippets::CreateService.new(project: nil, current_user: current_user, params: attrs, spam_params: spam_params).execute
|
2020-01-16 19:09:00 -05:00
|
|
|
snippet = service_response.payload[:snippet]
|
2016-11-26 10:37:26 -05:00
|
|
|
|
2020-05-18 08:08:08 -04:00
|
|
|
if service_response.success?
|
2020-07-01 11:08:45 -04:00
|
|
|
present snippet, with: Entities::PersonalSnippet, current_user: current_user
|
2016-11-26 10:37:26 -05:00
|
|
|
else
|
2020-05-18 08:08:08 -04:00
|
|
|
render_spam_error! if snippet.spam?
|
|
|
|
|
|
|
|
render_api_error!({ error: service_response.message }, service_response.http_status)
|
2016-11-26 10:37:26 -05:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
desc 'Update an existing snippet' do
|
|
|
|
detail 'This feature was introduced in GitLab 8.15.'
|
|
|
|
success Entities::PersonalSnippet
|
|
|
|
end
|
2020-09-02 05:10:23 -04:00
|
|
|
|
2016-11-26 10:37:26 -05:00
|
|
|
params do
|
|
|
|
requires :id, type: Integer, desc: 'The ID of a snippet'
|
2020-05-19 08:08:21 -04:00
|
|
|
optional :content, type: String, allow_blank: false, desc: 'The content of a snippet'
|
2017-05-03 11:26:49 -04:00
|
|
|
optional :description, type: String, desc: 'The description of a snippet'
|
2020-09-02 05:10:23 -04:00
|
|
|
optional :file_name, type: String, desc: 'The name of a snippet file'
|
|
|
|
optional :title, type: String, allow_blank: false, desc: 'The title of a snippet'
|
2017-02-16 10:42:17 -05:00
|
|
|
optional :visibility, type: String,
|
|
|
|
values: Gitlab::VisibilityLevel.string_values,
|
|
|
|
desc: 'The visibility of the snippet'
|
2020-09-02 05:10:23 -04:00
|
|
|
|
|
|
|
use :update_file_params
|
2020-09-09 08:08:22 -04:00
|
|
|
use :minimum_update_params
|
2016-11-26 10:37:26 -05:00
|
|
|
end
|
|
|
|
put ':id' do
|
2020-10-06 05:08:32 -04:00
|
|
|
authenticate!
|
|
|
|
|
2019-03-05 11:12:27 -05:00
|
|
|
snippet = snippets_for_current_user.find_by_id(params.delete(:id))
|
2018-04-18 05:19:40 -04:00
|
|
|
break not_found!('Snippet') unless snippet
|
2017-11-14 04:02:39 -05:00
|
|
|
|
2020-01-23 07:08:38 -05:00
|
|
|
authorize! :update_snippet, snippet
|
2016-11-26 10:37:26 -05:00
|
|
|
|
2020-09-02 05:10:23 -04:00
|
|
|
validate_params_for_multiple_files(snippet)
|
|
|
|
|
|
|
|
attrs = process_update_params(declared_params(include_missing: false))
|
|
|
|
|
2021-06-21 08:07:45 -04:00
|
|
|
spam_params = ::Spam::SpamParams.new_from_request(request: request)
|
|
|
|
service_response = ::Snippets::UpdateService.new(project: nil, current_user: current_user, params: attrs, spam_params: spam_params).execute(snippet)
|
2020-09-02 05:10:23 -04:00
|
|
|
|
2020-01-16 19:09:00 -05:00
|
|
|
snippet = service_response.payload[:snippet]
|
2017-02-14 14:07:11 -05:00
|
|
|
|
2020-05-18 08:08:08 -04:00
|
|
|
if service_response.success?
|
2020-07-01 11:08:45 -04:00
|
|
|
present snippet, with: Entities::PersonalSnippet, current_user: current_user
|
2016-11-26 10:37:26 -05:00
|
|
|
else
|
2020-05-18 08:08:08 -04:00
|
|
|
render_spam_error! if snippet.spam?
|
|
|
|
|
|
|
|
render_api_error!({ error: service_response.message }, service_response.http_status)
|
2016-11-26 10:37:26 -05:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
desc 'Remove snippet' do
|
|
|
|
detail 'This feature was introduced in GitLab 8.15.'
|
|
|
|
success Entities::PersonalSnippet
|
|
|
|
end
|
|
|
|
params do
|
|
|
|
requires :id, type: Integer, desc: 'The ID of a snippet'
|
|
|
|
end
|
|
|
|
delete ':id' do
|
2020-10-06 05:08:32 -04:00
|
|
|
authenticate!
|
|
|
|
|
2019-03-05 11:12:27 -05:00
|
|
|
snippet = snippets_for_current_user.find_by_id(params.delete(:id))
|
2018-04-18 05:19:40 -04:00
|
|
|
break not_found!('Snippet') unless snippet
|
2017-02-20 13:18:12 -05:00
|
|
|
|
2020-01-23 07:08:38 -05:00
|
|
|
authorize! :admin_snippet, snippet
|
2017-02-20 13:18:12 -05:00
|
|
|
|
2020-01-16 19:09:00 -05: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
|
2016-11-26 10:37:26 -05:00
|
|
|
end
|
|
|
|
|
|
|
|
desc 'Get a raw snippet' do
|
|
|
|
detail 'This feature was introduced in GitLab 8.15.'
|
|
|
|
end
|
|
|
|
params do
|
|
|
|
requires :id, type: Integer, desc: 'The ID of a snippet'
|
|
|
|
end
|
|
|
|
get ":id/raw" do
|
2019-03-05 11:12:27 -05:00
|
|
|
snippet = snippets.find_by_id(params.delete(:id))
|
2020-07-09 08:08:56 -04:00
|
|
|
not_found!('Snippet') unless snippet
|
2016-11-26 10:37:26 -05:00
|
|
|
|
2020-04-21 11:21:10 -04:00
|
|
|
present content_for(snippet)
|
2016-11-26 10:37:26 -05:00
|
|
|
end
|
2017-07-05 10:27:32 -04:00
|
|
|
|
2020-07-09 08:08:56 -04:00
|
|
|
desc 'Get raw snippet file contents from the repository'
|
|
|
|
params do
|
|
|
|
use :raw_file_params
|
|
|
|
end
|
|
|
|
get ":id/files/:ref/:file_path/raw", requirements: { file_path: API::NO_SLASH_URL_PART_REGEX } do
|
|
|
|
snippet = snippets.find_by_id(params.delete(:id))
|
|
|
|
not_found!('Snippet') unless snippet&.repo_exists?
|
|
|
|
|
|
|
|
present file_content_for(snippet)
|
|
|
|
end
|
|
|
|
|
2017-07-05 10:27:32 -04:00
|
|
|
desc 'Get the user agent details for a snippet' do
|
|
|
|
success Entities::UserAgentDetail
|
|
|
|
end
|
|
|
|
params do
|
|
|
|
requires :id, type: Integer, desc: 'The ID of a snippet'
|
|
|
|
end
|
|
|
|
get ":id/user_agent_detail" do
|
|
|
|
authenticated_as_admin!
|
|
|
|
|
2019-03-05 11:12:27 -05:00
|
|
|
snippet = Snippet.find_by_id!(params[:id])
|
2017-07-05 10:27:32 -04:00
|
|
|
|
2018-04-18 05:19:40 -04:00
|
|
|
break not_found!('UserAgentDetail') unless snippet.user_agent_detail
|
2017-07-05 10:27:32 -04:00
|
|
|
|
|
|
|
present snippet.user_agent_detail, with: Entities::UserAgentDetail
|
|
|
|
end
|
2016-11-26 10:37:26 -05:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|