gitlab 4.6.0 → 4.7.0

data/lib/gitlab/client/milestones.rb

@@ -1,92 +1,94 @@
 # frozen_string_literal: true
 
-# Defines methods related to milestones.
-# @see https://docs.gitlab.com/ce/api/milestones.html
-module Milestones
-  # Gets a list of project's milestones.
-  #
-  # @example
-  #   Gitlab.milestones(5)
-  #
-  # @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 milestones(project, options = {})
-    get("/projects/#{url_encode project}/milestones", query: options)
-  end
+class Gitlab::Client
+  # Defines methods related to milestones.
+  # @see https://docs.gitlab.com/ce/api/milestones.html
+  module Milestones
+    # Gets a list of project's milestones.
+    #
+    # @example
+    #   Gitlab.milestones(5)
+    #
+    # @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 milestones(project, options = {})
+      get("/projects/#{url_encode project}/milestones", query: options)
+    end
 
-  # Gets a single milestone.
-  #
-  # @example
-  #   Gitlab.milestone(5, 36)
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [Integer] id The ID of a milestone.
-  # @return [Gitlab::ObjectifiedHash]
-  def milestone(project, id)
-    get("/projects/#{url_encode project}/milestones/#{id}")
-  end
+    # Gets a single milestone.
+    #
+    # @example
+    #   Gitlab.milestone(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a milestone.
+    # @return [Gitlab::ObjectifiedHash]
+    def milestone(project, id)
+      get("/projects/#{url_encode project}/milestones/#{id}")
+    end
 
-  # Gets the issues of a given milestone.
-  #
-  # @example
-  #   Gitlab.milestone_issues(5, 2)
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [Integer, String] milestone The ID of a milestone.
-  # @option options [Integer] :page The page number.
-  # @option options [Integer] :per_page The number of results per page.
-  # @return [Array<Gitlab::ObjectifiedHash>]
-  def milestone_issues(project, milestone, options = {})
-    get("/projects/#{url_encode project}/milestones/#{milestone}/issues", query: options)
-  end
+    # Gets the issues of a given milestone.
+    #
+    # @example
+    #   Gitlab.milestone_issues(5, 2)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer, String] milestone The ID of a milestone.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def milestone_issues(project, milestone, options = {})
+      get("/projects/#{url_encode project}/milestones/#{milestone}/issues", query: options)
+    end
 
-  # Gets the merge_requests of a given milestone.
-  #
-  # @example
-  #   Gitlab.milestone_merge_requests(5, 2)
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [Integer, String] milestone The ID of a milestone.
-  # @option options [Integer] :page The page number.
-  # @option options [Integer] :per_page The number of results per page.
-  # @return [Array<Gitlab::ObjectifiedHash>]
-  def milestone_merge_requests(project, milestone, options = {})
-    get("/projects/#{url_encode project}/milestones/#{milestone}/merge_requests", query: options)
-  end
+    # Gets the merge_requests of a given milestone.
+    #
+    # @example
+    #   Gitlab.milestone_merge_requests(5, 2)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer, String] milestone The ID of a milestone.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def milestone_merge_requests(project, milestone, options = {})
+      get("/projects/#{url_encode project}/milestones/#{milestone}/merge_requests", query: options)
+    end
 
-  # Creates a new milestone.
-  #
-  # @example
-  #   Gitlab.create_milestone(5, 'v1.0')
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [String] title The title of a milestone.
-  # @param  [Hash] options A customizable set of options.
-  # @option options [String] :description The description of a milestone.
-  # @option options [String] :due_date The due date of a milestone.
-  # @return [Gitlab::ObjectifiedHash] Information about created milestone.
-  def create_milestone(project, title, options = {})
-    body = { title: title }.merge(options)
-    post("/projects/#{url_encode project}/milestones", body: body)
-  end
+    # Creates a new milestone.
+    #
+    # @example
+    #   Gitlab.create_milestone(5, 'v1.0')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] title The title of a milestone.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :description The description of a milestone.
+    # @option options [String] :due_date The due date of a milestone.
+    # @return [Gitlab::ObjectifiedHash] Information about created milestone.
+    def create_milestone(project, title, options = {})
+      body = { title: title }.merge(options)
+      post("/projects/#{url_encode project}/milestones", body: body)
+    end
 
