gitlabhq/lib/api/projects.rb

473 lines
15 KiB
Ruby
Raw Normal View History

2012-06-29 12:46:01 +02:00
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 = paginate current_user.authorized_projects
present @projects, with: Entities::Project
2012-06-29 12:46:01 +02:00
end
# Get a single project
#
# Parameters:
# id (required) - The ID of a project
2012-06-29 12:46:01 +02:00
# Example Request:
# GET /projects/:id
get ":id" do
present user_project, with: Entities::Project
2012-06-29 12:46:01 +02:00
end
2012-08-31 09:15:37 +02:00
# Create new project
#
# Parameters:
# name (required) - name for new project
2012-09-03 17:00:24 +02:00
# description (optional) - short project description
# default_branch (optional) - 'master' by default
# issues_enabled (optional) - enabled by default
# wall_enabled (optional) - enabled by default
# merge_requests_enabled (optional) - enabled by default
# wiki_enabled (optional) - enabled by default
2012-08-31 09:15:37 +02:00
# Example Request
# POST /projects
post do
attrs = attributes_for_keys [:name,
2012-09-21 12:22:30 +02:00
:description,
:default_branch,
:issues_enabled,
:wall_enabled,
:merge_requests_enabled,
2013-03-01 17:36:19 +01:00
:wiki_enabled,
:namespace_id]
2013-01-18 19:21:13 +01:00
@project = ::Projects::CreateContext.new(current_user, attrs).execute
2012-08-31 09:15:37 +02:00
if @project.saved?
present @project, with: Entities::Project
else
2012-09-10 09:41:46 +02:00
not_found!
2012-08-31 09:15:37 +02:00
end
end
2012-09-21 12:23:17 +02:00
# Get a project team members
2012-09-06 22:49:29 +02:00
#
# Parameters:
# id (required) - The ID of a project
2012-12-18 19:52:18 +01:00
# query - Query string
2012-09-06 22:49:29 +02:00
# Example Request:
2012-09-21 12:23:17 +02:00
# GET /projects/:id/members
get ":id/members" do
2012-12-18 19:52:18 +01:00
if params[:query].present?
@members = paginate user_project.users.where("username LIKE ?", "%#{params[:query]}%")
else
@members = paginate user_project.users
end
2012-09-21 12:23:17 +02:00
present @members, with: Entities::ProjectMember, project: user_project
2012-09-06 22:49:29 +02:00
end
2012-09-21 12:23:17 +02:00
# Get a project team members
#
# Parameters:
# id (required) - The ID of a project
2012-09-21 12:23:17 +02:00
# user_id (required) - The ID of a user
# Example Request:
2012-09-21 12:23:17 +02:00
# GET /projects/:id/members/:user_id
get ":id/members/:user_id" do
@member = user_project.users.find params[:user_id]
present @member, with: Entities::ProjectMember, project: user_project
end
# Add a new project team member
#
# Parameters:
# id (required) - The ID of a project
2012-09-21 12:23:17 +02:00
# user_id (required) - The ID of a user
# access_level (required) - Project access level
# Example Request:
# POST /projects/:id/members
post ":id/members" do
2012-09-10 08:06:11 +02:00
authorize! :admin_project, user_project
2012-09-21 12:23:17 +02:00
users_project = user_project.users_projects.new(
user_id: params[:user_id],
project_access: params[:access_level]
)
if users_project.save
@member = users_project.user
present @member, with: Entities::ProjectMember, project: user_project
else
not_found!
end
end
2012-09-21 12:23:17 +02:00
# Update project team member
2012-09-06 22:49:29 +02:00
#
# Parameters:
# id (required) - The ID of a project
2012-09-21 12:23:17 +02:00
# user_id (required) - The ID of a team member
# access_level (required) - Project access level
2012-09-06 22:49:29 +02:00
# Example Request:
2012-09-21 12:23:17 +02:00
# PUT /projects/:id/members/:user_id
put ":id/members/:user_id" do
2012-09-10 08:06:11 +02:00
authorize! :admin_project, user_project
2012-09-21 12:23:17 +02:00
users_project = user_project.users_projects.find_by_user_id params[:user_id]
if users_project.update_attributes(project_access: params[:access_level])
@member = users_project.user
present @member, with: Entities::ProjectMember, project: user_project
else
not_found!
end
2012-09-06 22:49:29 +02:00
end
2012-09-21 12:23:17 +02:00
# Remove a team member from project
2012-09-06 22:49:29 +02:00
#
# Parameters:
# id (required) - The ID of a project
2012-09-21 12:23:17 +02:00
# user_id (required) - The ID of a team member
2012-09-06 22:49:29 +02:00
# Example Request:
2012-09-21 12:23:17 +02:00
# DELETE /projects/:id/members/:user_id
delete ":id/members/:user_id" do
2012-09-10 08:06:11 +02:00
authorize! :admin_project, user_project
2012-09-21 12:23:17 +02:00
users_project = user_project.users_projects.find_by_user_id params[:user_id]
users_project.destroy
2012-09-06 22:49:29 +02:00
end
2012-09-08 19:51:12 +02:00
# Get project hooks
#
# Parameters:
# id (required) - The ID of a project
2012-09-08 19:51:12 +02:00
# Example Request:
# GET /projects/:id/hooks
get ":id/hooks" do
2012-09-10 15:50:01 +02:00
authorize! :admin_project, user_project
2012-09-08 19:51:12 +02:00
@hooks = paginate user_project.hooks
present @hooks, with: Entities::Hook
end
2012-11-09 18:36:55 +01:00
# 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
get ":id/hooks/:hook_id" do
authorize! :admin_project, user_project
@hook = user_project.hooks.find(params[:hook_id])
present @hook, with: Entities::Hook
end
2012-11-09 18:36:55 +01:00
2012-09-08 19:51:12 +02:00
# Add hook to project
#
# Parameters:
# id (required) - The ID of a project
2012-09-08 19:51:12 +02:00
# url (required) - The hook URL
# Example Request:
# POST /projects/:id/hooks
post ":id/hooks" do
2012-09-10 15:50:01 +02:00
authorize! :admin_project, user_project
2012-09-08 19:51:12 +02:00
@hook = user_project.hooks.new({"url" => params[:url]})
if @hook.save
present @hook, with: Entities::Hook
else
error!({'message' => '404 Not found'}, 404)
end
end
2012-11-09 18:36:55 +01:00
# 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
put ":id/hooks/:hook_id" do
@hook = user_project.hooks.find(params[:hook_id])
authorize! :admin_project, user_project
attrs = attributes_for_keys [:url]
if @hook.update_attributes attrs
present @hook, with: Entities::Hook
else
not_found!
end
end
2012-09-08 19:51:12 +02:00
# Delete project hook
#
# Parameters:
# id (required) - The ID of a project
2012-09-08 19:51:12 +02:00
# hook_id (required) - The ID of hook to delete
# Example Request:
# DELETE /projects/:id/hooks/:hook_id
delete ":id/hooks/:hook_id" do
2012-09-10 15:50:01 +02:00
authorize! :admin_project, user_project
2012-09-08 19:51:12 +02:00
@hook = user_project.hooks.find(params[:hook_id])
@hook.destroy
end
2012-06-29 12:46:01 +02:00
# Get a project repository branches
#
# Parameters:
# id (required) - The ID of a project
2012-06-29 12:46:01 +02:00
# Example Request:
# GET /projects/:id/repository/branches
get ":id/repository/branches" do
present user_project.repo.heads.sort_by(&:name), with: Entities::RepoObject, project: user_project
2012-06-29 12:46:01 +02:00
end
# Get a single branch
#
# Parameters:
# id (required) - The ID of a project
2012-08-01 14:48:15 +02:00
# branch (required) - The name of the branch
# Example Request:
2012-08-01 14:48:15 +02:00
# GET /projects/:id/repository/branches/:branch
get ":id/repository/branches/:branch" do
@branch = user_project.repo.heads.find { |item| item.name == params[:branch] }
not_found!("Branch does not exist") if @branch.nil?
present @branch, with: Entities::RepoObject, project: user_project
end
# Protect a single branch
#
# Parameters:
# id (required) - The ID of a project
# branch (required) - The name of the branch
# Example Request:
# PUT /projects/:id/repository/branches/:branch/protect
put ":id/repository/branches/:branch/protect" do
@branch = user_project.repo.heads.find { |item| item.name == params[:branch] }
protected = user_project.protected_branches.find_by_name(@branch.name)
unless protected
user_project.protected_branches.create(:name => @branch.name)
end
present @branch, with: Entities::RepoObject, project: user_project
end
# Unprotect a single branch
#
# Parameters:
# id (required) - The ID of a project
# branch (required) - The name of the branch
# Example Request:
# PUT /projects/:id/repository/branches/:branch/unprotect
put ":id/repository/branches/:branch/unprotect" do
@branch = user_project.repo.heads.find { |item| item.name == params[:branch] }
protected = user_project.protected_branches.find_by_name(@branch.name)
if protected
protected.destroy
end
present @branch, with: Entities::RepoObject, project: user_project
end
2012-06-29 12:46:01 +02:00
# Get a project repository tags
#
# Parameters:
# id (required) - The ID of a project
2012-06-29 12:46:01 +02:00
# Example Request:
# GET /projects/:id/repository/tags
get ":id/repository/tags" do
present user_project.repo.tags.sort_by(&:name).reverse, with: Entities::RepoObject
2012-06-29 12:46:01 +02:00
end
2012-06-29 15:34:08 +02:00
# Get a project repository commits
#
# Parameters:
# id (required) - The ID of a project
# ref_name (optional) - The name of a repository branch or tag
# Example Request:
# GET /projects/:id/repository/commits
get ":id/repository/commits" do
authorize! :download_code, user_project
page = params[:page] || 0
2013-02-27 15:47:04 +01:00
per_page = (params[:per_page] || 20).to_i
ref = params[:ref_name] || user_project.try(:default_branch) || 'master'
2013-01-04 17:50:31 +01:00
commits = user_project.repository.commits(ref, nil, per_page, page * per_page)
present CommitDecorator.decorate(commits), with: Entities::RepoCommit
end
2012-10-08 11:13:53 +02:00
# Get a project snippets
#
# Parameters:
# id (required) - The ID of a project
2012-10-08 11:13:53 +02:00
# Example Request:
# GET /projects/:id/snippets
get ":id/snippets" do
present paginate(user_project.snippets), with: Entities::ProjectSnippet
end
2012-06-29 15:34:08 +02:00
# Get a project snippet
#
# Parameters:
# id (required) - The ID of a project
2012-06-29 15:34:08 +02:00
# snippet_id (required) - The ID of a project snippet
# Example Request:
# GET /projects/:id/snippets/:snippet_id
get ":id/snippets/:snippet_id" do
2012-07-06 15:08:17 +02:00
@snippet = user_project.snippets.find(params[:snippet_id])
present @snippet, with: Entities::ProjectSnippet
2012-06-29 15:34:08 +02:00
end
# Create a new project snippet
#
# Parameters:
# id (required) - The ID of a project
2012-06-29 15:34:08 +02:00
# 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
2012-09-21 12:22:30 +02:00
authorize! :write_snippet, user_project
2012-09-16 19:08:57 +02:00
attrs = attributes_for_keys [:title, :file_name]
2012-09-16 18:51:04 +02:00
attrs[:expires_at] = params[:lifetime] if params[:lifetime].present?
attrs[:content] = params[:code] if params[:code].present?
@snippet = user_project.snippets.new attrs
2012-06-29 15:34:08 +02:00
@snippet.author = current_user
if @snippet.save
present @snippet, with: Entities::ProjectSnippet
2012-06-29 15:34:08 +02:00
else
2012-09-10 09:41:46 +02:00
not_found!
2012-06-29 15:34:08 +02:00
end
end
# Update an existing project snippet
#
# Parameters:
# id (required) - The ID of a project
# snippet_id (required) - The ID of a project snippet
# title (optional) - The title of a snippet
# file_name (optional) - The name of a snippet file
# lifetime (optional) - The expiration date of a snippet
# code (optional) - The content of a snippet
# Example Request:
# PUT /projects/:id/snippets/:snippet_id
put ":id/snippets/:snippet_id" do
2012-07-06 15:08:17 +02:00
@snippet = user_project.snippets.find(params[:snippet_id])
2012-09-10 08:06:11 +02:00
authorize! :modify_snippet, @snippet
2012-09-16 19:08:57 +02:00
attrs = attributes_for_keys [:title, :file_name]
2012-09-16 18:51:04 +02:00
attrs[:expires_at] = params[:lifetime] if params[:lifetime].present?
attrs[:content] = params[:code] if params[:code].present?
2012-09-16 18:51:04 +02:00
if @snippet.update_attributes attrs
present @snippet, with: Entities::ProjectSnippet
else
2012-09-10 09:41:46 +02:00
not_found!
end
end
2012-06-29 15:34:08 +02:00
# Delete a project snippet
#
# Parameters:
# id (required) - The ID of a project
2012-06-29 15:34:08 +02:00
# snippet_id (required) - The ID of a project snippet
# Example Request:
# DELETE /projects/:id/snippets/:snippet_id
delete ":id/snippets/:snippet_id" do
2012-07-06 15:08:17 +02:00
@snippet = user_project.snippets.find(params[:snippet_id])
2012-09-10 08:06:11 +02:00
authorize! :modify_snippet, @snippet
2012-06-29 15:34:08 +02:00
@snippet.destroy
end
# Get a raw project snippet
#
# Parameters:
# id (required) - The ID of a project
# snippet_id (required) - The ID of a project snippet
# Example Request:
# GET /projects/:id/snippets/:snippet_id/raw
get ":id/snippets/:snippet_id/raw" do
2012-07-06 15:08:17 +02:00
@snippet = user_project.snippets.find(params[:snippet_id])
2012-08-01 14:57:56 +02:00
content_type 'text/plain'
present @snippet.content
end
# Get a raw file contents
#
# Parameters:
# id (required) - The ID of a project
2012-08-01 14:48:15 +02:00
# sha (required) - The commit or branch name
# filepath (required) - The path to the file to display
# Example Request:
# GET /projects/:id/repository/commits/:sha/blob
get ":id/repository/commits/:sha/blob" do
2012-09-21 12:22:30 +02:00
authorize! :download_code, user_project
ref = params[:sha]
2013-01-04 17:50:31 +01:00
commit = user_project.repository.commit ref
2012-09-10 09:41:46 +02:00
not_found! "Commit" unless commit
2012-08-01 14:48:15 +02:00
2013-01-04 17:50:31 +01:00
tree = Tree.new commit.tree, ref, params[:filepath]
2012-09-10 09:41:46 +02:00
not_found! "File" unless tree.try(:tree)
2012-08-01 14:48:15 +02:00
2012-11-09 18:36:55 +01:00
content_type tree.mime_type
present tree.data
end
2013-03-05 22:23:29 +01:00
# Get a specific project's keys
#
# Example Request:
# GET /projects/:id/keys
get ":id/keys" do
present user_project.deploy_keys, with: Entities::SSHKey
end
# Get single key owned by currently authenticated user
#
# Example Request:
# GET /projects/:id/keys/:id
get ":id/keys/:key_id" do
key = user_project.deploy_keys.find params[:key_id]
present key, with: Entities::SSHKey
end
# Add new ssh key to currently authenticated user
#
# Parameters:
# key (required) - New SSH Key
# title (required) - New SSH Key's title
# Example Request:
# POST /projects/:id/keys
post ":id/keys" do
attrs = attributes_for_keys [:title, :key]
key = user_project.deploy_keys.new attrs
if key.save
present key, with: Entities::SSHKey
else
not_found!
end
end
# Delete existed ssh key of currently authenticated user
#
# Example Request:
# DELETE /projects/:id/keys/:id
delete ":id/keys/:key_id" do
key = user_project.deploy_keys.find params[:key_id]
key.delete
end
2012-06-29 12:46:01 +02:00
end
end
end