debian-mirror-gitlab/lib/api/system_hooks.rb

83 lines
2.3 KiB
Ruby
Raw Normal View History

2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2014-09-02 18:07:02 +05:30
module API
2021-01-03 14:25:43 +05:30
class SystemHooks < ::API::Base
2017-08-17 22:00:37 +05:30
include PaginationParams
2021-01-29 00:20:46 +05:30
feature_category :integrations
2015-04-26 12:48:37 +05:30
before do
2014-09-02 18:07:02 +05:30
authenticate!
authenticated_as_admin!
2015-04-26 12:48:37 +05:30
end
2014-09-02 18:07:02 +05:30
resource :hooks do
2016-11-03 12:29:30 +05:30
desc 'Get the list of system hooks' do
success Entities::Hook
end
2017-08-17 22:00:37 +05:30
params do
use :pagination
end
2014-09-02 18:07:02 +05:30
get do
2017-08-17 22:00:37 +05:30
present paginate(SystemHook.all), with: Entities::Hook
2014-09-02 18:07:02 +05:30
end
2016-11-03 12:29:30 +05:30
desc 'Create a new system hook' do
success Entities::Hook
end
params do
2017-08-17 22:00:37 +05:30
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"
2018-03-17 18:26:18 +05:30
optional :merge_requests_events, type: Boolean, desc: "Trigger hook on tag push events"
2017-08-17 22:00:37 +05:30
optional :enable_ssl_verification, type: Boolean, desc: "Do SSL verification when triggering the hook"
2016-11-03 12:29:30 +05:30
end
2014-09-02 18:07:02 +05:30
post do
2017-08-17 22:00:37 +05:30
hook = SystemHook.new(declared_params(include_missing: false))
2016-11-03 12:29:30 +05:30
if hook.save
present hook, with: Entities::Hook
2014-09-02 18:07:02 +05:30
else
2017-08-17 22:00:37 +05:30
render_validation_error!(hook)
2014-09-02 18:07:02 +05:30
end
end
2016-11-03 12:29:30 +05:30
desc 'Test a hook'
params do
requires :id, type: Integer, desc: 'The ID of the system hook'
end
2014-09-02 18:07:02 +05:30
get ":id" do
2016-11-03 12:29:30 +05:30
hook = SystemHook.find(params[:id])
2014-09-02 18:07:02 +05:30
data = {
event_name: "project_create",
name: "Ruby",
path: "ruby",
project_id: 1,
owner_name: "Someone",
owner_email: "example@gitlabhq.com"
}
2016-11-03 12:29:30 +05:30
hook.execute(data, 'system_hooks')
2014-09-02 18:07:02 +05:30
data
end
2016-11-03 12:29:30 +05:30
desc 'Delete a hook' do
success Entities::Hook
end
params do
requires :id, type: Integer, desc: 'The ID of the system hook'
end
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2014-09-02 18:07:02 +05:30
delete ":id" do
2016-11-03 12:29:30 +05:30
hook = SystemHook.find_by(id: params[:id])
not_found!('System hook') unless hook
2021-01-03 14:25:43 +05:30
destroy_conditionally!(hook) do
WebHooks::DestroyService.new(current_user).execute(hook)
end
2014-09-02 18:07:02 +05:30
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2014-09-02 18:07:02 +05:30
end
end
end