feat: polls

Author: Droid00000

lib/discordrb.rb

@@ -32,7 +32,9 @@ module Discordrb
     server_message_typing: 1 << 11,
     direct_messages: 1 << 12,
     direct_message_reactions: 1 << 13,
-    direct_message_typing: 1 << 14
+    direct_message_typing: 1 << 14,
+    server_message_polls: 1 << 24,
+    direct_message_polls: 1 << 25
   }.freeze
 
   # All available intents

lib/discordrb/api/channel.rb

@@ -75,8 +75,8 @@ def message(token, channel_id, message_id)
   # https://discord.com/developers/docs/resources/channel#create-message
   # @param attachments [Array<File>, nil] Attachments to use with `attachment://` in embeds. See
   #   https://discord.com/developers/docs/resources/channel#create-message-using-attachments-within-embeds
-  def create_message(token, channel_id, message, tts = false, embeds = nil, nonce = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil, flags = nil, enforce_nonce = false)
-    body = { content: message, tts: tts, embeds: embeds, nonce: nonce, allowed_mentions: allowed_mentions, message_reference: message_reference, components: components&.to_a, flags: flags, enforce_nonce: enforce_nonce }
+  def create_message(token, channel_id, message, tts = false, embeds = nil, nonce = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil, flags = nil, enforce_nonce = false, poll = nil)
+    body = { content: message, tts: tts, embeds: embeds, nonce: nonce, allowed_mentions: allowed_mentions, message_reference: message_reference, components: components&.to_a, flags: flags, enforce_nonce: enforce_nonce, poll: poll }
     body = if attachments
              files = [*0...attachments.size].zip(attachments).to_h
              { **files, payload_json: body.to_json }
@@ -634,4 +634,31 @@ def start_thread_in_forum_or_media_channel(token, channel_id, name, message, att
       headers
     )
   end
+
+  # Get a list of users that have voted for a poll answer.
+  # https://discord.com/developers/docs/resources/poll#get-answer-voters
+  def get_poll_answer_voters(token, channel_id, message_id, answer_id, limit = 100, after = nil, before = nil)
+    query = URI.encode_www_form({ limit: limit, after: after, before: before }.compact)
+
+    Discordrb::API.request(
+      :channels_cid_polls_mid_answers_aid,
+      channel_id,
+      :get,
+      "#{Discordrb::API.api_base}/channels/#{channel_id}/polls/#{message_id}/answers/#{answer_id}?#{query}",
+      Authorization: token
+    )
+  end
+
+  # End a poll created by the current user.
+  # https://discord.com/developers/docs/resources/poll#end-poll
+  def end_poll(token, channel_id, message_id)
+    Discordrb::API.request(
+      :channels_cid_polls_mid_expire,
+      channel_id,
+      :post,
+      "#{Discordrb::API.api_base}/channels/#{channel_id}/polls/#{message_id}/expire",
+      nil,
+      Authorization: token
+    )
+  end
 end

lib/discordrb/api/interaction.rb

@@ -6,8 +6,8 @@ module Discordrb::API::Interaction
 
   # Respond to an interaction.
   # https://discord.com/developers/docs/interactions/slash-commands#create-interaction-response
-  def create_interaction_response(interaction_token, interaction_id, type, content = nil, tts = nil, embeds = nil, allowed_mentions = nil, flags = nil, components = nil, attachments = nil, choices = nil)
-    body = { tts: tts, content: content, embeds: embeds, allowed_mentions: allowed_mentions, flags: flags, components: components, choices: choices }.compact
+  def create_interaction_response(interaction_token, interaction_id, type, content = nil, tts = nil, embeds = nil, allowed_mentions = nil, flags = nil, components = nil, attachments = nil, choices = nil, poll = nil)
+    body = { tts: tts, content: content, embeds: embeds, allowed_mentions: allowed_mentions, flags: flags, components: components, choices: choices, poll: poll }.compact
 
     body = if attachments
              files = [*0...attachments.size].zip(attachments).to_h
