Module: Gitlab::Client::Projects

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

Overview

Defines methods related to projects.

See Also:

Instance Method Summary collapse

Instance Method Details

#add_project_custom_attribute(key, value, project_id) ⇒ Gitlab::ObjectifiedHash

Creates a new custom_attribute

Examples:

Gitlab.add_custom_attribute('some_new_key', 'some_new_value', 2)

Parameters:

  • key (String) —

    The custom_attributes key

  • value (String) —

    The custom_attributes value

  • project_id (Integer) —

    The ID of a project.

Returns:



679
680
681
682
 
# File 'lib/gitlab/client/projects.rb', line 679

def add_project_custom_attribute(key, value, project_id)
  url = "/projects/#{project_id}/custom_attributes/#{key}"
  put(url, body: { value: value })
end

#add_project_hook(project, url, options = {}) ⇒ 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 path of a project.

  • url (String) —

    The hook URL.

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

    A customizable set of options.

  • option (Boolean) —

    :push_events Trigger hook on push events (0 = false, 1 = true)

  • option (Boolean) —

    :issues_events Trigger hook on issues events (0 = false, 1 = true)

  • option (Boolean) —

    :merge_requests_events Trigger hook on merge_requests events (0 = false, 1 = true)

  • option (Boolean) —

    :tag_push_events Trigger hook on push_tag events (0 = false, 1 = true)

Returns:



224
225
226
227
 
# File 'lib/gitlab/client/projects.rb', line 224

def add_project_hook(project, url, options = {})
  body = { url: url }.merge(options)
  post("/projects/#{url_encode project}/hooks", body: body)
end

#add_push_rule(id, options = {}) ⇒ Gitlab::ObjectifiedHash

Adds a project push rule.

Examples:

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

Parameters:

  • id (Integer) —

    The ID of a project.

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

    A customizable set of options.

  • option (Boolean) —

    :deny_delete_tag Do not allow users to remove git tags with git push (0 = false, 1 = true)

  • option (String) —

    :commit_message_regex Commit message regex

Returns:

See Also:



283
284
285
 
# File 'lib/gitlab/client/projects.rb', line 283

def add_push_rule(id, options = {})
  post("/projects/#{url_encode id}/push_rule", body: options)
end

#add_team_member(project, id, access_level, options = {}) ⇒ Gitlab::ObjectifiedHash

Adds a user to project team.

Examples:

Gitlab.add_team_member('gitlab', 2, 40)
Gitlab.add_team_member('gitlab', 2, 40, { expires_at: "2018-12-31"})

Parameters:

  • project (Integer, String) —

    The ID or path of a project.

  • id (Integer) —

    The ID of a user.

  • access_level (Integer) —

    The access level to project.

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

    A customizable set of options.

Options Hash (options):

  • :expires_at (String) —

    A date string in the format YEAR-MONTH-DAY.

Returns:



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

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

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

Gets a list of all project team members including inherited members.

Examples:

Gitlab.all_members(42)
Gitlab.all_members('gitlab')

Parameters:

  • project (Integer, String) —

    The ID or path 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:



120
121
122
 
# File 'lib/gitlab/client/projects.rb', line 120

def all_members(project, options = {})
  get("/projects/#{url_encode project}/members/all", query: options)
end

#archive_project(id) ⇒ Gitlab::ObjectifiedHash

Archives a project.

Examples:

Gitlab.archive_project(4)

Parameters:

  • id (Integer, String) —

    The ID or path of a project.

Returns:



632
633
634
 
# File 'lib/gitlab/client/projects.rb', line 632

def archive_project(id)
  post("/projects/#{url_encode id}/archive")
end

#create_deploy_key(project, title, key, options = {}) ⇒ Gitlab::ObjectifiedHash

Creates a new deploy key.

Examples:

Gitlab.create_deploy_key(42, 'My Key', 'Key contents', can_push: true)

