Module: Brat::Client::Projects

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

Overview

Defines methods related to projects.

Instance Method Summary collapse

Instance Method Details

#add_project_hook(project, url, options = {}) ⇒ Brat::ObjectifiedHash

Adds a new hook to the project.

Examples:

Brat.add_project_hook(42, 'https://api.example.net/v1/webhooks/ci')

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • url (String) —

    The hook URL.

  • options (Hash) (defaults to: {}) —

    Events list (‘true, merge_requests_events: false`).

Returns:



190
191
192
193
194
195
196
 
# File 'lib/brat/client/projects.rb', line 190

def add_project_hook(project, url, options = {})
  available_events = [:push_events, :merge_requests_events, :issues_events]
  passed_events = available_events.select { |event| options[event] }
  events = Hash[passed_events.map { |event| [event, options[event]] }]

  post("/projects/#{project}/hooks", :body => {:url => url}.merge(events))
end

#add_team_member(project, id, access_level) ⇒ Brat::ObjectifiedHash

Adds a user to project team.

Examples:

Brat.add_team_member('brat', 2, 40)

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • id (Integer) —

    The ID of a user.

  • access_level (Integer) —

    The access level to project.

  • options (Hash) —

    A customizable set of options.

Returns:



122
123
124
 
# File 'lib/brat/client/projects.rb', line 122

def add_team_member(project, id, access_level)
  post("/projects/#{project}/members", :body => {:user_id => id, :access_level => access_level})
end

#create_deploy_key(project, title, key) ⇒ Brat::ObjectifiedHash

Creates a new deploy key.

Examples:

Brat.create_deploy_key(42, 'My Key', 'Key contents')

Parameters:

  • project (Integer) —

    The ID of a project.

  • title (String) —

    The title of a deploy key.

  • key (String) —

    The content of a deploy key.

Returns:



282
283
284
 
# File 'lib/brat/client/projects.rb', line 282

def create_deploy_key(project, title, key)
  post("/projects/#{project}/keys", body: {title: title, key: key})
end

#create_project(name, options = {}) ⇒ Brat::ObjectifiedHash

Creates a new project.

Examples:

Brat.create_project('brat')
Brat.create_project('viking', :description => 'Awesome project')
Brat.create_project('Red', :wall_enabled => false)

Parameters:

  • name (String) —

    The name of a project.

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Options Hash (options):

  • :description (String) —

    The description of a project.

  • :default_branch (String) —

    The default branch of a project.

  • :wiki_enabled (Boolean) —

    The wiki integration for a project (0 = false, 1 = true).

  • :wall_enabled (Boolean) —

    The wall functionality for a project (0 = false, 1 = true).

  • :issues_enabled (Boolean) —

    The issues integration for a project (0 = false, 1 = true).

  • :snippets_enabled (Boolean) —

    The snippets integration for a project (0 = false, 1 = true).

  • :merge_requests_enabled (Boolean) —

    The merge requests functionality for a project (0 = false, 1 = true).

  • :public (Boolean) —

    The setting for making a project public (0 = false, 1 = true).

  • :user_id (Integer) —

    The user/owner id of a project.

Returns:



68
69
70
71
 
# File 'lib/brat/client/projects.rb', line 68

def create_project(name, options={})
  url = options[:user_id] ? "/projects/user/#{options[:user_id]}" : "/projects"
  post(url, :body => {:name => name}.merge(options))
end

#delete_deploy_key(project, id) ⇒ Brat::ObjectifiedHash

Deletes a deploy key from project.

Examples:

Brat.delete_deploy_key(42, 1)

Parameters:

  • project (Integer) —

    The ID of a project.

  • id (Integer) —

    The ID of a deploy key.

Returns:



294
295
296
 
# File 'lib/brat/client/projects.rb', line 294

def delete_deploy_key(project, id)
  delete("/projects/#{project}/keys/#{id}")
end

#delete_project(id) ⇒ Brat::ObjectifiedHash

Deletes a project.

Examples:

Brat.delete_project(4)

Parameters:

  • id (Integer, String) —

    The ID or name of a project.

Returns:



80
81
82
 
# File 'lib/brat/client/projects.rb', line 80

def delete_project(id)
  delete("/projects/#{id}")
end

#delete_project_hook(project, id) ⇒ Brat::ObjectifiedHash

Deletes a hook from project.

Examples:

Brat.delete_project_hook('brat', 4)

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • id (String) —

    The ID of the hook.

Returns:



219
220
221
 
# File 'lib/brat/client/projects.rb', line 219

def delete_project_hook(project, id)
  delete("/projects/#{project}/hooks/#{id}")
end

#deploy_key(project, id) ⇒ Brat::ObjectifiedHash

Gets a single project deploy key.

Examples:

Brat.deploy_key(42, 1)

Parameters:

  • project (Integer, String) —

    The ID of a project.

  • id (Integer) —

    The ID of a deploy key.

Returns:



269
270
271
 
# File 'lib/brat/client/projects.rb', line 269

def deploy_key(project, id)
  get("/projects/#{project}/keys/#{id}")
end

#deploy_keys(project, options = {}) ⇒ Array<Brat::ObjectifiedHash>

Gets a project deploy keys.

Examples:

Brat.deploy_keys(42)

Parameters:

  • project (Integer) —

    The ID of a project.

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Options Hash (options):

  • :page (Integer) —

    The page number.

  • :per_page (Integer) —

    The number of results per page.

Returns:



257
258
259
 
# File 'lib/brat/client/projects.rb', line 257

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

#edit_project_hook(project, id, url) ⇒ Brat::ObjectifiedHash

Updates a project hook URL.

Examples:

Brat.edit_project_hook(42, 1, 'https://api.example.net/v1/webhooks/ci')

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • id (Integer) —

    The ID of the hook.

  • url (String) —

    The hook URL.

Returns:



207
208
209
 
# File 'lib/brat/client/projects.rb', line 207

def edit_project_hook(project, id, url)
  put("/projects/#{project}/hooks/#{id}", :body => {:url => url})
end

#edit_team_member(project, id, access_level) ⇒ Array<Brat::ObjectifiedHash>

Updates a team member’s project access level.

Examples:

Brat.edit_team_member('brat', 3, 20)

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • id (Integer) —

    The ID of a user.

  • access_level (Integer) —

    The access level to project.

  • options (Hash) —

    A customizable set of options.

Returns:



136
137
138
 
# File 'lib/brat/client/projects.rb', line 136

def edit_team_member(project, id, access_level)
  put("/projects/#{project}/members/#{id}", :body => {:access_level => access_level})
end

#make_forked_from(project, id) ⇒ Brat::ObjectifiedHash

Mark this project as forked from the other

Examples:

Brat.make_forked(42, 24)

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • id (Integer) —

    The ID of the project it is forked from.

Returns:



231
232
233
 
# File 'lib/brat/client/projects.rb', line 231

def make_forked_from(project, id)
  post("/projects/#{project}/fork/#{id}")
end

#project(id) ⇒ Brat::ObjectifiedHash

Gets information about a project.

Examples:

Brat.project(3)
Brat.project('brat')

Parameters:

  • id (Integer, String) —

    The ID or name of a project.

Returns:



30
31
32
 
# File 'lib/brat/client/projects.rb', line 30

def project(id)
  get("/projects/#{id}")
end

#project_events(project, options = {}) ⇒ Array<Brat::ObjectifiedHash>

Gets a list of project events.

Examples:

Brat.project_events(42)
Brat.project_events('brat')

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Options Hash (options):

  • :page (Integer) —

    The page number.

  • :per_page (Integer) —

    The number of results per page.

Returns:



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

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

#project_hook(project, id) ⇒ Brat::ObjectifiedHash

Gets a project hook.

Examples:

Brat.project_hook(42, 5)
Brat.project_hook('brat', 5)

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • id (Integer) —

    The ID of a hook.

Returns:



177
178
179
 
# File 'lib/brat/client/projects.rb', line 177

def project_hook(project, id)
  get("/projects/#{project}/hooks/#{id}")
end

#project_hooks(project, options = {}) ⇒ Array<Brat::ObjectifiedHash>

Gets a list of project hooks.

Examples:

Brat.project_hooks(42)
Brat.project_hooks('brat')

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Options Hash (options):

  • :page (Integer) —

    The page number.

  • :per_page (Integer) —

    The number of results per page.

Returns:



164
165
166
 
# File 'lib/brat/client/projects.rb', line 164

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

#projects(options = {}) ⇒ Array<Brat::ObjectifiedHash>

Gets a list of projects owned by the authenticated user.

Examples:

Brat.projects

Parameters:

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Options Hash (options):

  • :page (Integer) —

    The page number.

  • :per_page (Integer) —

    The number of results per page.

  • :scope (String) —

    Scope of projects. ‘owned’ for list of projects owned by the authenticated user, ‘all’ to get all projects (admin only)

Returns:



14
15
16
17
18
19
20
 
# File 'lib/brat/client/projects.rb', line 14

def projects(options={})
  if (options[:scope])
    get("/projects/#{options[:scope]}", :query => options)
  else
    get("/projects", :query => options)
  end
end

#remove_forked(project) ⇒ Brat::ObjectifiedHash

Remove a forked_from relationship for a project.

Examples:

Brat.remove_forked(42)

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • project (Integer) —

    The ID of the project it is forked from

Returns:



243
244
245
 
# File 'lib/brat/client/projects.rb', line 243

def remove_forked(project)
  delete("/projects/#{project}/fork")
end

#remove_team_member(project, id) ⇒ Brat::ObjectifiedHash

Removes a user from project team.

Examples:

Brat.remove_team_member('brat', 2)

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • id (Integer) —

    The ID of a user.

  • options (Hash) —

    A customizable set of options.

Returns:



149
150
151
 
# File 'lib/brat/client/projects.rb', line 149

def remove_team_member(project, id)
  delete("/projects/#{project}/members/#{id}")
end

#team_member(project, id) ⇒ Brat::ObjectifiedHash

Gets a project team member.

Examples:

Brat.team_member('brat', 2)

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • id (Integer) —

    The ID of a project team member.

Returns:



108
109
110
 
# File 'lib/brat/client/projects.rb', line 108

def team_member(project, id)
  get("/projects/#{project}/members/#{id}")
end

#team_members(project, options = {}) ⇒ Array<Brat::ObjectifiedHash>

Gets a list of project team members.

Examples:

Brat.team_members(42)
Brat.team_members('brat')

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Options Hash (options):

  • :query (String) —

    The search query.

  • :page (Integer) —

    The page number.

  • :per_page (Integer) —

    The number of results per page.

Returns:



96
97
98
 
# File 'lib/brat/client/projects.rb', line 96

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