@@ -51,8 +51,8 @@ def get_original_interaction_response(interaction_token, application_id)
 
   # Edit the original response to an interaction.
   # https://discord.com/developers/docs/interactions/slash-commands#edit-original-interaction-response
-  def edit_original_interaction_response(interaction_token, application_id, content = nil, embeds = nil, allowed_mentions = nil, components = nil, attachments = nil)
-    Discordrb::API::Webhook.token_edit_message(interaction_token, application_id, '@original', content, embeds, allowed_mentions, components, attachments)
+  def edit_original_interaction_response(interaction_token, application_id, content = nil, embeds = nil, allowed_mentions = nil, components = nil, attachments = nil, poll = nil)
+    Discordrb::API::Webhook.token_edit_message(interaction_token, application_id, '@original', content, embeds, allowed_mentions, components, attachments, poll)
   end
 
   # Delete the original response to an interaction.

lib/discordrb/api/webhook.rb

@@ -29,8 +29,8 @@ def token_webhook(webhook_token, webhook_id)
 
   # Execute a webhook via token.
   # https://discord.com/developers/docs/resources/webhook#execute-webhook
-  def token_execute_webhook(webhook_token, webhook_id, wait = false, content = nil, username = nil, avatar_url = nil, tts = nil, file = nil, embeds = nil, allowed_mentions = nil, flags = nil, components = nil, attachments = nil)
-    body = { content: content, username: username, avatar_url: avatar_url, tts: tts, embeds: embeds&.map(&:to_hash),  allowed_mentions: allowed_mentions, flags: flags, components: components }
+  def token_execute_webhook(webhook_token, webhook_id, wait = false, content = nil, username = nil, avatar_url = nil, tts = nil, file = nil, embeds = nil, allowed_mentions = nil, flags = nil, components = nil, attachments = nil, poll = nil)
+    body = { content: content, username: username, avatar_url: avatar_url, tts: tts, embeds: embeds&.map(&:to_hash),  allowed_mentions: allowed_mentions, flags: flags, components: components, poll: poll }
 
     body = if file
              { file: file, payload_json: body.to_json }
@@ -120,8 +120,8 @@ def token_get_message(webhook_token, webhook_id, message_id)
 
   # Edit a webhook message via webhook token
   # https://discord.com/developers/docs/resources/webhook#edit-webhook-message
-  def token_edit_message(webhook_token, webhook_id, message_id, content = nil, embeds = nil, allowed_mentions = nil, components = nil, attachments = nil)
-    body = { content: content, embeds: embeds, allowed_mentions: allowed_mentions, components: components }
+  def token_edit_message(webhook_token, webhook_id, message_id, content = nil, embeds = nil, allowed_mentions = nil, components = nil, attachments = nil, poll = nil)
+    body = { content: content, embeds: embeds, allowed_mentions: allowed_mentions, components: components, poll: poll }
 
     body = if attachments
              files = [*0...attachments.size].zip(attachments).to_h

lib/discordrb/bot.rb

@@ -20,6 +20,7 @@
 require 'discordrb/events/invites'
 require 'discordrb/events/interactions'
 require 'discordrb/events/threads'
+require 'discordrb/events/polls'
 
 require 'discordrb/api'
 require 'discordrb/api/channel'
@@ -404,16 +405,17 @@ def delete_invite(code)
     # @param components [View, Array<Hash>] Interaction components to associate with this message.
     # @param flags [Integer] Flags for this message. Currently only SUPPRESS_EMBEDS (1 << 2), SUPPRESS_NOTIFICATIONS (1 << 12), and IS_COMPONENTS_V2 (1 << 15) can be set.
     # @param nonce [String, nil] A optional nonce in order to verify that a message was sent. Maximum of twenty-five characters.
-    # @param enforce_nonce [true, false] whether the nonce should be enforced and used for message de-duplication.
+    # @param enforce_nonce [true, false] Whether the nonce should be enforced and used for message de-duplication.
+    # @param poll [Hash, Poll::Builder, Poll, nil] The poll that should be attached to this message.
     # @return [Message] The message that was sent.
