gitlab-faraday 5.1.0

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