gitlab 4.2.0 → 4.18.0

data/lib/gitlab/client/milestones.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Gitlab::Client
   # Defines methods related to milestones.
   # @see https://docs.gitlab.com/ce/api/milestones.html
@@ -12,7 +14,7 @@ class Gitlab::Client
     # @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={})
+    def milestones(project, options = {})
       get("/projects/#{url_encode project}/milestones", query: options)
     end
 
@@ -38,7 +40,7 @@ class Gitlab::Client
     # @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={})
+    def milestone_issues(project, milestone, options = {})
       get("/projects/#{url_encode project}/milestones/#{milestone}/issues", query: options)
     end
 
@@ -52,7 +54,7 @@ class Gitlab::Client
     # @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={})
+    def milestone_merge_requests(project, milestone, options = {})
       get("/projects/#{url_encode project}/milestones/#{milestone}/merge_requests", query: options)
     end
 
@@ -67,7 +69,7 @@ class Gitlab::Client
     # @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={})
+    def create_milestone(project, title, options = {})
       body = { title: title }.merge(options)
       post("/projects/#{url_encode project}/milestones", body: body)
     end
@@ -85,8 +87,20 @@ class Gitlab::Client
     # @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={})
+    def edit_milestone(project, id, options = {})
       put("/projects/#{url_encode project}/milestones/#{id}", body: options)
     end
+
+    # Delete a project milestone.
+    #
+    # @example
+    #   Gitlab.delete_milestone(5, 2)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a milestone.
+    # @return [nil] This API call returns an empty response body.
+    def delete_milestone(project, id)
+      delete("/projects/#{url_encode project}/milestones/#{id}")
+    end
   end
 end

data/lib/gitlab/client/namespaces.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Gitlab::Client
   # Defines methods related to namespaces
   # @see https://docs.gitlab.com/ce/api/namespaces.html
@@ -13,8 +15,8 @@ class Gitlab::Client
     # @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)
+    def namespaces(options = {})
+      get('/namespaces', query: options)
     end
   end
 end

data/lib/gitlab/client/notes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Gitlab::Client
   # Defines methods related to notes.
   # @see https://docs.gitlab.com/ce/api/notes.html
@@ -11,7 +13,7 @@ class Gitlab::Client
     # @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={})
+    def notes(project, options = {})
       get("/projects/#{url_encode project}/notes", query: options)
     end
 
@@ -25,7 +27,7 @@ class Gitlab::Client
     # @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={})
+    def issue_notes(project, issue, options = {})
       get("/projects/#{url_encode project}/issues/#{issue}/notes", query: options)
     end
 
@@ -39,7 +41,7 @@ class Gitlab::Client
     # @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={})
+    def snippet_notes(project, snippet, options = {})
       get("/projects/#{url_encode project}/snippets/#{snippet}/notes", query: options)
     end
 
@@ -53,10 +55,24 @@ class Gitlab::Client
     # @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={})
+    def merge_request_notes(project, merge_request, options = {})
       get("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes", query: options)
     end
-    alias_method :merge_request_comments, :merge_request_notes
+    alias merge_request_comments merge_request_notes
+
+    # Gets a list of notes for an epic.
+    #
+    # @example
+    #   Gitlab.epic_notes(5, 10)
+    #
+    # @param [Integer] project The ID of a group.
+    # @param [Integer] epic The ID of an epic.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def epic_notes(group, epic, options = {})
+      get("/groups/#{url_encode group}/epics/#{epic}/notes", query: options)
+    end
 
     # Gets a single wall note.
     #
@@ -158,7 +174,20 @@ class Gitlab::Client
     def create_merge_request_note(project, merge_request, body)
       post("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes", body: { body: body })
     end