-  # Updates a milestone.
-  #
-  # @example
-  #   Gitlab.edit_milestone(5, 2, { state_event: 'activate' })
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [Integer] id The ID of a milestone.
-  # @param  [Hash] options A customizable set of options.
-  # @option options [String] :title The title of a milestone.
-  # @option options [String] :description The description of a milestone.
-  # @option options [String] :due_date The due date of a milestone.
-  # @option options [String] :state_event The state of a milestone ('close' or 'activate').
-  # @return [Gitlab::ObjectifiedHash] Information about updated milestone.
-  def edit_milestone(project, id, options = {})
-    put("/projects/#{url_encode project}/milestones/#{id}", body: options)
+    # Updates a milestone.
+    #
+    # @example
+    #   Gitlab.edit_milestone(5, 2, { state_event: 'activate' })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a milestone.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :title The title of a milestone.
+    # @option options [String] :description The description of a milestone.
+    # @option options [String] :due_date The due date of a milestone.
+    # @option options [String] :state_event The state of a milestone ('close' or 'activate').
+    # @return [Gitlab::ObjectifiedHash] Information about updated milestone.
+    def edit_milestone(project, id, options = {})
+      put("/projects/#{url_encode project}/milestones/#{id}", body: options)
+    end
   end
 end

data/lib/gitlab/client/namespaces.rb

@@ -1,20 +1,22 @@
 # frozen_string_literal: true
 
-# Defines methods related to namespaces
-# @see https://docs.gitlab.com/ce/api/namespaces.html
-module Namespaces
-  # Gets a list of namespaces.
-  # @see https://docs.gitlab.com/ce/api/namespaces.html#list-namespaces
-  #
-  # @example
-  #   Gitlab.namespaces
-  #
-  # @param  [Hash] options A customizable set of options.
-  # @options options [Integer] :page The page number.
-  # @options options [Integer] :per_page The number of results per page.
-  # @options opttion [String]  :search The string to search for.
-  # @return [Array<Gitlab::ObjectifiedHash>]
-  def namespaces(options = {})
-    get('/namespaces', query: options)
+class Gitlab::Client
+  # Defines methods related to namespaces
+  # @see https://docs.gitlab.com/ce/api/namespaces.html
+  module Namespaces
+    # Gets a list of namespaces.
+    # @see https://docs.gitlab.com/ce/api/namespaces.html#list-namespaces
+    #
+    # @example
+    #   Gitlab.namespaces
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @options options [Integer] :page The page number.
+    # @options options [Integer] :per_page The number of results per page.
+    # @options opttion [String]  :search The string to search for.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def namespaces(options = {})
+      get('/namespaces', query: options)
+    end
   end
 end

data/lib/gitlab/client/notes.rb

@@ -1,284 +1,286 @@
 # frozen_string_literal: true
 
-# Defines methods related to notes.
-# @see https://docs.gitlab.com/ce/api/notes.html
-module Notes
-  # Gets a list of projects notes.
-  #
-  # @example
-  #   Gitlab.notes(5)
-  #
-  # @param [Integer] project The ID of a project.
-  # @option options [Integer] :page The page number.
-  # @option options [Integer] :per_page The number of results per page.
-  # @return [Array<Gitlab::ObjectifiedHash>]
-  def notes(project, options = {})
-    get("/projects/#{url_encode project}/notes", query: options)
-  end
+class Gitlab::Client
+  # Defines methods related to notes.
+  # @see https://docs.gitlab.com/ce/api/notes.html
+  module Notes
+    # Gets a list of projects notes.
+    #
+    # @example
+    #   Gitlab.notes(5)
+    #
+    # @param [Integer] project The ID of a project.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def notes(project, options = {})
+      get("/projects/#{url_encode project}/notes", query: options)
+    end
 
-  # Gets a list of notes for a issue.
-  #
-  # @example
-  #   Gitlab.issue_notes(5, 10)
-  #
-  # @param [Integer] project The ID of a project.
-  # @param [Integer] issue The ID of an issue.
-  # @option options [Integer] :page The page number.
-  # @option options [Integer] :per_page The number of results per page.
-  # @return [Array<Gitlab::ObjectifiedHash>]
-  def issue_notes(project, issue, options = {})
-    get("/projects/#{url_encode project}/issues/#{issue}/notes", query: options)
-  end
+    # Gets a list of notes for a issue.
+    #
+    # @example
+    #   Gitlab.issue_notes(5, 10)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] issue The ID of an issue.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def issue_notes(project, issue, options = {})
+      get("/projects/#{url_encode project}/issues/#{issue}/notes", query: options)
+    end
 
