Merge branch 'api-group-labels' into 'master'

API group labels

Closes #44901

See merge request gitlab-org/gitlab-ce!21368

7 files changed, 236 insertions, 102 deletions

diff --git a/lib/api/api.rb b/lib/api/api.rb
index 9cbfc0e35ff..4dd1b459554 100644
--- a/lib/api/api.rb
+++ b/lib/api/api.rb
@@ -109,6 +109,7 @@ module API
     mount ::API::Features
     mount ::API::Files
     mount ::API::GroupBoards
+    mount ::API::GroupLabels
     mount ::API::GroupMilestones
     mount ::API::Groups
     mount ::API::GroupVariables
diff --git a/lib/api/entities.rb b/lib/api/entities.rb
index a1f0efa3c68..beb8ce349b4 100644
--- a/lib/api/entities.rb
+++ b/lib/api/entities.rb
@@ -1019,12 +1019,17 @@ module API
         label.open_merge_requests_count(options[:current_user])
       end
 
-      expose :priority do |label, options|
-        label.priority(options[:project])
+      expose :subscribed do |label, options|
+        label.subscribed?(options[:current_user], options[:parent])
       end
+    end
 
-      expose :subscribed do |label, options|
-        label.subscribed?(options[:current_user], options[:project])
+    class GroupLabel < Label
+    end
+
+    class ProjectLabel < Label
+      expose :priority do |label, options|
+        label.priority(options[:parent])
       end
     end
 
diff --git a/lib/api/group_labels.rb b/lib/api/group_labels.rb
new file mode 100644
index 00000000000..0dbc5f45a68
--- /dev/null
+++ b/lib/api/group_labels.rb
@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module API
+  class GroupLabels < Grape::API
+    include PaginationParams
+    helpers ::API::Helpers::LabelHelpers
+
+    before { authenticate! }
+
+    params do
+      requires :id, type: String, desc: 'The ID of a group'
+    end
+    resource :groups, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
+      desc 'Get all labels of the group' do
+        detail 'This feature was added in GitLab 11.8'
+        success Entities::GroupLabel
+      end
+      params do
+        use :pagination
+      end
+      get ':id/labels' do
+        get_labels(user_group, Entities::GroupLabel)
+      end
+
+      desc 'Create a new label' do
+        detail 'This feature was added in GitLab 11.8'
+        success Entities::GroupLabel
+      end
+      params do
+        use :label_create_params
+      end
+      post ':id/labels' do
+        create_label(user_group, Entities::GroupLabel)
+      end
+
+      desc 'Update an existing label. At least one optional parameter is required.' do
+        detail 'This feature was added in GitLab 11.8'
+        success Entities::GroupLabel
+      end
+      params do
+        requires :name, type: String, desc: 'The name of the label to be updated'
+        optional :new_name, type: String, desc: 'The new name of the label'
+        optional :color, type: String, desc: "The new color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB) or one of the allowed CSS color names"
+        optional :description, type: String, desc: 'The new description of label'
+        at_least_one_of :new_name, :color, :description
+      end
+      put ':id/labels' do
+        update_label(user_group, Entities::GroupLabel)
+      end
+
+      desc 'Delete an existing label' do
+        detail 'This feature was added in GitLab 11.8'
+        success Entities::GroupLabel
+      end
+      params do
+        requires :name, type: String, desc: 'The name of the label to be deleted'
+      end
+      delete ':id/labels' do
+        delete_label(user_group)
+      end
+    end
+  end
+end
diff --git a/lib/api/helpers.rb b/lib/api/helpers.rb
index e3d0b981065..2eb7b04711a 100644
--- a/lib/api/helpers.rb
+++ b/lib/api/helpers.rb
@@ -84,8 +84,8 @@ module API
       page || not_found!('Wiki Page')
     end
 
-    def available_labels_for(label_parent)
-      search_params = { include_ancestor_groups: true }
+    def available_labels_for(label_parent, include_ancestor_groups: true)
+      search_params = { include_ancestor_groups: include_ancestor_groups }
 
       if label_parent.is_a?(Project)
         search_params[:project_id] = label_parent.id
@@ -170,13 +170,6 @@ module API
       end
     end
 
-    def find_project_label(id)
-      labels = available_labels_for(user_project)
-      label = labels.find_by_id(id) || labels.find_by_title(id)
-
-      label || not_found!('Label')
-    end
-
     # rubocop: disable CodeReuse/ActiveRecord
     def find_project_issue(iid)
       IssuesFinder.new(current_user, project_id: user_project.id).find_by!(iid: iid)
