gitlab 4.6.0 → 4.7.0

data/lib/gitlab/client/tags.rb

@@ -1,95 +1,97 @@
 # frozen_string_literal: true
 
-# Defines methods related to tags.
-# @see https://docs.gitlab.com/ce/api/tags.html
-module Tags
-  # Gets a list of project repository tags.
-  #
-  # @example
-  #   Gitlab.tags(42)
-  #
-  # @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>]
-  def tags(project, options = {})
-    get("/projects/#{url_encode project}/repository/tags", query: options)
-  end
-  alias repo_tags tags
+class Gitlab::Client
+  # Defines methods related to tags.
+  # @see https://docs.gitlab.com/ce/api/tags.html
+  module Tags
+    # Gets a list of project repository tags.
+    #
+    # @example
+    #   Gitlab.tags(42)
+    #
+    # @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>]
+    def tags(project, options = {})
+      get("/projects/#{url_encode project}/repository/tags", query: options)
+    end
+    alias repo_tags tags
 
-  # Creates a new project repository tag.
-  #
-  # @example
-  #   Gitlab.create_tag(42, 'new_tag', 'master')
-  #   Gitlab.create_tag(42, 'v1.0', 'master', 'Release 1.0')
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [String]  tag_name The name of the new tag.
-  # @param  [String]  ref The ref (commit sha, branch name, or another tag) the tag will point to.
-  # @param  [String]  message Optional message for tag, creates annotated tag if specified.
-  # @param  [String]  description Optional release notes for tag.
-  # @return [Gitlab::ObjectifiedHash]
-  def create_tag(project, tag_name, ref, message = '', description = nil)
-    post("/projects/#{url_encode project}/repository/tags", body: { tag_name: tag_name, ref: ref, message: message, release_description: description })
-  end
-  alias repo_create_tag create_tag
+    # Creates a new project repository tag.
+    #
+    # @example
+    #   Gitlab.create_tag(42, 'new_tag', 'master')
+    #   Gitlab.create_tag(42, 'v1.0', 'master', 'Release 1.0')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String]  tag_name The name of the new tag.
+    # @param  [String]  ref The ref (commit sha, branch name, or another tag) the tag will point to.
+    # @param  [String]  message Optional message for tag, creates annotated tag if specified.
+    # @param  [String]  description Optional release notes for tag.
+    # @return [Gitlab::ObjectifiedHash]
+    def create_tag(project, tag_name, ref, message = '', description = nil)
+      post("/projects/#{url_encode project}/repository/tags", body: { tag_name: tag_name, ref: ref, message: message, release_description: description })
+    end
+    alias repo_create_tag create_tag
 
-  # Gets information about a repository tag.
-  #
-  # @example
-  #   Gitlab.tag(3, 'api')
-  #   Gitlab.repo_tag(5, 'master')
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [String] tag The name of the tag.
-  # @return [Gitlab::ObjectifiedHash]
-  def tag(project, tag)
-    get("/projects/#{url_encode project}/repository/tags/#{url_encode tag}")
-  end
-  alias repo_tag tag
+    # Gets information about a repository tag.
+    #
+    # @example
+    #   Gitlab.tag(3, 'api')
+    #   Gitlab.repo_tag(5, 'master')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] tag The name of the tag.
+    # @return [Gitlab::ObjectifiedHash]
+    def tag(project, tag)
+      get("/projects/#{url_encode project}/repository/tags/#{url_encode tag}")
+    end
+    alias repo_tag tag
 
