discordrb 3.4.3 → 3.6.0

data/lib/discordrb/api/server.rb

@@ -4,20 +4,6 @@
 module Discordrb::API::Server
   module_function
 
-  # Create a server
-  # https://discord.com/developers/docs/resources/guild#create-guild
-  def create(token, name, region = :'eu-central')
-    Discordrb::API.request(
-      :guilds,
-      nil,
-      :post,
-      "#{Discordrb::API.api_base}/guilds",
-      { name: name, region: region.to_s }.to_json,
-      Authorization: token,
-      content_type: :json
-    )
-  end
-
   # Get a server's data
   # https://discord.com/developers/docs/resources/guild#get-guild
   def resolve(token, server_id, with_counts = nil)
@@ -45,33 +31,6 @@ module Discordrb::API::Server
     )
   end
 
-  # Transfer server ownership
-  # https://discord.com/developers/docs/resources/guild#modify-guild
-  def transfer_ownership(token, server_id, user_id, reason = nil)
-    Discordrb::API.request(
-      :guilds_sid,
-      server_id,
-      :patch,
-      "#{Discordrb::API.api_base}/guilds/#{server_id}",
-      { owner_id: user_id }.to_json,
-      Authorization: token,
-      content_type: :json,
-      'X-Audit-Log-Reason': reason
-    )
-  end
-
-  # Delete a server
-  # https://discord.com/developers/docs/resources/guild#delete-guild
-  def delete(token, server_id)
-    Discordrb::API.request(
-      :guilds_sid,
-      server_id,
-      :delete,
-      "#{Discordrb::API.api_base}/guilds/#{server_id}",
-      Authorization: token
-    )
-  end
-
   # Get a server's channels list
   # https://discord.com/developers/docs/resources/guild#get-guild-channels
   def channels(token, server_id)
@@ -99,6 +58,18 @@ module Discordrb::API::Server
     )
   end
 
+  # Get the preview of a server.
+  # https://discord.com/developers/docs/resources/guild#get-guild-preview
+  def preview(token, server_id)
+    Discordrb::API.request(
+      :guilds_sid_preview,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/preview",
+      Authorization: token
+    )
+  end
+
   # Update a channels position
   # https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions
   def update_channel_positions(token, server_id, positions)
@@ -128,18 +99,33 @@ module Discordrb::API::Server
   # Gets members from the server
   # https://discord.com/developers/docs/resources/guild#list-guild-members
   def resolve_members(token, server_id, limit, after = nil)
+    query_string = URI.encode_www_form({ limit: limit, after: after }.compact)
     Discordrb::API.request(
       :guilds_sid_members,
       server_id,
       :get,
-      "#{Discordrb::API.api_base}/guilds/#{server_id}/members?limit=#{limit}#{"&after=#{after}" if after}",
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/members?#{query_string}",
+      Authorization: token
+    )
+  end
+
+  # Search for a guild member
+  # https://discord.com/developers/docs/resources/guild#search-guild-members
+  def search_guild_members(token, server_id, query, limit)
+    query_string = URI.encode_www_form({ query: query, limit: limit }.compact)
+    Discordrb::API.request(
+      :guilds_sid_members,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/members/search?#{query_string}",
       Authorization: token
     )
   end
 
   # Update a user properties
   # https://discord.com/developers/docs/resources/guild#modify-guild-member
