gitlab 4.2.0 → 4.18.0

data/lib/gitlab/client/features.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to feature flags.
+  # https://docs.gitlab.com/ce/api/features.html
+  module Features
+    # Get a list of all persisted features, with its gate values.
+    #
+    # @example
+    #   Gitlab.features
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def features
+      get('/features')
+    end
+
+    # Set a features gate value.
+    # If a feature with the given name does not exist yet it will be created. The value can be a boolean, or an integer to indicate percentage of time.
+    #
+    # @example
+    #   Gitlab.set_feature('new_library', true)
+    #   Gitlab.set_feature('new_library', 8)
+    #   Gitlab.set_feature('new_library', true, {user: 'gitlab'})
+    #
+    # @param  [String] name(required) Name of the feature to create or update
+    # @param  [String, Integer] value(required) true or false to enable/disable, or an integer for percentage of time
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :feature_group(optional) A Feature group name
+    # @option options [String] :user(optional) A GitLab username
+    # @option options [String] :project(optional) A projects path, for example "gitlab-org/gitlab-ce"
+    # @return [Gitlab::ObjectifiedHash] Information about the set/created/updated feature.
+    def set_feature(name, value, options = {})
+      body = { value: value }.merge(options)
+      post("/features/#{name}", body: body)
+    end
+
+    # Delete a feature.
+    #
+    # @example
+    #   Gitlab.delete_feature('new_library')
+    #
+    # @param  [String] name Name of the feature to delete
+    # @return [void] This API call returns an empty response body.
+    def delete_feature(name)
+      delete("/features/#{name}")
+    end
+  end
+end

data/lib/gitlab/client/group_badges.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to group badges.
+  # @see https://docs.gitlab.com/ee/api/group_badges.html
+  module GroupBadges
+    # Gets a list of a groups badges.
+    #
+    # @example
+    #   Gitlab.group_badges(5)
+    #   Gitlab.group_badges(5, 'Coverage')
+    #
+    # @param [Integer, String] group(required) The ID or URL-encoded path of the group owned by the authenticated user.
+    # @param [String] name(optional) Name of the badges to return (case-sensitive).
+    # @return [Array<Gitlab::ObjectifiedHash>] List of all badges of a group
+    def group_badges(group, name = nil)
+      query = { name: name } if name
+      get("/groups/#{url_encode group}/badges", query: query)
+    end
+
+    # Gets a badge of a group.
+    #
+    # @example
+    #   Gitlab.group_badge(5, 42)
+    #
+    # @param [Integer, String] group(required) The ID or URL-encoded path of the group owned by the authenticated user.
+    # @param [Integer] badge_id(required) The badge ID.
+    # @return [Gitlab::ObjectifiedHash] Information about the requested badge
+    def group_badge(group, badge_id)
+      get("/groups/#{url_encode group}/badges/#{badge_id}")
+    end
+
+    # Adds a badge to a group.
+    #
+    # @example
+    #   Gitlab.add_group_badge(5, { link_url: 'https://abc.com/gitlab/gitlab-ce/commits/master', image_url: 'https://shields.io/my/badge1' })
+    #
+    # @param [Integer, String] group(required) The ID or URL-encoded path of the group owned by the authenticated user.
+    # @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 group badge.
+    def add_group_badge(group, options = {})
+      post("/groups/#{url_encode group}/badges", body: options)
+    end
+
+    # Updates a badge of a group.
+    #
+    # @example
+    #   Gitlab.edit_group_badge(5, 1, { link_url: 'https://abc.com/gitlab/gitlab-ce/commits/master', image_url: 'https://shields.io/my/badge1' })
+    #
+    # @param [Integer, String] group(required) The ID or URL-encoded path of the group owned by the authenticated user.
+    # @param [Integer] badge_id(required) 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 group badge.
+    def edit_group_badge(group, badge_id, options = {})
+      put("/groups/#{url_encode group}/badges/#{badge_id}", body: options)
+    end
+
+    # Removes a badge from a group.
+    #
+    # @example
+    #   Gitlab.remove_group_badge(5, 42)
+    #
+    # @param [Integer, String] group(required) The ID or URL-encoded path of the group owned by the authenticated user.
+    # @param [Integer] badge_id(required) The badge ID.
+    # @return [nil] This API call returns an empty response body.
+    def remove_group_badge(group, badge_id)
+      delete("/groups/#{url_encode group}/badges/#{badge_id}")
+    end
+
+    # Preview a badge from a group.
+    #
+    # @example
+    #   Gitlab.preview_group_badge(3, 'https://abc.com/gitlab/gitlab-ce/commits/master', 'https://shields.io/my/badge1')
+    #
+    # @param [Integer, String] group(required) The ID or URL-encoded path of the group owned by the authenticated user.
+    # @param [String] :link_url(required) URL of the badge link
+    # @param [String] :image_url(required) 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_group_badge(group, link_url, image_url)
+      query = { link_url: link_url, image_url: image_url }
+      get("/groups/#{url_encode group}/badges/render", query: query)
+    end
+  end
+end

