award_emoji.rb 4.2 KB
Newer Older
Robert Schilling's avatar
Robert Schilling committed
1 2 3 4 5 6 7 8
module API
  module V3
    class AwardEmoji < Grape::API
      include PaginationParams

      before { authenticate! }
      AWARDABLES = %w[issue merge_request snippet].freeze

9
      resource :projects, requirements: { id: %r{[^/]+} } do
Robert Schilling's avatar
Robert Schilling committed
10 11 12 13 14 15 16 17 18
        AWARDABLES.each do |awardable_type|
          awardable_string = awardable_type.pluralize
          awardable_id_string = "#{awardable_type}_id"

          params do
            requires :id, type: String, desc: 'The ID of a project'
            requires :"#{awardable_id_string}", type: Integer, desc: "The ID of an Issue, Merge Request or Snippet"
          end

19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
          [
            ":id/#{awardable_string}/:#{awardable_id_string}/award_emoji",
            ":id/#{awardable_string}/:#{awardable_id_string}/notes/:note_id/award_emoji"
          ].each do |endpoint|

            desc 'Get a list of project +awardable+ award emoji' do
              detail 'This feature was introduced in 8.9'
              success Entities::AwardEmoji
            end
            params do
              use :pagination
            end
            get endpoint do
              if can_read_awardable?
                awards = awardable.award_emoji
                present paginate(awards), with: Entities::AwardEmoji
              else
                not_found!("Award Emoji")
              end
            end

            desc 'Get a specific award emoji' do
              detail 'This feature was introduced in 8.9'
              success Entities::AwardEmoji
            end
            params do
              requires :award_id, type: Integer, desc: 'The ID of the award'
            end
            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

            desc 'Award a new Emoji' do
              detail 'This feature was introduced in 8.9'
              success Entities::AwardEmoji
            end
            params do
              requires :name, type: String, desc: 'The name of a award_emoji (without colons)'
            end
            post endpoint do
              not_found!('Award Emoji') unless can_read_awardable? && can_award_awardable?

              award = awardable.create_award_emoji(params[:name], current_user)

              if award.persisted?
                present award, with: Entities::AwardEmoji
              else
                not_found!("Award Emoji #{award.errors.messages}")
              end
            end

Robert Schilling's avatar
Robert Schilling committed
74 75
            desc 'Delete a +awardables+ award emoji' do
              detail 'This feature was introduced in 8.9'
76
              success Entities::AwardEmoji
Robert Schilling's avatar
Robert Schilling committed
77 78 79 80 81 82 83 84 85
            end
            params do
              requires :award_id, type: Integer, desc: 'The ID of an award emoji'
            end
            delete "#{endpoint}/:award_id" do
              award = awardable.award_emoji.find(params[:award_id])

              unauthorized! unless award.user == current_user || current_user.admin?

86
              award.destroy
87
              present award, with: Entities::AwardEmoji
Robert Schilling's avatar
Robert Schilling committed
88 89 90 91 92 93
            end
          end
        end
      end

      helpers do
94 95 96 97 98 99 100 101
        def can_read_awardable?
          can?(current_user, read_ability(awardable), awardable)
        end

        def can_award_awardable?
          awardable.user_can_award?(current_user, params[:name])
        end

Robert Schilling's avatar
Robert Schilling committed
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
        def awardable
          @awardable ||=
            begin
              if params.include?(:note_id)
                note_id = params.delete(:note_id)

                awardable.notes.find(note_id)
              elsif params.include?(:issue_id)
                user_project.issues.find(params[:issue_id])
              elsif params.include?(:merge_request_id)
                user_project.merge_requests.find(params[:merge_request_id])
              else
                user_project.snippets.find(params[:snippet_id])
              end
            end
        end
118 119 120 121 122 123 124 125 126

        def read_ability(awardable)
          case awardable
          when Note
            read_ability(awardable.noteable)
          else
            :"read_#{awardable.class.to_s.underscore}"
          end
        end
Robert Schilling's avatar
Robert Schilling committed
127 128 129 130
      end
    end
  end
end