module Gitlab::Client::Projects

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

Public Instance Methods

add_git_hook(id, options={}) click to toggle source

Adds a project git hook. @see docs.gitlab.com/ee/api/projects.html#add-project-git-hook

@example

Gitlab.add_git_hook(42, { deny_delete_tag: false, commit_message_regex: '\\b[A-Z]{3}-[0-9]+\\b' })

@param [Integer] id The ID of a project. @param [Hash] options A customizable set of options. @param option [Boolean] :deny_delete_tag Do not allow users to remove git tags with git push (0 = false, 1 = true) @param option [String] :commit_message_regex Commit message regex @return [Gitlab::ObjectifiedHash] Information about added git hook.

# File lib/gitlab/client/projects.rb, line 273
def add_git_hook(id, options={})
  post("/projects/#{id}/git_hook", body: options)
end
add_project_hook(project, url, options={}) click to toggle source

Adds a new hook to the project.

@example

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

@param [Integer, String] project The ID or name of a project. @param [String] url The hook URL. @param [Hash] options A customizable set of options. @param option [Boolean] :push_events Trigger hook on push events (0 = false, 1 = true) @param option [Boolean] :issues_events Trigger hook on issues events (0 = false, 1 = true) @param option [Boolean] :merge_requests_events Trigger hook on merge_requests events (0 = false, 1 = true) @param option [Boolean] :tag_push_events Trigger hook on push_tag events (0 = false, 1 = true) @return [Gitlab::ObjectifiedHash] Information about added hook.

# File lib/gitlab/client/projects.rb, line 214
def add_project_hook(project, url, options={})
  body = { url: url }.merge(options)
  post("/projects/#{project}/hooks", body: body)
end
add_team_member(project, id, access_level) click to toggle source

Adds a user to project team.

@example

Gitlab.add_team_member('gitlab', 2, 40)

@param [Integer, String] project The ID or name of a project. @param [Integer] id The ID of a user. @param [Integer] access_level The access level to project. @param [Hash] options A customizable set of options. @return [Gitlab::ObjectifiedHash] Information about added team member.

# File lib/gitlab/client/projects.rb, line 142
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) click to toggle source

Creates a new deploy key.

@example

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

@param [Integer] project The ID of a project. @param [String] title The title of a deploy key. @param [String] key The content of a deploy key. @return [Gitlab::ObjectifiedHash] Information about created deploy key.

# File lib/gitlab/client/projects.rb, line 363
def create_deploy_key(project, title, key)
  post("/projects/#{project}/keys", body: { title: title, key: key })
end
create_fork(id, options={}) click to toggle source

Forks a project into the user namespace.

@example

Gitlab.create_fork(42)
Gitlab.create_fork(42, { sudo: 'another_username' })

@param [Integer] project The ID of a project. @param [Hash] options A customizable set of options. @option options [String] :sudo The username the project will be forked for @return [Gitlab::ObjectifiedHash] Information about the forked project.

# File lib/gitlab/client/projects.rb, line 413
def create_fork(id, options={})
  post("/projects/fork/#{id}", body: options)
end
create_project(name, options={}) click to toggle source

Creates a new project.

@example

Gitlab.create_project('gitlab')
Gitlab.create_project('viking', { description: 'Awesome project' })
Gitlab.create_project('Red', { wall_enabled: false })

@param [String] name The name of a project. @param [Hash] options A customizable set of options. @option options [String] :description The description of a project. @option options [String] :default_branch The default branch of a project. @option options [String] :namespace_id The namespace in which to create a project. @option options [Boolean] :wiki_enabled The wiki integration for a project (0 = false, 1 = true). @option options [Boolean] :wall_enabled The wall functionality for a project (0 = false, 1 = true). @option options [Boolean] :issues_enabled The issues integration for a project (0 = false, 1 = true). @option options [Boolean] :snippets_enabled The snippets integration for a project (0 = false, 1 = true). @option options [Boolean] :merge_requests_enabled The merge requests functionality for a project (0 = false, 1 = true). @option options [Boolean] :public The setting for making a project public (0 = false, 1 = true). @option options [Integer] :user_id The user/owner id of a project. @return [Gitlab::ObjectifiedHash] Information about created project.

# File lib/gitlab/client/projects.rb, line 88
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) click to toggle source

