BigW Consortium Gitlab

repositories.rb 5.08 KB
Newer Older
1 2
require 'mime/types'

3 4 5 6
module API
  # Projects API
  class Repositories < Grape::API
    before { authenticate! }
7
    before { authorize! :download_code, user_project }
8 9 10 11 12 13 14 15 16 17

    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
18

19 20 21 22 23 24 25
      # 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
26
        present user_project.repo.tags.sort_by(&:name).reverse, with: Entities::RepoObject, project: user_project
27 28
      end

29 30 31 32 33 34 35 36 37 38 39 40 41 42
      # 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
      # Example Request:
      #   POST /projects/:id/repository/tags
      post ':id/repository/tags' do
        authorize_push_project
        @tag = CreateTagService.new.execute(user_project, params[:tag_name],
                                            params[:ref], current_user)

        present @tag, with: Entities::RepoObject, project: user_project
43 44
      end

45 46 47 48 49 50 51 52 53 54 55 56
      # 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)
57
        tree = user_project.repository.tree(commit.id, path)
58

59
        present tree.sorted_entries, with: Entities::RepoTreeObject
60 61
      end

62 63 64 65 66 67 68
      # 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:
69 70
      #   GET /projects/:id/repository/blobs/:sha
      get [ ":id/repository/blobs/:sha", ":id/repository/commits/:sha/blob" ] do
71 72 73 74 75 76 77 78 79
        required_attributes! [:filepath]

        ref = params[:sha]

        repo = user_project.repository

        commit = repo.commit(ref)
        not_found! "Commit" unless commit

80 81
        blob = Gitlab::Git::Blob.find(repo, commit.id, params[:filepath])
        not_found! "File" unless blob
82

83
        content_type 'text/plain'
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
        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
104

105 106 107
        content_type blob.mime_type
        present blob.data
      end
108 109 110 111 112

      # Get a an archive of the repository
      #
      # Parameters:
      #   id (required) - The ID of a project
113
      #   sha (optional) - the commit sha to download defaults to the tip of the default branch
114 115
      # Example Request:
      #   GET /projects/:id/repository/archive
116
      get ":id/repository/archive", requirements: { format: Gitlab::Regex.archive_formats_regex } do
117
        authorize! :download_code, user_project
118
        file_path = ArchiveRepositoryService.new.execute(user_project, params[:sha], params[:format])
119

120 121
        if file_path && File.exists?(file_path)
          data = File.open(file_path, 'rb').read
122 123
          header["Content-Disposition"] = "attachment; filename=\"#{File.basename(file_path)}\""
          content_type MIME::Types.type_for(file_path).first.content_type
124
          env['api.format'] = :binary
125 126 127 128 129
          present data
        else
          not_found!
        end
      end
130 131 132 133 134 135 136 137 138 139 140

      # 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
141
        required_attributes! [:from, :to]
142
        compare = Gitlab::Git::Compare.new(user_project.repository.raw_repository, params[:from], params[:to])
143 144
        present compare, with: Entities::Compare
      end
145 146 147 148 149 150 151 152 153 154

      # 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

155
        present user_project.repository.contributors, with: Entities::Contributor
156
      end
157 158 159
    end
  end
end