Module: Gitlab::Client::Projects

Included in:
Gitlab::Client
Defined in:
lib/gitlab/client/projects.rb

Overview

Defines methods related to projects.

Instance Method Summary collapse

Instance Method Details

#add_project_hook(project, url) ⇒ Gitlab::ObjectifiedHash

Adds a new hook to the project.

Examples:

Gitlab.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.

Returns:



158
159
160
 
# File 'lib/gitlab/client/projects.rb', line 158

def add_project_hook(project, url)
  post("/projects/#{project}/hooks", :body => {:url => url})
end

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

Adds a user to project team.

Examples:

Gitlab.add_team_member('gitlab', 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:



91
92
93
 
# File 'lib/gitlab/client/projects.rb', line 91

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) ⇒ Gitlab::ObjectifiedHash

Creates a new deploy key.

Examples:

Gitlab.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:



246
247
248
 
# File 'lib/gitlab/client/projects.rb', line 246

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

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

Creates a new project.

Examples:

Gitlab.create_project('gitlab')
Gitlab.create_project('viking', :description => 'Awesome project')
Gitlab.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:



48
49
50
51
 
# File 'lib/gitlab/client/projects.rb', line 48

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) ⇒ Gitlab::ObjectifiedHash

Deletes a deploy key from project.

Examples:

Gitlab.delete_deploy_key(42, 1)

Parameters:

  • project (Integer) —

    The ID of a project.

  • id (Integer) —

    The ID of a deploy key.

Returns:



258
259
260
 
# File 'lib/gitlab/client/projects.rb', line 258

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

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

Deletes a hook from project.

Examples:

Gitlab.delete_project_hook('gitlab', 4)

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • id (String) —

    The ID of the hook.

Returns:



183
184
185
 
# File 'lib/gitlab/client/projects.rb', line 183

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

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

Gets a single project deploy key.

Examples:

Gitlab.deploy_key(42, 1)

Parameters:

  • project (Integer, String) —

    The ID of a project.

  • id (Integer) —

    The ID of a deploy key.

Returns:



233
234
235
 
# File 'lib/gitlab/client/projects.rb', line 233

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

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

Gets a project deploy keys.

Examples:

Gitlab.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:



221
222
223
 
# File 'lib/gitlab/client/projects.rb', line 221

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

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

Updates a project hook URL.

Examples:

Gitlab.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:



171
172
173
 
# File 'lib/gitlab/client/projects.rb', line 171

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

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

Updates a team member’s project access level.

Examples:

Gitlab.edit_team_member('gitlab', 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:



105
106
107
 
# File 'lib/gitlab/client/projects.rb', line 105

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

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

Mark this project as forked from the other

Examples:

Gitlab.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:



195
196
197
 
# File 'lib/gitlab/client/projects.rb', line 195

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

#project(id) ⇒ Gitlab::ObjectifiedHash

Gets information about a project.

Examples:

Gitlab.project(3)
Gitlab.project('gitlab')

Parameters:

  • id (Integer, String) —

    The ID or name of a project.

Returns:



25
26
27
 
# File 'lib/gitlab/client/projects.rb', line 25

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

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

Gets a project hook.

Examples:

Gitlab.project_hook(42, 5)
Gitlab.project_hook('gitlab', 5)

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • id (Integer) —

    The ID of a hook.

Returns:



146
147
148
 
# File 'lib/gitlab/client/projects.rb', line 146

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

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

Gets a list of project hooks.

Examples:

Gitlab.project_hooks(42)
Gitlab.project_hooks('gitlab')

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:



133
134
135
 
# File 'lib/gitlab/client/projects.rb', line 133

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

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

Gets a list of projects owned by the authenticated user.

Examples:

Gitlab.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.

Returns:



13
14
15
 
# File 'lib/gitlab/client/projects.rb', line 13

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

#remove_forked(project) ⇒ Gitlab::ObjectifiedHash

Remove a forked_from relationship for a project.

Examples:

Gitlab.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:



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

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

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

Removes a user from project team.

Examples:

Gitlab.remove_team_member('gitlab', 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:



118
119
120
 
# File 'lib/gitlab/client/projects.rb', line 118

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

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

Gets a project team member.

Examples:

Gitlab.team_member('gitlab', 2)

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • id (Integer) —

    The ID of a project team member.

Returns:



77
78
79
 
# File 'lib/gitlab/client/projects.rb', line 77

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

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

Gets a list of project team members.

Examples:

Gitlab.team_members(42)
Gitlab.team_members('gitlab')

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:



65
66
67
 
# File 'lib/gitlab/client/projects.rb', line 65

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