Deletes a deploy key from project.

@example

Gitlab.delete_deploy_key(42, 1)

@param [Integer] project The ID of a project. @param [Integer] id The ID of a deploy key. @return [Gitlab::ObjectifiedHash] Information about deleted deploy key.

# File lib/gitlab/client/projects.rb, line 399
def delete_deploy_key(project, id)
  delete("/projects/#{project}/keys/#{id}")
end
delete_git_hook(id, options={}) click to toggle source

Deletes a git hook from a project. @see docs.gitlab.com/ee/api/projects.html#delete-project-git-hook

@example

Gitlab.delete_git_hook(42)

@param [Integer] id The ID of a project. @return [Gitlab::ObjectifiedHash] Information about deleted git hook.

# File lib/gitlab/client/projects.rb, line 300
def delete_git_hook(id, options={})
  delete("/projects/#{id}/git_hook")
end
delete_project(id) click to toggle source

Deletes a project.

@example

Gitlab.delete_project(4)

@param [Integer, String] id The ID or name of a project. @return [Gitlab::ObjectifiedHash] Information about deleted project.

# File lib/gitlab/client/projects.rb, line 100
def delete_project(id)
  delete("/projects/#{id}")
end
delete_project_hook(project, id) click to toggle source

Deletes a hook from project.

@example

Gitlab.delete_project_hook('gitlab', 4)

@param [Integer, String] project The ID or name of a project. @param [String] id The ID of the hook. @return [Gitlab::ObjectifiedHash] Information about deleted hook.

# File lib/gitlab/client/projects.rb, line 246
def delete_project_hook(project, id)
  delete("/projects/#{project}/hooks/#{id}")
end
deploy_key(project, id) click to toggle source

Gets a single project deploy key.

@example

Gitlab.deploy_key(42, 1)

@param [Integer, String] project The ID of a project. @param [Integer] id The ID of a deploy key. @return [Gitlab::ObjectifiedHash]

# File lib/gitlab/client/projects.rb, line 350
def deploy_key(project, id)
  get("/projects/#{project}/keys/#{id}")
end
deploy_keys(project, options={}) click to toggle source

Gets a project deploy keys.

@example

Gitlab.deploy_keys(42)

@param [Integer] project The ID of a project. @param [Hash] options A customizable set of options. @option options [Integer] :page The page number. @option options [Integer] :per_page The number of results per page. @return [Array<Gitlab::ObjectifiedHash>]

# File lib/gitlab/client/projects.rb, line 338
def deploy_keys(project, options={})
  get("/projects/#{project}/keys", query: options)
end
disable_deploy_key(project, key) click to toggle source

Disables a deploy key at the project.

@example

Gitlab.disable_deploy_key(42, 66)

@param [Integer] project The ID of a project. @param [Integer] key The ID of a deploy key. @return [Gitlab::ObjectifiedHash] Information about the disabled deploy key.

# File lib/gitlab/client/projects.rb, line 387
def disable_deploy_key(project, key)
  post("/projects/#{project}/deploy_keys/#{key}/disable", body: { id: project, key_id: key })
end
edit_git_hook(id, options={}) click to toggle source

Updates a project git hook. @see docs.gitlab.com/ee/api/projects.html#edit-project-git-hook

@example

Gitlab.edit_git_hook(42, { deny_delete_tag: false, commit_message_regex: '\\b[A-Z]{3}-[0-9]+\\b' })

@param [Integer] id The ID of a project. @param [Hash] options A customizable set of options. @param option [Boolean] :deny_delete_tag Do not allow users to remove git tags with git push (0 = false, 1 = true) @param option [String] :commit_message_regex Commit message regex @return [Gitlab::ObjectifiedHash] Information about updated git hook.

# File lib/gitlab/client/projects.rb, line 288
def edit_git_hook(id, options={})
  put("/projects/#{id}/git_hook", body: options)
end
edit_project(id, options={}) click to toggle source

Updates an existing project.

@example

Gitlab.edit_project(42)
Gitlab.edit_project(42, { name: 'project_name' })

@param [Integer] project The ID of a project. @param [Hash] options A customizable set of options. @option options [String] :name The name of a project @option options [String] :path The name of a project @option options [String] :description The name of a project @return [Gitlab::ObjectifiedHash] Information about the edited project.