data/lib/gitlab/client/group_boards.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to group issue boards.
+  # @see https://docs.gitlab.com/ee/api/group_boards.html
+  module GroupBoards
+    # Lists Issue Boards in the given group.
+    #
+    # @example
+    #   Gitlab.group_boards(5)
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @return [Array<Gitlab::ObjectifiedHash>] List of issue boards of the group
+    def group_boards(group)
+      get("/groups/#{url_encode group}/boards")
+    end
+
+    # Gets a single group issue board.
+    #
+    # @example
+    #   Gitlab.group_board(5, 1)
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer] id The ID of the issue board.
+    # @return [Gitlab::ObjectifiedHash] Returns information about a group issue board
+    def group_board(group, id)
+      get("/groups/#{url_encode group}/boards/#{id}")
+    end
+
+    # Creates a new group issue board.
+    #
+    # @example
+    #   Gitlab.create_group_board(5, 'Documentcloud')
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [String] name The name of the new board.
+    # @return [Gitlab::ObjectifiedHash] Information about created group issue board.
+    def create_group_board(group, name)
+      body = { name: name }
+      post("/groups/#{url_encode group}/boards", body: body)
+    end
+
+    # Updates a group issue board.
+    #
+    # @example
+    #   Gitlab.edit_group_board(5, 1, { name: 'DocumentCloud2' })
+    #   Gitlab.edit_group_board(5, 1, { name: 'DocumentCloud2', assignee_id: 3 })
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer] id The ID of the issue board.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :name(optional) The new name of the board.
+    # @option options [Integer] :assignee_id(optional) The assignee the board should be scoped to.
+    # @option options [Integer] :milestone_id(optional) The milestone the board should be scoped to.
+    # @option options [String] :labels(optional) Comma-separated list of label names which the board should be scoped to.
+    # @option options [Integer] :weight(optional) The weight range from 0 to 9, to which the board should be scoped to.
+    # @return [Gitlab::ObjectifiedHash] Information about updated group issue board.
+    def edit_group_board(group, id, options = {})
+      put("/groups/#{url_encode group}/boards/#{id}", body: options)
+    end
+
+    # Deletes a group issue board.
+    #
+    # @example
+    #   Gitlab.delete_group_board(5, 1)
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer] id The ID of the issue board.
+    # @return [void] This API call returns an empty response body.
+    def delete_group_board(group, id)
+      delete("/groups/#{url_encode group}/boards/#{id}")
+    end
+
+    # Get a list of the boards lists. Does not include open and closed lists
+    #
+    # @example
+    #   Gitlab.group_board_lists(5, 1)
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer] board_id The ID of the group issue board.
+    # @return [Array<Gitlab::ObjectifiedHash>] List of boards lists of the group
+    def group_board_lists(group, board_id)
+      get("/groups/#{url_encode group}/boards/#{board_id}/lists")
+    end
+
+    # Get a single group issue board list.
+    #
+    # @example
+    #   Gitlab.group_board_list(5, 1, 1)
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer] board_id The ID of the group issue board.
+    # @param  [Integer] list_id The ID of a boards list.
+    # @return [Gitlab::ObjectifiedHash] Returns information about a single group issue board list
+    def group_board_list(group, board_id, id)
+      get("/groups/#{url_encode group}/boards/#{board_id}/lists/#{id}")
+    end
+
+    # Creates a new group issue board list.
+    #
+    # @example
+    #   Gitlab.create_group_board_list(5, 1)
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer] board_id The ID of the group issue board.
+    # @param  [Integer] label_id The ID of a label.
+    # @return [Gitlab::ObjectifiedHash] Information about created group issue board list.
+    def create_group_board_list(group, board_id, label_id)
+      body = { label_id: label_id }
+      post("/groups/#{url_encode group}/boards/#{board_id}/lists", body: body)
+    end
+
+    # Updates an existing group issue board list. This call is used to change list position.
+    #
+    # @example
+    #   Gitlab.edit_group_board_list(5, 1, 1, { position: 1 })
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer] board_id The ID of the group issue board.
+    # @param  [Integer] list_id The ID of a boards list.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :position(required) The position of the list.
+    # @return [Gitlab::ObjectifiedHash] Information about updated group issue board list.
+    def edit_group_board_list(group, board_id, id, options = {})
+      put("/groups/#{url_encode group}/boards/#{board_id}/lists/#{id}", body: options)
+    end
+
+    # Deletes a group issue board list.
+    #
+    # @example
+    #   Gitlab.delete_group_board_list(5, 1, 1)
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer] board_id The ID of the group issue board.
+    # @param  [Integer] list_id The ID of a boards list.
+    # @return [void] This API call returns an empty response body.
+    def delete_group_board_list(group, board_id, id)
+      delete("/groups/#{url_encode group}/boards/#{board_id}/lists/#{id}")
+    end
+  end
+end