-    alias_method :create_merge_request_comment, :create_merge_request_note
+    alias create_merge_request_comment create_merge_request_note
+
+    # Creates a new epic note.
+    #
+    # @example
+    #   Gitlab.create_epic_note(6, 1, 'Adding a note to my epic.')
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer] epic The ID of an epic.
+    # @param  [String] body The body of a note.
+    # @return [Gitlab::ObjectifiedHash] Information about created note.
+    def create_epic_note(group, epic, body)
+      post("/groups/#{url_encode group}/epics/#{epic}/notes", body: { body: body })
+    end
 
     # Deletes a wall note.
     #
@@ -210,7 +239,7 @@ class Gitlab::Client
     def delete_merge_request_note(project, merge_request, id)
       delete("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes/#{id}")
     end
-    alias_method :delete_merge_request_comment, :delete_merge_request_note
+    alias delete_merge_request_comment delete_merge_request_note
 
     # Modifies a wall note.
     #
@@ -219,9 +248,10 @@ class Gitlab::Client
     #
     # @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: body)
+      put("/projects/#{url_encode project}/notes/#{id}", body: note_content(body))
     end
 
     # Modifies an issue note.
@@ -232,9 +262,10 @@ class Gitlab::Client
     # @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: body)
+      put("/projects/#{url_encode project}/issues/#{issue}/notes/#{id}", body: note_content(body))
     end
 
     # Modifies a snippet note.
@@ -245,9 +276,10 @@ class Gitlab::Client
     # @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: body)
+      put("/projects/#{url_encode project}/snippets/#{snippet}/notes/#{id}", body: note_content(body))
     end
 
     # Modifies a merge_request note.
@@ -258,10 +290,24 @@ class Gitlab::Client
     # @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: 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
+
+    # 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)
+        warn 'Passing the note body as a Hash is deprecated.  You should just pass the String.'
+        body
+      else
+        { body: body }
+      end
     end
-    alias_method :edit_merge_request_comment, :edit_merge_request_note
   end
 end