-  # Gets a list of notes for a snippet.
-  #
-  # @example
-  #   Gitlab.snippet_notes(5, 1)
-  #
-  # @param [Integer] project The ID of a project.
-  # @param [Integer] snippet The ID of a snippet.
-  # @option options [Integer] :page The page number.
-  # @option options [Integer] :per_page The number of results per page.
-  # @return [Array<Gitlab::ObjectifiedHash>]
-  def snippet_notes(project, snippet, options = {})
-    get("/projects/#{url_encode project}/snippets/#{snippet}/notes", query: options)
-  end
+    # Gets a list of notes for a snippet.
+    #
+    # @example
+    #   Gitlab.snippet_notes(5, 1)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] snippet The ID of a snippet.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def snippet_notes(project, snippet, options = {})
+      get("/projects/#{url_encode project}/snippets/#{snippet}/notes", query: options)
+    end
 
-  # Gets a list of notes for a merge request.
-  #
-  # @example
-  #   Gitlab.merge_request_notes(5, 1)
-  #
-  # @param [Integer] project The ID of a project.
-  # @param [Integer] merge_request The ID of a merge request.
-  # @option options [Integer] :page The page number.
-  # @option options [Integer] :per_page The number of results per page.
-  # @return [Array<Gitlab::ObjectifiedHash>]
-  def merge_request_notes(project, merge_request, options = {})
-    get("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes", query: options)
-  end
-  alias merge_request_comments merge_request_notes
+    # Gets a list of notes for a merge request.
+    #
+    # @example
+    #   Gitlab.merge_request_notes(5, 1)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] merge_request The ID of a merge request.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def merge_request_notes(project, merge_request, options = {})
+      get("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes", query: options)
+    end
+    alias merge_request_comments merge_request_notes
 
-  # Gets a single wall note.
-  #
-  # @example
-  #   Gitlab.note(5, 15)
-  #
-  # @param [Integer] project The ID of a project.
-  # @param [Integer] id The ID of a note.
-  # @return [Gitlab::ObjectifiedHash]
-  def note(project, id)
-    get("/projects/#{url_encode project}/notes/#{id}")
-  end
+    # Gets a single wall note.
+    #
+    # @example
+    #   Gitlab.note(5, 15)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] id The ID of a note.
+    # @return [Gitlab::ObjectifiedHash]
+    def note(project, id)
+      get("/projects/#{url_encode project}/notes/#{id}")
+    end
 
-  # Gets a single issue note.
-  #
-  # @example
-  #   Gitlab.issue_note(5, 10, 1)
-  #
-  # @param [Integer] project The ID of a project.
-  # @param [Integer] issue The ID of an issue.
-  # @param [Integer] id The ID of a note.
-  # @return [Gitlab::ObjectifiedHash]
-  def issue_note(project, issue, id)
-    get("/projects/#{url_encode project}/issues/#{issue}/notes/#{id}")
-  end
+    # Gets a single issue note.
+    #
+    # @example
+    #   Gitlab.issue_note(5, 10, 1)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] issue The ID of an issue.
+    # @param [Integer] id The ID of a note.
+    # @return [Gitlab::ObjectifiedHash]
+    def issue_note(project, issue, id)
+      get("/projects/#{url_encode project}/issues/#{issue}/notes/#{id}")
+    end
 
-  # Gets a single snippet note.
-  #
-  # @example
-  #   Gitlab.snippet_note(5, 11, 3)
-  #
-  # @param [Integer] project The ID of a project.
-  # @param [Integer] snippet The ID of a snippet.
-  # @param [Integer] id The ID of a note.
-  # @return [Gitlab::ObjectifiedHash]
-  def snippet_note(project, snippet, id)
-    get("/projects/#{url_encode project}/snippets/#{snippet}/notes/#{id}")
-  end
+    # Gets a single snippet note.
+    #
+    # @example
+    #   Gitlab.snippet_note(5, 11, 3)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] snippet The ID of a snippet.
+    # @param [Integer] id The ID of a note.
+    # @return [Gitlab::ObjectifiedHash]
+    def snippet_note(project, snippet, id)
+      get("/projects/#{url_encode project}/snippets/#{snippet}/notes/#{id}")
+    end
 
