gitlab 4.5.0 → 4.6.0

data/lib/gitlab/client.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Gitlab
   # Wrapper for the Gitlab REST API.
   class Client < API
-    Dir[File.expand_path('../client/*.rb', __FILE__)].each { |f| require f }
+    Dir[File.expand_path('client/*.rb', __dir__)].each { |f| require f }
 
     # Please keep in alphabetical order
     include AccessRequests
@@ -39,22 +41,19 @@ module Gitlab
     include Tags
     include Todos
     include Users
+    include Versions
 
     # Text representation of the client, masking private token.
     #
     # @return [String]
     def inspect
       inspected = super
-
-      if @private_token
-        inspected = inspected.sub! @private_token, only_show_last_four_chars(@private_token)
-      end
-
+      inspected.sub! @private_token, only_show_last_four_chars(@private_token) if @private_token
       inspected
     end
 
-    def url_encode(s)
-      URI.encode(s.to_s, /\W/)
+    def url_encode(url)
+      URI.encode(url.to_s, /\W/)
     end
 
     private

data/lib/gitlab/client/access_requests.rb

@@ -1,94 +1,101 @@
-class Gitlab::Client
-  # Defines methods related to Award Emojis.
-  # @see https://docs.gitlab.com/ce/api/access_requests.html
-  module AccessRequests
-    # Gets a list of access requests for a project viewable by the authenticated user.
-    #
-    # @example
-    #   Gitlab.project_access_requests(1)
-    #
-    # @param  [Integer, String] :project(required) The ID or name of a project.
-    # @return [Array<Gitlab::ObjectifiedHash>] List of project access requests
-    def project_access_requests(project)
-      get("/projects/#{url_encode project}/access_requests")
-    end
-    # Gets a list of access requests for a group viewable by the authenticated user.
-    #
-    # @example
-    #   Gitlab.group_access_requests(1)
-    #
-    # @param  [Integer, String] :group(required) The ID or name of a group.
-    # @return [Array<Gitlab::ObjectifiedHash>] List of group access requests
-    def group_access_requests(group)
-      get("/groups/#{url_encode group}/access_requests")
-    end
-    # Requests access for the authenticated user to a project.
-    #
-    # @example
-    #    Gitlab.request_project_access(1)
-    #
-    # @param  [Integer, String] :project(required) The ID or name of a project.
-    # @return <Gitlab::ObjectifiedHash] Information about the requested project access
-    def request_project_access(project)
-      post("/projects/#{url_encode project}/access_requests")
-    end
-    # Requests access for the authenticated user to a group.
-    #
-    # @example
-    #    Gitlab.request_group_access(1)
-    #
-    # @param  [Integer, String] :group(required) The ID or name of a group.
-    # @return <Gitlab::ObjectifiedHash] Information about the requested group access
-    def request_group_access(group)
-      post("/groups/#{url_encode group}/access_requests")
-    end
-    # Approves a project access request for the given user.
-    #
-    # @example
-    #    Gitlab.approve_project_access_request(1, 1)
-    #    Gitlab.approve_project_access_request(1, 1, {access_level: '30'})
-    #
-    # @param  [Integer, String] :project(required) The ID or name of a project.
-    # @param  [Integer] :user_id(required) The user ID of the access requester
-    # @option options [Integer] :access_level(optional) A valid access level (defaults: 30, developer access level)
-    # @return <Gitlab::ObjectifiedHash] Information about the approved project access request
-    def approve_project_access_request(project, user_id, options = {})
-      put("/projects/#{url_encode project}/access_requests/#{user_id}/approve", body: options)
-    end
-    # Approves a group access request for the given user.
-    #
-    # @example
-    #    Gitlab.approve_group_access_request(1, 1)
-    #    Gitlab.approve_group_access_request(1, 1, {access_level: '30'})
-    #
-    # @param  [Integer, String] :group(required) The ID or name of a group.
-    # @param  [Integer] :user_id(required) The user ID of the access requester
-    # @option options [Integer] :access_level(optional) A valid access level (defaults: 30, developer access level)
-    # @return <Gitlab::ObjectifiedHash] Information about the approved group access request
-    def approve_group_access_request(group, user_id, options = {})
-      put("/groups/#{url_encode group}/access_requests/#{user_id}/approve", body: options)
-    end
-    # Denies a project access request for the given user.
-    #
-    # @example
-    #    Gitlab.deny_project_access_request(1, 1)
-    #
-    # @param  [Integer, String] :project(required) The ID or name of a project.
-    # @param  [Integer] :user_id(required) The user ID of the access requester
-    # @return [void] This API call returns an empty response body.
-    def deny_project_access_request(project, user_id)
-      delete("/projects/#{url_encode project}/access_requests/#{user_id}")
-    end
-    # Denies a group access request for the given user.
-    #
-    # @example
-    #    Gitlab.deny_group_access_request(1, 1)
-    #
-    # @param  [Integer, String] :group(required) The ID or name of a group.
-    # @param  [Integer] :user_id(required) The user ID of the access requester
-    # @return [void] This API call returns an empty response body.
-    def deny_group_access_request(group, user_id)
-      delete("/groups/#{url_encode group}/access_requests/#{user_id}")
-    end
+# frozen_string_literal: true
+
+# Defines methods related to Award Emojis.
+# @see https://docs.gitlab.com/ce/api/access_requests.html
+module AccessRequests
+  # Gets a list of access requests for a project viewable by the authenticated user.
+  #
+  # @example
+  #   Gitlab.project_access_requests(1)
+  #
+  # @param  [Integer, String] :project(required) The ID or name of a project.
+  # @return [Array<Gitlab::ObjectifiedHash>] List of project access requests
+  def project_access_requests(project)
+    get("/projects/#{url_encode project}/access_requests")
   end
