kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Merge branch 'zj-grapify-project-hooks' into 'master'

Browse source 
GrapeDSL for project hooks

See merge request !6963
This commit is contained in:
Rémy Coutable 2016-11-04 14:32:53 +00:00
commit 5368b9f249
1 changed files with 69 additions and 84 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

153
lib/api/project_hooks.rb
View file

@ -1,114 +1,99 @@
module API
# Projects API
class ProjectHooks < Grape::API
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 :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 :build_events, type: Boolean, desc: "Trigger hook on build events"
optional :pipeline_events, type: Boolean, desc: "Trigger hook on pipeline events"
optional :wiki_events, type: Boolean, desc: "Trigger hook on wiki events"
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"
end
end
before { authenticate! }
before { authorize_admin_project }
params do
requires :id, type: String, desc: 'The ID of a project'
end
resource :projects do
# Get project hooks
#
# Parameters:
# id (required) - The ID of a project
# Example Request:
# GET /projects/:id/hooks
desc 'Get project hooks' do
success Entities::ProjectHook
end
get ":id/hooks" do
@hooks = paginate user_project.hooks
present @hooks, with: Entities::ProjectHook
hooks = paginate user_project.hooks
present hooks, with: Entities::ProjectHook
end
# Get a project hook
#
# Parameters:
# id (required) - The ID of a project
# hook_id (required) - The ID of a project hook
# Example Request:
# GET /projects/:id/hooks/:hook_id
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
@hook = user_project.hooks.find(params[:hook_id])
present @hook, with: Entities::ProjectHook
hook = user_project.hooks.find(params[:hook_id])
present hook, with: Entities::ProjectHook
end
# Add hook to project
#
# Parameters:
# id (required) - The ID of a project
# url (required) - The hook URL
# Example Request:
# POST /projects/:id/hooks
desc 'Add hook to project' do
success Entities::ProjectHook
end
params do
use :project_hook_properties
end
post ":id/hooks" do
required_attributes! [:url]
attrs = attributes_for_keys [
:url,
:push_events,
:issues_events,
:merge_requests_events,
:tag_push_events,
:note_events,
:build_events,
:pipeline_events,
:wiki_page_events,
:enable_ssl_verification,
:token
]
@hook = user_project.hooks.new(attrs)
new_hook_params = declared(params, include_missing: false, include_parent_namespaces: false).to_h
hook = user_project.hooks.new(new_hook_params)
if @hook.save
present @hook, with: Entities::ProjectHook
if hook.save
present hook, with: Entities::ProjectHook
else
if @hook.errors[:url].present?
error!("Invalid url given", 422)
end
not_found!("Project hook #{@hook.errors.messages}")
error!("Invalid url given", 422) if hook.errors[:url].present?
not_found!("Project hook #{hook.errors.messages}")
end
end
# Update an existing project hook
#
# Parameters:
# id (required) - The ID of a project
# hook_id (required) - The ID of a project hook
# url (required) - The hook URL
# Example Request:
# PUT /projects/:id/hooks/:hook_id
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"
use :project_hook_properties
end
put ":id/hooks/:hook_id" do
@hook = user_project.hooks.find(params[:hook_id])
required_attributes! [:url]
attrs = attributes_for_keys [
:url,
:push_events,
:issues_events,
:merge_requests_events,
:tag_push_events,
:note_events,
:build_events,
:pipeline_events,
:wiki_page_events,
:enable_ssl_verification,
:token
]
hook = user_project.hooks.find(params[:hook_id])
if @hook.update_attributes attrs
present @hook, with: Entities::ProjectHook
new_params = declared(params, include_missing: false, include_parent_namespaces: false).to_h
new_params.delete('hook_id')
if hook.update_attributes(new_params)
present hook, with: Entities::ProjectHook
else
if @hook.errors[:url].present?
error!("Invalid url given", 422)
end
not_found!("Project hook #{@hook.errors.messages}")
error!("Invalid url given", 422) if hook.errors[:url].present?
not_found!("Project hook #{hook.errors.messages}")
end
end
# Deletes project hook. This is an idempotent function.
#
# Parameters:
# id (required) - The ID of a project
# hook_id (required) - The ID of hook to delete
# Example Request:
# DELETE /projects/:id/hooks/:hook_id
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
required_attributes! [:hook_id]
begin
@hook = user_project.hooks.destroy(params[:hook_id])
present user_project.hooks.destroy(params[:hook_id]), with: Entities::ProjectHook
rescue
# ProjectHook can raise Error if hook_id not found
not_found!("Error deleting hook #{params[:hook_id]}")