# File lib/gitlab/client/projects.rb, line 429
def edit_project(id, options={})
  put("/projects/#{id}", query: options)
end
edit_project_hook(project, id, url, options={}) click to toggle source

Updates a project hook URL.

@example

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

@param [Integer, String] project The ID or name of a project. @param [Integer] id The ID of the hook. @param [String] url The hook URL. @param [Hash] options A customizable set of options. @param option [Boolean] :push_events Trigger hook on push events (0 = false, 1 = true) @param option [Boolean] :issues_events Trigger hook on issues events (0 = false, 1 = true) @param option [Boolean] :merge_requests_events Trigger hook on merge_requests events (0 = false, 1 = true) @param option [Boolean] :tag_push_events Trigger hook on push_tag events (0 = false, 1 = true) @return [Gitlab::ObjectifiedHash] Information about updated hook.

# File lib/gitlab/client/projects.rb, line 233
def edit_project_hook(project, id, url, options={})
  body = { url: url }.merge(options)
  put("/projects/#{project}/hooks/#{id}", body: body)
end
edit_team_member(project, id, access_level) click to toggle source

Updates a team member's project access level.

@example

Gitlab.edit_team_member('gitlab', 3, 20)

@param [Integer, String] project The ID or name of a project. @param [Integer] id The ID of a user. @param [Integer] access_level The access level to project. @param [Hash] options A customizable set of options. @return [Array<Gitlab::ObjectifiedHash>] Information about updated team member.

# File lib/gitlab/client/projects.rb, line 156
def edit_team_member(project, id, access_level)
  put("/projects/#{project}/members/#{id}", body: { access_level: access_level })
end
enable_deploy_key(project, key) click to toggle source

Enables a deploy key at the project.

@example

Gitlab.enable_deploy_key(42, 66)

@param [Integer] project The ID of a project. @param [Integer] key The ID of a deploy key. @return [Gitlab::ObjectifiedHash] Information about the enabled deploy key.

# File lib/gitlab/client/projects.rb, line 375
def enable_deploy_key(project, key)
  post("/projects/#{project}/deploy_keys/#{key}/enable", body: { id: project, key_id: key })
end
git_hook(id) click to toggle source

Gets a project git hook. @see docs.gitlab.com/ee/api/projects.html#show-project-git-hooks

@example

Gitlab.git_hook(42)

@param [Integer] id The ID of a project. @return [Gitlab::ObjectifiedHash]

# File lib/gitlab/client/projects.rb, line 258
def git_hook(id)
  get("/projects/#{id}/git_hook")
end
make_forked_from(project, id) click to toggle source

Mark this project as forked from the other

@example

Gitlab.make_forked(42, 24)

@param [Integer, String] project The ID or name of a project. @param [Integer] id The ID of the project it is forked from. @return [Gitlab::ObjectifiedHash] Information about the forked project.

# File lib/gitlab/client/projects.rb, line 312
def make_forked_from(project, id)
  post("/projects/#{project}/fork/#{id}")
end
project(id) click to toggle source

Gets information about a project.

@example

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

@param [Integer, String] id The ID or name of a project. @return [Gitlab::ObjectifiedHash]

# File lib/gitlab/client/projects.rb, line 49
def project(id)
  get("/projects/#{id}")
end
project_events(project, options={}) click to toggle source

Gets a list of project events.

@example

Gitlab.project_events(42)
Gitlab.project_events('gitlab')

@param [Integer, String] project The ID or name of a project. @param [Hash] options A customizable set of options. @option options [Integer] :page The page number. @option options [Integer] :per_page The number of results per page. @return [Array<Gitlab::ObjectifiedHash>]

# File lib/gitlab/client/projects.rb, line 64
def project_events(project, options={})
  get("/projects/#{project}/events", query: options)
end
project_hook(project, id) click to toggle source

Gets a project hook.

@example

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

@param [Integer, String] project The ID or name of a project. @param [Integer] id The ID of a hook. @return [Gitlab::ObjectifiedHash]

# File lib/gitlab/client/projects.rb, line 197
def project_hook(project, id)
  get("/projects/#{project}/hooks/#{id}")
end
project_hooks(project, options={}) click to toggle source

Gets a list of project hooks.