-end
+
+  # Gets a list of access requests for a group viewable by the authenticated user.
+  #
+  # @example
+  #   Gitlab.group_access_requests(1)
+  #
+  # @param  [Integer, String] :group(required) The ID or name of a group.
+  # @return [Array<Gitlab::ObjectifiedHash>] List of group access requests
+  def group_access_requests(group)
+    get("/groups/#{url_encode group}/access_requests")
+  end
+
+  # Requests access for the authenticated user to a project.
+  #
+  # @example
+  #    Gitlab.request_project_access(1)
+  #
+  # @param  [Integer, String] :project(required) The ID or name of a project.
+  # @return <Gitlab::ObjectifiedHash] Information about the requested project access
+  def request_project_access(project)
+    post("/projects/#{url_encode project}/access_requests")
+  end
+
+  # Requests access for the authenticated user to a group.
+  #
+  # @example
+  #    Gitlab.request_group_access(1)
+  #
+  # @param  [Integer, String] :group(required) The ID or name of a group.
+  # @return <Gitlab::ObjectifiedHash] Information about the requested group access
+  def request_group_access(group)
+    post("/groups/#{url_encode group}/access_requests")
+  end
+
+  # Approves a project access request for the given user.
+  #
+  # @example
+  #    Gitlab.approve_project_access_request(1, 1)
+  #    Gitlab.approve_project_access_request(1, 1, {access_level: '30'})
+  #
+  # @param  [Integer, String] :project(required) The ID or name of a project.
+  # @param  [Integer] :user_id(required) The user ID of the access requester
+  # @option options [Integer] :access_level(optional) A valid access level (defaults: 30, developer access level)
+  # @return <Gitlab::ObjectifiedHash] Information about the approved project access request
+  def approve_project_access_request(project, user_id, options = {})
+    put("/projects/#{url_encode project}/access_requests/#{user_id}/approve", body: options)
+  end
+
+  # Approves a group access request for the given user.
+  #
+  # @example
+  #    Gitlab.approve_group_access_request(1, 1)
+  #    Gitlab.approve_group_access_request(1, 1, {access_level: '30'})
+  #
+  # @param  [Integer, String] :group(required) The ID or name of a group.
+  # @param  [Integer] :user_id(required) The user ID of the access requester
+  # @option options [Integer] :access_level(optional) A valid access level (defaults: 30, developer access level)
+  # @return <Gitlab::ObjectifiedHash] Information about the approved group access request
+  def approve_group_access_request(group, user_id, options = {})
+    put("/groups/#{url_encode group}/access_requests/#{user_id}/approve", body: options)
+  end
+
+  # Denies a project access request for the given user.
+  #
+  # @example
+  #    Gitlab.deny_project_access_request(1, 1)
+  #
+  # @param  [Integer, String] :project(required) The ID or name of a project.
+  # @param  [Integer] :user_id(required) The user ID of the access requester
+  # @return [void] This API call returns an empty response body.
+  def deny_project_access_request(project, user_id)
+    delete("/projects/#{url_encode project}/access_requests/#{user_id}")
+  end
+
+  # Denies a group access request for the given user.
+  #
+  # @example
+  #    Gitlab.deny_group_access_request(1, 1)
+  #
+  # @param  [Integer, String] :group(required) The ID or name of a group.
+  # @param  [Integer] :user_id(required) The user ID of the access requester
+  # @return [void] This API call returns an empty response body.
+  def deny_group_access_request(group, user_id)
+    delete("/groups/#{url_encode group}/access_requests/#{user_id}")
+  end
+end

