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

84 lines
2.4 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
module API
class SystemHooks < ::API::Base
include PaginationParams
feature_category :integrations
before do
2013-03-20 17:46:30 -04:00
authenticate!
authenticated_as_admin!
end
2013-03-20 17:46:30 -04:00
resource :hooks do
2016-10-13 11:52:21 -04:00
desc 'Get the list of system hooks' do
success Entities::Hook
end
params do
use :pagination
end
2013-03-20 17:46:30 -04:00
get do
present paginate(SystemHook.all), with: Entities::Hook
2013-03-20 17:46:30 -04:00
end
2016-10-13 11:52:21 -04:00
desc 'Create a new system hook' do
success Entities::Hook
end
params do
requires :url, type: String, desc: "The URL to send the request to"
optional :token, type: String, desc: 'The token used to validate payloads'
optional :push_events, type: Boolean, desc: "Trigger hook on push events"
optional :tag_push_events, type: Boolean, desc: "Trigger hook on tag push events"
optional :merge_requests_events, type: Boolean, desc: "Trigger hook on tag push events"
optional :repository_update_events, type: Boolean, desc: "Trigger hook on repository update events"
optional :enable_ssl_verification, type: Boolean, desc: "Do SSL verification when triggering the hook"
2016-10-13 11:52:21 -04:00
end
2013-03-20 17:46:30 -04:00
post do
2016-11-14 08:44:27 -05:00
hook = SystemHook.new(declared_params(include_missing: false))
2016-10-13 11:52:21 -04:00
if hook.save
present hook, with: Entities::Hook
2013-03-20 17:46:30 -04:00
else
render_validation_error!(hook)
2013-03-20 17:46:30 -04:00
end
end
2016-10-13 11:52:21 -04:00
desc 'Test a hook'
params do
requires :id, type: Integer, desc: 'The ID of the system hook'
end
post ":id" do
2016-10-13 11:52:21 -04:00
hook = SystemHook.find(params[:id])
2013-03-20 17:46:30 -04:00
data = {
event_name: "project_create",
name: "Ruby",
path: "ruby",
project_id: 1,
owner_name: "Someone",
owner_email: "example@gitlabhq.com"
}
2016-10-13 11:52:21 -04:00
hook.execute(data, 'system_hooks')
2013-03-20 17:46:30 -04:00
data
end
2016-10-13 11:52:21 -04:00
desc 'Delete a hook' do
success Entities::Hook
end
params do
requires :id, type: Integer, desc: 'The ID of the system hook'
end
# rubocop: disable CodeReuse/ActiveRecord
2013-03-20 17:46:30 -04:00
delete ":id" do
2016-10-13 13:32:10 -04:00
hook = SystemHook.find_by(id: params[:id])
not_found!('System hook') unless hook
destroy_conditionally!(hook) do
WebHooks::DestroyService.new(current_user).execute(hook)
end
2013-03-20 17:46:30 -04:00
end
# rubocop: enable CodeReuse/ActiveRecord
2013-03-20 17:46:30 -04:00
end
end
end