Parameters:

  • project (Integer, String) —

    The ID or path of a project.

  • title (String) —

    The title of a deploy key.

  • key (String) —

    The content of a deploy key.

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

    A customizable set of options.

Returns:



374
375
376
 
# File 'lib/gitlab/client/projects.rb', line 374

def create_deploy_key(project, title, key, options = {})
  post("/projects/#{url_encode project}/deploy_keys", body: { title: title, key: key }.merge(options))
end

#create_fork(id, options = {}) ⇒ Gitlab::ObjectifiedHash

Forks a project into the user namespace.

Examples:

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

Parameters:

  • project (Integer, String) —

    The ID or path of a project.

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

    A customizable set of options.

Options Hash (options):

  • :sudo (String) —

    The username the project will be forked for

Returns:



438
439
440
 
# File 'lib/gitlab/client/projects.rb', line 438

def create_fork(id, options = {})
  post("/projects/#{url_encode id}/fork", body: options)
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.

  • :path (String) —

    Repository name for new project. (Default is lowercase name with dashes)

  • :namespace_id (String) —

    The namespace in which to create 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).

  • :visibility (String) —

    The setting for making a project public (‘private’, ‘internal’, ‘public’).

  • :user_id (Integer) —

    The user/owner id of a project.

Returns:



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

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

#create_project_access_token(project, name, scopes, expires_at, options = {}) ⇒ Gitlab::ObjectifiedHash

Creates a new project access token.

Examples:

Gitlab.create_project_access_token(42, 'My Token', ['api'], '2024-12-12', access_level: 40)

Parameters:

  • project (Integer, String) —

    The ID or path of a project.

  • name (String) —

    The name of the project access token.

  • scopes (Array) —

    List of scopes of the project access token.

  • expires_at (String) —

    A date string in the format YYYY-MM-DD.

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

    a customizable set of options

Options Hash (options):

  • :access_level (Integer) —

    Access level. Optional. Defaults to 40.

Returns:



757
758
759
 
# File 'lib/gitlab/client/projects.rb', line 757

def create_project_access_token(project, name, scopes, expires_at, options = {})
  post("/projects/#{url_encode project}/access_tokens", body: { name: name, scopes: scopes, expires_at: expires_at }.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, String) —

    The ID or path of a project.

  • id (Integer) —

    The ID of a deploy key.

Returns:



424
425
426
 
# File 'lib/gitlab/client/projects.rb', line 424

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

#delete_project(id) ⇒ Gitlab::ObjectifiedHash

Deletes a project.

Examples:

Gitlab.delete_project(4)

Parameters:

  • id (Integer, String) —

    The ID or path of a project.

Returns:



88
89
90
 
# File 'lib/gitlab/client/projects.rb', line 88

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

#delete_project_custom_attribute(key, project_id = nil) ⇒ Boolean

Delete custom_attribute Will delete a custom_attribute

Examples:

Gitlab.delete_project_custom_attribute('somekey', 2)

Parameters:

  • key (String) —

    The custom_attribute key to delete

  • project_id (Integer) (defaults to: nil) —

    The ID of a project.

Returns:

  • (Boolean) 


693
694
695
 
# File 'lib/gitlab/client/projects.rb', line 693

def delete_project_custom_attribute(key, project_id = nil)
  delete("/projects/#{project_id}/custom_attributes/#{key}")
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 path of a project.

  • id (String) —

    The ID of the hook.

Returns:



256
257
258
 
# File 'lib/gitlab/client/projects.rb', line 256

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

#delete_push_rule(id) ⇒ Gitlab::ObjectifiedHash

Deletes a push rule from a project.

Examples:

Gitlab.delete_push_rule(42)

Parameters:

  • id (Integer) —

    The ID of a project.

Returns:

See Also:



310
311
312
 
# File 'lib/gitlab/client/projects.rb', line 310

def delete_push_rule(id)
  delete("/projects/#{url_encode id}/push_rule")
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 or path of a project.

  • id (Integer) —

    The ID of a deploy key.