diff --git a/lib/api/helpers/label_helpers.rb b/lib/api/helpers/label_helpers.rb
new file mode 100644
index 00000000000..c11e7d614ab
--- /dev/null
+++ b/lib/api/helpers/label_helpers.rb
@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module API
+  module Helpers
+    module LabelHelpers
+      extend Grape::API::Helpers
+
+      params :label_create_params do
+        requires :name, type: String, desc: 'The name of the label to be created'
+        requires :color, type: String, desc: "The color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB) or one of the allowed CSS color names"
+        optional :description, type: String, desc: 'The description of label to be created'
+      end
+
+      def find_label(parent, id, include_ancestor_groups: true)
+        labels = available_labels_for(parent, include_ancestor_groups: include_ancestor_groups)
+        label = labels.find_by_id(id) || labels.find_by_title(id)
+
+        label || not_found!('Label')
+      end
+
+      def get_labels(parent, entity)
+        present paginate(available_labels_for(parent)), with: entity, current_user: current_user, parent: parent
+      end
+
+      def create_label(parent, entity)
+        authorize! :admin_label, parent
+
+        label = available_labels_for(parent).find_by_title(params[:name])
+        conflict!('Label already exists') if label
+
+        priority = params.delete(:priority)
+        label_params = declared_params(include_missing: false)
+
+        label =
+          if parent.is_a?(Project)
+            ::Labels::CreateService.new(label_params).execute(project: parent)
+          else
+            ::Labels::CreateService.new(label_params).execute(group: parent)
+          end
+
+        if label.persisted?
+          if parent.is_a?(Project)
+            label.prioritize!(parent, priority) if priority
+          end
+
+          present label, with: entity, current_user: current_user, parent: parent
+        else
+          render_validation_error!(label)
+        end
+      end
+
+      def update_label(parent, entity)
+        authorize! :admin_label, parent
+
+        label = find_label(parent, params[:name], include_ancestor_groups: false)
+        update_priority = params.key?(:priority)
+        priority = params.delete(:priority)
+
+        label = ::Labels::UpdateService.new(declared_params(include_missing: false)).execute(label)
+        render_validation_error!(label) unless label.valid?
+
+        if parent.is_a?(Project) && update_priority
+          if priority.nil?
+            label.unprioritize!(parent)
+          else
+            label.prioritize!(parent, priority)
+          end
+        end
+
+        present label, with: entity, current_user: current_user, parent: parent
+      end
+
+      def delete_label(parent)
+        authorize! :admin_label, parent
+
+        label = find_label(parent, params[:name], include_ancestor_groups: false)
+
+        destroy_conditionally!(label)
+      end
+    end
+  end
+end
diff --git a/lib/api/labels.rb b/lib/api/labels.rb
index d5eb2b94669..d729d3ee625 100644
--- a/lib/api/labels.rb
+++ b/lib/api/labels.rb
@@ -3,6 +3,7 @@
 module API
   class Labels < Grape::API
     include PaginationParams
+    helpers ::API::Helpers::LabelHelpers
 
     before { authenticate! }
 
@@ -11,62 +12,28 @@ module API
     end
     resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
       desc 'Get all labels of the project' do
-        success Entities::Label
+        success Entities::ProjectLabel
       end
       params do
         use :pagination
       end
       get ':id/labels' do
-        present paginate(available_labels_for(user_project)), with: Entities::Label, current_user: current_user, project: user_project
+        get_labels(user_project, Entities::ProjectLabel)
       end
 
       desc 'Create a new label' do
-        success Entities::Label
+        success Entities::ProjectLabel
       end
       params do
-        requires :name, type: String, desc: 'The name of the label to be created'
-        requires :color, type: String, desc: "The color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB) or one of the allowed CSS color names"
-        optional :description, type: String, desc: 'The description of label to be created'
+        use :label_create_params
         optional :priority, type: Integer, desc: 'The priority of the label', allow_blank: true
       end
-      # rubocop: disable CodeReuse/ActiveRecord
       post ':id/labels' do
-        authorize! :admin_label, user_project
-
-        label = available_labels_for(user_project).find_by(title: params[:name])
-        conflict!('Label already exists') if label
-
-        priority = params.delete(:priority)
-        label = ::Labels::CreateService.new(declared_params(include_missing: false)).execute(project: user_project)
-
-        if label.valid?
-          label.prioritize!(user_project, priority) if priority
-          present label, with: Entities::Label, current_user: current_user, project: user_project
-        else
-          render_validation_error!(label)
-        end
-      end
-      # rubocop: enable CodeReuse/ActiveRecord
-
-      desc 'Delete an existing label' do
-        success Entities::Label
-      end
-      params do
-        requires :name, type: String, desc: 'The name of the label to be deleted'
-      end
-      # rubocop: disable CodeReuse/ActiveRecord
-      delete ':id/labels' do
-        authorize! :admin_label, user_project
-
-        label = user_project.labels.find_by(title: params[:name])
-        not_found!('Label') unless label
-
-        destroy_conditionally!(label)
+        create_label(user_project, Entities::ProjectLabel)
       end
-      # rubocop: enable CodeReuse/ActiveRecord
 
       desc 'Update an existing label. At least one optional parameter is required.' do
-        success Entities::Label
+        success Entities::ProjectLabel
       end
       params do
         requires :name, type: String, desc: 'The name of the label to be updated'
@@ -76,33 +43,19 @@ module API
         optional :priority, type: Integer, desc: 'The priority of the label', allow_blank: true
         at_least_one_of :new_name, :color, :description, :priority
       end
-      # rubocop: disable CodeReuse/ActiveRecord
       put ':id/labels' do
