repositories.rb 7.0 KB
Newer Older
1 2 3 4
module API
  # Projects API
  class Repositories < Grape::API
    before { authenticate! }
5
    before { authorize! :download_code, user_project }
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

    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
48
        authorize_admin_project
49

50 51 52 53
        @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
54 55 56 57 58 59 60 61 62 63 64 65

        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
66
        authorize_admin_project
67

68 69 70 71
        @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
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93

        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
      end

      # Get a project repository commits
      #
      # 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/commits
      get ":id/repository/commits" do
94
        page = (params[:page] || 0).to_i
95 96 97 98 99 100 101
        per_page = (params[:per_page] || 20).to_i
        ref = params[:ref_name] || user_project.try(:default_branch) || 'master'

        commits = user_project.repository.commits(ref, nil, per_page, page * per_page)
        present commits, with: Entities::RepoCommit
      end

G
Gabor Nagy 已提交
102 103 104 105
      # Get a specific commit of a project
      #
      # Parameters:
      #   id (required) - The ID of a project
106 107 108 109 110 111 112 113 114 115 116 117 118 119
      #   sha (required) - The commit hash or name of a repository branch or tag
      # Example Request:
      #   GET /projects/:id/repository/commits/:sha
      get ":id/repository/commits/:sha" do
        sha = params[:sha]
        commit = user_project.repository.commit(sha)
        not_found! "Commit" unless commit
        present commit, with: Entities::RepoCommit
      end

      # Get the diff for a specific commit of a project
      #
      # Parameters:
      #   id (required) - The ID of a project
G
Gabor Nagy 已提交
120 121
      #   sha (required) - The commit or branch name
      # Example Request:
122 123
      #   GET /projects/:id/repository/commits/:sha/diff
      get ":id/repository/commits/:sha/diff" do
G
Gabor Nagy 已提交
124 125
        sha = params[:sha]
        result = CommitLoadContext.new(user_project, current_user, {id: sha}).execute
126
        not_found! "Commit" unless result[:commit]
G
Gabor Nagy 已提交
127 128 129
        result[:commit].diffs
      end

130 131 132 133 134 135 136 137 138 139 140 141
      # 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)
142
        tree = Tree.new(user_project.repository, commit.id, path)
143 144 145 146

        trees = []

        %w(trees blobs submodules).each do |type|
147
          trees += tree.send(type).map { |t| {name: t.name, type: type.singularize, mode: t.mode, id: t.id} }
148 149 150 151 152
        end

        trees
      end

153 154 155 156 157 158 159
      # 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:
160 161
      #   GET /projects/:id/repository/blobs/:sha
      get [ ":id/repository/blobs/:sha", ":id/repository/commits/:sha/blob" ] do
162 163 164 165 166 167 168 169 170
        required_attributes! [:filepath]

        ref = params[:sha]

        repo = user_project.repository

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

171 172
        blob = Gitlab::Git::Blob.find(repo, commit.id, params[:filepath])
        not_found! "File" unless blob
173

174 175
        env['api.format'] = :txt

176 177 178
        content_type blob.mime_type
        present blob.data
      end
179 180 181 182 183

      # Get a an archive of the repository
      #
      # Parameters:
      #   id (required) - The ID of a project
184
      #   sha (optional) - the commit sha to download defaults to the tip of the default branch
185 186 187 188 189 190 191 192
      # Example Request:
      #   GET /projects/:id/repository/archive
      get ":id/repository/archive" do
        authorize! :download_code, user_project
        repo = user_project.repository
        ref = params[:sha]
        storage_path = Rails.root.join("tmp", "repositories")

193 194 195 196 197
        file_path = repo.archive_repo(ref, storage_path)
        if file_path && File.exists?(file_path)
          data = File.open(file_path, 'rb').read

          header "Content-Disposition:", " infile; filename=\"#{File.basename(file_path)}\""
198
          content_type 'application/x-gzip'
199 200 201

          env['api.format'] = :binary

202 203 204 205 206
          present data
        else
          not_found!
        end
      end
207 208 209 210
    end
  end
end