data/lib/gitlab/client/pipeline_schedules.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to pipeline schedules.
+  # @see https://docs.gitlab.com/ce/api/pipeline_schedules.html
+  module PipelineSchedules
+    # Gets a list of project pipeline schedules.
+    #
+    # @example
+    #   Gitlab.pipeline_schedules(5)
+    #   Gitlab.pipeline_schedules(5, { scope: 'active' })
+    #
+    # @param   [Integer, String] project the ID or name of a project.
+    # @param   [Hash] options A customizable set of options.
+    # @options options [String] :scope The scope of pipeline schedules, one of a 'active' or 'inactive'.
+    # @return  [Array<Gitlab::ObjectifiedHash>]
+    def pipeline_schedules(project, options = {})
+      get("/projects/#{url_encode project}/pipeline_schedules", query: options)
+    end
+
+    # Gets a single pipeline schedule.
+    #
+    # @example
+    #   Gitlab.pipeline_schedule(5, 3)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of the pipeline schedule.
+    # @return [Gitlab::ObjectifiedHash]
+    def pipeline_schedule(project, id)
+      get("/projects/#{url_encode project}/pipeline_schedules/#{id}")
+    end
+
+    # Create a pipeline schedule.
+    #
+    # @example
+    #   Gitlab.create_pipeline_schedule(5, { description: 'example' })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :description The description of pipeline scehdule.
+    # @option options [String] :ref The branch/tag name will be triggered.
+    # @option options [String] :cron The cron (e.g. 0 1 * * *).
+    # @option options [String] :cron_timezone The timezone supproted by ActiveSupport::TimeZone (e.g. Pacific Time (US & Canada)) (default: 'UTC').
+    # @option options [Boolean] :active The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially (default: true).
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def create_pipeline_schedule(project, options = {})
+      post("/projects/#{url_encode project}/pipeline_schedules", body: options)
+    end
+
+    # Updates the pipeline schedule of a project.
+    #
+    # @example
+    #   Gitlab.edit_pipeline_schedule(3, 2, { description: 'example2' })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] The pipeline schedule ID.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :description The description of pipeline scehdule.
+    # @option options [String] :ref The branch/tag name will be triggered.
+    # @option options [String] :cron The cron (e.g. 0 1 * * *).
+    # @option options [String] :cron_timezone The timezone supproted by ActiveSupport::TimeZone (e.g. Pacific Time (US & Canada)) (default: 'UTC').
+    # @option options [Boolean] :active The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially (default: true).
+    # @return [Array<Gitlab::ObjectifiedHash>] The updated pipeline schedule.
+    def edit_pipeline_schedule(project, pipeline_schedule_id, options = {})
+      put("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}", body: options)
+    end
+
+    # Take ownership of a pipeline schedule.
+    #
+    # @example
+    #   Gitlab.pipeline_schedule_take_ownership(5, 1)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] trigger_id The pipeline schedule ID.
+    # @return [Gitlab::ObjectifiedHash] The updated pipeline schedule.
+    def pipeline_schedule_take_ownership(project, pipeline_schedule_id)
+      post("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}/take_ownership")
+    end
+
+    # Run a scheduled pipeline immediately.
+    #
+    # @example
+    #   Gitlab.run_pipeline_schedule(5, 1)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] trigger_id The pipeline schedule ID.
+    # @return [Gitlab::ObjectifiedHash] Pipeline created message.
+    def run_pipeline_schedule(project, pipeline_schedule_id)
+      post("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}/play")
+    end
+
+    # Delete a pipeline schedule.
+    #
+    # @example
+    #   Gitlab.delete_pipeline_schedule(5, 1)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] trigger_id The pipeline schedule ID.
+    # @return [Gitlab::ObjectifiedHash] The deleted pipeline schedule.
+    def delete_pipeline_schedule(project, pipeline_schedule_id)
+      delete("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}")
+    end
+
+    # Create a pipeline schedule variable.
+    #
+    # @example
+    #   Gitlab.create_pipeline_schedule_variable(5, 1, { key: 'foo', value: 'bar' })
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] trigger_id The pipeline schedule ID.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :key The key of a variable; must have no more than 255 characters; only A-Z, a-z, 0-9, and _ are allowed.
+    # @option options [String] :value The value of a variable
+    # @return [Array<Gitlab::ObjectifiedHash>] The created pipeline schedule variable.
+    def create_pipeline_schedule_variable(project, pipeline_schedule_id, options = {})
+      post("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}/variables", body: options)
+    end
+
+    # Updates the variable of a pipeline schedule.
+    #
+    # @example
+    #   Gitlab.edit_pipeline_schedule_variable(3, 2, "foo" { value: 'bar' })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] The pipeline schedule ID.
+    # @param  [String] The key of a variable.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :value The value of a variable.
+    # @return [Array<Gitlab::ObjectifiedHash>] The updated pipeline schedule variable.
+    def edit_pipeline_schedule_variable(project, pipeline_schedule_id, key, options = {})
+      put("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}/variables/#{url_encode key}", body: options)
+    end
+
+    # Delete the variable of a pipeline schedule
+    #
+    # @example
+    #   Gitlab.delete_pipeline_schedule_variable(3, 2, "foo")
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] The pipeline schedule ID.
+    # @param  [String] The key of a variable.
+    # @return [Array<Gitlab::ObjectifiedHash>] The deleted pipeline schedule variable.
+    def delete_pipeline_schedule_variable(project, pipeline_schedule_id, key, _options = {})
+      delete("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}/variables/#{url_encode key}")
+    end
+  end
+end

data/lib/gitlab/client/pipeline_triggers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Gitlab::Client
   # Defines methods related to pipelines.
   # @see https://docs.gitlab.com/ce/api/pipeline_triggers.html
@@ -35,7 +37,7 @@ class Gitlab::Client
     # @param  [String] description The trigger name
     # @return [Gitlab::ObjectifiedHash] The created trigger.
     def create_trigger(project, description)