-  # Deletes a repository tag.  Requires Gitlab >= 6.8.x
-  #
-  # @example
-  #   Gitlab.delete_tag(3, 'api')
-  #   Gitlab.repo_delete_tag(5, 'master')
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [String] tag The name of the tag to delete
-  # @return [Gitlab::ObjectifiedHash]
-  def delete_tag(project, tag)
-    delete("/projects/#{url_encode project}/repository/tags/#{url_encode tag}")
-  end
-  alias repo_delete_tag delete_tag
+    # Deletes a repository tag.  Requires Gitlab >= 6.8.x
+    #
+    # @example
+    #   Gitlab.delete_tag(3, 'api')
+    #   Gitlab.repo_delete_tag(5, 'master')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] tag The name of the tag to delete
+    # @return [Gitlab::ObjectifiedHash]
+    def delete_tag(project, tag)
+      delete("/projects/#{url_encode project}/repository/tags/#{url_encode tag}")
+    end
+    alias repo_delete_tag delete_tag
 
-  # Adds release notes to an existing repository tag.  Requires Gitlab >= 8.2.0
-  #
-  # @example
-  #   Gitlab.create_release(3, '1.0.0', 'This is ready for production')
-  #   Gitlab.repo_create_release(5, '1.0.0', 'This is ready for production')
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [String] tag The name of the new tag.
-  # @param  [String] description Release notes with markdown support
-  # @return [Gitlab::ObjectifiedHash]
-  def create_release(project, tag, description)
-    post("/projects/#{url_encode project}/repository/tags/#{url_encode tag}/release", body: { description: description })
-  end
-  alias repo_create_release create_release
+    # Adds release notes to an existing repository tag.  Requires Gitlab >= 8.2.0
+    #
+    # @example
+    #   Gitlab.create_release(3, '1.0.0', 'This is ready for production')
+    #   Gitlab.repo_create_release(5, '1.0.0', 'This is ready for production')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] tag The name of the new tag.
+    # @param  [String] description Release notes with markdown support
+    # @return [Gitlab::ObjectifiedHash]
+    def create_release(project, tag, description)
+      post("/projects/#{url_encode project}/repository/tags/#{url_encode tag}/release", body: { description: description })
+    end
+    alias repo_create_release create_release
 
-  # Updates the release notes of a given release.  Requires Gitlab >= 8.2.0
-  #
-  # @example
-  #   Gitlab.update_release(3, '1.0.0', 'This is even more ready for production')
-  #   Gitlab.repo_update_release(5, '1.0.0', 'This is even more ready for production')
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [String] tag The name of the new tag.
-  # @param  [String] description Release notes with markdown support
-  # @return [Gitlab::ObjectifiedHash]
-  def update_release(project, tag, description)
-    put("/projects/#{url_encode project}/repository/tags/#{url_encode tag}/release", body: { description: description })
+    # Updates the release notes of a given release.  Requires Gitlab >= 8.2.0
+    #
+    # @example
+    #   Gitlab.update_release(3, '1.0.0', 'This is even more ready for production')
+    #   Gitlab.repo_update_release(5, '1.0.0', 'This is even more ready for production')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] tag The name of the new tag.
+    # @param  [String] description Release notes with markdown support
+    # @return [Gitlab::ObjectifiedHash]
+    def update_release(project, tag, description)
+      put("/projects/#{url_encode project}/repository/tags/#{url_encode tag}/release", body: { description: description })
+    end
+    alias repo_update_release update_release
   end
-  alias repo_update_release update_release
 end

data/lib/gitlab/client/todos.rb

@@ -1,44 +1,46 @@
 # frozen_string_literal: true
 