-  def update_member(token, server_id, user_id, nick: nil, roles: nil, mute: nil, deaf: nil, channel_id: nil, reason: nil)
+  def update_member(token, server_id, user_id, nick: :undef, roles: :undef, mute: :undef, deaf: :undef, channel_id: :undef,
+                    communication_disabled_until: :undef, flags: :undef, reason: nil)
     Discordrb::API.request(
       :guilds_sid_members_uid,
       server_id,
@@ -149,8 +135,25 @@ module Discordrb::API::Server
         nick: nick,
         mute: mute,
         deaf: deaf,
-        channel_id: channel_id
-      }.compact.to_json,
+        channel_id: channel_id,
+        communication_disabled_until: communication_disabled_until,
+        flags: flags
+      }.reject { |_, v| v == :undef }.to_json,
+      Authorization: token,
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
+    )
+  end
+
+  # Update the current member's properties.
+  # https://discord.com/developers/docs/resources/guild#modify-current-member
+  def update_current_member(token, server_id, nick = :undef, reason = nil)
+    Discordrb::API.request(
+      :guilds_sid_members_me,
+      server_id,
+      :patch,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/members/@me",
+      { nick: nick }.reject { |_, v| v == :undef }.to_json,
       Authorization: token,
       content_type: :json,
       'X-Audit-Log-Reason': reason
@@ -173,27 +176,35 @@ module Discordrb::API::Server
 
   # Get a server's banned users
   # https://discord.com/developers/docs/resources/guild#get-guild-bans
-  def bans(token, server_id)
+  def bans(token, server_id, limit = nil, before = nil, after = nil)
+    query_string = URI.encode_www_form({ limit: limit, before: before, after: after }.compact)
     Discordrb::API.request(
       :guilds_sid_bans,
       server_id,
       :get,
-      "#{Discordrb::API.api_base}/guilds/#{server_id}/bans",
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/bans?#{query_string}",
       Authorization: token
     )
   end
 
-  # Ban a user from a server and delete their messages from the last message_days days
+  # @deprecated Please use {ban_user!} instead.
   # https://discord.com/developers/docs/resources/guild#create-guild-ban
   def ban_user(token, server_id, user_id, message_days, reason = nil)
-    reason = URI.encode_www_form_component(reason) if reason
+    ban_user!(token, server_id, user_id, message_days * 86_400, reason)
+  end
+
+  # Ban a user from a server and delete their messages up to a given amount of time.
+  # https://discord.com/developers/docs/resources/guild#create-guild-ban
+  def ban_user!(token, server_id, user_id, message_seconds, reason = nil)
     Discordrb::API.request(
       :guilds_sid_bans_uid,
       server_id,
       :put,
-      "#{Discordrb::API.api_base}/guilds/#{server_id}/bans/#{user_id}?delete-message-days=#{message_days}&reason=#{reason}",
-      nil,
-      Authorization: token
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/bans/#{user_id}",
+      { delete_message_seconds: message_seconds }.to_json,
+      Authorization: token,
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 
@@ -227,13 +238,13 @@ module Discordrb::API::Server
   # sending TTS messages, embedding links, sending files, reading the history, mentioning everybody,
   # connecting to voice, speaking and voice activity (push-to-talk isn't mandatory)
   # https://discord.com/developers/docs/resources/guild#get-guild-roles
-  def create_role(token, server_id, name, colour, hoist, mentionable, packed_permissions, reason = nil)
+  def create_role(token, server_id, name, colour, hoist, mentionable, packed_permissions, reason = nil, colours = nil, icon = nil, unicode_emoji = nil)
     Discordrb::API.request(
       :guilds_sid_roles,
       server_id,
       :post,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/roles",
-      { color: colour, name: name, hoist: hoist, mentionable: mentionable, permissions: packed_permissions }.to_json,
+      { color: colour, name: name, hoist: hoist, mentionable: mentionable, permissions: packed_permissions, colors: colours, icon: icon, unicode_emoji: unicode_emoji }.compact.to_json,
       Authorization: token,
       content_type: :json,
       'X-Audit-Log-Reason': reason
@@ -245,13 +256,22 @@ module Discordrb::API::Server
   # sending TTS messages, embedding links, sending files, reading the history, mentioning everybody,
   # connecting to voice, speaking and voice activity (push-to-talk isn't mandatory)
   # https://discord.com/developers/docs/resources/guild#batch-modify-guild-role
-  def update_role(token, server_id, role_id, name, colour, hoist = false, mentionable = false, packed_permissions = 104_324_161, reason = nil)
+  # @param icon [:undef, File]
+  def update_role(token, server_id, role_id, name, colour, hoist = false, mentionable = false, packed_permissions = 104_324_161, reason = nil, icon = :undef, unicode_emoji = :undef, colours = :undef)
+    data = { color: colour, name: name, hoist: hoist, mentionable: mentionable, permissions: packed_permissions, colors: colours, unicode_emoji: unicode_emoji }
+
+    if icon != :undef && icon
+      data[:icon] = Discordrb.encode64(icon)
+    elsif icon.nil?
+      data[:icon] = nil
+    end
+
     Discordrb::API.request(
       :guilds_sid_roles_rid,
       server_id,
       :patch,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/roles/#{role_id}",
-      { color: colour, name: name, hoist: hoist, mentionable: mentionable, permissions: packed_permissions }.to_json,
+      data.reject { |_, value| value == :undef }.to_json,
       Authorization: token,
       content_type: :json,
       'X-Audit-Log-Reason': reason
@@ -375,7 +395,7 @@ module Discordrb::API::Server
   end
 
   # Create a server integration
-  # https://discordapp.com/developers/docs/resources/guild#create-guild-integration
+  # https://discord.com/developers/docs/resources/guild#create-guild-integration
   def create_integration(token, server_id, type, id, reason = nil)
     Discordrb::API.request(
       :guilds_sid_integrations,
@@ -403,7 +423,7 @@ module Discordrb::API::Server
   end
 
   # Delete a server integration
-  # https://discordapp.com/developers/docs/resources/guild#delete-guild-integration
+  # https://discord.com/developers/docs/resources/guild#delete-guild-integration
   def delete_integration(token, server_id, integration_id, reason = nil)
     Discordrb::API.request(
       :guilds_sid_integrations_iid,
@@ -428,32 +448,34 @@ module Discordrb::API::Server
     )
   end
 
-  # Retrieves a server's embed information
-  # https://discord.com/developers/docs/resources/guild#get-guild-embed
-  def embed(token, server_id)
+  # Retrieves a server's widget information
+  # https://discord.com/developers/docs/resources/guild#get-guild-widget
+  def widget(token, server_id)
     Discordrb::API.request(
       :guilds_sid_embed,
       server_id,
       :get,
-      "#{Discordrb::API.api_base}/guilds/#{server_id}/embed",
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/widget",
       Authorization: token
     )
   end
+  alias embed widget
 
-  # Modify a server's embed settings
-  # https://discord.com/developers/docs/resources/guild#modify-guild-embed
-  def modify_embed(token, server_id, enabled, channel_id, reason = nil)
+  # Modify a server's widget settings
+  # https://discord.com/developers/docs/resources/guild#modify-guild-widget
+  def modify_widget(token, server_id, enabled, channel_id, reason = nil)
     Discordrb::API.request(
       :guilds_sid_embed,
       server_id,
       :patch,
-      "#{Discordrb::API.api_base}/guilds/#{server_id}/embed",
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/widget",
       { enabled: enabled, channel_id: channel_id }.to_json,
       Authorization: token,
       'X-Audit-Log-Reason': reason,
       content_type: :json
     )
   end
+  alias modify_embed modify_widget
 
   # Adds a custom emoji.
   # https://discord.com/developers/docs/resources/emoji#create-guild-emoji
@@ -535,4 +557,39 @@ module Discordrb::API::Server
       Authorization: token
     )
   end
+
+  # Make an member avatar URL from the server, user and avatar IDs
+  def avatar_url(server_id, user_id, avatar_id, format = nil)
+    format ||= if avatar_id.start_with?('a_')
+                 'gif'
+               else
+                 'webp'
+               end
+    "#{Discordrb::API.cdn_url}/guilds/#{server_id}/users/#{user_id}/avatars/#{avatar_id}.#{format}"
+  end
+
+  # Make a banner URL from the server, user and banner IDs
+  def banner_url(server_id, user_id, banner_id, format = nil)
+    format ||= if banner_id.start_with?('a_')
+                 'gif'
+               else
+                 'webp'
+               end
+    "#{Discordrb::API.cdn_url}/guilds/#{server_id}/users/#{user_id}/banners/#{banner_id}.#{format}"
+  end
+
+  # Ban multiple users in one go
+  # https://discord.com/developers/docs/resources/guild#bulk-guild-ban
+  def bulk_ban(token, server_id, users, message_seconds, reason = nil)
+    Discordrb::API.request(
+      :guilds_sid_bulk_bans,
+      server_id,
+      :post,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/bulk-ban",
+      { user_ids: users, delete_message_seconds: message_seconds }.compact.to_json,
+      content_type: :json,
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
+    )
+  end
 end

data/lib/discordrb/api/user.rb

@@ -28,8 +28,8 @@ module Discordrb::API::User
     )
   end
 
-  # Change the current bot's nickname on a server
-  # https://discord.com/developers/docs/resources/user#modify-current-user
+  # @deprecated Please use {Discordrb::API::Server.update_current_member} instead.
+  # https://discord.com/developers/docs/resources/user#modify-current-user-nick
   def change_own_nickname(token, server_id, nick, reason = nil)
     Discordrb::API.request(
       :guilds_sid_members_me_nick,
@@ -132,9 +132,14 @@ module Discordrb::API::User
     )
   end
 
-  # Returns one of the "default" discord avatars from the CDN given a discriminator
-  def default_avatar(discrim = 0)
-    index = discrim.to_i % 5
+  # Returns one of the "default" discord avatars from the CDN given a discriminator or id since new usernames
+  # TODO: Maybe change this method again after discriminator removal ?
+  def default_avatar(discrim_id = 0, legacy: false)
+    index = if legacy
+              discrim_id.to_i % 5
+            else
+              (discrim_id.to_i >> 22) % 5
+            end
     "#{Discordrb::API.cdn_url}/embed/avatars/#{index}.png"
   end
 
@@ -147,4 +152,14 @@ module Discordrb::API::User
                end
     "#{Discordrb::API.cdn_url}/avatars/#{user_id}/#{avatar_id}.#{format}"
   end
+
+  # Make a banner URL from the user and banner IDs
+  def banner_url(user_id, banner_id, format = nil)
+    format ||= if banner_id.start_with?('a_')
+                 'gif'
+               else
+                 'png'
+               end
+    "#{Discordrb::API.cdn_url}/banners/#{user_id}/#{banner_id}.#{format}"
+  end
 end

data/lib/discordrb/api/webhook.rb

@@ -27,6 +27,32 @@ module Discordrb::API::Webhook
     )
   end
 
+  # 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 }
+
+    body = if file
+             { file: file, payload_json: body.to_json }
+           elsif attachments
+             files = [*0...attachments.size].zip(attachments).to_h
+             { **files, payload_json: body.to_json }
+           else
+             body.to_json
+           end
+
+    headers = { content_type: :json } unless file || attachments
+
+    Discordrb::API.request(
+      :webhooks_wid,
+      webhook_id,
+      :post,
+      "#{Discordrb::API.api_base}/webhooks/#{webhook_id}/#{webhook_token}?wait=#{wait}",
+      body,
+      headers
+    )
+  end
+
   # Update a webhook
   # https://discord.com/developers/docs/resources/webhook#modify-webhook
   def update_webhook(token, webhook_id, data, reason = nil)
@@ -80,4 +106,50 @@ module Discordrb::API::Webhook
       'X-Audit-Log-Reason': reason
     )
   end
+
+  # Get a message that was created by the webhook corresponding to the provided token.
+  # https://discord.com/developers/docs/resources/webhook#get-webhook-message
+  def token_get_message(webhook_token, webhook_id, message_id)
+    Discordrb::API.request(
+      :webhooks_wid_messages_mid,
+      webhook_id,
+      :get,
+      "#{Discordrb::API.api_base}/webhooks/#{webhook_id}/#{webhook_token}/messages/#{message_id}"
+    )
+  end
+
+  # 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 }
+
+    body = if attachments
+             files = [*0...attachments.size].zip(attachments).to_h
+             { **files, payload_json: body.to_json }
+           else
+             body.to_json
+           end
+
+    headers = { content_type: :json } unless attachments
+
+    Discordrb::API.request(
+      :webhooks_wid_messages,
+      webhook_id,
+      :patch,
+      "#{Discordrb::API.api_base}/webhooks/#{webhook_id}/#{webhook_token}/messages/#{message_id}",
+      body,
+      headers
+    )
+  end
+
+  # Delete a webhook message via webhook token.
+  # https://discord.com/developers/docs/resources/webhook#delete-webhook-message
+  def token_delete_message(webhook_token, webhook_id, message_id)
+    Discordrb::API.request(
+      :webhooks_wid_messages,
+      webhook_id,
+      :delete,
+      "#{Discordrb::API.api_base}/webhooks/#{webhook_id}/#{webhook_token}/messages/#{message_id}"
+    )
+  end
 end

data/lib/discordrb/api.rb

@@ -9,7 +9,7 @@ require 'discordrb/errors'
 # List of methods representing endpoints in Discord's API
 module Discordrb::API
   # The base URL of the Discord REST API.
-  APIBASE = 'https://discord.com/api/v6'
+  APIBASE = 'https://discord.com/api/v9'
 
   # The URL of Discord's CDN
   CDN_URL = 'https://cdn.discordapp.com'
@@ -94,9 +94,6 @@ module Discordrb::API
     # Add a custom user agent
     attributes.last[:user_agent] = user_agent if attributes.last.is_a? Hash
 
-    # Specify RateLimit precision
-    attributes.last[:x_ratelimit_precision] = 'millisecond' if attributes.last.is_a?(Hash)
-
     # The most recent Discord rate limit requirements require the support of major parameters, where a particular route
     # and major parameter combination (*not* the HTTP method) uniquely identifies a RL bucket.
     key = [key, major_parameter].freeze
@@ -115,6 +112,15 @@ module Discordrb::API
         response = raw_request(type, attributes)
       rescue RestClient::Exception => e
         response = e.response
+
+        if response.body && !e.is_a?(RestClient::TooManyRequests)
+          data = JSON.parse(response.body)
+          err_klass = Discordrb::Errors.error_class_for(data['code'] || 0)
+          e = err_klass.new(data['message'], data['errors'])
+
+          Discordrb::LOGGER.error(e.full_message)
+        end
+
         raise e
       rescue Discordrb::Errors::NoPermission => e
         if e.respond_to?(:_rc_response)
@@ -137,7 +143,7 @@ module Discordrb::API
 
       unless mutex.locked?
         response = JSON.parse(e.response)
-        wait_seconds = response['retry_after'].to_i / 1000.0
+        wait_seconds = response['retry_after'] ? response['retry_after'].to_f : e.response.headers[:retry_after].to_i
         Discordrb::LOGGER.ratelimit("Locking RL mutex (key: #{key}) for #{wait_seconds} seconds due to Discord rate limiting")
         trace("429 #{key.join(' ')}")
 
@@ -197,6 +203,11 @@ module Discordrb::API
     "#{cdn_url}/splashes/#{server_id}/#{splash_id}.#{format}"
   end
 
+  # Make a discovery splash URL from server and splash IDs
+  def discovery_splash_url(server_id, splash_id, format = 'webp')
+    "#{cdn_url}/discovery-splashes/#{server_id}/#{splash_id}.#{format}"
+  end
+
   # Make a banner URL from server and banner IDs
   def banner_url(server_id, banner_id, format = 'webp')
     "#{cdn_url}/banners/#{server_id}/#{banner_id}.#{format}"
@@ -217,28 +228,27 @@ module Discordrb::API
     "#{cdn_url}/app-assets/#{application_id}/achievements/#{achievement_id}/icons/#{icon_hash}.#{format}"
   end
 
-  # Login to the server
-  def login(email, password)
-    request(
-      :auth_login,
-      nil,
-      :post,
-      "#{api_base}/auth/login",
-      email: email,
-      password: password
-    )
+  # @param role_id [String, Integer]
+  # @param icon_hash [String]
+  # @param format ['webp', 'png', 'jpeg']
+  # @return [String]
+  def role_icon_url(role_id, icon_hash, format = 'webp')
+    "#{cdn_url}/role-icons/#{role_id}/#{icon_hash}.#{format}"
   end
 
-  # Logout from the server
-  def logout(token)
-    request(
-      :auth_logout,
-      nil,
-      :post,
-      "#{api_base}/auth/logout",
-      nil,
-      Authorization: token
-    )
+  # make an avatar decoration URL from an avatar decoration ID.
+  def avatar_decoration_url(avatar_decoration_id, format = 'png')
+    "#{cdn_url}/avatar-decoration-presets/#{avatar_decoration_id}.#{format}"
+  end
+
+  # make a nameplate URL from the nameplate asset.
+  def nameplate_url(nameplate_asset, format = 'webm')
+    "#{cdn_url}/assets/collectibles/#{nameplate_asset.delete_suffix('/')}/asset.#{format}"
+  end
+
+  # make a server tag badge URL from a server ID and badge ID.
+  def server_tag_badge_url(server_id, badge_id, format = 'webp')
+    "#{cdn_url}/guild-tag-badges/#{server_id}/#{badge_id}.#{format}"
   end
 
   # Create an OAuth application