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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

117 lines
4.3 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
module API
class ProjectHooks < ::API::Base
2016-12-04 12:11:19 -05:00
include PaginationParams
before { authenticate! }
before { authorize_admin_project }
feature_category :integrations
2016-10-31 09:56:53 -04:00
helpers do
params :project_hook_properties do
requires :url, type: String, desc: "The URL to send the request to"
optional :push_events, type: Boolean, desc: "Trigger hook on push events"
optional :issues_events, type: Boolean, desc: "Trigger hook on issues events"
optional :confidential_issues_events, type: Boolean, desc: "Trigger hook on confidential issues events"
2016-10-31 09:56:53 -04:00
optional :merge_requests_events, type: Boolean, desc: "Trigger hook on merge request events"
optional :tag_push_events, type: Boolean, desc: "Trigger hook on tag push events"
optional :note_events, type: Boolean, desc: "Trigger hook on note(comment) events"
optional :confidential_note_events, type: Boolean, desc: "Trigger hook on confidential note(comment) events"
optional :job_events, type: Boolean, desc: "Trigger hook on job events"
2016-10-31 09:56:53 -04:00
optional :pipeline_events, type: Boolean, desc: "Trigger hook on pipeline events"
2017-01-03 15:07:12 -05:00
optional :wiki_page_events, type: Boolean, desc: "Trigger hook on wiki events"
optional :deployment_events, type: Boolean, desc: "Trigger hook on deployment events"
optional :releases_events, type: Boolean, desc: "Trigger hook on release events"
2016-10-31 09:56:53 -04:00
optional :enable_ssl_verification, type: Boolean, desc: "Do SSL verification when triggering the hook"
optional :token, type: String, desc: "Secret token to validate received payloads; this will not be returned in the response"
optional :push_events_branch_filter, type: String, desc: "Trigger hook on specified branch only"
2016-10-31 09:56:53 -04:00
end
end
2016-10-18 13:27:10 -04:00
params do
requires :id, type: String, desc: 'The ID of a project'
end
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
2016-10-18 13:27:10 -04:00
desc 'Get project hooks' do
success Entities::ProjectHook
end
2016-12-04 12:11:19 -05:00
params do
use :pagination
end
get ":id/hooks" do
present paginate(user_project.hooks), with: Entities::ProjectHook
end
2016-10-18 13:27:10 -04:00
desc 'Get a project hook' do
success Entities::ProjectHook
end
params do
requires :hook_id, type: Integer, desc: 'The ID of a project hook'
end
get ":id/hooks/:hook_id" do
2016-10-18 13:27:10 -04:00
hook = user_project.hooks.find(params[:hook_id])
present hook, with: Entities::ProjectHook
end
2016-10-18 13:27:10 -04:00
desc 'Add hook to project' do
success Entities::ProjectHook
end
params do
2016-10-31 09:56:53 -04:00
use :project_hook_properties
2016-10-18 13:27:10 -04:00
end
post ":id/hooks" do
hook_params = declared_params(include_missing: false)
hook = user_project.hooks.new(hook_params)
2016-10-18 13:27:10 -04:00
if hook.save
present hook, with: Entities::ProjectHook
else
2016-10-18 13:27:10 -04:00
error!("Invalid url given", 422) if hook.errors[:url].present?
error!("Invalid branch filter given", 422) if hook.errors[:push_events_branch_filter].present?
2016-10-18 13:27:10 -04:00
not_found!("Project hook #{hook.errors.messages}")
end
end
2016-10-18 13:27:10 -04:00
desc 'Update an existing project hook' do
success Entities::ProjectHook
end
params do
requires :hook_id, type: Integer, desc: "The ID of the hook to update"
2016-10-31 09:56:53 -04:00
use :project_hook_properties
2016-10-18 13:27:10 -04:00
end
put ":id/hooks/:hook_id" do
2016-11-14 08:44:27 -05:00
hook = user_project.hooks.find(params.delete(:hook_id))
update_params = declared_params(include_missing: false)
2018-07-02 06:43:06 -04:00
if hook.update(update_params)
2016-10-18 13:27:10 -04:00
present hook, with: Entities::ProjectHook
else
2016-10-18 13:27:10 -04:00
error!("Invalid url given", 422) if hook.errors[:url].present?
error!("Invalid branch filter given", 422) if hook.errors[:push_events_branch_filter].present?
2016-10-18 13:27:10 -04:00
not_found!("Project hook #{hook.errors.messages}")
end
end
2016-10-18 13:27:10 -04:00
desc 'Deletes project hook' do
success Entities::ProjectHook
end
params do
requires :hook_id, type: Integer, desc: 'The ID of the hook to delete'
end
delete ":id/hooks/:hook_id" do
2017-02-20 13:18:12 -05:00
hook = user_project.hooks.find(params.delete(:hook_id))
destroy_conditionally!(hook) do
WebHooks::DestroyService.new(current_user).execute(hook)
end
end
end
end
end