8686d09d3e
Complete api files CRUD Adds ability to read file from repository with content encoded with Base64.
183 lines
5.9 KiB
Ruby
183 lines
5.9 KiB
Ruby
require 'mime/types'
|
|
|
|
module API
|
|
# Projects API
|
|
class Repositories < Grape::API
|
|
before { authenticate! }
|
|
before { authorize! :download_code, user_project }
|
|
|
|
resource :projects do
|
|
helpers do
|
|
def handle_project_member_errors(errors)
|
|
if errors[:project_access].any?
|
|
error!(errors[:project_access], 422)
|
|
end
|
|
not_found!
|
|
end
|
|
end
|
|
|
|
# Get a project repository branches
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a project
|
|
# 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
|
|
end
|
|
|
|
# Get a single branch
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a project
|
|
# branch (required) - The name of the branch
|
|
# Example Request:
|
|
# 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
|
|
authorize_admin_project
|
|
|
|
@branch = user_project.repository.find_branch(params[:branch])
|
|
not_found! unless @branch
|
|
protected_branch = user_project.protected_branches.find_by(name: @branch.name)
|
|
user_project.protected_branches.create(name: @branch.name) unless protected_branch
|
|
|
|
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
|
|
authorize_admin_project
|
|
|
|
@branch = user_project.repository.find_branch(params[:branch])
|
|
not_found! unless @branch
|
|
protected_branch = user_project.protected_branches.find_by(name: @branch.name)
|
|
protected_branch.destroy if protected_branch
|
|
|
|
present @branch, with: Entities::RepoObject, project: user_project
|
|
end
|
|
|
|
# Get a project repository tags
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a project
|
|
# Example Request:
|
|
# GET /projects/:id/repository/tags
|
|
get ":id/repository/tags" do
|
|
present user_project.repo.tags.sort_by(&:name).reverse, with: Entities::RepoObject, project: user_project
|
|
end
|
|
|
|
# Get a project repository tree
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a project
|
|
# ref_name (optional) - The name of a repository branch or tag, if not given the default branch is used
|
|
# Example Request:
|
|
# GET /projects/:id/repository/tree
|
|
get ":id/repository/tree" do
|
|
ref = params[:ref_name] || user_project.try(:default_branch) || 'master'
|
|
path = params[:path] || nil
|
|
|
|
commit = user_project.repository.commit(ref)
|
|
tree = user_project.repository.tree(commit.id, path)
|
|
|
|
present tree.sorted_entries, with: Entities::RepoTreeObject
|
|
end
|
|
|
|
# Get a raw file contents
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a project
|
|
# sha (required) - The commit or branch name
|
|
# filepath (required) - The path to the file to display
|
|
# Example Request:
|
|
# GET /projects/:id/repository/blobs/:sha
|
|
get [ ":id/repository/blobs/:sha", ":id/repository/commits/:sha/blob" ] do
|
|
required_attributes! [:filepath]
|
|
|
|
ref = params[:sha]
|
|
|
|
repo = user_project.repository
|
|
|
|
commit = repo.commit(ref)
|
|
not_found! "Commit" unless commit
|
|
|
|
blob = Gitlab::Git::Blob.find(repo, commit.id, params[:filepath])
|
|
not_found! "File" unless blob
|
|
|
|
content_type 'text/plain'
|
|
present blob.data
|
|
end
|
|
|
|
# Get a raw blob contents by blob sha
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a project
|
|
# sha (required) - The blob's sha
|
|
# Example Request:
|
|
# GET /projects/:id/repository/raw_blobs/:sha
|
|
get ":id/repository/raw_blobs/:sha" do
|
|
ref = params[:sha]
|
|
|
|
repo = user_project.repository
|
|
|
|
blob = Gitlab::Git::Blob.raw(repo, ref)
|
|
|
|
not_found! "Blob" unless blob
|
|
|
|
env['api.format'] = :txt
|
|
|
|
content_type blob.mime_type
|
|
present blob.data
|
|
end
|
|
|
|
# Get a an archive of the repository
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a project
|
|
# sha (optional) - the commit sha to download defaults to the tip of the default branch
|
|
# Example Request:
|
|
# GET /projects/:id/repository/archive
|
|
get ":id/repository/archive", requirements: { format: Gitlab::Regex.archive_formats_regex } do
|
|
authorize! :download_code, user_project
|
|
repo = user_project.repository
|
|
ref = params[:sha]
|
|
format = params[:format]
|
|
storage_path = Rails.root.join("tmp", "repositories")
|
|
|
|
file_path = repo.archive_repo(ref, storage_path, format)
|
|
if file_path && File.exists?(file_path)
|
|
data = File.open(file_path, 'rb').read
|
|
|
|
header["Content-Disposition"] = "attachment; filename=\"#{File.basename(file_path)}\""
|
|
|
|
content_type MIME::Types.type_for(file_path).first.content_type
|
|
|
|
env['api.format'] = :binary
|
|
|
|
present data
|
|
else
|
|
not_found!
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|