-# Defines methods related to todos
-# @see https://docs.gitlab.com/ce/api/todos.html
-module Todos
-  # Gets a list of todos.
-  #
-  # @example
-  #   Gitlab.todos
-  #   Gitlab.todos({ action: 'assigned' })
-  #   Gitlab.todos({ state: 'pending' })
-  #
-  # @param  [Hash] options A customizable set of options.
-  # @option options [Integer] :action The action to be filtered. Can be `assigned`, `mentioned`, `build_failed`, `marked`, or `approval_required`.
-  # @option options [Integer] :author_id The ID of an author
-  # @option options [Integer] :project_id The ID of a project
-  # @option options [Integer] :state The state of the todo. Can be either `pending` or `done`
-  # @option options [Integer] :type The type of a todo. Can be either `Issue` or `MergeRequest`
-  # @return [Array<Gitlab::ObjectifiedHash>]
-  def todos(options = {})
-    get('/todos', query: options)
-  end
+class Gitlab::Client
+  # Defines methods related to todos
+  # @see https://docs.gitlab.com/ce/api/todos.html
+  module Todos
+    # Gets a list of todos.
+    #
+    # @example
+    #   Gitlab.todos
+    #   Gitlab.todos({ action: 'assigned' })
+    #   Gitlab.todos({ state: 'pending' })
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :action The action to be filtered. Can be `assigned`, `mentioned`, `build_failed`, `marked`, or `approval_required`.
+    # @option options [Integer] :author_id The ID of an author
+    # @option options [Integer] :project_id The ID of a project
+    # @option options [Integer] :state The state of the todo. Can be either `pending` or `done`
+    # @option options [Integer] :type The type of a todo. Can be either `Issue` or `MergeRequest`
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def todos(options = {})
+      get('/todos', query: options)
+    end
 
-  # Marks a single pending todo for the current user as done.
-  #
-  # @example
-  #   Gitlab.mark_todo_as_done(42)
-  #
-  # @param  [Integer] id The ID of the todo.
-  # @return [Gitlab::ObjectifiedHash]
-  def mark_todo_as_done(id)
-    post("/todos/#{id}/mark_as_done")
-  end
+    # Marks a single pending todo for the current user as done.
+    #
+    # @example
+    #   Gitlab.mark_todo_as_done(42)
+    #
+    # @param  [Integer] id The ID of the todo.
+    # @return [Gitlab::ObjectifiedHash]
+    def mark_todo_as_done(id)
+      post("/todos/#{id}/mark_as_done")
+    end
 
-  # Marks all todos for the current user as done
-  #
-  # @example
-  #   Gitlab.mark_all_todos_as_done
-  #
-  # @return [void] This API call returns an empty response body.
-  def mark_all_todos_as_done
-    post('/todos/mark_as_done')
+    # Marks all todos for the current user as done
+    #
+    # @example
+    #   Gitlab.mark_all_todos_as_done
+    #
+    # @return [void] This API call returns an empty response body.
+    def mark_all_todos_as_done
+      post('/todos/mark_as_done')
+    end
   end
 end

data/lib/gitlab/client/users.rb

@@ -1,264 +1,266 @@
 # frozen_string_literal: true
 
-# Defines methods related to users.
-# @see https://docs.gitlab.com/ce/api/users.html
-# @see https://docs.gitlab.com/ce/api/session.html
-module Users
-  # Gets a list of users.
-  #
-  # @example
-  #   Gitlab.users
-  #
-  # @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>]
-  def users(options = {})
-    get('/users', query: options)
-  end
+class Gitlab::Client
+  # Defines methods related to users.
+  # @see https://docs.gitlab.com/ce/api/users.html
+  # @see https://docs.gitlab.com/ce/api/session.html
+  module Users
+    # Gets a list of users.
+    #
+    # @example
+    #   Gitlab.users
+    #
+    # @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>]
+    def users(options = {})
+      get('/users', query: options)
+    end
 
-  # Gets information about a user.
-  # Will return information about an authorized user if no ID passed.
-  #
-  # @example
-  #   Gitlab.user
-  #   Gitlab.user(2)
-  #
-  # @param  [Integer] id The ID of a user.
-  # @return [Gitlab::ObjectifiedHash]
-  def user(id = nil)
-    id.to_i.zero? ? get('/user') : get("/users/#{id}")
-  end
+    # Gets information about a user.
+    # Will return information about an authorized user if no ID passed.
+    #
+    # @example
+    #   Gitlab.user
+    #   Gitlab.user(2)
+    #
+    # @param  [Integer] id The ID of a user.
+    # @return [Gitlab::ObjectifiedHash]
+    def user(id = nil)
+      id.to_i.zero? ? get('/user') : get("/users/#{id}")
+    end
 
