2018-09-29 22:34:47 +00:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2013-06-06 09:37:51 +00:00
|
|
|
module API
|
|
|
|
class ProjectSnippets < Grape::API
|
2016-12-04 17:11:19 +00:00
|
|
|
include PaginationParams
|
|
|
|
|
2013-06-06 09:37:51 +00:00
|
|
|
before { authenticate! }
|
2020-03-03 18:08:16 +00:00
|
|
|
before { check_snippets_enabled }
|
2013-06-06 09:37:51 +00:00
|
|
|
|
2016-11-21 14:06:32 +00:00
|
|
|
params do
|
|
|
|
requires :id, type: String, desc: 'The ID of a project'
|
|
|
|
end
|
2018-11-08 12:18:17 +00:00
|
|
|
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
|
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
|
|
|
|
end
|
2016-12-04 17:11:19 +00:00
|
|
|
params do
|
|
|
|
use :pagination
|
|
|
|
end
|
2013-06-06 09:37:51 +00:00
|
|
|
get ":id/snippets" do
|
2016-04-25 04:45:26 +00:00
|
|
|
present paginate(snippets_for_current_user), with: Entities::ProjectSnippet
|
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
|
|
|
|
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])
|
|
|
|
present snippet, with: Entities::ProjectSnippet
|
|
|
|
end
|
|
|
|
|
|
|
|
desc 'Create a new project snippet' do
|
|
|
|
success Entities::ProjectSnippet
|
|
|
|
end
|
|
|
|
params do
|
|
|
|
requires :title, type: String, desc: 'The title of the snippet'
|
|
|
|
requires :file_name, type: String, desc: 'The file name of the snippet'
|
2019-08-27 19:52:27 +00:00
|
|
|
optional :code, type: String, allow_blank: false, desc: 'The content of the snippet (deprecated in favor of "content")'
|
|
|
|
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'
|
2017-03-01 15:16:29 +00:00
|
|
|
requires :visibility, type: String,
|
|
|
|
values: Gitlab::VisibilityLevel.string_values,
|
|
|
|
desc: 'The visibility of the snippet'
|
2019-08-27 19:52:27 +00:00
|
|
|
mutually_exclusive :code, :content
|
2016-11-21 14:06:32 +00:00
|
|
|
end
|
2013-06-06 09:37:51 +00:00
|
|
|
post ":id/snippets" do
|
2020-01-23 12:08:38 +00:00
|
|
|
authorize! :create_snippet, user_project
|
2019-08-27 19:52:27 +00:00
|
|
|
snippet_params = declared_params(include_missing: false).merge(request: request, api: true)
|
|
|
|
snippet_params[:content] = snippet_params.delete(:code) if snippet_params[:code].present?
|
2013-06-06 09:37:51 +00:00
|
|
|
|
2020-01-17 00:09:00 +00:00
|
|
|
service_response = ::Snippets::CreateService.new(user_project, current_user, snippet_params).execute
|
|
|
|
snippet = service_response.payload[:snippet]
|
2013-06-06 09:37:51 +00:00
|
|
|
|
2017-02-14 19:07:11 +00:00
|
|
|
render_spam_error! if snippet.spam?
|
|
|
|
|
2016-11-21 14:06:32 +00:00
|
|
|
if snippet.persisted?
|
|
|
|
present snippet, with: Entities::ProjectSnippet
|
2015-03-11 00:21:09 +00:00
|
|
|
else
|
2016-11-21 14:06:32 +00:00
|
|
|
render_validation_error!(snippet)
|
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
|
|
|
|
end
|
|
|
|
params do
|
|
|
|
requires :snippet_id, type: Integer, desc: 'The ID of a project snippet'
|
|
|
|
optional :title, type: String, desc: 'The title of the snippet'
|
|
|
|
optional :file_name, type: String, desc: 'The file name of the snippet'
|
2019-08-27 19:52:27 +00:00
|
|
|
optional :code, type: String, allow_blank: false, desc: 'The content of the snippet (deprecated in favor of "content")'
|
|
|
|
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'
|
2017-03-01 15:16:29 +00:00
|
|
|
optional :visibility, type: String,
|
|
|
|
values: Gitlab::VisibilityLevel.string_values,
|
|
|
|
desc: 'The visibility of the snippet'
|
2019-08-27 19:52:27 +00:00
|
|
|
at_least_one_of :title, :file_name, :code, :content, :visibility_level
|
|
|
|
mutually_exclusive :code, :content
|
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
|
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
|
|
|
|
2017-03-01 20:23:00 +00:00
|
|
|
snippet_params = declared_params(include_missing: false)
|
2017-02-14 19:07:11 +00:00
|
|
|
.merge(request: request, api: true)
|
|
|
|
|
2016-11-21 14:06:32 +00:00
|
|
|
snippet_params[:content] = snippet_params.delete(:code) if snippet_params[:code].present?
|
2013-06-06 09:37:51 +00:00
|
|
|
|
2020-01-17 00:09:00 +00:00
|
|
|
service_response = ::Snippets::UpdateService.new(user_project, current_user, snippet_params).execute(snippet)
|
|
|
|
snippet = service_response.payload[:snippet]
|
2013-06-06 09:37:51 +00:00
|
|
|
|
2017-02-14 19:07:11 +00:00
|
|
|
render_spam_error! if snippet.spam?
|
|
|
|
|
|
|
|
if snippet.valid?
|
2016-11-21 14:06:32 +00:00
|
|
|
present snippet, with: Entities::ProjectSnippet
|
2015-03-07 19:47:06 +00:00
|
|
|
else
|
2016-11-21 14:06:32 +00:00
|
|
|
render_validation_error!(snippet)
|
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
|
|
|
|
2016-11-21 14:06:32 +00:00
|
|
|
desc 'Delete a project snippet'
|
|
|
|
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
|
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
|
|
|
|
2016-11-21 14:06:32 +00:00
|
|
|
desc 'Get a raw project snippet'
|
|
|
|
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
|
|
|
|
|
|
|
env['api.format'] = :txt
|
2013-06-06 09:37:51 +00:00
|
|
|
content_type 'text/plain'
|
2016-11-21 14:06:32 +00:00
|
|
|
present snippet.content
|
2013-06-06 09:37:51 +00:00
|
|
|
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
|
|
|
|
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
|