@example

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

@param [Integer, String] project The ID or name of a project. @param [Hash] options A customizable set of options. @option options [Integer] :page The page number. @option options [Integer] :per_page The number of results per page. @return [Array<Gitlab::ObjectifiedHash>]

# File lib/gitlab/client/projects.rb, line 184
def project_hooks(project, options={})
  get("/projects/#{project}/hooks", query: options)
end
projects(options={}) click to toggle source

Gets a list of projects owned by the authenticated user.

@example

Gitlab.projects

@param [Hash] options A customizable set of options. @option options [Integer] :page The page number. @option options [Integer] :per_page The number of results per page. @option options [String] :scope Scope of projects. 'owned' for list of projects owned by the authenticated user, 'all' to get all projects (admin only) @return [Array<Gitlab::ObjectifiedHash>]

# File lib/gitlab/client/projects.rb, line 15
def projects(options={})
  if options[:scope]
    get("/projects/#{options[:scope]}", query: options)
  else
    get("/projects", query: options)
  end
end
remove_forked(project) click to toggle source

Remove a forked_from relationship for a project.

@example

Gitlab.remove_forked(42)

@param [Integer, String] project The ID or name of a project. @param [Integer] project The ID of the project it is forked from @return [Gitlab::ObjectifiedHash] Information about the forked project.

# File lib/gitlab/client/projects.rb, line 324
def remove_forked(project)
  delete("/projects/#{project}/fork")
end
remove_team_member(project, id) click to toggle source

Removes a user from project team.

@example

Gitlab.remove_team_member('gitlab', 2)

@param [Integer, String] project The ID or name of a project. @param [Integer] id The ID of a user. @param [Hash] options A customizable set of options. @return [Gitlab::ObjectifiedHash] Information about removed team member.

# File lib/gitlab/client/projects.rb, line 169
def remove_team_member(project, id)
  delete("/projects/#{project}/members/#{id}")
end
search_projects(query, options={})
Alias for: project_search
share_project_with_group(project, id, group_access) click to toggle source

Share project with group.

@example

Gitlab.share_project_with_group('gitlab', 2, 40)

@param [Integer, String] project The ID or name of a project. @param [Integer] id The ID of a group. @param [Integer] group_access The access level to project.

# File lib/gitlab/client/projects.rb, line 441
def share_project_with_group(project, id, group_access)
  post("/projects/#{project}/share", body: { group_id: id, group_access: group_access })
end
star_project(id) click to toggle source

Stars a project. @see docs.gitlab.com/ce/api/projects.html#star-a-project

@example

Gitlab.star_project(42)
Gitlab.star_project('gitlab-org/gitlab-ce')

@param [Integer, String] id The ID or name of a project. @return [Gitlab::ObjectifiedHash] Information about starred project.

# File lib/gitlab/client/projects.rb, line 454
def star_project(id)
  post("/projects/#{id}/star")
end
team_member(project, id) click to toggle source

Gets a project team member.

@example

Gitlab.team_member('gitlab', 2)

@param [Integer, String] project The ID or name of a project. @param [Integer] id The ID of a project team member. @return [Gitlab::ObjectifiedHash]

# File lib/gitlab/client/projects.rb, line 128
def team_member(project, id)
  get("/projects/#{project}/members/#{id}")
end
team_members(project, options={}) click to toggle source

Gets a list of project team members.

@example

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

@param [Integer, String] project The ID or name of a project. @param [Hash] options A customizable set of options. @option options [String] :query The search query. @option options [Integer] :page The page number. @option options [Integer] :per_page The number of results per page. @return [Array<Gitlab::ObjectifiedHash>]

# File lib/gitlab/client/projects.rb, line 116
def team_members(project, options={})
  get("/projects/#{project}/members", query: options)
end
unstar_project(id) click to toggle source

Unstars a project. @see docs.gitlab.com/ce/api/projects.html#unstar-a-project

@example

Gitlab.unstar_project(42)
Gitlab.unstar_project('gitlab-org/gitlab-ce')

@param [Integer, String] id The ID or name of a project. @return [Gitlab::ObjectifiedHash] Information about unstarred project.

# File lib/gitlab/client/projects.rb, line 467
def unstar_project(id)
  delete("/projects/#{id}/star")
end