-  # Creates a new user.
-  # Requires authentication from an admin account.
-  #
-  # @example
-  #   Gitlab.create_user('joe@foo.org', 'secret', 'joe', { name: 'Joe Smith' })
-  #   or
-  #   Gitlab.create_user('joe@foo.org', 'secret')
-  #
-  # @param  [String] email The email of a user.
-  # @param  [String] password The password of a user.
-  # @param  [String] username The username of a user.
-  # @param  [Hash] options A customizable set of options.
-  # @option options [String] :name The name of a user. Defaults to email.
-  # @option options [String] :skype The skype of a user.
-  # @option options [String] :linkedin The linkedin of a user.
-  # @option options [String] :twitter The twitter of a user.
-  # @option options [Integer] :projects_limit The limit of projects for a user.
-  # @return [Gitlab::ObjectifiedHash] Information about created user.
-  def create_user(*args)
-    options = args.last.is_a?(Hash) ? args.pop : {}
-    body = if args[2]
-             { email: args[0], password: args[1], username: args[2] }
-           else
-             { email: args[0], password: args[1], name: args[0] }
-           end
-    body.merge!(options)
-    post('/users', body: body)
-  end
+    # Creates a new user.
+    # Requires authentication from an admin account.
+    #
+    # @example
+    #   Gitlab.create_user('joe@foo.org', 'secret', 'joe', { name: 'Joe Smith' })
+    #   or
+    #   Gitlab.create_user('joe@foo.org', 'secret')
+    #
+    # @param  [String] email The email of a user.
+    # @param  [String] password The password of a user.
+    # @param  [String] username The username of a user.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :name The name of a user. Defaults to email.
+    # @option options [String] :skype The skype of a user.
+    # @option options [String] :linkedin The linkedin of a user.
+    # @option options [String] :twitter The twitter of a user.
+    # @option options [Integer] :projects_limit The limit of projects for a user.
+    # @return [Gitlab::ObjectifiedHash] Information about created user.
+    def create_user(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      body = if args[2]
+               { email: args[0], password: args[1], username: args[2] }
+             else
+               { email: args[0], password: args[1], name: args[0] }
+             end
+      body.merge!(options)
+      post('/users', body: body)
+    end
 
-  # Updates a user.
-  #
-  # @example
-  #   Gitlab.edit_user(15, { email: 'joe.smith@foo.org', projects_limit: 20 })
-  #
-  # @param  [Integer] id The ID of a user.
-  # @param  [Hash] options A customizable set of options.
-  # @option options [String] :email The email of a user.
-  # @option options [String] :password The password of a user.
-  # @option options [String] :name The name of a user. Defaults to email.
-  # @option options [String] :skype The skype of a user.
-  # @option options [String] :linkedin The linkedin of a user.
-  # @option options [String] :twitter The twitter of a user.
-  # @option options [Integer] :projects_limit The limit of projects for a user.
-  # @return [Gitlab::ObjectifiedHash] Information about created user.
-  def edit_user(user_id, options = {})
-    put("/users/#{user_id}", body: options)
-  end
+    # Updates a user.
+    #
+    # @example
+    #   Gitlab.edit_user(15, { email: 'joe.smith@foo.org', projects_limit: 20 })
+    #
+    # @param  [Integer] id The ID of a user.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :email The email of a user.
+    # @option options [String] :password The password of a user.
+    # @option options [String] :name The name of a user. Defaults to email.
+    # @option options [String] :skype The skype of a user.
+    # @option options [String] :linkedin The linkedin of a user.
+    # @option options [String] :twitter The twitter of a user.
+    # @option options [Integer] :projects_limit The limit of projects for a user.
+    # @return [Gitlab::ObjectifiedHash] Information about created user.
+    def edit_user(user_id, options = {})
+      put("/users/#{user_id}", body: options)
+    end
 
-  # Deletes a user.
-  #
-  # @example
-  #   Gitlab.delete_user(1)
-  #
-  # @param [Integer] id The ID of a user.
-  # @return [Gitlab::ObjectifiedHash] Information about deleted user.
-  def delete_user(user_id)
-    delete("/users/#{user_id}")
-  end
+    # Deletes a user.
+    #
+    # @example
+    #   Gitlab.delete_user(1)
+    #
+    # @param [Integer] id The ID of a user.
+    # @return [Gitlab::ObjectifiedHash] Information about deleted user.
+    def delete_user(user_id)
+      delete("/users/#{user_id}")
+    end
 
-  # Blocks the specified user. Available only for admin.
-  #
-  # @example
-  #   Gitlab.block_user(15)
-  #
-  # @param [Integer] user_id The Id of user
-  # @return [Boolean] success or not
-  def block_user(user_id)
-    post("/users/#{user_id}/block")
-  end
+    # Blocks the specified user. Available only for admin.
+    #
+    # @example
+    #   Gitlab.block_user(15)
+    #
+    # @param [Integer] user_id The Id of user
+    # @return [Boolean] success or not
+    def block_user(user_id)
+      post("/users/#{user_id}/block")
+    end
 
-  # Unblocks the specified user. Available only for admin.
-  #
-  # @example
-  #   Gitlab.unblock_user(15)
-  #
-  # @param [Integer] user_id The Id of user
-  # @return [Boolean] success or not
-  def unblock_user(user_id)
-    post("/users/#{user_id}/unblock")
-  end
+    # Unblocks the specified user. Available only for admin.
+    #
+    # @example
+    #   Gitlab.unblock_user(15)
+    #
+    # @param [Integer] user_id The Id of user
+    # @return [Boolean] success or not
+    def unblock_user(user_id)
+      post("/users/#{user_id}/unblock")
+    end
 
-  # Creates a new user session.
-  #
-  # @example
-  #   Gitlab.session('jack@example.com', 'secret12345')
-  #
-  # @param  [String] email The email of a user.
-  # @param  [String] password The password of a user.
-  # @return [Gitlab::ObjectifiedHash]
-  # @note This method doesn't require private_token to be set.
-  def session(email, password)
-    post('/session', body: { email: email, password: password }, unauthenticated: true)
-  end
+    # Creates a new user session.
+    #
+    # @example
+    #   Gitlab.session('jack@example.com', 'secret12345')
+    #
+    # @param  [String] email The email of a user.
+    # @param  [String] password The password of a user.
+    # @return [Gitlab::ObjectifiedHash]
+    # @note This method doesn't require private_token to be set.
+    def session(email, password)
+      post('/session', body: { email: email, password: password }, unauthenticated: true)
+    end
 
-  # Gets a list of user's SSH keys.
-  #
-  # @example
-  #   Gitlab.ssh_keys
-  #   Gitlab.ssh_keys({ user_id: 2 })
-  #
-  # @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 [Integer] :user_id The ID of the user to retrieve the keys for.
-  # @return [Array<Gitlab::ObjectifiedHash>]
-  def ssh_keys(options = {})
-    user_id = options.delete :user_id
-    if user_id.to_i.zero?
-      get('/user/keys', query: options)
-    else
-      get("/users/#{user_id}/keys", query: options)
+    # Gets a list of user's SSH keys.
+    #
+    # @example
+    #   Gitlab.ssh_keys
+    #   Gitlab.ssh_keys({ user_id: 2 })
+    #
+    # @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 [Integer] :user_id The ID of the user to retrieve the keys for.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def ssh_keys(options = {})
+      user_id = options.delete :user_id
+      if user_id.to_i.zero?
+        get('/user/keys', query: options)
+      else
+        get("/users/#{user_id}/keys", query: options)
+      end
     end
-  end
 
-  # Gets information about SSH key.
-  #
-  # @example
-  #   Gitlab.ssh_key(1)
-  #
-  # @param  [Integer] id The ID of a user's SSH key.
-  # @return [Gitlab::ObjectifiedHash]
-  def ssh_key(id)
-    get("/user/keys/#{id}")
-  end
+    # Gets information about SSH key.
+    #
+    # @example
+    #   Gitlab.ssh_key(1)
+    #
+    # @param  [Integer] id The ID of a user's SSH key.
+    # @return [Gitlab::ObjectifiedHash]
+    def ssh_key(id)
+      get("/user/keys/#{id}")
+    end
 
-  # Creates a new SSH key.
-  #
-  # @example
-  #   Gitlab.create_ssh_key('key title', 'key body')
-  #
-  # @param  [String] title The title of an SSH key.
-  # @param  [String] key The SSH key body.
-  # @param  [Hash] options A customizable set of options.
-  # @option options  [Integer] :user_id id of the user to associate the key with
-  # @return [Gitlab::ObjectifiedHash] Information about created SSH key.
-  def create_ssh_key(title, key, options = {})
-    user_id = options.delete :user_id
-    if user_id.to_i.zero?
-      post('/user/keys', body: { title: title, key: key })
-    else
-      post("/users/#{user_id}/keys", body: { title: title, key: key })
+    # Creates a new SSH key.
+    #
+    # @example
+    #   Gitlab.create_ssh_key('key title', 'key body')
+    #
+    # @param  [String] title The title of an SSH key.
+    # @param  [String] key The SSH key body.
+    # @param  [Hash] options A customizable set of options.
+    # @option options  [Integer] :user_id id of the user to associate the key with
+    # @return [Gitlab::ObjectifiedHash] Information about created SSH key.
+    def create_ssh_key(title, key, options = {})
+      user_id = options.delete :user_id
+      if user_id.to_i.zero?
+        post('/user/keys', body: { title: title, key: key })
+      else
+        post("/users/#{user_id}/keys", body: { title: title, key: key })
+      end
     end
-  end
 
-  # Deletes an SSH key.
-  #
-  # @example
-  #   Gitlab.delete_ssh_key(1)
-  #
-  # @param  [Integer] id The ID of a user's SSH key.
-  # @param  [Hash] options A customizable set of options.
-  # @option options  [Integer] :user_id id of the user to associate the key with
-  # @return [Gitlab::ObjectifiedHash] Information about deleted SSH key.
-  def delete_ssh_key(id, options = {})
-    user_id = options.delete :user_id
-    if user_id.to_i.zero?
-      delete("/user/keys/#{id}")
-    else
-      delete("/users/#{user_id}/keys/#{id}")
+    # Deletes an SSH key.
+    #
+    # @example
+    #   Gitlab.delete_ssh_key(1)
+    #
+    # @param  [Integer] id The ID of a user's SSH key.
+    # @param  [Hash] options A customizable set of options.
+    # @option options  [Integer] :user_id id of the user to associate the key with
+    # @return [Gitlab::ObjectifiedHash] Information about deleted SSH key.
+    def delete_ssh_key(id, options = {})
+      user_id = options.delete :user_id
+      if user_id.to_i.zero?
+        delete("/user/keys/#{id}")
+      else
+        delete("/users/#{user_id}/keys/#{id}")
+      end
     end
-  end
 
-  # Gets user emails.
-  # Will return emails an authorized user if no user ID passed.
-  #
-  # @example
-  #   Gitlab.emails
-  #   Gitlab.emails(2)
-  #
-  # @param  [Integer] user_id The ID of a user.
-  # @return [Gitlab::ObjectifiedHash]
-  def emails(user_id = nil)
-    url = user_id.to_i.zero? ? '/user/emails' : "/users/#{user_id}/emails"
-    get(url)
-  end
+    # Gets user emails.
+    # Will return emails an authorized user if no user ID passed.
+    #
+    # @example
+    #   Gitlab.emails
+    #   Gitlab.emails(2)
+    #
+    # @param  [Integer] user_id The ID of a user.
+    # @return [Gitlab::ObjectifiedHash]
+    def emails(user_id = nil)
+      url = user_id.to_i.zero? ? '/user/emails' : "/users/#{user_id}/emails"
+      get(url)
+    end
 
-  # Get a single email.
-  #
-  # @example
-  #   Gitlab.email(3)
-  #
-  # @param  [Integer] id The ID of a email.
-  # @return [Gitlab::ObjectifiedHash]
-  def email(id)
-    get("/user/emails/#{id}")
-  end
+    # Get a single email.
+    #
+    # @example
+    #   Gitlab.email(3)
+    #
+    # @param  [Integer] id The ID of a email.
+    # @return [Gitlab::ObjectifiedHash]
+    def email(id)
+      get("/user/emails/#{id}")
+    end
 
-  # Creates a new email
-  # Will create a new email an authorized user if no user ID passed.
-  #
-  # @example
-  #   Gitlab.add_email('email@example.com')
-  #   Gitlab.add_email('email@example.com', 2)
-  #
-  # @param  [String] email Email address
-  # @param  [Integer] user_id The ID of a user.
-  # @return [Gitlab::ObjectifiedHash]
-  def add_email(email, user_id = nil)
-    url = user_id.to_i.zero? ? '/user/emails' : "/users/#{user_id}/emails"
-    post(url, body: { email: email })
-  end
+    # Creates a new email
+    # Will create a new email an authorized user if no user ID passed.
+    #
+    # @example
+    #   Gitlab.add_email('email@example.com')
+    #   Gitlab.add_email('email@example.com', 2)
+    #
+    # @param  [String] email Email address
+    # @param  [Integer] user_id The ID of a user.
+    # @return [Gitlab::ObjectifiedHash]
+    def add_email(email, user_id = nil)
+      url = user_id.to_i.zero? ? '/user/emails' : "/users/#{user_id}/emails"
+      post(url, body: { email: email })
+    end
 
-  # Delete email
-  # Will delete a email an authorized user if no user ID passed.
-  #
-  # @example
-  #   Gitlab.delete_email(2)
-  #   Gitlab.delete_email(3, 2)
-  #
-  # @param  [Integer] id Email address ID
-  # @param  [Integer] user_id The ID of a user.
-  # @return [Boolean]
-  def delete_email(id, user_id = nil)
-    url = user_id.to_i.zero? ? "/user/emails/#{id}" : "/users/#{user_id}/emails/#{id}"
-    delete(url)
-  end
+    # Delete email
+    # Will delete a email an authorized user if no user ID passed.
+    #
+    # @example
+    #   Gitlab.delete_email(2)
+    #   Gitlab.delete_email(3, 2)
+    #
+    # @param  [Integer] id Email address ID
+    # @param  [Integer] user_id The ID of a user.
+    # @return [Boolean]
+    def delete_email(id, user_id = nil)
+      url = user_id.to_i.zero? ? "/user/emails/#{id}" : "/users/#{user_id}/emails/#{id}"
+      delete(url)
+    end
 
-  # Search for groups by name
-  #
-  # @example
-  #   Gitlab.user_search('gitlab')
-  #
-  # @param  [String] search A string to search for in user names and paths.
-  # @param  [Hash] options A customizable set of options.
-  # @option options [String] :per_page Number of user to return per page
-  # @option options [String] :page The page to retrieve
-  # @return [Array<Gitlab::ObjectifiedHash>]
-  def user_search(search, options = {})
-    options[:search] = search
-    get('/users', query: options)
+    # Search for groups by name
+    #
+    # @example
+    #   Gitlab.user_search('gitlab')
+    #
+    # @param  [String] search A string to search for in user names and paths.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :per_page Number of user to return per page
+    # @option options [String] :page The page to retrieve
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def user_search(search, options = {})
+      options[:search] = search
+      get('/users', query: options)
+    end
   end
 end