Returns:



360
361
362
 
# File 'lib/gitlab/client/projects.rb', line 360

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

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

Gets a project deploy keys.

Examples:

Gitlab.deploy_keys(42)

Parameters:

  • project (Integer, String) —

    The ID or path 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:



348
349
350
 
# File 'lib/gitlab/client/projects.rb', line 348

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

#disable_deploy_key(project, key) ⇒ Gitlab::ObjectifiedHash

Disables a deploy key at the project.

Examples:

Gitlab.disable_deploy_key(42, 66)

Parameters:

  • project (Integer, String) —

    The ID or path of a project.

  • key (Integer) —

    The ID of a deploy key.

Returns:



398
399
400
 
# File 'lib/gitlab/client/projects.rb', line 398

def disable_deploy_key(project, key)
  post("/projects/#{url_encode project}/deploy_keys/#{key}/disable", body: { id: project, key_id: key })
end

#edit_deploy_key(project, id, title, options = {}) ⇒ Gitlab::ObjectifiedHash

Updates an existing deploy key.

Examples:

Gitlab.edit_deploy_key(42, 66, 'New key name', can_push: false)

Parameters:

  • project (Integer, String) —

    The ID or path of a project.

  • id (Integer) —

    The ID of a deploy key.

  • title (String) —

    The title of a deploy key.

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

    A customizable set of options.

Returns:



412
413
414
 
# File 'lib/gitlab/client/projects.rb', line 412

def edit_deploy_key(project, id, title, options = {})
  put("/projects/#{url_encode project}/deploy_keys/#{id}", body: { title: title }.merge(options))
end

#edit_project(id, options = {}) ⇒ Gitlab::ObjectifiedHash

Updates an existing project.

(Any provided options will be passed to Gitlab. See Gitlab docs for all valid options)

Examples:

Gitlab.edit_project(42)
Gitlab.edit_project(42, { name: 'Project Name' })
Gitlab.edit_project('project-name', { name: 'New Project Name', path: 'new-project-patth' })

Parameters:

  • project (Integer, String) —

    The ID or path of a project.

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

    A customizable set of options

Options Hash (options):

  • :name (String) —

    The name of a project

  • :path (String) —

    The project’s repository name, also used in Gitlab’s URLs

  • :description (String) —

    The description to show in Gitlab

Returns:



475
476
477
 
# File 'lib/gitlab/client/projects.rb', line 475

def edit_project(id, options = {})
  put("/projects/#{url_encode id}", body: options)
end

#edit_project_hook(project, id, url, options = {}) ⇒ 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 path of a project.

  • id (Integer) —

    The ID of the hook.

  • url (String) —

    The hook URL.

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

    A customizable set of options.

  • option (Boolean) —

    :push_events Trigger hook on push events (0 = false, 1 = true)

  • option (Boolean) —

    :issues_events Trigger hook on issues events (0 = false, 1 = true)

  • option (Boolean) —

    :merge_requests_events Trigger hook on merge_requests events (0 = false, 1 = true)

  • option (Boolean) —

    :tag_push_events Trigger hook on push_tag events (0 = false, 1 = true)

Returns:



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

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

#edit_push_rule(id, options = {}) ⇒ Gitlab::ObjectifiedHash

Updates a project push rule.

Examples:

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

Parameters:

  • id (Integer) —

    The ID of a project.

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

    A customizable set of options.

  • option (Boolean) —

    :deny_delete_tag Do not allow users to remove git tags with git push (0 = false, 1 = true)

  • option (String) —

    :commit_message_regex Commit message regex

Returns:

See Also:



298
299
300
 
# File 'lib/gitlab/client/projects.rb', line 298

def edit_push_rule(id, options = {})
  put("/projects/#{url_encode id}/push_rule", body: options)
end

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

Updates a team member’s project access level.

Examples:

