Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kazuhiko Shiozaki
gitlab-ce
Commits
1dd712dd
Commit
1dd712dd
authored
Mar 06, 2013
by
Matt Humphrey
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
System hooks API.
parent
d03af842
Changes
4
Show whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
177 additions
and
0 deletions
+177
-0
doc/api/system_hooks.md
doc/api/system_hooks.md
+47
-0
lib/api.rb
lib/api.rb
+1
-0
lib/api/system_hooks.rb
lib/api/system_hooks.rb
+60
-0
spec/requests/api/system_hooks_spec.rb
spec/requests/api/system_hooks_spec.rb
+69
-0
No files found.
doc/api/system_hooks.md
0 → 100644
View file @
1dd712dd
All methods require admin authorization.
## List system hooks
Get list of system hooks
```
GET /hooks
```
Will return hooks with status
`200 OK`
on success, or
`404 Not found`
on fail.
## Add new system hook hook
```
POST /hooks
```
Parameters:
+
`url`
(required) - The hook URL
Will return status
`201 Created`
on success, or
`404 Not found`
on fail.
## Test system hook
```
GET /hooks/:id
```
Parameters:
+
`id`
(required) - The ID of hook
Will return hook with status
`200 OK`
on success, or
`404 Not found`
on fail.
## Delete system hook
```
DELETE /hooks/:id
```
Parameters:
+
`id`
(required) - The ID of hook
Will return status
`200 OK`
on success, or
`404 Not found`
on fail.
\ No newline at end of file
lib/api.rb
View file @
1dd712dd
...
@@ -20,5 +20,6 @@ module Gitlab
...
@@ -20,5 +20,6 @@ module Gitlab
mount
MergeRequests
mount
MergeRequests
mount
Notes
mount
Notes
mount
Internal
mount
Internal
mount
SystemHooks
end
end
end
end
lib/api/system_hooks.rb
0 → 100644
View file @
1dd712dd
module
Gitlab
# Hooks API
class
SystemHooks
<
Grape
::
API
before
{
authenticated_as_admin!
}
resource
:hooks
do
# Get the list of system hooks
#
# Example Request:
# GET /hooks
get
do
@hooks
=
SystemHook
.
all
present
@hooks
,
with:
Entities
::
Hook
end
# Create new system hook
#
# Parameters:
# url (required) - url for system hook
# Example Request
# POST /hooks
post
do
attrs
=
attributes_for_keys
[
:url
]
@hook
=
SystemHook
.
new
attrs
if
@hook
.
save
present
@hook
,
with:
Entities
::
Hook
else
not_found!
end
end
# Test a hook
#
# Example Request
# GET /hooks/:id
get
":id"
do
@hook
=
SystemHook
.
find
(
params
[
:id
])
data
=
{
event_name:
"project_create"
,
name:
"Ruby"
,
path:
"ruby"
,
project_id:
1
,
owner_name:
"Someone"
,
owner_email:
"example@gitlabhq.com"
}
@hook
.
execute
(
data
)
data
end
# Delete a hook
#
# Example Request:
# DELETE /hooks/:id
delete
":id"
do
@hook
=
SystemHook
.
find
(
params
[
:id
])
@hook
.
destroy
end
end
end
end
\ No newline at end of file
spec/requests/api/system_hooks_spec.rb
0 → 100644
View file @
1dd712dd
require
'spec_helper'
describe
Gitlab
::
API
do
include
ApiHelpers
let
(
:user
)
{
create
(
:user
)
}
let
(
:admin
)
{
create
(
:admin
)
}
let!
(
:hook
)
{
create
(
:system_hook
,
url:
"http://example.com"
)
}
before
{
stub_request
(
:post
,
hook
.
url
)
}
describe
"GET /hooks"
do
context
"when not an admin"
do
it
"should return forbidden error"
do
get
api
(
"/hooks"
,
user
)
response
.
status
.
should
==
403
end
end
context
"when authenticated as admin"
do
it
"should return an array of hooks"
do
get
api
(
"/hooks"
,
admin
)
response
.
status
.
should
==
200
json_response
.
should
be_an
Array
json_response
.
first
[
'url'
].
should
==
hook
.
url
end
end
end
describe
"POST /hooks"
do
it
"should create new hook"
do
expect
{
post
api
(
"/hooks"
,
admin
),
url:
'http://example.com'
}.
to
change
{
SystemHook
.
count
}.
by
(
1
)
end
it
"should respond with 404 on failure"
do
post
api
(
"/hooks"
,
admin
)
response
.
status
.
should
==
404
end
it
"should not create new hook without url"
do
expect
{
post
api
(
"/hooks"
,
admin
)
}.
to_not
change
{
SystemHook
.
count
}
end
end
describe
"GET /hooks/:id"
do
it
"should return hook by id"
do
get
api
(
"/hooks/
#{
hook
.
id
}
"
,
admin
)
response
.
status
.
should
==
200
json_response
[
'event_name'
].
should
==
'project_create'
end
it
"should return 404 on failure"
do
get
api
(
"/hooks/404"
,
admin
)
response
.
status
.
should
==
404
end
end
describe
"DELETE /hooks/:id"
do
it
"should delete a hook"
do
expect
{
delete
api
(
"/hooks/
#{
hook
.
id
}
"
,
admin
)
}.
to
change
{
SystemHook
.
count
}.
by
(
-
1
)
end
end
end
\ No newline at end of file
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment