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 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 # Create tag # # Parameters: # id (required) - The ID of a project # tag_name (required) - The name of the tag # ref (required) - Create tag from commit sha or branch # message (optional) - Specifying a message creates an annotated tag. # Example Request: # POST /projects/:id/repository/tags post ':id/repository/tags' do authorize_push_project message = params[:message] || nil result = CreateTagService.new(user_project, current_user). execute(params[:tag_name], params[:ref], message) if result[:status] == :success present result[:tag], with: Entities::RepoObject, project: user_project else render_api_error!(result[:message], 400) end 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 file_path = ArchiveRepositoryService.new.execute(user_project, params[:sha], params[: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 # Compare two branches, tags or commits # # Parameters: # id (required) - The ID of a project # from (required) - the commit sha or branch name # to (required) - the commit sha or branch name # Example Request: # GET /projects/:id/repository/compare?from=master&to=feature get ':id/repository/compare' do authorize! :download_code, user_project required_attributes! [:from, :to] compare = Gitlab::Git::Compare.new(user_project.repository.raw_repository, params[:from], params[:to]) present compare, with: Entities::Compare end # Get repository contributors # # Parameters: # id (required) - The ID of a project # Example Request: # GET /projects/:id/repository/contributors get ':id/repository/contributors' do authorize! :download_code, user_project present user_project.repository.contributors, with: Entities::Contributor end end end end