-    def send_message(channel, content, tts = false, embeds = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil, flags = 0, nonce = nil, enforce_nonce = false)
+    def send_message(channel, content, tts = false, embeds = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil, flags = 0, nonce = nil, enforce_nonce = false, poll = nil)
       channel = channel.resolve_id
       debug("Sending message to #{channel} with content '#{content}'")
       allowed_mentions = { parse: [] } if allowed_mentions == false
       message_reference = { message_id: message_reference.resolve_id } if message_reference.respond_to?(:resolve_id)
       embeds = (embeds.instance_of?(Array) ? embeds.map(&:to_hash) : [embeds&.to_hash]).compact
 
-      response = API::Channel.create_message(token, channel, content, tts, embeds, nonce, attachments, allowed_mentions&.to_hash, message_reference, components, flags, enforce_nonce)
+      response = API::Channel.create_message(token, channel, content, tts, embeds, nonce, attachments, allowed_mentions&.to_hash, message_reference, components, flags, enforce_nonce, poll&.to_h)
       Message.new(JSON.parse(response), self)
     end
 
@@ -430,12 +432,13 @@ def send_message(channel, content, tts = false, embeds = nil, attachments = nil,
     # @param components [View, Array<Hash>] Interaction components to associate with this message.
     # @param flags [Integer] Flags for this message. Currently only SUPPRESS_EMBEDS (1 << 2), SUPPRESS_NOTIFICATIONS (1 << 12), and IS_COMPONENTS_V2 (1 << 15) can be set.
     # @param nonce [String, nil] A optional nonce in order to verify that a message was sent. Maximum of twenty-five characters.
-    # @param enforce_nonce [true, false] whether the nonce should be enforced and used for message de-duplication.
-    def send_temporary_message(channel, content, timeout, tts = false, embeds = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil, flags = 0, nonce = nil, enforce_nonce = false)
+    # @param enforce_nonce [true, false] Whether the nonce should be enforced and used for message de-duplication.
+    # @param poll [Hash, Poll::Builder, Poll, nil] The poll that should be attached to this message.
+    def send_temporary_message(channel, content, timeout, tts = false, embeds = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil, flags = 0, nonce = nil, enforce_nonce = false, poll = nil)
       Thread.new do
         Thread.current[:discordrb_name] = "#{@current_thread}-temp-msg"
 
-        message = send_message(channel, content, tts, embeds, attachments, allowed_mentions, message_reference, components, flags, nonce, enforce_nonce)
+        message = send_message(channel, content, tts, embeds, attachments, allowed_mentions, message_reference, components, flags, nonce, enforce_nonce, poll)
         sleep(timeout)
         message.delete
       end
@@ -1712,6 +1715,14 @@ def handle_dispatch(type, data)
         end
 
         event = ThreadMembersUpdateEvent.new(data, self)
+        raise_event(event)
+      when :MESSAGE_POLL_VOTE_ADD
+        event = PollVoteAddEvent.new(data, self)
+
+        raise_event(event)
+      when :MESSAGE_POLL_VOTE_REMOVE
+        event = PollVoteRemoveEvent.new(data, self)
+
         raise_event(event)
       else
         # another event that we don't support yet

lib/discordrb/container.rb

@@ -681,6 +681,34 @@ def application_command_permissions_update(attributes = {}, &block)
       register_event(ApplicationCommandPermissionsUpdateEvent, attributes, block)
     end
 
+    # This **event** is raised whenever a user votes on a poll.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, User, Member] :user A user to match against.
+    # @option attributes [String, Integer, Channel] :channel A channel to match against.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @option attributes [String, Integer, Message] :message A message to match against.
+    # @option attributes [String, Integer, Answer] :answer A poll answer to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [PollVoteAddEvent] The event that was raised.
+    # @return [PollVoteAddEventHandler] The event handler that was registered.
+    def poll_vote_add(attributes = {}, &block)
+      register_event(PollVoteAddEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever a user removes their vote on a poll.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, User, Member] :user A user to match against.
+    # @option attributes [String, Integer, Channel] :channel A channel to match against.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @option attributes [String, Integer, Message] :message A message to match against.
+    # @option attributes [String, Integer, Answer] :answer A poll answer to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [PollVoteRemoveEvent] The event that was raised.
+    # @return [PollVoteRemoveEventHandler] The event handler that was registered.
+    def poll_vote_remove(attributes = {}, &block)
+      register_event(PollVoteRemoveEvent, attributes, block)
+    end
+
     # This **event** is raised for every dispatch received over the gateway, whether supported by discordrb or not.
     # @param attributes [Hash] The event's attributes.
     # @option attributes [String, Symbol, Regexp] :type Matches the event type of the dispatch.

lib/discordrb/data.rb

@@ -46,3 +46,4 @@
 require 'discordrb/data/server_preview'
 require 'discordrb/data/call'
 require 'discordrb/data/snapshot'
+require 'discordrb/data/poll'

lib/discordrb/data/channel.rb

@@ -496,14 +496,16 @@ def send_embed(message = '', embed = nil, attachments = nil, tts = false, allowe
     # @param has_components [true, false] Whether this message includes any V2 components. Enabling this disables sending content and embeds.
     # @param nonce [nil, String, Integer, false] The 25 character nonce that should be used when sending this message.
     # @param enforce_nonce [true, false] Whether the provided nonce should be enforced and used for message de-duplication.
+    # @param poll [Hash, Poll::Builder, Poll, nil] The poll that should be attached to this message.
     # @yieldparam builder [Webhooks::Builder] An optional message builder. Arguments passed to the builder overwrite method data.
     # @yieldparam view [Webhooks::View] An optional component builder. Arguments passed to the builder overwrite method data.
     # @return [Message, nil] The resulting message that was created, or `nil` if the `timeout` parameter was set to a non `nil` value.
-    def send_message!(content: '', timeout: nil, tts: false, embeds: [], attachments: nil, allowed_mentions: nil, reference: nil, components: nil, flags: 0, has_components: false, nonce: nil, enforce_nonce: false)
+    def send_message!(content: '', timeout: nil, tts: false, embeds: [], attachments: nil, allowed_mentions: nil, reference: nil, components: nil, flags: 0, has_components: false, nonce: nil, enforce_nonce: false, poll: nil)
       builder = Discordrb::Webhooks::Builder.new
       view = Discordrb::Webhooks::View.new
 
       builder.tts = tts
+      builder.poll = poll
       builder.content = content
       embeds&.each { |embed| builder << embed }
       builder.allowed_mentions = allowed_mentions
@@ -515,9 +517,9 @@ def send_message!(content: '', timeout: nil, tts: false, embeds: [], attachments
       builder = builder.to_json_hash
 
       if timeout
-        @bot.send_temporary_message(@id, builder[:content], timeout, builder[:tts], builder[:embeds], attachments, builder[:allowed_mentions], reference, components&.to_a || view.to_a, flags, nonce, enforce_nonce)
+        @bot.send_temporary_message(@id, builder[:content], timeout, builder[:tts], builder[:embeds], attachments, builder[:allowed_mentions], reference, components&.to_a || view.to_a, flags, nonce, enforce_nonce, builder[:poll])
       else
-        @bot.send_message(@id, builder[:content], builder[:tts], builder[:embeds], attachments, builder[:allowed_mentions], reference, components&.to_a || view.to_a, flags, nonce, enforce_nonce)
+        @bot.send_message(@id, builder[:content], builder[:tts], builder[:embeds], attachments, builder[:allowed_mentions], reference, components&.to_a || view.to_a, flags, nonce, enforce_nonce, builder[:poll])
       end
     end
 

lib/discordrb/data/emoji.rb

@@ -87,6 +87,12 @@ def inspect
       "<Emoji name=#{name} id=#{id} animated=#{animated}>"
     end
 
+    # Converts this Emoji into a hash that can be sent back to Discord in other endpoints.
+    # @return [Hash] A hash representation of this emoji.
+    def to_h
+      id.nil? ? { name: name } : { id: id }
+    end
+
     # @!visibility private
     def process_roles(roles)
       @roles = []