Module: Gitlab::Client::MergeRequests

Included in:

Gitlab::Client

Defined in:

lib/gitlab/client/merge_requests.rb

Overview

Defines methods related to merge requests.

See Also:

• https://docs.gitlab.com/ce/api/merge_requests.html

Instance Method Summary

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

  Accepts a merge request.

• #create_merge_request(project, title, options = {}) ⇒ Gitlab::ObjectifiedHash

  Creates a merge request.

• #merge_request(project, id) ⇒ Gitlab::ObjectifiedHash

  Gets a single merge request.

• #merge_request_changes(project, id) ⇒ Gitlab::ObjectifiedHash

  Gets the changes of a merge request.

• #merge_request_closes_issues(project_id, merge_request_iid) ⇒ Object

  List issues that will close on merge.

• #merge_request_commits(project, id) ⇒ Array<Gitlab::ObjectifiedHash>

  Gets the commits of a merge request.

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

  Gets a list of project merge requests.

• #subscribe_to_merge_request(project, id) ⇒ Gitlab::ObjectifiedHash

  Subscribes to a merge request.

• #unsubscribe_from_merge_request(project, id) ⇒ Gitlab::ObjectifiedHash

  Unsubscribes from a merge request.

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

  Updates a merge request.

Instance Method Details

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

Accepts a merge request.

Examples:

Gitlab.accept_merge_request(5, 42, { merge_commit_message: 'Nice!' })

Parameters:

• project (Integer, String) —

  The ID or name of a project.

• id (Integer) —

  The ID of a merge request.

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

  A customizable set of options.

Options Hash (options):

• :merge_commit_message (String) —

  Custom merge commit message

Returns:

• (Gitlab::ObjectifiedHash) —

  Information about updated merge request.

# File 'lib/gitlab/client/merge_requests.rb', line 81

def accept_merge_request(project, id, options={})
  put("/projects/#{url_encode project}/merge_requests/#{id}/merge", body: options)
end

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

Creates a merge request.

Examples:

Gitlab.create_merge_request(5, 'New merge request',
  { source_branch: 'source_branch', target_branch: 'target_branch' })
Gitlab.create_merge_request(5, 'New merge request',
  { source_branch: 'source_branch', target_branch: 'target_branch', assignee_id: 42 })

Parameters:

• project (Integer, String) —

  The ID or name of a project.

• title (String) —

  The title of a merge request.

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

  A customizable set of options.

Options Hash (options):

• :source_branch (String) — default: required —

  The source branch name.

• :target_branch (String) — default: required —

  The target branch name.

• :assignee_id (Integer) — default: optional —

  The ID of a user to assign merge request.

• :target_project_id (Integer) — default: optional —

  The target project ID.

Returns:

• (Gitlab::ObjectifiedHash) —

  Information about created merge request.

# File 'lib/gitlab/client/merge_requests.rb', line 48

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

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

Gets a single merge request.

Examples:

Gitlab.merge_request(5, 36)

Parameters:

• project (Integer, String) —

  The ID or name of a project.

• id (Integer) —

  The ID of a merge request.

Returns:

• (Gitlab::ObjectifiedHash)

# File 'lib/gitlab/client/merge_requests.rb', line 28

def merge_request(project, id)
  get("/projects/#{url_encode project}/merge_requests/#{id}")
end

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

Gets the changes of a merge request.

Examples:

Gitlab.merge_request_changes(5, 1)

Parameters:

• project (Integer, String) —

  The ID or name of a project.

• id (Integer) —

  The ID of a merge request.

Returns:

• (Gitlab::ObjectifiedHash) —

  The merge request’s changes.

# File 'lib/gitlab/client/merge_requests.rb', line 93

def merge_request_changes(project, id)
  get("/projects/#{url_encode project}/merge_requests/#{id}/changes")
end

#merge_request_closes_issues(project_id, merge_request_iid) ⇒ Object

List issues that will close on merge

Examples:

Gitlab.merge_request_closes_issues(5, 1)

Parameters:

• project (Integer) —

  The ID of a project

• iid (Integer) —

  The internal ID of a merge request

# File 'lib/gitlab/client/merge_requests.rb', line 116

def merge_request_closes_issues(project_id, merge_request_iid)
  get("/projects/#{project_id}/merge_requests/#{merge_request_iid}/closes_issues")
end

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

Gets the commits of a merge request.

Examples:

Gitlab.merge_request_commits(5, 1)

Parameters:

• project (Integer, String) —

  The ID or name of a project.

• id (Integer) —

  The ID of a merge request.

Returns:

• (Array<Gitlab::ObjectifiedHash>) —

  The merge request’s commits.

# File 'lib/gitlab/client/merge_requests.rb', line 105

def merge_request_commits(project, id)
  get("/projects/#{url_encode project}/merge_requests/#{id}/commits")
end

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

Gets a list of project merge requests.

Examples:

Gitlab.merge_requests(5)
Gitlab.merge_requests({ per_page: 40 })

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:

• (Array<Gitlab::ObjectifiedHash>)

# File 'lib/gitlab/client/merge_requests.rb', line 16

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

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

Subscribes to a merge request.

Examples:

Gitlab.subscribe_to_merge_request(5, 1)
Gitlab.subscribe_to_merge_request('gitlab', 1)

Parameters:

• project (Integer, String) —

  The ID or name of a project.

• id (Integer) —

  The ID of a merge request.

Returns:

• (Gitlab::ObjectifiedHash) —

  Information about subscribed merge request.

# File 'lib/gitlab/client/merge_requests.rb', line 129

def subscribe_to_merge_request(project, id)
  post("/projects/#{url_encode project}/merge_requests/#{id}/subscribe")
end

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

Unsubscribes from a merge request.

Examples:

Gitlab.unsubscribe_from_merge_request(5, 1)
Gitlab.unsubscribe_from_merge_request('gitlab', 1)

Parameters:

• project (Integer, String) —

  The ID or name of a project.

• id (Integer) —

  The ID of a merge request.

Returns:

• (Gitlab::ObjectifiedHash) —

  Information about unsubscribed merge request.

# File 'lib/gitlab/client/merge_requests.rb', line 142

def unsubscribe_from_merge_request(project, id)
  post("/projects/#{url_encode project}/merge_requests/#{id}/unsubscribe")
end

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

Updates a merge request.

Examples:

Gitlab.update_merge_request(5, 42, { title: 'New title' })

Parameters:

• project (Integer, String) —

  The ID or name of a project.

• id (Integer) —

  The ID of a merge request.

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

  A customizable set of options.

Options Hash (options):

• :title (String) —

  The title of a merge request.

• :source_branch (String) —

  The source branch name.

• :target_branch (String) —

  The target branch name.

• :assignee_id (Integer) —

  The ID of a user to assign merge request.

• :state_event (String) —

  New state (close|reopen|merge).

Returns:

• (Gitlab::ObjectifiedHash) —

  Information about updated merge request.

# File 'lib/gitlab/client/merge_requests.rb', line 67

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