-  # Gets a single merge_request note.
-  #
-  # @example
-  #   Gitlab.merge_request_note(5, 11, 3)
-  #
-  # @param [Integer] project The ID of a project.
-  # @param [Integer] merge_request The ID of a merge_request.
-  # @param [Integer] id The ID of a note.
-  # @return [Gitlab::ObjectifiedHash]
-  def merge_request_note(project, merge_request, id)
-    get("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes/#{id}")
-  end
+    # Gets a single merge_request note.
+    #
+    # @example
+    #   Gitlab.merge_request_note(5, 11, 3)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] merge_request The ID of a merge_request.
+    # @param [Integer] id The ID of a note.
+    # @return [Gitlab::ObjectifiedHash]
+    def merge_request_note(project, merge_request, id)
+      get("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes/#{id}")
+    end
 
-  # Creates a new wall note.
-  #
-  # @example
-  #   Gitlab.create_note(5, 'This is a wall note!')
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [String] body The body of a note.
-  # @return [Gitlab::ObjectifiedHash] Information about created note.
-  def create_note(project, body)
-    post("/projects/#{url_encode project}/notes", body: { body: body })
-  end
+    # Creates a new wall note.
+    #
+    # @example
+    #   Gitlab.create_note(5, 'This is a wall note!')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] body The body of a note.
+    # @return [Gitlab::ObjectifiedHash] Information about created note.
+    def create_note(project, body)
+      post("/projects/#{url_encode project}/notes", body: { body: body })
+    end
 
-  # Creates a new issue note.
-  #
-  # @example
-  #   Gitlab.create_issue_note(6, 1, 'Adding a note to my issue.')
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [Integer] issue The ID of an issue.
-  # @param  [String] body The body of a note.
-  # @return [Gitlab::ObjectifiedHash] Information about created note.
-  def create_issue_note(project, issue, body)
-    post("/projects/#{url_encode project}/issues/#{issue}/notes", body: { body: body })
-  end
+    # Creates a new issue note.
+    #
+    # @example
+    #   Gitlab.create_issue_note(6, 1, 'Adding a note to my issue.')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] issue The ID of an issue.
+    # @param  [String] body The body of a note.
+    # @return [Gitlab::ObjectifiedHash] Information about created note.
+    def create_issue_note(project, issue, body)
+      post("/projects/#{url_encode project}/issues/#{issue}/notes", body: { body: body })
+    end
 
-  # Creates a new snippet note.
-  #
-  # @example
-  #   Gitlab.create_snippet_note(3, 2, 'Look at this awesome snippet!')
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [Integer] snippet The ID of a snippet.
-  # @param  [String] body The body of a note.
-  # @return [Gitlab::ObjectifiedHash] Information about created note.
-  def create_snippet_note(project, snippet, body)
-    post("/projects/#{url_encode project}/snippets/#{snippet}/notes", body: { body: body })
-  end
+    # Creates a new snippet note.
+    #
+    # @example
+    #   Gitlab.create_snippet_note(3, 2, 'Look at this awesome snippet!')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] snippet The ID of a snippet.
+    # @param  [String] body The body of a note.
+    # @return [Gitlab::ObjectifiedHash] Information about created note.
+    def create_snippet_note(project, snippet, body)
+      post("/projects/#{url_encode project}/snippets/#{snippet}/notes", body: { body: body })
+    end
 
-  # Creates a new note for a single merge request.
-  #
-  # @example
-  #   Gitlab.create_merge_request_note(5, 3, 'This MR is ready for review.')
-  #
-  # @param [Integer] project The ID of a project.
-  # @param [Integer] merge_request The ID of a merge request.
-  # @param [String] body The content of a note.
-  def create_merge_request_note(project, merge_request, body)
-    post("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes", body: { body: body })
-  end
-  alias create_merge_request_comment create_merge_request_note
+    # Creates a new note for a single merge request.
+    #
+    # @example
+    #   Gitlab.create_merge_request_note(5, 3, 'This MR is ready for review.')
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] merge_request The ID of a merge request.
+    # @param [String] body The content of a note.
+    def create_merge_request_note(project, merge_request, body)
+      post("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes", body: { body: body })
+    end
+    alias create_merge_request_comment create_merge_request_note
 
