discordrb 3.3.0 → 3.5.0

data/lib/discordrb/api/webhook.rb

@@ -5,7 +5,7 @@ module Discordrb::API::Webhook
   module_function
 
   # Get a webhook
-  # https://discordapp.com/developers/docs/resources/webhook#get-webhook
+  # https://discord.com/developers/docs/resources/webhook#get-webhook
   def webhook(token, webhook_id)
     Discordrb::API.request(
       :webhooks_wid,
@@ -17,7 +17,7 @@ module Discordrb::API::Webhook
   end
 
   # Get a webhook via webhook token
-  # https://discordapp.com/developers/docs/resources/webhook#get-webhook-with-token
+  # https://discord.com/developers/docs/resources/webhook#get-webhook-with-token
   def token_webhook(webhook_token, webhook_id)
     Discordrb::API.request(
       :webhooks_wid,
@@ -27,8 +27,30 @@ 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)
+    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 }
+           else
+             body.to_json
+           end
+
+    headers = { content_type: :json } unless file
+
+    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://discordapp.com/developers/docs/resources/webhook#modify-webhook
+  # https://discord.com/developers/docs/resources/webhook#modify-webhook
   def update_webhook(token, webhook_id, data, reason = nil)
     Discordrb::API.request(
       :webhooks_wid,
@@ -43,7 +65,7 @@ module Discordrb::API::Webhook
   end
 
   # Update a webhook via webhook token
-  # https://discordapp.com/developers/docs/resources/webhook#modify-webhook-with-token
+  # https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token
   def token_update_webhook(webhook_token, webhook_id, data, reason = nil)
     Discordrb::API.request(
       :webhooks_wid,
@@ -57,7 +79,7 @@ module Discordrb::API::Webhook
   end
 
   # Deletes a webhook
-  # https://discordapp.com/developers/docs/resources/webhook#delete-webhook
+  # https://discord.com/developers/docs/resources/webhook#delete-webhook
   def delete_webhook(token, webhook_id, reason = nil)
     Discordrb::API.request(
       :webhooks_wid,
@@ -70,7 +92,7 @@ module Discordrb::API::Webhook
   end
 
   # Deletes a webhook via webhook token
-  # https://discordapp.com/developers/docs/resources/webhook#delete-webhook-with-token
+  # https://discord.com/developers/docs/resources/webhook#delete-webhook-with-token
   def token_delete_webhook(webhook_token, webhook_id, reason = nil)
     Discordrb::API.request(
       :webhooks_wid,
@@ -80,4 +102,39 @@ 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)
+    Discordrb::API.request(
+      :webhooks_wid_messages,
+      webhook_id,
+      :patch,
+      "#{Discordrb::API.api_base}/webhooks/#{webhook_id}/#{webhook_token}/messages/#{message_id}",
+      { content: content, embeds: embeds, allowed_mentions: allowed_mentions, components: components }.to_json,
+      content_type: :json
+    )
+  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,10 +9,10 @@ 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://discordapp.com/api/v6'.freeze
+  APIBASE = 'https://discord.com/api/v9'
 
   # The URL of Discord's CDN
-  CDN_URL = 'https://cdn.discordapp.com'.freeze
+  CDN_URL = 'https://cdn.discordapp.com'
 
   module_function
 
@@ -31,12 +31,12 @@ module Discordrb::API
     @cdn_url || CDN_URL
   end
 
-  # @return [String] the bot name, previously specified using #bot_name=.
+  # @return [String] the bot name, previously specified using {.bot_name=}.
   def bot_name
     @bot_name
   end
 
-  # Sets the bot name to something.
+  # Sets the bot name to something. Used in {.user_agent}. For the bot's username, see {Profile#username=}.
   def bot_name=(value)
     @bot_name = value
   end
@@ -51,7 +51,7 @@ module Discordrb::API
   # Generate a user agent identifying this requester as discordrb.
   def user_agent
     # This particular string is required by the Discord devs.
-    required = "DiscordBot (https://github.com/meew0/discordrb, v#{Discordrb::VERSION})"
+    required = "DiscordBot (https://github.com/shardlab/discordrb, v#{Discordrb::VERSION})"
     @bot_name ||= ''
 
     "#{required} rest-client/#{RestClient::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION}p#{RUBY_PATCHLEVEL} discordrb/#{Discordrb::VERSION} #{@bot_name}"
@@ -80,7 +80,7 @@ module Discordrb::API
   def raw_request(type, attributes)
     RestClient.send(type, *attributes)
   rescue RestClient::Forbidden => e
-    # HACK: for #request, dynamically inject restclient's response into NoPermission - this allows us to ratelimit
+    # HACK: for #request, dynamically inject restclient's response into NoPermission - this allows us to rate limit
     noprm = Discordrb::Errors::NoPermission.new
     noprm.define_singleton_method(:_rc_response) { e.response }
     raise noprm, "The bot doesn't have the required permission to do this!"
@@ -112,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)
@@ -134,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(' ')}")
 
@@ -149,17 +158,12 @@ module Discordrb::API
     response
   end
 
-  # Handles premeptive ratelimiting by waiting the given mutex by the difference of the Date header to the
+  # Handles pre-emptive rate limiting by waiting the given mutex by the difference of the Date header to the
   # X-Ratelimit-Reset header, thus making sure we don't get 429'd in any subsequent requests.
   def handle_preemptive_rl(headers, mutex, key)
     Discordrb::LOGGER.ratelimit "RL bucket depletion detected! Date: #{headers[:date]} Reset: #{headers[:x_ratelimit_reset]}"
-
-    now = Time.rfc2822(headers[:date])
-    reset = Time.at(headers[:x_ratelimit_reset].to_i)
-
-    delta = reset - now
-
-    Discordrb::LOGGER.warn("Locking RL mutex (key: #{key}) for #{delta} seconds preemptively")
+    delta = headers[:x_ratelimit_reset_after].to_f
+    Discordrb::LOGGER.warn("Locking RL mutex (key: #{key}) for #{delta} seconds pre-emptively")
     sync_wait(delta, mutex)
   end
 
@@ -175,7 +179,7 @@ module Discordrb::API
     Discordrb::LOGGER.ratelimit("Trace (#{reason}):")
 
     caller.each do |str|
-      Discordrb::LOGGER.ratelimit(' ' + str)
+      Discordrb::LOGGER.ratelimit(" #{str}")
     end
   end
 
@@ -199,11 +203,34 @@ module Discordrb::API
     "#{cdn_url}/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}"
+  end
+
   # Make an emoji icon URL from emoji ID
   def emoji_icon_url(emoji_id, format = 'webp')
     "#{cdn_url}/emojis/#{emoji_id}.#{format}"
   end
 
+  # Make an asset URL from application and asset IDs
+  def asset_url(application_id, asset_id, format = 'webp')
+    "#{cdn_url}/app-assets/#{application_id}/#{asset_id}.#{format}"
+  end
+
+  # Make an achievement icon URL from application ID, achievement ID, and icon hash
+  def achievement_icon_url(application_id, achievement_id, icon_hash, format = 'webp')
+    "#{cdn_url}/app-assets/#{application_id}/achievements/#{achievement_id}/icons/#{icon_hash}.#{format}"
+  end
+
+  # @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
+
   # Login to the server
   def login(email, password)
     request(
@@ -290,6 +317,18 @@ module Discordrb::API
     )
   end
 
+  # Get the gateway to be used, with additional information for sharding and
+  # session start limits
+  def gateway_bot(token)
+    request(
+      :gateway_bot,
+      nil,
+      :get,
+      "#{api_base}/gateway/bot",
+      Authorization: token
+    )
+  end
+
   # Validate a token (this request will fail if the token is invalid)
   def validate_token(token)
     request(

data/lib/discordrb/await.rb

@@ -43,7 +43,6 @@ module Discordrb
       dummy_handler = EventContainer.handler_class(@type).new(@attributes, @bot)
       return [nil, nil] unless event.instance_of?(@type) && dummy_handler.matches?(event)
 
-      should_delete = nil
       should_delete = true if (@block && @block.call(event) != false) || !@block
 
       [@key, should_delete]