gitlab-org--gitlab-foss/lib/api/project_snippets.rb

165 lines
5.7 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
module API
class ProjectSnippets < Grape::API
2016-12-04 12:11:19 -05:00
include PaginationParams
before { authenticate! }
2016-11-21 09:06:32 -05:00
params do
requires :id, type: String, desc: 'The ID of a project'
end
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
helpers do
def handle_project_member_errors(errors)
if errors[:project_access].any?
error!(errors[:project_access], 422)
end
not_found!
end
def snippets_for_current_user
SnippetsFinder.new(current_user, project: user_project).execute
end
end
2016-11-21 09:06:32 -05:00
desc 'Get all project snippets' do
success Entities::ProjectSnippet
end
2016-12-04 12:11:19 -05:00
params do
use :pagination
end
get ":id/snippets" do
present paginate(snippets_for_current_user), with: Entities::ProjectSnippet
end
2016-11-21 09:06:32 -05: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
get ":id/snippets/:snippet_id" do
2016-11-21 09:06:32 -05: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'
requires :code, type: String, allow_blank: false, desc: 'The content of the snippet'
2017-05-03 11:26:49 -04:00
optional :description, type: String, desc: 'The description of a snippet'
requires :visibility, type: String,
values: Gitlab::VisibilityLevel.string_values,
desc: 'The visibility of the snippet'
2016-11-21 09:06:32 -05:00
end
post ":id/snippets" do
authorize! :create_project_snippet, user_project
snippet_params = declared_params.merge(request: request, api: true)
2016-11-21 09:06:32 -05:00
snippet_params[:content] = snippet_params.delete(:code)
2016-11-21 09:06:32 -05:00
snippet = CreateSnippetService.new(user_project, current_user, snippet_params).execute
2017-02-14 14:07:11 -05:00
render_spam_error! if snippet.spam?
2016-11-21 09:06:32 -05:00
if snippet.persisted?
present snippet, with: Entities::ProjectSnippet
else
2016-11-21 09:06:32 -05:00
render_validation_error!(snippet)
end
end
2016-11-21 09:06:32 -05: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'
optional :code, type: String, allow_blank: false, desc: 'The content of the snippet'
2017-05-03 11:26:49 -04:00
optional :description, type: String, desc: 'The description of a snippet'
optional :visibility, type: String,
values: Gitlab::VisibilityLevel.string_values,
desc: 'The visibility of the snippet'
2016-11-21 09:06:32 -05:00
at_least_one_of :title, :file_name, :code, :visibility_level
end
# rubocop: disable CodeReuse/ActiveRecord
put ":id/snippets/:snippet_id" do
2016-11-21 09:06:32 -05:00
snippet = snippets_for_current_user.find_by(id: params.delete(:snippet_id))
not_found!('Snippet') unless snippet
authorize! :update_project_snippet, snippet
snippet_params = declared_params(include_missing: false)
2017-02-14 14:07:11 -05:00
.merge(request: request, api: true)
2016-11-21 09:06:32 -05:00
snippet_params[:content] = snippet_params.delete(:code) if snippet_params[:code].present?
2016-11-21 09:06:32 -05:00
UpdateSnippetService.new(user_project, current_user, snippet,
snippet_params).execute
2017-02-14 14:07:11 -05:00
render_spam_error! if snippet.spam?
if snippet.valid?
2016-11-21 09:06:32 -05:00
present snippet, with: Entities::ProjectSnippet
else
2016-11-21 09:06:32 -05:00
render_validation_error!(snippet)
end
end
# rubocop: enable CodeReuse/ActiveRecord
2016-11-21 09:06:32 -05:00
desc 'Delete a project snippet'
params do
requires :snippet_id, type: Integer, desc: 'The ID of a project snippet'
end
# rubocop: disable CodeReuse/ActiveRecord
delete ":id/snippets/:snippet_id" do
2016-11-21 09:06:32 -05:00
snippet = snippets_for_current_user.find_by(id: params[:snippet_id])
not_found!('Snippet') unless snippet
authorize! :admin_project_snippet, snippet
2017-03-02 07:14:13 -05:00
destroy_conditionally!(snippet)
end
# rubocop: enable CodeReuse/ActiveRecord
2016-11-21 09:06:32 -05:00
desc 'Get a raw project snippet'
params do
requires :snippet_id, type: Integer, desc: 'The ID of a project snippet'
end
# rubocop: disable CodeReuse/ActiveRecord
get ":id/snippets/:snippet_id/raw" do
2016-11-21 09:06:32 -05:00
snippet = snippets_for_current_user.find_by(id: params[:snippet_id])
not_found!('Snippet') unless snippet
2013-06-06 09:10:24 -04:00
env['api.format'] = :txt
content_type 'text/plain'
2016-11-21 09:06:32 -05:00
present snippet.content
end
# rubocop: enable CodeReuse/ActiveRecord
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
# rubocop: disable CodeReuse/ActiveRecord
get ":id/snippets/:snippet_id/user_agent_detail" do
authenticated_as_admin!
snippet = Snippet.find_by!(id: params[:snippet_id], project_id: params[:id])
break not_found!('UserAgentDetail') unless snippet.user_agent_detail
present snippet.user_agent_detail, with: Entities::UserAgentDetail
end
# rubocop: enable CodeReuse/ActiveRecord
end
end
end