Gitlab.edit_team_member('gitlab', 3, 20)
Gitlab.edit_team_member('gitlab', 3, 20, { expires_at: "2018-12-31"})

Parameters:

  • project (Integer, String) —

    The ID or path of a project.

  • id (Integer) —

    The ID of a user.

  • access_level (Integer) —

    The access level to project.

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

    A customizable set of options.

Options Hash (options):

  • :expires_at (String) —

    A date string in the format YEAR-MONTH-DAY.

Returns:



165
166
167
168
 
# File 'lib/gitlab/client/projects.rb', line 165

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

#enable_deploy_key(project, key) ⇒ Gitlab::ObjectifiedHash

Enables a deploy key at the project.

Examples:

Gitlab.enable_deploy_key(42, 66)

Parameters:

  • project (Integer, String) —

    The ID or path of a project.

  • key (Integer) —

    The ID of a deploy key.

Returns:



386
387
388
 
# File 'lib/gitlab/client/projects.rb', line 386

def enable_deploy_key(project, key)
  post("/projects/#{url_encode project}/deploy_keys/#{key}/enable", body: { id: project, key_id: key })
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 path of a project.

  • id (Integer) —

    The ID of the project it is forked from.

Returns:



322
323
324
 
# File 'lib/gitlab/client/projects.rb', line 322

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

#project(id, options = {}) ⇒ Gitlab::ObjectifiedHash

Gets information about a project.

Examples:

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

Parameters:

  • id (Integer, String) —

    The ID or path of a project.

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

    :license Include project license data

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

    :statistics Include project statistics.

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

    :with_custom_attributes Include custom attributes in response. (admins only)

Returns:



51
52
53
 
# File 'lib/gitlab/client/projects.rb', line 51

def project(id, options = {})
  get("/projects/#{url_encode id}", query: options)
end

#project_access_token(project, token_id) ⇒ Gitlab::ObjectifiedHash

Get a specific project access token.

Examples:

Gitlab.project_access_token(42, 1234)

Parameters:

  • project (Integer, String) —

    The ID or path of a project.

  • token_id (Integer) —

    The ID of the project access token.

Returns:



741
742
743
 
# File 'lib/gitlab/client/projects.rb', line 741

def project_access_token(project, token_id)
  get("/projects/#{url_encode project}/access_tokens/#{token_id}")
end

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

List all project access tokens.

Examples:

Gitlab.project_access_tokens(42)

Parameters:

  • project (Integer, String) —

    The ID or path of a project.

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

    a customizable set of options

Options Hash (options):

  • :state (String) —

    Limit by active/inactive state. Optional.

Returns:



728
729
730
 
# File 'lib/gitlab/client/projects.rb', line 728

def project_access_tokens(project, options = {})
  get("/projects/#{url_encode project}/access_tokens", query: options)
end

#project_custom_attribute(key, project_id) ⇒ Gitlab::ObjectifiedHash

Gets single project custom_attribute.

Examples:

Gitlab.project_custom_attribute(key, 2)

Parameters:

  • key (String) —

    The custom_attributes key

  • project_id (Integer) —

    The ID of a project.

Returns:



666
667
668
 
# File 'lib/gitlab/client/projects.rb', line 666

def project_custom_attribute(key, project_id)
  get("/projects/#{project_id}/custom_attributes/#{key}")
end

#project_custom_attributes(project_id) ⇒ Gitlab::ObjectifiedHash

Gets project custom_attributes.

Examples:

Gitlab.project_custom_attributes(2)

Parameters:

  • project_id (Integer) —

    The ID of a project.

Returns:



654
655
656
 
# File 'lib/gitlab/client/projects.rb', line 654

def project_custom_attributes(project_id)
  get("/projects/#{project_id}/custom_attributes")
end

#project_deploy_tokens(project, options = {}) ⇒ Object

List project deploy tokens

Examples:

Gitlab.project_deploy_tokens(42)

Parameters:

  • id (Integer, String) —

    The ID or path of a project.

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

    a customizable set of options