-  # Deletes a wall note.
-  #
-  # @example
-  #   Gitlab.delete_note(5, 15)
-  #
-  # @param [Integer] project The ID of a project.
-  # @param [Integer] id The ID of a note.
-  # @return [Gitlab::ObjectifiedHash]
-  def delete_note(project, id)
-    delete("/projects/#{url_encode project}/notes/#{id}")
-  end
+    # Deletes a wall note.
+    #
+    # @example
+    #   Gitlab.delete_note(5, 15)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] id The ID of a note.
+    # @return [Gitlab::ObjectifiedHash]
+    def delete_note(project, id)
+      delete("/projects/#{url_encode project}/notes/#{id}")
+    end
 
-  # Deletes an issue note.
-  #
-  # @example
-  #   Gitlab.delete_issue_note(5, 10, 1)
-  #
-  # @param [Integer] project The ID of a project.
-  # @param [Integer] issue The ID of an issue.
-  # @param [Integer] id The ID of a note.
-  # @return [Gitlab::ObjectifiedHash]
-  def delete_issue_note(project, issue, id)
-    delete("/projects/#{url_encode project}/issues/#{issue}/notes/#{id}")
-  end
+    # Deletes an issue note.
+    #
+    # @example
+    #   Gitlab.delete_issue_note(5, 10, 1)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] issue The ID of an issue.
+    # @param [Integer] id The ID of a note.
+    # @return [Gitlab::ObjectifiedHash]
+    def delete_issue_note(project, issue, id)
+      delete("/projects/#{url_encode project}/issues/#{issue}/notes/#{id}")
+    end
 
-  # Deletes a snippet note.
-  #
-  # @example
-  #   Gitlab.delete_snippet_note(5, 11, 3)
-  #
-  # @param [Integer] project The ID of a project.
-  # @param [Integer] snippet The ID of a snippet.
-  # @param [Integer] id The ID of a note.
-  # @return [Gitlab::ObjectifiedHash]
-  def delete_snippet_note(project, snippet, id)
-    delete("/projects/#{url_encode project}/snippets/#{snippet}/notes/#{id}")
-  end
+    # Deletes a snippet note.
+    #
+    # @example
+    #   Gitlab.delete_snippet_note(5, 11, 3)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] snippet The ID of a snippet.
+    # @param [Integer] id The ID of a note.
+    # @return [Gitlab::ObjectifiedHash]
+    def delete_snippet_note(project, snippet, id)
+      delete("/projects/#{url_encode project}/snippets/#{snippet}/notes/#{id}")
+    end
 
-  # Deletes a merge_request note.
-  #
-  # @example
-  #   Gitlab.delete_merge_request_note(5, 11, 3)
-  #
-  # @param [Integer] project The ID of a project.
-  # @param [Integer] merge_request The ID of a merge_request.
-  # @param [Integer] id The ID of a note.
-  # @return [Gitlab::ObjectifiedHash]
-  def delete_merge_request_note(project, merge_request, id)
-    delete("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes/#{id}")
-  end
-  alias delete_merge_request_comment delete_merge_request_note
+    # Deletes a merge_request note.
+    #
+    # @example
+    #   Gitlab.delete_merge_request_note(5, 11, 3)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] merge_request The ID of a merge_request.
+    # @param [Integer] id The ID of a note.
+    # @return [Gitlab::ObjectifiedHash]
+    def delete_merge_request_note(project, merge_request, id)
+      delete("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes/#{id}")
+    end
+    alias delete_merge_request_comment delete_merge_request_note
 
-  # Modifies a wall note.
-  #
-  # @example
-  #   Gitlab.edit_note(5, 15, 'This is an edited note')
-  #
-  # @param [Integer] project The ID of a project.
-  # @param [Integer] id The ID of a note.
-  # @param [String] body The content of a note.
-  # @return [Gitlab::ObjectifiedHash]
-  def edit_note(project, id, body)
-    put("/projects/#{url_encode project}/notes/#{id}", body: note_content(body))
-  end
+    # Modifies a wall note.
+    #
+    # @example
+    #   Gitlab.edit_note(5, 15, 'This is an edited note')
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] id The ID of a note.
+    # @param [String] body The content of a note.
+    # @return [Gitlab::ObjectifiedHash]
+    def edit_note(project, id, body)
+      put("/projects/#{url_encode project}/notes/#{id}", body: note_content(body))
+    end
 
