BigW Consortium Gitlab
Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
G
gitlab-ce
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
Registry
Registry
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
Forest Godfrey
gitlab-ce
Commits
b110c6bc
Commit
b110c6bc
authored
Jun 29, 2012
by
Dmitriy Zaporozhets
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #1019 from NARKOZ/api
API
parents
fca95708
378dc55d
Hide whitespace changes
Inline
Side-by-side
Showing
6 changed files
with
178 additions
and
54 deletions
+178
-54
api.rb
lib/api.rb
+4
-53
entities.rb
lib/api/entities.rb
+6
-0
helpers.rb
lib/api/helpers.rb
+1
-1
projects.rb
lib/api/projects.rb
+103
-0
users.rb
lib/api/users.rb
+36
-0
projects_spec.rb
spec/api/projects_spec.rb
+28
-0
No files found.
lib/api.rb
View file @
b110c6bc
require
'api/entities'
require
'api/helpers'
Dir
[
"
#{
Rails
.
root
}
/lib/api/*.rb"
].
each
{
|
file
|
require
file
}
module
Gitlab
class
API
<
Grape
::
API
format
:json
error_format
:json
helpers
APIHelpers
# Users API
resource
:users
do
before
{
authenticate!
}
# GET /users
get
do
@users
=
User
.
all
present
@users
,
:with
=>
Entities
::
User
end
# GET /users/:id
get
":id"
do
@user
=
User
.
find
(
params
[
:id
])
present
@user
,
:with
=>
Entities
::
User
end
end
# GET /user
get
"/user"
do
authenticate!
present
@current_user
,
:with
=>
Entities
::
User
end
# Projects API
resource
:projects
do
before
{
authenticate!
}
# GET /projects
get
do
@projects
=
current_user
.
projects
present
@projects
,
:with
=>
Entities
::
Project
end
# GET /projects/:id
get
":id"
do
@project
=
current_user
.
projects
.
find_by_code
(
params
[
:id
])
present
@project
,
:with
=>
Entities
::
Project
end
# GET /projects/:id/repository/branches
get
":id/repository/branches"
do
@project
=
current_user
.
projects
.
find_by_code
(
params
[
:id
])
present
@project
.
repo
.
heads
.
sort_by
(
&
:name
),
:with
=>
Entities
::
ProjectRepositoryBranches
end
# GET /projects/:id/repository/tags
get
":id/repository/tags"
do
@project
=
current_user
.
projects
.
find_by_code
(
params
[
:id
])
present
@project
.
repo
.
tags
.
sort_by
(
&
:name
).
reverse
,
:with
=>
Entities
::
ProjectRepositoryTags
end
end
mount
Users
mount
Projects
end
end
lib/api/entities.rb
View file @
b110c6bc
...
...
@@ -19,5 +19,11 @@ module Gitlab
class
ProjectRepositoryTags
<
Grape
::
Entity
expose
:name
,
:commit
end
class
ProjectSnippet
<
Grape
::
Entity
expose
:id
,
:title
,
:file_name
expose
:author
,
:using
=>
Entities
::
User
expose
:expires_at
,
:updated_at
,
:created_at
end
end
end
lib/api/helpers.rb
View file @
b110c6bc
...
...
@@ -5,7 +5,7 @@ module Gitlab
end
def
authenticate!
error!
(
'401 Unauthorized'
,
401
)
unless
current_user
error!
(
{
'message'
=>
'401 Unauthorized'
}
,
401
)
unless
current_user
end
end
end
lib/api/projects.rb
0 → 100644
View file @
b110c6bc
module
Gitlab
# Projects API
class
Projects
<
Grape
::
API
before
{
authenticate!
}
resource
:projects
do
# Get a projects list for authenticated user
#
# Example Request:
# GET /projects
get
do
@projects
=
current_user
.
projects
present
@projects
,
:with
=>
Entities
::
Project
end
# Get a single project
#
# Parameters:
# id (required) - The code of a project
# Example Request:
# GET /projects/:id
get
":id"
do
@project
=
current_user
.
projects
.
find_by_code
(
params
[
:id
])
present
@project
,
:with
=>
Entities
::
Project
end
# Get a project repository branches
#
# Parameters:
# id (required) - The code of a project
# Example Request:
# GET /projects/:id/repository/branches
get
":id/repository/branches"
do
@project
=
current_user
.
projects
.
find_by_code
(
params
[
:id
])
present
@project
.
repo
.
heads
.
sort_by
(
&
:name
),
:with
=>
Entities
::
ProjectRepositoryBranches
end
# Get a project repository tags
#
# Parameters:
# id (required) - The code of a project
# Example Request:
# GET /projects/:id/repository/tags
get
":id/repository/tags"
do
@project
=
current_user
.
projects
.
find_by_code
(
params
[
:id
])
present
@project
.
repo
.
tags
.
sort_by
(
&
:name
).
reverse
,
:with
=>
Entities
::
ProjectRepositoryTags
end
# Get a project snippet
#
# Parameters:
# id (required) - The code of a project
# snippet_id (required) - The ID of a project snippet
# Example Request:
# GET /projects/:id/snippets/:snippet_id
get
":id/snippets/:snippet_id"
do
@project
=
current_user
.
projects
.
find_by_code
(
params
[
:id
])
@snippet
=
@project
.
snippets
.
find
(
params
[
:snippet_id
])
present
@snippet
,
:with
=>
Entities
::
ProjectSnippet
end
# Create a new project snippet
#
# Parameters:
# id (required) - The code name of a project
# title (required) - The title of a snippet
# file_name (required) - The name of a snippet file
# lifetime (optional) - The expiration date of a snippet
# code (required) - The content of a snippet
# Example Request:
# POST /projects/:id/snippets
post
":id/snippets"
do
@project
=
current_user
.
projects
.
find_by_code
(
params
[
:id
])
@snippet
=
@project
.
snippets
.
new
(
:title
=>
params
[
:title
],
:file_name
=>
params
[
:file_name
],
:expires_at
=>
params
[
:lifetime
],
:content
=>
params
[
:code
]
)
@snippet
.
author
=
current_user
if
@snippet
.
save
present
@snippet
,
:with
=>
Entities
::
ProjectSnippet
else
error!
({
'message'
=>
'404 Not found'
},
404
)
end
end
# Delete a project snippet
#
# Parameters:
# id (required) - The code of a project
# snippet_id (required) - The ID of a project snippet
# Example Request:
# DELETE /projects/:id/snippets/:snippet_id
delete
":id/snippets/:snippet_id"
do
@project
=
current_user
.
projects
.
find_by_code
(
params
[
:id
])
@snippet
=
@project
.
snippets
.
find
(
params
[
:snippet_id
])
@snippet
.
destroy
end
end
end
end
lib/api/users.rb
0 → 100644
View file @
b110c6bc
module
Gitlab
# Users API
class
Users
<
Grape
::
API
before
{
authenticate!
}
resource
:users
do
# Get a users list
#
# Example Request:
# GET /users
get
do
@users
=
User
.
all
present
@users
,
:with
=>
Entities
::
User
end
# Get a single user
#
# Parameters:
# id (required) - The ID of a user
# Example Request:
# GET /users/:id
get
":id"
do
@user
=
User
.
find
(
params
[
:id
])
present
@user
,
:with
=>
Entities
::
User
end
end
# Get currently authenticated user
#
# Example Request:
# GET /user
get
"/user"
do
present
@current_user
,
:with
=>
Entities
::
User
end
end
end
spec/api/projects_spec.rb
View file @
b110c6bc
...
...
@@ -3,6 +3,7 @@ require 'spec_helper'
describe
Gitlab
::
API
do
let
(
:user
)
{
Factory
:user
}
let!
(
:project
)
{
Factory
:project
,
:owner
=>
user
}
let!
(
:snippet
)
{
Factory
:snippet
,
:author
=>
user
,
:project
=>
project
}
before
{
project
.
add_access
(
user
,
:read
)
}
describe
"GET /projects"
do
...
...
@@ -52,4 +53,31 @@ describe Gitlab::API do
json
.
first
[
'name'
].
should
==
project
.
repo
.
tags
.
sort_by
(
&
:name
).
reverse
.
first
.
name
end
end
describe
"GET /projects/:id/snippets/:snippet_id"
do
it
"should return a project snippet"
do
get
"/api/projects/
#{
project
.
code
}
/snippets/
#{
snippet
.
id
}
?private_token=
#{
user
.
private_token
}
"
response
.
status
.
should
==
200
json
=
JSON
.
parse
(
response
.
body
)
json
[
'title'
].
should
==
snippet
.
title
end
end
describe
"POST /projects/:id/snippets"
do
it
"should create a new project snippet"
do
post
"/api/projects/
#{
project
.
code
}
/snippets?private_token=
#{
user
.
private_token
}
"
,
:title
=>
'api test'
,
:file_name
=>
'sample.rb'
,
:code
=>
'test'
response
.
status
.
should
==
201
json
=
JSON
.
parse
(
response
.
body
)
json
[
'title'
].
should
==
'api test'
end
end
describe
"DELETE /projects/:id/snippets/:snippet_id"
do
it
"should create a new project snippet"
do
expect
{
delete
"/api/projects/
#{
project
.
code
}
/snippets/
#{
snippet
.
id
}
?private_token=
#{
user
.
private_token
}
"
}.
should
change
{
Snippet
.
count
}.
by
(
-
1
)
end
end
end
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