discordrb 3.3.0 → 3.4.3

data/lib/discordrb/api/channel.rb

@@ -5,7 +5,7 @@ module Discordrb::API::Channel
   module_function
 
   # Get a channel's data
-  # https://discordapp.com/developers/docs/resources/channel#get-channel
+  # https://discord.com/developers/docs/resources/channel#get-channel
   def resolve(token, channel_id)
     Discordrb::API.request(
       :channels_cid,
@@ -17,7 +17,7 @@ module Discordrb::API::Channel
   end
 
   # Update a channel's data
-  # https://discordapp.com/developers/docs/resources/channel#modify-channel
+  # https://discord.com/developers/docs/resources/channel#modify-channel
   def update(token, channel_id, name, topic, position, bitrate, user_limit, nsfw, permission_overwrites = nil, parent_id = nil, rate_limit_per_user = nil, reason = nil)
     data = { name: name, position: position, topic: topic, bitrate: bitrate, user_limit: user_limit, nsfw: nsfw, parent_id: parent_id, rate_limit_per_user: rate_limit_per_user }
     data[:permission_overwrites] = permission_overwrites unless permission_overwrites.nil?
@@ -34,7 +34,7 @@ module Discordrb::API::Channel
   end
 
   # Delete a channel
-  # https://discordapp.com/developers/docs/resources/channel#deleteclose-channel
+  # https://discord.com/developers/docs/resources/channel#deleteclose-channel
   def delete(token, channel_id, reason = nil)
     Discordrb::API.request(
       :channels_cid,
@@ -47,7 +47,7 @@ module Discordrb::API::Channel
   end
 
   # Get a list of messages from a channel's history
-  # https://discordapp.com/developers/docs/resources/channel#get-channel-messages
+  # https://discord.com/developers/docs/resources/channel#get-channel-messages
   def messages(token, channel_id, amount, before = nil, after = nil, around = nil)
     Discordrb::API.request(
       :channels_cid_messages,
@@ -59,7 +59,7 @@ module Discordrb::API::Channel
   end
 
   # Get a single message from a channel's history by id
-  # https://discordapp.com/developers/docs/resources/channel#get-channel-message
+  # https://discord.com/developers/docs/resources/channel#get-channel-message
   def message(token, channel_id, message_id)
     Discordrb::API.request(
       :channels_cid_messages_mid,
@@ -72,24 +72,37 @@ module Discordrb::API::Channel
 
   # Send a message to a channel
   # https://discordapp.com/developers/docs/resources/channel#create-message
-  def create_message(token, channel_id, message, tts = false, embed = nil, nonce = nil) # send 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, embed = nil, nonce = nil, attachments = nil, allowed_mentions = nil, message_reference = nil)
+    body = { content: message, tts: tts, embed: embed, nonce: nonce, allowed_mentions: allowed_mentions, message_reference: message_reference }
+    body = if attachments
+             files = [*0...attachments.size].zip(attachments).to_h
+             { **files, payload_json: body.to_json }
+           else
+             body.to_json
+           end
+
+    headers = { Authorization: token }
+    headers[:content_type] = :json unless attachments
+
     Discordrb::API.request(
       :channels_cid_messages_mid,
       channel_id,
       :post,
       "#{Discordrb::API.api_base}/channels/#{channel_id}/messages",
-      { content: message, tts: tts, embed: embed, nonce: nonce }.to_json,
-      Authorization: token,
-      content_type: :json
+      body,
+      **headers
     )
   rescue RestClient::BadRequest => e
     parsed = JSON.parse(e.response.body)
-    raise Discordrb::Errors::MessageTooLong, "Message over the character limit (#{message.length} > 2000)" if parsed['content'] && parsed['content'].is_a?(Array) && parsed['content'].first == 'Must be 2000 or fewer in length.'
+    raise Discordrb::Errors::MessageTooLong, "Message over the character limit (#{message.length} > 2000)" if parsed['content'].is_a?(Array) && parsed['content'].first == 'Must be 2000 or fewer in length.'
+
     raise
   end
 
   # Send a file as a message to a channel
-  # https://discordapp.com/developers/docs/resources/channel#upload-file
+  # https://discord.com/developers/docs/resources/channel#upload-file
   def upload_file(token, channel_id, file, caption: nil, tts: false)
     Discordrb::API.request(
       :channels_cid_messages_mid,
@@ -102,7 +115,7 @@ module Discordrb::API::Channel
   end
 
   # Edit a message
-  # https://discordapp.com/developers/docs/resources/channel#edit-message
+  # https://discord.com/developers/docs/resources/channel#edit-message
   def edit_message(token, channel_id, message_id, message, mentions = [], embed = nil)
     Discordrb::API.request(
       :channels_cid_messages_mid,
@@ -117,19 +130,20 @@ module Discordrb::API::Channel
 
   # Delete a message
   # https://discordapp.com/developers/docs/resources/channel#delete-message
-  def delete_message(token, channel_id, message_id)
+  def delete_message(token, channel_id, message_id, reason = nil)
     Discordrb::API.request(
       :channels_cid_messages_mid,
       channel_id,
       :delete,
       "#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}",
-      Authorization: token
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Delete messages in bulk
   # https://discordapp.com/developers/docs/resources/channel#bulk-delete-messages
-  def bulk_delete_messages(token, channel_id, messages = [])
+  def bulk_delete_messages(token, channel_id, messages = [], reason = nil)
     Discordrb::API.request(
       :channels_cid_messages_bulk_delete,
       channel_id,
@@ -137,14 +151,15 @@ module Discordrb::API::Channel
       "#{Discordrb::API.api_base}/channels/#{channel_id}/messages/bulk-delete",
       { messages: messages }.to_json,
       Authorization: token,
-      content_type: :json
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Create a reaction on a message using this client
-  # https://discordapp.com/developers/docs/resources/channel#create-reaction
+  # https://discord.com/developers/docs/resources/channel#create-reaction
   def create_reaction(token, channel_id, message_id, emoji)
-    emoji = URI.encode(emoji) unless emoji.ascii_only?
+    emoji = URI.encode_www_form_component(emoji) unless emoji.ascii_only?
     Discordrb::API.request(
       :channels_cid_messages_mid_reactions_emoji_me,
       channel_id,
@@ -157,9 +172,9 @@ module Discordrb::API::Channel
   end
 
   # Delete this client's own reaction on a message
-  # https://discordapp.com/developers/docs/resources/channel#delete-own-reaction
+  # https://discord.com/developers/docs/resources/channel#delete-own-reaction
   def delete_own_reaction(token, channel_id, message_id, emoji)
-    emoji = URI.encode(emoji) unless emoji.ascii_only?
+    emoji = URI.encode_www_form_component(emoji) unless emoji.ascii_only?
     Discordrb::API.request(
       :channels_cid_messages_mid_reactions_emoji_me,
       channel_id,
@@ -170,9 +185,9 @@ module Discordrb::API::Channel
   end
 
   # Delete another client's reaction on a message
-  # https://discordapp.com/developers/docs/resources/channel#delete-user-reaction
+  # https://discord.com/developers/docs/resources/channel#delete-user-reaction
   def delete_user_reaction(token, channel_id, message_id, emoji, user_id)
-    emoji = URI.encode(emoji) unless emoji.ascii_only?
+    emoji = URI.encode_www_form_component(emoji) unless emoji.ascii_only?
     Discordrb::API.request(
       :channels_cid_messages_mid_reactions_emoji_uid,
       channel_id,
@@ -183,20 +198,21 @@ module Discordrb::API::Channel
   end
 
   # Get a list of clients who reacted with a specific reaction on a message
-  # https://discordapp.com/developers/docs/resources/channel#get-reactions
-  def get_reactions(token, channel_id, message_id, emoji)
-    emoji = URI.encode(emoji) unless emoji.ascii_only?
+  # https://discord.com/developers/docs/resources/channel#get-reactions
+  def get_reactions(token, channel_id, message_id, emoji, before_id, after_id, limit = 100)
+    emoji = URI.encode_www_form_component(emoji) unless emoji.ascii_only?
+    query_string = "limit=#{limit}#{"&before=#{before_id}" if before_id}#{"&after=#{after_id}" if after_id}"
     Discordrb::API.request(
       :channels_cid_messages_mid_reactions_emoji,
       channel_id,
       :get,
-      "#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}/reactions/#{emoji}",
+      "#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}/reactions/#{emoji}?#{query_string}",
       Authorization: token
     )
   end
 
   # Deletes all reactions on a message from all clients
-  # https://discordapp.com/developers/docs/resources/channel#delete-all-reactions
+  # https://discord.com/developers/docs/resources/channel#delete-all-reactions
   def delete_all_reactions(token, channel_id, message_id)
     Discordrb::API.request(
       :channels_cid_messages_mid_reactions,
@@ -208,7 +224,7 @@ module Discordrb::API::Channel
   end
 
   # Update a channels permission for a role or member
-  # https://discordapp.com/developers/docs/resources/channel#edit-channel-permissions
+  # https://discord.com/developers/docs/resources/channel#edit-channel-permissions
   def update_permission(token, channel_id, overwrite_id, allow, deny, type, reason = nil)
     Discordrb::API.request(
       :channels_cid_permissions_oid,
@@ -223,7 +239,7 @@ module Discordrb::API::Channel
   end
 
   # Get a channel's invite list
-  # https://discordapp.com/developers/docs/resources/channel#get-channel-invites
+  # https://discord.com/developers/docs/resources/channel#get-channel-invites
   def invites(token, channel_id)
     Discordrb::API.request(
       :channels_cid_invites,
@@ -235,7 +251,7 @@ module Discordrb::API::Channel
   end
 
   # Create an instant invite from a server or a channel id
-  # https://discordapp.com/developers/docs/resources/channel#create-channel-invite
+  # https://discord.com/developers/docs/resources/channel#create-channel-invite
   def create_invite(token, channel_id, max_age = 0, max_uses = 0, temporary = false, unique = false, reason = nil)
     Discordrb::API.request(
       :channels_cid_invites,
@@ -250,7 +266,7 @@ module Discordrb::API::Channel
   end
 
   # Delete channel permission
-  # https://discordapp.com/developers/docs/resources/channel#delete-channel-permission
+  # https://discord.com/developers/docs/resources/channel#delete-channel-permission
   def delete_permission(token, channel_id, overwrite_id, reason = nil)
     Discordrb::API.request(
       :channels_cid_permissions_oid,
@@ -263,7 +279,7 @@ module Discordrb::API::Channel
   end
 
   # Start typing (needs to be resent every 5 seconds to keep up the typing)
-  # https://discordapp.com/developers/docs/resources/channel#trigger-typing-indicator
+  # https://discord.com/developers/docs/resources/channel#trigger-typing-indicator
   def start_typing(token, channel_id)
     Discordrb::API.request(
       :channels_cid_typing,
@@ -276,7 +292,7 @@ module Discordrb::API::Channel
   end
 
   # Get a list of pinned messages in a channel
-  # https://discordapp.com/developers/docs/resources/channel#get-pinned-messages
+  # https://discord.com/developers/docs/resources/channel#get-pinned-messages
   def pinned_messages(token, channel_id)
     Discordrb::API.request(
       :channels_cid_pins,
@@ -289,30 +305,33 @@ module Discordrb::API::Channel
 
   # Pin a message
   # https://discordapp.com/developers/docs/resources/channel#add-pinned-channel-message
-  def pin_message(token, channel_id, message_id)
+  def pin_message(token, channel_id, message_id, reason = nil)
     Discordrb::API.request(
       :channels_cid_pins_mid,
       channel_id,
       :put,
       "#{Discordrb::API.api_base}/channels/#{channel_id}/pins/#{message_id}",
       nil,
-      Authorization: token
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Unpin a message
   # https://discordapp.com/developers/docs/resources/channel#delete-pinned-channel-message
-  def unpin_message(token, channel_id, message_id)
+  def unpin_message(token, channel_id, message_id, reason = nil)
     Discordrb::API.request(
       :channels_cid_pins_mid,
       channel_id,
       :delete,
       "#{Discordrb::API.api_base}/channels/#{channel_id}/pins/#{message_id}",
-      Authorization: token
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Create an empty group channel.
+  # https://discord.com/developers/docs/resources/user#create-group-dm
   def create_empty_group(token, bot_user_id)
     Discordrb::API.request(
       :users_uid_channels,
@@ -326,6 +345,7 @@ module Discordrb::API::Channel
   end
 
   # Create a group channel.
+  # https://discord.com/developers/docs/resources/channel#group-dm-add-recipient
   def create_group(token, pm_channel_id, user_id)
     Discordrb::API.request(
       :channels_cid_recipients_uid,
@@ -345,6 +365,7 @@ module Discordrb::API::Channel
   end
 
   # Add a user to a group channel.
+  # https://discord.com/developers/docs/resources/channel#group-dm-add-recipient
   def add_group_user(token, group_channel_id, user_id)
     Discordrb::API.request(
       :channels_cid_recipients_uid,
@@ -358,6 +379,7 @@ module Discordrb::API::Channel
   end
 
   # Remove a user from a group channel.
+  # https://discord.com/developers/docs/resources/channel#group-dm-remove-recipient
   def remove_group_user(token, group_channel_id, user_id)
     Discordrb::API.request(
       :channels_cid_recipients_uid,
@@ -370,6 +392,7 @@ module Discordrb::API::Channel
   end
 
   # Leave a group channel.
+  # https://discord.com/developers/docs/resources/channel#deleteclose-channel
   def leave_group(token, group_channel_id)
     Discordrb::API.request(
       :channels_cid,
@@ -382,7 +405,7 @@ module Discordrb::API::Channel
   end
 
   # Create a webhook
-  # https://discordapp.com/developers/docs/resources/webhook#create-webhook
+  # https://discord.com/developers/docs/resources/webhook#create-webhook
   def create_webhook(token, channel_id, name, avatar = nil, reason = nil)
     Discordrb::API.request(
       :channels_cid_webhooks,
@@ -397,7 +420,7 @@ module Discordrb::API::Channel
   end
 
   # Get channel webhooks
-  # https://discordapp.com/developers/docs/resources/webhook#get-channel-webhooks
+  # https://discord.com/developers/docs/resources/webhook#get-channel-webhooks
   def webhooks(token, channel_id)
     Discordrb::API.request(
       :channels_cid_webhooks,

data/lib/discordrb/api/invite.rb

@@ -5,7 +5,7 @@ module Discordrb::API::Invite
   module_function
 
   # Resolve an invite
-  # https://discordapp.com/developers/docs/resources/invite#get-invite
+  # https://discord.com/developers/docs/resources/invite#get-invite
   def resolve(token, invite_code, counts = true)
     Discordrb::API.request(
       :invite_code,
@@ -17,7 +17,7 @@ module Discordrb::API::Invite
   end
 
   # Delete an invite by code
-  # https://discordapp.com/developers/docs/resources/invite#delete-invite
+  # https://discord.com/developers/docs/resources/invite#delete-invite
   def delete(token, code, reason = nil)
     Discordrb::API.request(
       :invites_code,
@@ -30,7 +30,7 @@ module Discordrb::API::Invite
   end
 
   # Join a server using an invite
-  # https://discordapp.com/developers/docs/resources/invite#accept-invite
+  # https://discord.com/developers/docs/resources/invite#accept-invite
   def accept(token, invite_code)
     Discordrb::API.request(
       :invite_code,