-  # Modifies an issue note.
-  #
-  # @example
-  #   Gitlab.edit_issue_note(5, 10, 1, 'This is an edited issue note')
-  #
-  # @param [Integer] project The ID of a project.
-  # @param [Integer] issue The ID of an issue.
-  # @param [Integer] id The ID of a note.
-  # @param [String] body The content of a note.
-  # @return [Gitlab::ObjectifiedHash]
-  def edit_issue_note(project, issue, id, body)
-    put("/projects/#{url_encode project}/issues/#{issue}/notes/#{id}", body: note_content(body))
-  end
+    # Modifies an issue note.
+    #
+    # @example
+    #   Gitlab.edit_issue_note(5, 10, 1, 'This is an edited issue note')
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] issue The ID of an issue.
+    # @param [Integer] id The ID of a note.
+    # @param [String] body The content of a note.
+    # @return [Gitlab::ObjectifiedHash]
+    def edit_issue_note(project, issue, id, body)
+      put("/projects/#{url_encode project}/issues/#{issue}/notes/#{id}", body: note_content(body))
+    end
 
-  # Modifies a snippet note.
-  #
-  # @example
-  #   Gitlab.edit_snippet_note(5, 11, 3, 'This is an edited snippet note')
-  #
-  # @param [Integer] project The ID of a project.
-  # @param [Integer] snippet The ID of a snippet.
-  # @param [Integer] id The ID of a note.
-  # @param [String] body The content of a note.
-  # @return [Gitlab::ObjectifiedHash]
-  def edit_snippet_note(project, snippet, id, body)
-    put("/projects/#{url_encode project}/snippets/#{snippet}/notes/#{id}", body: note_content(body))
-  end
+    # Modifies a snippet note.
+    #
+    # @example
+    #   Gitlab.edit_snippet_note(5, 11, 3, 'This is an edited snippet note')
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] snippet The ID of a snippet.
+    # @param [Integer] id The ID of a note.
+    # @param [String] body The content of a note.
+    # @return [Gitlab::ObjectifiedHash]
+    def edit_snippet_note(project, snippet, id, body)
+      put("/projects/#{url_encode project}/snippets/#{snippet}/notes/#{id}", body: note_content(body))
+    end
 
-  # Modifies a merge_request note.
-  #
-  # @example
-  #   Gitlab.edit_merge_request_note(5, 11, 3, 'This is an edited merge request note')
-  #
-  # @param [Integer] project The ID of a project.
-  # @param [Integer] merge_request The ID of a merge_request.
-  # @param [Integer] id The ID of a note.
-  # @param [String] body The content of a note.
-  # @return [Gitlab::ObjectifiedHash]
-  def edit_merge_request_note(project, merge_request, id, body)
-    put("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes/#{id}", body: note_content(body))
-  end
-  alias edit_merge_request_comment edit_merge_request_note
+    # Modifies a merge_request note.
+    #
+    # @example
+    #   Gitlab.edit_merge_request_note(5, 11, 3, 'This is an edited merge request note')
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] merge_request The ID of a merge_request.
+    # @param [Integer] id The ID of a note.
+    # @param [String] body The content of a note.
+    # @return [Gitlab::ObjectifiedHash]
+    def edit_merge_request_note(project, merge_request, id, body)
+      put("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes/#{id}", body: note_content(body))
+    end
+    alias edit_merge_request_comment edit_merge_request_note
 
-  private
+    private
 
-  # TODO: Remove this method after a couple deprecation cycles.  Replace calls with the code
-  # in the 'else'.
-  def note_content(body)
-    if body.is_a?(Hash)
-      STDERR.puts 'Passing the note body as a Hash is deprecated.  You should just pass the String.'
-      body
-    else
-      { body: body }
+    # TODO: Remove this method after a couple deprecation cycles.  Replace calls with the code
+    # in the 'else'.
+    def note_content(body)
+      if body.is_a?(Hash)
+        STDERR.puts 'Passing the note body as a Hash is deprecated.  You should just pass the String.'
+        body
+      else
+        { body: body }
+      end
     end
   end
 end