-      post("/projects/#{url_encode project}/triggers", body: {description: description})
+      post("/projects/#{url_encode project}/triggers", body: { description: description })
     end
 
     # Update a project trigger
@@ -48,7 +50,7 @@ class Gitlab::Client
     # @param [Hash] options A customizable set of options.
     # @option options [String] :description The trigger name.
     # @return [Gitlab::ObjectifiedHash] The updated trigger.
-    def update_trigger(project, trigger_id, options={})
+    def update_trigger(project, trigger_id, options = {})
       put("/projects/#{url_encode project}/triggers/#{trigger_id}", body: options)
     end
 
@@ -75,13 +77,13 @@ class Gitlab::Client
     def remove_trigger(project, trigger_id)
       delete("/projects/#{url_encode project}/triggers/#{trigger_id}")
     end
-    alias_method :delete_trigger, :remove_trigger
+    alias delete_trigger remove_trigger
 
     # Run the given project pipeline trigger.
     #
     # @example
-    #   Gitlab.trigger_build(5, '7b9148c158980bbd9bcea92c17522d', 'master')
-    #   Gitlab.trigger_build(5, '7b9148c158980bbd9bcea92c17522d', 'master', { variable1: "value", variable2: "value2" })
+    #   Gitlab.run_trigger(5, '7b9148c158980bbd9bcea92c17522d', 'master')
+    #   Gitlab.run_trigger(5, '7b9148c158980bbd9bcea92c17522d', 'master', { variable1: "value", variable2: "value2" })
     #
     # @see https://docs.gitlab.com/ce/ci/triggers/README.html
     #
@@ -90,12 +92,12 @@ class Gitlab::Client
     # @param  [String] ref Branch or tag name to build.
     # @param  [Hash] variables A set of build variables to use for the build. (optional)
     # @return [Gitlab::ObjectifiedHash] The trigger.
-    def run_trigger(project, token, ref, variables={})
+    def run_trigger(project, token, ref, variables = {})
       post("/projects/#{url_encode project}/trigger/pipeline", unauthenticated: true, body: {
-        token: token,
-        ref: ref,
-        variables: variables
-      })
+             token: token,
+             ref: ref,
+             variables: variables
+           })
     end
   end
 end

data/lib/gitlab/client/pipelines.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Gitlab::Client
   # Defines methods related to pipelines.
   # @see https://docs.gitlab.com/ce/api/pipelines.html
@@ -13,7 +15,7 @@ class Gitlab::Client
     # @option options [Integer] :page The page number.
     # @option options [Integer] :per_page The number of results per page.
     # @return [Array<Gitlab::ObjectifiedHash>]
-    def pipelines(project, options={})
+    def pipelines(project, options = {})
       get("/projects/#{url_encode project}/pipelines", query: options)
     end
 
@@ -29,6 +31,18 @@ class Gitlab::Client
       get("/projects/#{url_encode project}/pipelines/#{id}")
     end
 
+    # Gets a single pipeline's test report.
+    #
+    # @example
+    #   Gitlab.pipeline_test_report(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a pipeline.
+    # @return [Gitlab::ObjectifiedHash]
+    def pipeline_test_report(project, id)
+      get("/projects/#{url_encode project}/pipelines/#{id}/test_report")
+    end
+
     # Create a pipeline.
     #
     # @example
@@ -36,9 +50,20 @@ class Gitlab::Client
     #
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] ref Reference to commit.
+    # @param  [Hash] variables Variables passed to pipelines
     # @return [Gitlab::ObjectifiedHash] The pipelines changes.