data/lib/gitlab/client/award_emojis.rb

@@ -1,135 +1,135 @@
-class Gitlab::Client
-  # Defines methods related to Award Emojis.
-  # @see https://docs.gitlab.com/ce/api/award_emoji.html
-  module AwardEmojis
-    # Gets a list of all award emoji for an awardable(issue, merge request or snippet)
-    #
-    # @example
-    #   Gitlab.award_emojis(1, 80, 'issue')
-    #   Gitlab.award_emojis(1, 60, 'merge_request')
-    #   Gitlab.award_emojis(1, 40, 'snippet')
-    #
-    # @param [Integer] project The ID of a project.
-    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
-    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def award_emojis(project, awardable_id, awardable_type)
-      get("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/award_emoji")
-    end
+# frozen_string_literal: true
 
-    # Gets a list of all award emoji for a single note on an awardable(issue, merge request or snippet)
-    #
-    # @example
-    #   Gitlab.note_award_emojis(1, 80, 'issue', 1)
-    #   Gitlab.note_award_emojis(1, 60, 'merge_request', 1)
-    #   Gitlab.note_award_emojis(1, 40, 'snippet', 1)
-    #
-    # @param [Integer] project The ID of a project.
-    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
-    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
-    # @param [Integer] note_id The ID of a note.
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def note_award_emojis(project, awardable_id, awardable_type, note_id)
-      get("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji")
-    end
+# Defines methods related to Award Emojis.
+# @see https://docs.gitlab.com/ce/api/award_emoji.html
+module AwardEmojis
+  # Gets a list of all award emoji for an awardable(issue, merge request or snippet)
+  #
+  # @example
+  #   Gitlab.award_emojis(1, 80, 'issue')
+  #   Gitlab.award_emojis(1, 60, 'merge_request')
+  #   Gitlab.award_emojis(1, 40, 'snippet')
+  #
+  # @param [Integer] project The ID of a project.
+  # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
+  # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
+  # @return [Array<Gitlab::ObjectifiedHash>]
+  def award_emojis(project, awardable_id, awardable_type)
+    get("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/award_emoji")
+  end
+
+  # Gets a list of all award emoji for a single note on an awardable(issue, merge request or snippet)
+  #
+  # @example
+  #   Gitlab.note_award_emojis(1, 80, 'issue', 1)
+  #   Gitlab.note_award_emojis(1, 60, 'merge_request', 1)
+  #   Gitlab.note_award_emojis(1, 40, 'snippet', 1)
+  #
+  # @param [Integer] project The ID of a project.
+  # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
+  # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
+  # @param [Integer] note_id The ID of a note.
+  # @return [Array<Gitlab::ObjectifiedHash>]
+  def note_award_emojis(project, awardable_id, awardable_type, note_id)
+    get("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji")
+  end
 