-        authorize! :admin_label, user_project
-
-        label = user_project.labels.find_by(title: params[:name])
-        not_found!('Label not found') unless label
-
-        update_priority = params.key?(:priority)
-        priority = params.delete(:priority)
-        label_params = declared_params(include_missing: false)
-        # Rename new name to the actual label attribute name
-        label_params[:name] = label_params.delete(:new_name) if label_params.key?(:new_name)
-
-        label = ::Labels::UpdateService.new(label_params).execute(label)
-        render_validation_error!(label) unless label.valid?
-
-        if update_priority
-          if priority.nil?
-            label.unprioritize!(user_project)
-          else
-            label.prioritize!(user_project, priority)
-          end
-        end
+        update_label(user_project, Entities::ProjectLabel)
+      end
 
-        present label, with: Entities::Label, current_user: current_user, project: user_project
+      desc 'Delete an existing label' do
+        success Entities::ProjectLabel
+      end
+      params do
+        requires :name, type: String, desc: 'The name of the label to be deleted'
+      end
+      delete ':id/labels' do
+        delete_label(user_project)
       end
-      # rubocop: enable CodeReuse/ActiveRecord
     end
   end
 end
diff --git a/lib/api/subscriptions.rb b/lib/api/subscriptions.rb
index 74ad3c35a61..dfb54446ddf 100644
--- a/lib/api/subscriptions.rb
+++ b/lib/api/subscriptions.rb
@@ -2,51 +2,88 @@
 
 module API
   class Subscriptions < Grape::API
+    helpers ::API::Helpers::LabelHelpers
+
     before { authenticate! }
 
-    subscribable_types = {
-      'merge_requests' => proc { |id| find_merge_request_with_access(id, :update_merge_request) },
-      'issues' => proc { |id| find_project_issue(id) },
-      'labels' => proc { |id| find_project_label(id) }
-    }
+    subscribables = [
+      {
+        type: 'merge_requests',
+        entity: Entities::MergeRequest,
+        source: Project,
+        finder: ->(id) { find_merge_request_with_access(id, :update_merge_request) }
+      },
+      {
+        type: 'issues',
+        entity: Entities::Issue,
+        source: Project,
+        finder: ->(id) { find_project_issue(id) }
+      },
+      {
+        type: 'labels',
+        entity: Entities::ProjectLabel,
+        source: Project,
+        finder: ->(id) { find_label(user_project, id) }
+      },
+      {
+        type: 'labels',
+        entity: Entities::GroupLabel,
+        source: Group,
+        finder: ->(id) { find_label(user_group, id) }
+      }
+    ]
 
-    params do
-      requires :id, type: String, desc: 'The ID of a project'
-      requires :subscribable_id, type: String, desc: 'The ID of a resource'
-    end
-    resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
-      subscribable_types.each do |type, finder|
-        type_singularized = type.singularize
-        entity_class = Entities.const_get(type_singularized.camelcase)
+    subscribables.each do |subscribable|
+      source_type = subscribable[:source].name.underscore
 
+      params do
+        requires :id, type: String, desc: "The #{source_type} ID"
+        requires :subscribable_id, type: String, desc: 'The ID of a resource'
+      end
+      resource source_type.pluralize, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
         desc 'Subscribe to a resource' do
-          success entity_class
+          success subscribable[:entity]
         end
-        post ":id/#{type}/:subscribable_id/subscribe" do
-          resource = instance_exec(params[:subscribable_id], &finder)
+        post ":id/#{subscribable[:type]}/:subscribable_id/subscribe" do
+          parent = parent_resource(source_type)
+          resource = instance_exec(params[:subscribable_id], &subscribable[:finder])
 
-          if resource.subscribed?(current_user, user_project)
+          if resource.subscribed?(current_user, parent)
             not_modified!
           else
-            resource.subscribe(current_user, user_project)
-            present resource, with: entity_class, current_user: current_user, project: user_project
+            resource.subscribe(current_user, parent)
+            present resource, with: subscribable[:entity], current_user: current_user, project: parent, parent: parent
           end
         end
 
         desc 'Unsubscribe from a resource' do
-          success entity_class
+          success subscribable[:entity]
         end
-        post ":id/#{type}/:subscribable_id/unsubscribe" do
-          resource = instance_exec(params[:subscribable_id], &finder)
+        post ":id/#{subscribable[:type]}/:subscribable_id/unsubscribe" do
+          parent = parent_resource(source_type)
+          resource = instance_exec(params[:subscribable_id], &subscribable[:finder])
 
-          if !resource.subscribed?(current_user, user_project)
+          if !resource.subscribed?(current_user, parent)
             not_modified!
           else
-            resource.unsubscribe(current_user, user_project)
-            present resource, with: entity_class, current_user: current_user, project: user_project
+            resource.unsubscribe(current_user, parent)
+            present resource, with: subscribable[:entity], current_user: current_user, project: parent, parent: parent
           end
         end
       end
     end
+
+    private
+
+    helpers do
+      def parent_resource(source_type)
+        case source_type
+        when 'project'
+          user_project
+        else
+          nil
+        end
+      end
+    end
   end
 end