module Gitlab::Client::Repositories

Defines methods related to repositories. @see docs.gitlab.com/ce/api/repositories.html

Public Instance Methods

compare(project, from, to) click to toggle source

Compares branches, tags or commits.

@example

Gitlab.compare(42, 'master', 'feature/branch')
Gitlab.repo_compare(42, 'master', 'feature/branch')

@param [Integer] project The ID of a project. @param [String] from The commit SHA or branch name of from branch. @param [String] to The commit SHA or branch name of to branch. @return [Gitlab::ObjectifiedHash]

# File lib/gitlab/client/repositories.rb, line 73
def compare(project, from, to)
  get("/projects/#{project}/repository/compare", query: { from: from, to: to })
end
Also aliased as: repo_compare
file_contents(project, filepath, ref='master') click to toggle source

Get the contents of a file

@example

Gitlab.file_contents(42, 'Gemfile')
Gitlab.repo_file_contents(3, 'Gemfile', 'ed899a2f4b50b4370feeea94676502b42383c746')

@param [Integer] project The ID of a project. @param [String] filepath The relative path of the file in the repository @param [String] ref The name of a repository branch or tag or if not given the default branch. @return [String]

# File lib/gitlab/client/repositories.rb, line 15
def file_contents(project, filepath, ref='master')
  ref = URI.encode(ref, /\W/)
  get "/projects/#{project}/repository/blobs/#{ref}?filepath=#{filepath}",
      format: nil,
      headers: { Accept: 'text/plain' },
      parser: ::Gitlab::Request::Parser
end
Also aliased as: repo_file_contents
repo_archive(project, ref = 'master') click to toggle source

Get project repository archive

@example

Gitlab.repo_archive(42)
Gitlab.repo_archive(42, 'deadbeef')

@param [Integer] project The ID of a project. @param [String] ref The commit sha, branch, or tag to download. @return [Gitlab::FileResponse]

# File lib/gitlab/client/repositories.rb, line 49
def repo_archive(project, ref = 'master')
  get("/projects/#{project}/repository/archive",
      format: nil,
      headers: { Accept: 'application/octet-stream' },
      query: { sha: ref },
      parser: proc { |body, _|
        if body.encoding == Encoding::ASCII_8BIT # binary response
          ::Gitlab::FileResponse.new StringIO.new(body, 'rb+')
        else # error with json response
          ::Gitlab::Request.parse(body)
        end
      })
end
repo_compare(project, from, to)
Alias for: compare
repo_file_contents(project, filepath, ref='master')
Alias for: file_contents
repo_tree(project, options={})
Alias for: tree
tree(project, options={}) click to toggle source

Get file tree project (root level).

@example

Gitlab.tree(42)
Gitlab.tree(42, { path: 'Gemfile' })

@param [Integer] project The ID of a project. @param [Hash] options A customizable set of options. @option options [String] :path The path inside repository. @option options [String] :ref_name The name of a repository branch or tag. @return [Gitlab::ObjectifiedHash]

# File lib/gitlab/client/repositories.rb, line 35
def tree(project, options={})
  get("/projects/#{project}/repository/tree", query: options)
end
Also aliased as: repo_tree