-    # Gets a single award emoji for an awardable(issue, merge request or snippet)
-    #
-    # @example
-    #   Gitlab.award_emoji(1, 80, 'issue', 4)
-    #   Gitlab.award_emoji(1, 60, 'merge_request', 4)
-    #   Gitlab.award_emoji(1, 40, 'snippet', 4)
-    #
-    # @param [Integer] project The ID of a project.
-    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
-    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
-    # @param [Integer] award_id The ID of an award emoji.
-    # @return [Gitlab::ObjectifiedHash]
-    def award_emoji(project, awardable_id, awardable_type, award_id)
-      get("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/award_emoji/#{award_id}")
-    end
+  # Gets a single award emoji for an awardable(issue, merge request or snippet)
+  #
+  # @example
+  #   Gitlab.award_emoji(1, 80, 'issue', 4)
+  #   Gitlab.award_emoji(1, 60, 'merge_request', 4)
+  #   Gitlab.award_emoji(1, 40, 'snippet', 4)
+  #
+  # @param [Integer] project The ID of a project.
+  # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
+  # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
+  # @param [Integer] award_id The ID of an award emoji.
+  # @return [Gitlab::ObjectifiedHash]
+  def award_emoji(project, awardable_id, awardable_type, award_id)
+    get("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/award_emoji/#{award_id}")
+  end
 
-    # Gets a single award emoji from a single note on an awardable(issue, merge request or snippet)
-    #
-    # @example
-    #   Gitlab.note_award_emoji(1, 80, 'issue', 1, 4)
-    #   Gitlab.note_award_emoji(1, 60, 'merge_request', 1, 4)
-    #   Gitlab.note_award_emoji(1, 40, 'snippet', 1, 4)
-    #
-    # @param [Integer] project The ID of a project.
-    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
-    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
-    # @param [Integer] note_id The ID of a note.
-    # @param [Integer] award_id The ID of an award emoji.
-    # @return [Gitlab::ObjectifiedHash]
-    def note_award_emoji(project, awardable_id, awardable_type, note_id, award_id)
-      get("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji/#{award_id}")
-    end
+  # Gets a single award emoji from a single note on an awardable(issue, merge request or snippet)
+  #
+  # @example
+  #   Gitlab.note_award_emoji(1, 80, 'issue', 1, 4)
+  #   Gitlab.note_award_emoji(1, 60, 'merge_request', 1, 4)
+  #   Gitlab.note_award_emoji(1, 40, 'snippet', 1, 4)
+  #
+  # @param [Integer] project The ID of a project.
+  # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
+  # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
+  # @param [Integer] note_id The ID of a note.
+  # @param [Integer] award_id The ID of an award emoji.
+  # @return [Gitlab::ObjectifiedHash]
+  def note_award_emoji(project, awardable_id, awardable_type, note_id, award_id)
+    get("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji/#{award_id}")
+  end
 
-    # Awards a new emoji to an awardable(issue, merge request or snippet)
-    #
-    # @example
-    #   Gitlab.create_award_emoji(1, 80, 'issue', 'blowfish')
-    #   Gitlab.create_award_emoji(1, 80, 'merge_request', 'blowfish')
-    #   Gitlab.create_award_emoji(1, 80, 'snippet', 'blowfish')
-    #
-    # @param [Integer] project The ID of a project.
-    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
-    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
-    # @param [String] emoji_name The name of the emoji, without colons.
-    # @return [Gitlab::ObjectifiedHash]
-    def create_award_emoji(project, awardable_id, awardable_type, emoji_name)
-      post("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/award_emoji", body: {name: emoji_name})
-    end
+  # Awards a new emoji to an awardable(issue, merge request or snippet)
+  #
+  # @example
+  #   Gitlab.create_award_emoji(1, 80, 'issue', 'blowfish')
+  #   Gitlab.create_award_emoji(1, 80, 'merge_request', 'blowfish')
+  #   Gitlab.create_award_emoji(1, 80, 'snippet', 'blowfish')
+  #
+  # @param [Integer] project The ID of a project.
+  # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
+  # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
+  # @param [String] emoji_name The name of the emoji, without colons.
+  # @return [Gitlab::ObjectifiedHash]
+  def create_award_emoji(project, awardable_id, awardable_type, emoji_name)
+    post("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/award_emoji", body: { name: emoji_name })
+  end
 
