Merge branch 'api-endpoints-award-emoji' into 'master'

API endpoints for award emoji

Closes #10884 

See merge request !4575

4 files changed, 150 insertions, 25 deletions

diff --git a/lib/api/api.rb b/lib/api/api.rb
index 51ddd0dbfc4..0e7a1cc2623 100644
--- a/lib/api/api.rb
+++ b/lib/api/api.rb
@@ -26,39 +26,40 @@ module API
     # Ensure the namespace is right, otherwise we might load Grape::API::Helpers
     helpers ::API::Helpers
 
-    mount ::API::Groups
+    mount ::API::AwardEmoji
+    mount ::API::Branches
+    mount ::API::Builds
+    mount ::API::CommitStatuses
+    mount ::API::Commits
+    mount ::API::DeployKeys
+    mount ::API::Files
+    mount ::API::Gitignores
     mount ::API::GroupMembers
-    mount ::API::Users
-    mount ::API::Projects
-    mount ::API::Repositories
+    mount ::API::Groups
+    mount ::API::Internal
     mount ::API::Issues
-    mount ::API::Milestones
-    mount ::API::Session
+    mount ::API::Keys
+    mount ::API::Labels
+    mount ::API::Licenses
     mount ::API::MergeRequests
+    mount ::API::Milestones
+    mount ::API::Namespaces
     mount ::API::Notes
-    mount ::API::Internal
-    mount ::API::SystemHooks
-    mount ::API::ProjectSnippets
-    mount ::API::ProjectMembers
-    mount ::API::DeployKeys
     mount ::API::ProjectHooks
+    mount ::API::ProjectMembers
+    mount ::API::ProjectSnippets
+    mount ::API::Projects
+    mount ::API::Repositories
+    mount ::API::Runners
     mount ::API::Services
-    mount ::API::Files
-    mount ::API::Commits
-    mount ::API::CommitStatuses
-    mount ::API::Namespaces
-    mount ::API::Branches
-    mount ::API::Labels
+    mount ::API::Session
     mount ::API::Settings
-    mount ::API::Keys
+    mount ::API::SidekiqMetrics
+    mount ::API::Subscriptions
+    mount ::API::SystemHooks
     mount ::API::Tags
     mount ::API::Triggers
-    mount ::API::Builds
+    mount ::API::Users
     mount ::API::Variables
-    mount ::API::Runners
-    mount ::API::Licenses
-    mount ::API::Subscriptions
-    mount ::API::Gitignores
-    mount ::API::SidekiqMetrics
   end
 end
diff --git a/lib/api/award_emoji.rb b/lib/api/award_emoji.rb
new file mode 100644
index 00000000000..985590312e3
--- /dev/null
+++ b/lib/api/award_emoji.rb
@@ -0,0 +1,116 @@
+module API
+  class AwardEmoji < Grape::API
+    before { authenticate! }
+    AWARDABLES = [Issue, MergeRequest]
+
+    resource :projects do
+      AWARDABLES.each do |awardable_type|
+        awardable_string = awardable_type.to_s.underscore.pluralize
+        awardable_id_string = "#{awardable_type.to_s.underscore}_id"
+
+        [ ":id/#{awardable_string}/:#{awardable_id_string}/award_emoji",
+          ":id/#{awardable_string}/:#{awardable_id_string}/notes/:note_id/award_emoji"
+        ].each do |endpoint|
+
+          # Get a list of project +awardable+ award emoji
+          #
+          # Parameters:
+          #   id (required)           - The ID of a project
+          #   awardable_id (required) - The ID of an issue or MR
+          # Example Request:
+          #   GET /projects/:id/issues/:awardable_id/award_emoji
+          get endpoint do
+            if can_read_awardable?
+              awards = paginate(awardable.award_emoji)
+              present awards, with: Entities::AwardEmoji
+            else
+              not_found!("Award Emoji")
+            end
+          end
+
+          # Get a specific award emoji
+          #
+          # Parameters:
+          #   id (required)           - The ID of a project
+          #   awardable_id (required) - The ID of an issue or MR
+          #   award_id (required)     - The ID of the award
+          # Example Request:
+          #   GET /projects/:id/issues/:awardable_id/award_emoji/:award_id
+          get "#{endpoint}/:award_id" do
+            if can_read_awardable?
+              present awardable.award_emoji.find(params[:award_id]), with: Entities::AwardEmoji
+            else
+              not_found!("Award Emoji")
+            end
+          end
+
+          # Award a new Emoji
+          #
+          # Parameters:
+          #   id (required) - The ID of a project
+          #   awardable_id (required) - The ID of an issue or mr
+          #   name (required) - The name of a award_emoji (without colons)
+          # Example Request:
+          #   POST /projects/:id/issues/:awardable_id/award_emoji
+          post endpoint do
+            required_attributes! [:name]
+
+            not_found!('Award Emoji') unless can_read_awardable?
+
+            award = awardable.award_emoji.new(name: params[:name], user: current_user)
+
+            if award.save
+              present award, with: Entities::AwardEmoji
+            else
+              not_found!("Award Emoji #{award.errors.messages}")
+            end
+          end
+
+          # Delete a +awardables+ award emoji
+          #
+          # Parameters:
+          #   id (required) - The ID of a project
+          #   awardable_id (required) - The ID of an issue or MR
+          #   award_emoji_id (required) - The ID of an award emoji
+          # Example Request:
+          #   DELETE /projects/:id/issues/:issue_id/notes/:note_id/award_emoji/:award_id
+          delete "#{endpoint}/:award_id" do
+            award = awardable.award_emoji.find(params[:award_id])
+
+            unauthorized! unless award.user == current_user || current_user.admin?
+
+            award.destroy
+            present award, with: Entities::AwardEmoji
+          end
+        end
+      end
+    end
+
+    helpers do
+      def can_read_awardable?
+        ability = "read_#{awardable.class.to_s.underscore}".to_sym
+
+        can?(current_user, ability, awardable)
+      end
+
+      def awardable
+        @awardable ||=
+          begin
+            if params.include?(:note_id)
+              noteable.notes.find(params[:note_id])
+            else
+              noteable
+            end
+          end
+      end
+
+      def noteable
+        if params.include?(:issue_id)
+          user_project.issues.find(params[:issue_id])
+        else
+          user_project.merge_requests.find(params[:merge_request_id])
+        end
+      end
+    end
+  end
+end
diff --git a/lib/api/entities.rb b/lib/api/entities.rb
index cc29c7ef428..2e397643ed1 100644
--- a/lib/api/entities.rb
+++ b/lib/api/entities.rb
@@ -225,6 +225,14 @@ module API
       expose(:downvote?)  { |note| false }
     end
 
+    class AwardEmoji < Grape::Entity
+      expose :id
+      expose :name
+      expose :user, using: Entities::UserBasic
+      expose :created_at, :updated_at
+      expose :awardable_id, :awardable_type
+    end
+
     class MRNote < Grape::Entity
       expose :note
       expose :author, using: Entities::UserBasic
diff --git a/lib/api/notes.rb b/lib/api/notes.rb
index d4fcfd3d4d3..8bfa998dc53 100644
--- a/lib/api/notes.rb
+++ b/lib/api/notes.rb
@@ -144,7 +144,7 @@ module API
 
     helpers do
       def noteable_read_ability_name(noteable)
-        "read_#{noteable.class.to_s.underscore.downcase}".to_sym
+        "read_#{noteable.class.to_s.underscore}".to_sym
       end
     end
   end