Module: Brat::Client::Repositories

Included in:
Brat::Client
Defined in:
lib/brat/client/repositories.rb

Overview

Defines methods related to repositories.

Instance Method Summary collapse

Instance Method Details

#commit(project, sha) ⇒ Brat::ObjectifiedHash Also known as: repo_commit

Gets a specific commit identified by the commit hash or name of a branch or tag.

Examples:

Brat.commit(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6')
Brat.repo_commit(3, 'ed899a2f4b50b4370feeea94676502b42383c746')



59
60
61
 
# File 'lib/brat/client/repositories.rb', line 59

def commit(project, sha)
  get("/projects/#{project}/repository/commits/#{sha}")
end

#commit_diff(project, sha) ⇒ Brat::ObjectifiedHash Also known as: repo_commit_diff

Get the diff of a commit in a project.

Examples:

Brat.commit_diff(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6')
Brat.repo_commit_diff(3, 'ed899a2f4b50b4370feeea94676502b42383c746')



73
74
75
 
# File 'lib/brat/client/repositories.rb', line 73

def commit_diff(project, sha)
  get("/projects/#{project}/repository/commits/#{sha}/diff") 
end

#commits(project, options = {}) ⇒ Array<Brat::ObjectifiedHash> Also known as: repo_commits

Gets a list of project commits.

Examples:

Brat.commits('viking')
Brat.repo_commits('brat', :ref_name => 'api')

Options Hash (options):

  • :ref_name (String) —

    The branch or tag name of a project repository.

  • :page (Integer) —

    The page number.

  • :per_page (Integer) —

    The number of results per page.



45
46
47
 
# File 'lib/brat/client/repositories.rb', line 45

def commits(project, options={})
  get("/projects/#{project}/repository/commits", :query => options)
end

#create_tag(project, tag_name, ref) ⇒ Brat::ObjectifiedHash Also known as: repo_create_tag

Creates a new project repository tag.

Examples:

Brat.create_tag(42,'new_tag','master'))



28
29
30
 
# File 'lib/brat/client/repositories.rb', line 28

def create_tag(project, tag_name, ref)
  post("/projects/#{project}/repository/tags", body: {tag_name: tag_name, ref: ref})
end

#tags(project, options = {}) ⇒ Array<Brat::ObjectifiedHash> Also known as: repo_tags

Gets a list of project repository tags.

Examples:

Brat.tags(42)

Options Hash (options):

  • :page (Integer) —

    The page number.

  • :per_page (Integer) —

    The number of results per page.



14
15
16
 
# File 'lib/brat/client/repositories.rb', line 14

def tags(project, options={})
  get("/projects/#{project}/repository/tags", :query => options)
end