-    # Awards a new emoji to a note on an awardable(issue, merge request or snippet)
-    #
-    # @example
-    #   Gitlab.create_note_award_emoji(1, 80, 'issue', 1, 'blowfish')
-    #   Gitlab.create_note_award_emoji(1, 80, 'merge_request', 1, 'blowfish')
-    #   Gitlab.create_note_award_emoji(1, 80, 'snippet', 1, 'blowfish')
-    #
-    # @param [Integer] project The ID of a project.
-    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
-    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
-    # @param [Integer] note_id The ID of a note.
-    # @param [String] emoji_name The name of the emoji, without colons.
-    # @return [Gitlab::ObjectifiedHash]
-    def create_note_award_emoji(project, awardable_id, awardable_type, note_id, emoji_name)
-      post("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji", body: {name: emoji_name})
-    end
+  # Awards a new emoji to a note on an awardable(issue, merge request or snippet)
+  #
+  # @example
+  #   Gitlab.create_note_award_emoji(1, 80, 'issue', 1, 'blowfish')
+  #   Gitlab.create_note_award_emoji(1, 80, 'merge_request', 1, 'blowfish')
+  #   Gitlab.create_note_award_emoji(1, 80, 'snippet', 1, 'blowfish')
+  #
+  # @param [Integer] project The ID of a project.
+  # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
+  # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
+  # @param [Integer] note_id The ID of a note.
+  # @param [String] emoji_name The name of the emoji, without colons.
+  # @return [Gitlab::ObjectifiedHash]
+  def create_note_award_emoji(project, awardable_id, awardable_type, note_id, emoji_name)
+    post("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji", body: { name: emoji_name })
+  end
 
-    # Deletes a single award emoji from an awardable(issue, merge request or snippet)
-    #
-    # @example
-    #   Gitlab.delete_award_emoji(1, 80, 'issue', 4)
-    #   Gitlab.delete_award_emoji(1, 60, 'merge_request', 4)
-    #   Gitlab.delete_award_emoji(1, 40, 'snippet', 4)
-    #
-    # @param [Integer] project The ID of a project.
-    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
-    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
-    # @param [Integer] award_id The ID of an award emoji.
-    # @return [void] This API call returns an empty response body.
-    def delete_award_emoji(project, awardable_id, awardable_type, award_id)
-      delete("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/award_emoji/#{award_id}")
-    end
+  # Deletes a single award emoji from an awardable(issue, merge request or snippet)
+  #
+  # @example
+  #   Gitlab.delete_award_emoji(1, 80, 'issue', 4)
+  #   Gitlab.delete_award_emoji(1, 60, 'merge_request', 4)
+  #   Gitlab.delete_award_emoji(1, 40, 'snippet', 4)
+  #
+  # @param [Integer] project The ID of a project.
+  # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
+  # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
+  # @param [Integer] award_id The ID of an award emoji.
+  # @return [void] This API call returns an empty response body.
+  def delete_award_emoji(project, awardable_id, awardable_type, award_id)
+    delete("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/award_emoji/#{award_id}")
+  end
 
-    # Deletes a single award emoji from a single note on an awardable(issue, merge request or snippet)
-    #
-    # @example
-    #   Gitlab.delete_note_award_emoji(1, 80, 'issue', 1, 4)
-    #   Gitlab.delete_note_award_emoji(1, 60, 'merge_request', 1, 4)
-    #   Gitlab.delete_note_award_emoji(1, 40, 'snippet', 1, 4)
-    #
-    # @param [Integer] project The ID of a project.
-    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
-    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
-    # @param [Integer] note_id The ID of a note.
-    # @param [Integer] award_id The ID of an award emoji.
-    # @return [void] This API call returns an empty response body.
-    def delete_note_award_emoji(project, awardable_id, awardable_type, note_id, award_id)
-      delete("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji/#{award_id}")
-    end
+  # Deletes a single award emoji from a single note on an awardable(issue, merge request or snippet)
+  #
+  # @example
+  #   Gitlab.delete_note_award_emoji(1, 80, 'issue', 1, 4)
+  #   Gitlab.delete_note_award_emoji(1, 60, 'merge_request', 1, 4)
+  #   Gitlab.delete_note_award_emoji(1, 40, 'snippet', 1, 4)
+  #
+  # @param [Integer] project The ID of a project.
+  # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
+  # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
+  # @param [Integer] note_id The ID of a note.
+  # @param [Integer] award_id The ID of an award emoji.
+  # @return [void] This API call returns an empty response body.
+  def delete_note_award_emoji(project, awardable_id, awardable_type, note_id, award_id)
+    delete("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji/#{award_id}")
   end
-end
+end