-    def create_pipeline(project, ref)
-      post("/projects/#{url_encode project}/pipeline?ref=#{ref}")
+    def create_pipeline(project, ref, variables = {})
+      body = {}
+
+      # This mapping is necessary, cause the API expects an array with objects (with `key` and `value` keys)
+      # See: https://docs.gitlab.com/ee/api/pipelines.html#create-a-new-pipeline
+      body[:variables] = variables.map { |(key, value)| { key: key, value: value } } if variables.any?
+
+      post(
+        "/projects/#{url_encode project}/pipeline",
+        query: { ref: ref },
+        body: body
+      )
     end
 
     # Cancels a pipeline.
@@ -64,5 +89,17 @@ class Gitlab::Client
     def retry_pipeline(project, id)
       post("/projects/#{url_encode project}/pipelines/#{id}/retry")
     end
+
+    # Delete a pipeline
+    #
+    # @example
+    #   Gitlab.delete_pipeline(5, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a pipeline.
+    # @return [void] This API call returns an empty response body.
+    def delete_pipeline(project, id)
+      delete("/projects/#{url_encode project}/pipelines/#{id}")
+    end
   end
 end

data/lib/gitlab/client/project_badges.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to project badges.
+  # @see https://docs.gitlab.com/ee/api/project_badges.html
+  module ProjectBadges
+    # Gets a list of a projects badges and its group badges.
+    #
+    # @example
+    #   Gitlab.project_badges(5)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>] List of all badges of a project
+    def project_badges(project)
+      get("/projects/#{url_encode project}/badges")
+    end
+
+    # Gets a badge of a project.
+    #
+    # @example
+    #   Gitlab.project_badge(5, 42)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] badge_id The badge ID.
+    # @return [Gitlab::ObjectifiedHash] Information about the requested badge
+    def project_badge(project, badge_id)
+      get("/projects/#{url_encode project}/badges/#{badge_id}")
+    end
+
+    # Adds a badge to a project.
+    #
+    # @example
+    #   Gitlab.add_project_badge(5, { link_url: 'https://abc.com/gitlab/gitlab-ce/commits/master', image_url: 'https://shields.io/my/badge1' })
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :link_url(required) URL of the badge link
+    # @option options [String] :image_url(required) URL of the badge image
+    # @return [Gitlab::ObjectifiedHash] Information about the added project badge.
+    def add_project_badge(project, options = {})
+      post("/projects/#{url_encode project}/badges", body: options)
+    end
+
+    # Updates a badge of a project..
+    #
+    # @example
+    #   Gitlab.edit_project_badge(5, 1, { link_url: 'https://abc.com/gitlab/gitlab-ce/commits/master', image_url: 'https://shields.io/my/badge1' })
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] badge_id The badge ID.
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] :link_url(optional) URL of the badge link
+    # @option options [String] :image_url(optional) URL of the badge image
+    # @return [Gitlab::ObjectifiedHash] Information about the updated project badge.
+    def edit_project_badge(project, badge_id, options = {})
+      put("/projects/#{url_encode project}/badges/#{badge_id}", body: options)
+    end
+
+    # Removes a badge from a project. Only projects badges will be removed by using this endpoint.
+    #
+    # @example
+    #   Gitlab.remove_project_badge(5, 42)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] badge_id The badge ID.
+    # @return [nil] This API call returns an empty response body.
+    def remove_project_badge(project, badge_id)
+      delete("/projects/#{url_encode project}/badges/#{badge_id}")
+    end
+
+    # Preview a badge from a project.
+    #
+    # @example
+    #   Gitlab.preview_project_badge(3, 'https://abc.com/gitlab/gitlab-ce/commits/master', 'https://shields.io/my/badge1')
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [String] :link_url URL of the badge link
+    # @param [String] :image_url URL of the badge image
+    # @return [Gitlab::ObjectifiedHash] Returns how the link_url and image_url final URLs would be after resolving the placeholder interpolation.
+    def preview_project_badge(project, link_url, image_url)
+      query = { link_url: link_url, image_url: image_url }
+      get("/projects/#{url_encode project}/badges/render", query: query)
+    end
+  end
+end