data/lib/gitlab/client/group_labels.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to group labels.
+  #
+  # @note Requires GitLab 11.8+
+  # @see https://docs.gitlab.com/ee/api/group_labels.html
+  module GroupLabels
+    # Gets a list of group's labels.
+    #
+    # @example
+    #   Gitlab.group_labels('globex')
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def group_labels(group, options = {})
+      get("/groups/#{url_encode group}/labels", query: options)
+    end
+
+    # Creates a new group label.
+    #
+    # @example
+    #   Gitlab.create_group_label('globex', 'Backlog', '#DD10AA')
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [String] name The name of a label.
+    # @param  [String] color The color of a label.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :description The description of the label.
+    # @return [Gitlab::ObjectifiedHash] Information about created label.
+    def create_group_label(group, name, color, options = {})
+      post("/groups/#{url_encode group}/labels", body: options.merge(name: name, color: color))
+    end
+
+    # Updates a group label.
+    #
+    # @example
+    #   Gitlab.edit_group_label('globex', 'Backlog', { new_name: 'Priority' })
+    #   Gitlab.edit_group_label('globex', 'Backlog', { new_name: 'Priority', color: '#DD10AA' })
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [String] name The name of a label.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :new_name The new name of a label.
+    # @option options [String] :color The color of a label.
+    # @option options [String] :description The description of the label.
+    # @return [Gitlab::ObjectifiedHash] Information about updated label.
+    def edit_group_label(group, name, options = {})
+      put("/groups/#{url_encode group}/labels", body: options.merge(name: name))
+    end
+
+    # Deletes a group label.
+    #
+    # @example
+    #   Gitlab.delete_group_label('globex', 'Backlog')
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [String] name The name of a label.
+    # @return [Gitlab::ObjectifiedHash] Information about deleted label.
+    def delete_group_label(group, name)
+      delete("/groups/#{url_encode group}/labels/#{name}")
+    end
+
+    # Subscribes the user to a group label to receive notifications
+    #
+    # @example
+    #   Gitlab.subscribe_to_group_label('globex', 'Backlog')
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [String] name The name of a label.
+    # @return [Gitlab::ObjectifiedHash] Information about the label subscribed to.
+    def subscribe_to_group_label(group, name)
+      post("/groups/#{url_encode group}/labels/#{url_encode name}/subscribe")
+    end
+
+    # Unsubscribes the user from a group label to not receive notifications from it
+    #
+    # @example
+    #   Gitlab.unsubscribe_from_group_label('globex', 'Backlog')
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [String] name The name of a label.
+    # @return [Gitlab::ObjectifiedHash] Information about the label unsubscribed from.
+    def unsubscribe_from_group_label(group, name)
+      post("/groups/#{url_encode group}/labels/#{url_encode name}/unsubscribe")
+    end
+  end
+end

data/lib/gitlab/client/group_milestones.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to group milestones.
+  # @see https://docs.gitlab.com/ee/api/group_milestones.html
+  module GroupMilestones
+    # Gets a list of a group's milestones.
+    #
+    # @example
+    #   Gitlab.group_milestones(5)
+    #
+    # @param  [Integer, String] id The ID or name of a group.
+    # @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 group_milestones(id, options = {})
+      get("/groups/#{url_encode id}/milestones", query: options)
+    end
+
+    # Gets a single group milestone.
+    #
+    # @example
+    #   Gitlab.group_milestone(5, 36)
+    #
+    # @param  [Integer, String] id The ID or name of a group.
+    # @param  [Integer] milestone_id The ID of a milestone.
+    # @return [Gitlab::ObjectifiedHash]
+    def group_milestone(id, milestone_id)
+      get("/groups/#{url_encode id}/milestones/#{milestone_id}")
+    end
+
+    # Creates a new group milestone.
+    #
+    # @example
+    #   Gitlab.create_group_milestone(5, 'v1.0')
+    #
+    # @param  [Integer, String] id The ID or name of a group.
+    # @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_group_milestone(id, title, options = {})
+      body = { title: title }.merge(options)
+      post("/groups/#{url_encode id}/milestones", body: body)
+    end
+
+    # Updates a group milestone.
+    #
+    # @example
+    #   Gitlab.edit_group_milestone(5, 2, { state_event: 'activate' })
+    #
+    # @param  [Integer, String] id The ID or name of a group.
+    # @param  [Integer] milestone_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_group_milestone(id, milestone_id, options = {})
+      put("/groups/#{url_encode id}/milestones/#{milestone_id}", body: options)
+    end
+
+    # Gets the issues of a given group milestone.
+    #
+    # @example
+    #   Gitlab.group_milestone_issues(5, 2)
+    #
+    # @param  [Integer, String] id The ID or name of a group.
+    # @param  [Integer, String] milestone_id 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 group_milestone_issues(id, milestone_id, options = {})
+      get("/groups/#{url_encode id}/milestones/#{milestone_id}/issues", query: options)
+    end
+
+    # Gets the merge_requests of a given group milestone.
+    #
+    # @example
+    #   Gitlab.group_milestone_merge_requests(5, 2)
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer, String] milestone_id 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 group_milestone_merge_requests(id, milestone_id, options = {})
+      get("/groups/#{url_encode id}/milestones/#{milestone_id}/merge_requests", query: options)
+    end
+  end
+end