Options Hash (options):

  • :active (Boolean) —

    Limit by active status. Optional.



704
705
706
 
# File 'lib/gitlab/client/projects.rb', line 704

def project_deploy_tokens(project, options = {})
  get("/projects/#{url_encode project}/deploy_tokens", query: options)
end

#project_forks(id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>

Get a list of all visible projects across GitLab for the authenticated user. When accessed without authentication, only public projects are returned.

Note: This feature was introduced in GitLab 10.1

Examples:

Gitlab.project_forks(42)

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.

  • :order_by (String) —

    Return requests ordered by id, name, created_at or last_activity_at fields

  • :sort (String) —

    Return requests sorted in asc or desc order

Returns:



456
457
458
 
# File 'lib/gitlab/client/projects.rb', line 456

def project_forks(id, options = {})
  get("/projects/#{url_encode id}/forks", query: options)
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 path of a project.

  • id (Integer) —

    The ID of a hook.

Returns:



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

def project_hook(project, id)
  get("/projects/#{url_encode 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 path 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:



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

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

#project_languages(project) ⇒ Gitlab::ObjectifiedHash

Get languages used with percentage value

Examples:

Gitlab.project_languages(42)

Parameters:

  • id (Integer, String) —

    The ID or path of a project.

Returns:



715
716
717
 
# File 'lib/gitlab/client/projects.rb', line 715

def project_languages(project)
  get("/projects/#{url_encode project}/languages")
end

#project_search(query, options = {}) ⇒ Array<Gitlab::ObjectifiedHash> Also known as: search_projects

Search for projects by name.

Examples:

Gitlab.project_search('gitlab')
Gitlab.project_search('gitlab', { order_by: 'last_activity_at' })
Gitlab.search_projects('gitlab', { order_by: 'name', sort: 'asc' })

Parameters:

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

    A customizable set of options.

Options Hash (options):

  • :per_page (String) —

    Number of projects to return per page

  • :page (String) —

    The page to retrieve

  • :order_by (String) —

    Return requests ordered by id, name, created_at or last_activity_at fields

  • :sort (String) —

    Return requests sorted in asc or desc order

Returns:



35
36
37
 
# File 'lib/gitlab/client/projects.rb', line 35

def project_search(query, options = {})
  get('/projects', query: options.merge(search: query))
end

#project_template(project, type, key, options = {}) ⇒ Gitlab::ObjectifiedHash

Get one project template of a particular type

Examples:

Gitlab.project_template(1, 'dockerfiles', 'dockey')
Gitlab.project_template(1, 'licenses', 'gpl', { project: 'some project', fullname: 'Holder Holding' })

Parameters:

  • project (Integer, String) —

    The ID or URL-encoded path of the project.

  • type (String) —

    The type (dockerfiles|gitignores|gitlab_ci_ymls|licenses) of the template

  • key (String) —

    The key of the template, as obtained from the collection endpoint

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

    A customizable set of options.

Options Hash (options):

  • project(optional) (String) —

    The project name to use when expanding placeholders in the template. Only affects licenses

  • fullname(optional) (String) —

    The full name of the copyright holder to use when expanding placeholders in the template. Only affects licenses

Returns:

See Also:



621
622
623
 
# File 'lib/gitlab/client/projects.rb', line 621

def project_template(project, type, key, options = {})
  get("/projects/#{url_encode project}/templates/#{type}/#{key}", query: options)
end

#project_templates(project, type) ⇒ Array<Gitlab::ObjectifiedHash>

Get all project templates of a particular type

Examples:

Gitlab.project_templates(1, 'dockerfiles')
Gitlab.project_templates(1, 'licenses')

Parameters:

  • id (Integer, String) —

    The ID or URL-encoded path of the project.

  • type (String) —

    The type (dockerfiles|gitignores|gitlab_ci_ymls|licenses) of the template

Returns:

See Also:



603
604
605
 
# File 'lib/gitlab/client/projects.rb', line 603

def project_templates(project, type)
  get("/projects/#{url_encode project}/templates/#{type}")
end

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

Gets a list of projects owned by the authenticated user.

(Any provided options will be passed to Gitlab. See Gitlab docs for all valid options)

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:



18
19
20
 
# File 'lib/gitlab/client/projects.rb', line 18

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

#push_rule(id) ⇒ Gitlab::ObjectifiedHash

Gets a project push rule.

Examples:

Gitlab.push_rule(42)

Parameters:

  • id (Integer) —

    The ID of a project.

Returns:

See Also:



268
269
270
 
# File 'lib/gitlab/client/projects.rb', line 268

def push_rule(id)
  get("/projects/#{url_encode id}/push_rule")
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 path of a project.

  • project (Integer) —

    The ID of the project it is forked from

Returns:



334
335
336
 
# File 'lib/gitlab/client/projects.rb', line 334

def remove_forked(project)
  delete("/projects/#{url_encode 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 path of a project.

  • id (Integer) —

    The ID of a user.

  • options (Hash) —

    A customizable set of options.

Returns:



179
180
181
 
# File 'lib/gitlab/client/projects.rb', line 179

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

#revoke_project_access_token(project, token_id) ⇒ Gitlab::ObjectifiedHash

Revoke a project access token.

Examples:

Gitlab.revoke_project_access_token(42, 1234)

Parameters:

  • project (Integer, String) —

    The ID or path of a project.

  • token_id (Integer) —

    The ID of the project access token.

Returns:



784
785
786
 
# File 'lib/gitlab/client/projects.rb', line 784

def revoke_project_access_token(project, token_id)
  delete("/projects/#{url_encode project}/access_tokens/#{token_id}")
end

#rotate_project_access_token(project, token_id, options = {}) ⇒ Gitlab::ObjectifiedHash

Rotate a project access token.

Examples:

Gitlab.rotate_project_access_token(42, 1234)

Parameters:

  • project (Integer, String) —

    The ID or path of a project.

  • token_id (Integer) —

    The ID of the project access token.

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

    a customizable set of options

Options Hash (options):

  • :expires_at (String) —

    A date string in the format YEAR-MONTH-DAY.

Returns:



771
772
773
 
# File 'lib/gitlab/client/projects.rb', line 771

def rotate_project_access_token(project, token_id, options = {})
  post("/projects/#{url_encode project}/access_tokens/#{token_id}/rotate", query: options)
end

#share_project_with_group(project, id, group_access) ⇒ Object

Share project with group.

Examples:

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

Parameters:

  • project (Integer, String) —

    The ID or path of a project.

  • id (Integer) —

    The ID of a group.

  • group_access (Integer) —

    The access level to project.



487
488
489
 
# File 'lib/gitlab/client/projects.rb', line 487

def share_project_with_group(project, id, group_access)
  post("/projects/#{url_encode project}/share", body: { group_id: id, group_access: group_access })
end

#star_project(id) ⇒ Gitlab::ObjectifiedHash

Stars a project.

Examples:

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

Parameters:

  • id (Integer, String) —

    The ID or path of a project.

Returns:

See Also:



524
525
526
 
# File 'lib/gitlab/client/projects.rb', line 524

def star_project(id)
  post("/projects/#{url_encode id}/star")
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 path of a project.

  • id (Integer) —

    The ID of a project team member.

Returns:



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

def team_member(project, id)
  get("/projects/#{url_encode 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 path 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:



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

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

#transfer_project(project, namespace) ⇒ Gitlab::ObjectifiedHash

Transfer a project to a new namespace.

Examples:

Gitlab.transfer_project(42, 'yolo')

Parameters:

  • project (Integer, String) —

    The ID or path of a project

  • namespace (Integer, String) —

    The ID or path of the namespace to transfer to project to

Returns:



511
512
513
 
# File 'lib/gitlab/client/projects.rb', line 511

def transfer_project(project, namespace)
  put("/projects/#{url_encode project}/transfer", body: { namespace: namespace })
end

#unarchive_project(id) ⇒ Gitlab::ObjectifiedHash

Unarchives a project.

Examples:

Gitlab.unarchive_project(4)

Parameters:

  • id (Integer, String) —

    The ID or path of a project.

Returns:



643
644
645
 
# File 'lib/gitlab/client/projects.rb', line 643

def unarchive_project(id)
  post("/projects/#{url_encode id}/unarchive")
end

#unshare_project_with_group(project, id) ⇒ void

This method returns an undefined value.

Unshare project with group.

Examples:

Gitlab.unshare_project_with_group('gitlab', 2)

Parameters:

  • project (Integer, String) —

    The ID or path of a project.

  • id (Integer) —

    The ID of a group.



499
500
501
 
# File 'lib/gitlab/client/projects.rb', line 499

def unshare_project_with_group(project, id)
  delete("/projects/#{url_encode project}/share/#{id}")
end

#unstar_project(id) ⇒ Gitlab::ObjectifiedHash

Unstars a project.

Examples:

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

Parameters:

  • id (Integer, String) —

    The ID or path of a project.

Returns:

See Also:



537
538
539
 
# File 'lib/gitlab/client/projects.rb', line 537

def unstar_project(id)
  delete("/projects/#{url_encode id}/star")
end

#upload_file(id, file_fullpath) ⇒ Gitlab::ObjectifiedHash

Uploads a file to the specified project to be used in an issue or merge request description, or a comment.

Examples:

Gitlab.upload_file(1, '/full/path/to/avatar.jpg')

Parameters:

  • id (Integer, String) —

    The ID or path of a project.

  • file_fullpath (String) —

    The fullpath of the file you are interested to upload.

Returns:

See Also:



589
590
591
 
# File 'lib/gitlab/client/projects.rb', line 589

def upload_file(id, file_fullpath)
  post("/projects/#{url_encode id}/uploads", body: { file: File.open(file_fullpath, 'r') })
end

#user_projects(user_id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>

Get a list of visible projects for the given user.

Examples:

Gitlab.user_projects(1)
Gitlab.user_projects(1, { order_by: 'last_activity_at' })
Gitlab.user_projects('username', { order_by: 'name', sort: 'asc' })

Parameters:

  • user_id (Integer, String) —

    The ID or username of the user.

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

    A customizable set of options.

Options Hash (options):

  • :per_page (String) —

    Number of projects to return per page

  • :page (String) —

    The page to retrieve

  • :order_by (String) —

    Return projects ordered by id, name, path, created_at, updated_at, or last_activity_at fields.

  • :sort (String) —

    Return projects sorted in asc or desc order.

Returns:

See Also:



575
576
577
 
# File 'lib/gitlab/client/projects.rb', line 575

def user_projects(user_id, options = {})
  get("/users/#{url_encode user_id}/projects", query: options)
end

#user_starred_projects(user_id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>

Get a list of visible projects that the given user has starred.

Examples:

Gitlab.user_starred_projects(1)
Gitlab.user_starred_projects(1, { order_by: 'last_activity_at' })
Gitlab.user_starred_projects('username', { order_by: 'name', sort: 'asc' })

Parameters:

  • user_id (Integer, String) —

    The ID or username of the user.

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

    A customizable set of options.

Options Hash (options):

  • :per_page (String) —

    Number of projects to return per page

  • :page (String) —

    The page to retrieve

  • :order_by (String) —

    Return projects ordered by id, name, path, created_at, updated_at, or last_activity_at fields.

  • :sort (String) —

    Return projects sorted in asc or desc order.

Returns:

See Also:



556
557
558
 
# File 'lib/gitlab/client/projects.rb', line 556

def user_starred_projects(user_id, options = {})
  get("/users/#{url_encode user_id}/starred_projects", query: options)
end