onyxcord 2.1.0 → 3.2.1

data/lib/onyxcord/internal/rate_limiter/rest.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require_relative '../json'
+
+module OnyxCord
+  module Internal
+    module RateLimiter
+      # Discord REST rate limiter keyed by route/major parameter and remapped to
+      # X-RateLimit-Bucket whenever Discord returns a concrete bucket id.
+      class Rest
+        DEFAULT_ENTRY_TTL = 3600
+        DEFAULT_PRUNE_INTERVAL = 100
+
+        def initialize(clock: -> { Time.now }, entry_ttl: DEFAULT_ENTRY_TTL, prune_interval: DEFAULT_PRUNE_INTERVAL)
+          @route_buckets = {}
+          @bucket_mutexes = {}
+          @bucket_last_used = {}
+          @global_mutex = Mutex.new
+          @clock = clock
+          @entry_ttl = entry_ttl
+          @prune_interval = prune_interval
+          @requests_since_prune = 0
+        end
+
+        def before_request(route, major_parameter)
+          mutex_wait(mutex_for(route, major_parameter))
+          mutex_wait(@global_mutex) if @global_mutex.locked?
+        end
+
+        def record_response(route, major_parameter, headers)
+          headers = normalize_headers(headers)
+          bucket = headers[:x_ratelimit_bucket]
+          key = route_key(route, major_parameter)
+          touch(key)
+
+          if bucket
+            bucket = bucket_key(bucket, major_parameter)
+            @route_buckets[key] = bucket
+            touch(bucket)
+          end
+
+          return unless headers[:x_ratelimit_remaining] == '0'
+
+          wait_seconds = headers[:x_ratelimit_reset_after].to_f
+          return unless wait_seconds.positive?
+
+          sync_wait(wait_seconds, mutex_for(route, major_parameter))
+        end
+
+        def handle_rate_limit(route, major_parameter, response)
+          headers = normalize_headers(response.headers)
+          mutex = headers[:x_ratelimit_global] == 'true' || headers[:x_ratelimit_scope] == 'global' ? @global_mutex : mutex_for(route, major_parameter)
+          wait_seconds = retry_after(response, headers)
+
+          sync_wait(wait_seconds, mutex) if wait_seconds.positive?
+        end
+
+        def stats
+          {
+            route_buckets: @route_buckets.size,
+            bucket_mutexes: @bucket_mutexes.size,
+            tracked_keys: @bucket_last_used.size
+          }
+        end
+
+        def prune!
+          return 0 unless @entry_ttl
+
+          cutoff = @clock.call - @entry_ttl
+          stale_keys = @bucket_last_used.select { |_, last_used| last_used < cutoff }.keys
+
+          stale_keys.each do |key|
+            @bucket_mutexes.delete(key)
+            @bucket_last_used.delete(key)
+            @route_buckets.delete(key)
+            @route_buckets.delete_if { |_, bucket_key| bucket_key == key }
+          end
+
+          @requests_since_prune = 0
+          stale_keys.length
+        end
+
+        private
+
+        def mutex_for(route, major_parameter)
+          key = resolved_key(route, major_parameter)
+          touch(key)
+          @bucket_mutexes[key] ||= Mutex.new
+        end
+
+        def resolved_key(route, major_parameter)
+          @route_buckets[route_key(route, major_parameter)] || route_key(route, major_parameter)
+        end
+
+        def route_key(route, major_parameter)
+          [route, major_parameter].freeze
+        end
+
+        def bucket_key(bucket, major_parameter)
+          [:bucket, bucket, major_parameter].freeze
+        end
+
+        def retry_after(response, headers)
+          body = response.respond_to?(:body) ? response.body : response.to_s
+          if body && !body.empty?
+            data = JSON.parse(body)
+            return data['retry_after'].to_f if data['retry_after']
+          end
+
+          (headers[:retry_after] || 0).to_f
+        rescue JSON::ParserError
+          (headers[:retry_after] || 0).to_f
+        end
+
+        def normalize_headers(headers)
+          headers.each_with_object({}) do |(key, value), memo|
+            memo[key.to_s.tr('-', '_').downcase.to_sym] = value.to_s
+          end
+        end
+
+        def touch(key)
+          @bucket_last_used[key] = @clock.call
+          prune_if_needed
+        end
+
+        def prune_if_needed
+          return unless @prune_interval
+
+          @requests_since_prune += 1
+          prune! if @requests_since_prune >= @prune_interval
+        end
+
+        def sync_wait(time, mutex)
+          mutex.synchronize { sleep time }
+        end
+
+        def mutex_wait(mutex)
+          mutex.lock
+          mutex.unlock
+        end
+      end
+    end
+  end
+end

data/lib/onyxcord/internal/websocket.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require_relative 'async_runtime'
+require 'async/http/endpoint'
+require 'async/http/protocol/http11'
+require 'async/websocket/client'
+
+module OnyxCord
+  module Internal
+    class WebSocket
+      attr_reader :connected
+
+      alias_method :connected?, :connected
+
+      def initialize(host, open_handler, message_handler, error_handler, close_handler)
+        @host = host
+        @open_handler = open_handler
+        @message_handler = message_handler
+        @error_handler = error_handler
+        @close_handler = close_handler
+
+        @connection = nil
+        @connected = false
+
+        connect
+      end
+
+      def send(data)
+        return unless @connection
+
+        data = data.to_json if data.is_a?(Hash)
+        @connection.write(Protocol::WebSocket::TextMessage.generate(data))
+        @connection.flush
+      rescue StandardError => e
+        @error_handler&.call(e)
+      end
+
+      def close
+        @connected = false
+        @connection&.close
+      rescue StandardError
+        # Ignore errors on close
+      end
+
+      private
+
+      def connect
+        endpoint = websocket_endpoint(@host)
+
+        @task = AsyncRuntime.async do
+          Async::WebSocket::Client.connect(endpoint, extensions: nil) do |connection|
+            @connection = connection
+            @connected = true
+            @open_handler&.call
+
+            while (message = connection.read)
+              @message_handler&.call(message.to_str)
+            end
+          rescue StandardError => e
+            @error_handler&.call(e)
+          ensure
+            @connected = false
+            @close_handler&.call(nil)
+          end
+        end
+      rescue StandardError => e
+        @error_handler&.call(e)
+      end
+
+      def websocket_endpoint(url)
+        Async::HTTP::Endpoint.parse(
+          url,
+          protocol: Async::HTTP::Protocol::HTTP11,
+          alpn_protocols: ['http/1.1']
+        )
+      end
+    end
+  end
+end

data/lib/onyxcord/light/data.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'onyxcord/data'
+require 'onyxcord/models'
 
 module OnyxCord::Light
   # Represents the bot account used for the light bot, but without any methods to change anything.

data/lib/onyxcord/light/integrations.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'onyxcord/data'
+require 'onyxcord/models'
 require 'onyxcord/light/data'
 
 module OnyxCord::Light

data/lib/onyxcord/light/light_bot.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'onyxcord/api'
-require 'onyxcord/api/invite'
-require 'onyxcord/api/user'
+require 'onyxcord/rest/client'
+require 'onyxcord/rest/routes/invite'
+require 'onyxcord/rest/routes/user'
 require 'onyxcord/light/data'
 require 'onyxcord/light/integrations'
 
@@ -31,13 +31,13 @@ module OnyxCord::Light
 
     # @return [LightProfile] the details of the user this bot is connected to.
     def profile
-      response = OnyxCord::API::User.profile(@token)
+      response = OnyxCord::REST::User.profile(@token)
       LightProfile.new(JSON.parse(response), self)
     end
 
     # @return [Array<LightServer>] the servers this bot is connected to.
     def servers
-      response = OnyxCord::API::User.servers(@token)
+      response = OnyxCord::REST::User.servers(@token)
       JSON.parse(response).map { |e| LightServer.new(e, self) }
     end
 
@@ -45,13 +45,13 @@ module OnyxCord::Light
     # @param code [String] The code part of the invite (for example 0cDvIgU2voWn4BaD if the invite URL is
     #   https://discord.gg/0cDvIgU2voWn4BaD)
     def join(code)
-      OnyxCord::API::Invite.accept(@token, code)
+      OnyxCord::REST::Invite.accept(@token, code)
     end
 
     # Gets the connections associated with this account.
     # @return [Array<Connection>] this account's connections.
     def connections
-      response = OnyxCord::API::User.connections(@token)
+      response = OnyxCord::REST::User.connections(@token)
       JSON.parse(response).map { |e| Connection.new(e, self) }
     end
   end

data/lib/onyxcord/{data → models}/activity.rb

@@ -188,14 +188,14 @@ module OnyxCord
       # @param format [String, nil] If `nil`, the URL will default to `webp`. You can otherwise specify one of `webp`, `jpg`, or `png`.
       # @return [String] the URL to the large image asset.
       def large_image_url(format = 'webp')
-        API.asset_url(@application_id, @large_image_id, format)
+        REST.asset_url(@application_id, @large_image_id, format)
       end
 
       # Utility function to get an Asset's large image URL.
       # @param format [String, nil] If `nil`, the URL will default to `webp`. You can otherwise specify one of `webp`, `jpg`, or `png`.
       # @return [String] the URL to the small image asset.
       def small_image_url(format = 'webp')
-        API.asset_url(@application_id, @small_image_id, format)
+        REST.asset_url(@application_id, @small_image_id, format)
       end
     end
 

data/lib/onyxcord/{data → models}/application.rb

@@ -131,14 +131,14 @@ module OnyxCord
     # @param format [String] The URL will default to `webp`. You can otherwise specify one of `webp`, `jpg` or `png` to override this.
     # @return [String, nil] The URL of the icon image (`nil` if no image is set).
     def icon_url(format: 'webp')
-      API.app_icon_url(@id, @icon_id, format) if @icon_id
+      REST.app_icon_url(@id, @icon_id, format) if @icon_id
     end
 
     # Utility method to get a application's cover image URL.
     # @param format [String] The URL will default to `webp`. You can otherwise specify one of `webp`, `jpg` or `png` to override this.
     # @return [String, nil] The URL of the cover image (`nil` if no cover is set).
     def cover_image_url(format: 'webp')
-      API.app_cover_url(@id, @cover_image_id, format) if @cover_image_id
+      REST.app_cover_url(@id, @cover_image_id, format) if @cover_image_id
     end
 
     # Delete an integration types config for the application.
@@ -236,7 +236,7 @@ module OnyxCord
         data[:flags] = ((@flags & ~to_flags.call(remove_flags)) | to_flags.call(add_flags))
       end
 
-      update_data(JSON.parse(API::Application.update_current_application(@bot.token, **data)))
+      update_data(JSON.parse(REST::Application.update_current_application(@bot.token, **data)))
       nil
     end
 

data/lib/onyxcord/{data → models}/avatar_decoration.rb

@@ -20,7 +20,7 @@ module OnyxCord
     # Utility method to get an avatar decoration URL.
     # @return [String] the URL to the avatar decoration.
     def url
-      API.avatar_decoration_url(@decoration_id)
+      REST.avatar_decoration_url(@decoration_id)
     end
   end
 end

data/lib/onyxcord/{data → models}/channel.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'onyxcord/webhooks/view'
-require 'onyxcord/message_components'
+require 'onyxcord/utils/message_components'
 require 'time'
 
 module OnyxCord
@@ -412,7 +412,7 @@ module OnyxCord
         move_argument << hash
       end
 
-      API::Server.update_channel_positions(@bot.token, @server_id, move_argument)
+      REST::Server.update_channel_positions(@bot.token, @server_id, move_argument)
     end
 
     # Check if this channel is marked as NSFW.
@@ -667,13 +667,13 @@ module OnyxCord
     # Deletes a message on this channel. Mostly useful in case a message needs to be deleted when only the ID is known
     # @param message [Message, String, Integer, String, Integer] The message, or its ID, that should be deleted.
     def delete_message(message)
-      API::Channel.delete_message(@bot.token, @id, message.resolve_id)
+      REST::Channel.delete_message(@bot.token, @id, message.resolve_id)
     end
 
     # Permanently deletes this channel
     # @param reason [String] The reason the for the channel deletion.
     def delete(reason = nil)
-      API::Channel.delete(@bot.token, @id, reason)
+      REST::Channel.delete(@bot.token, @id, reason)
     end
 
     # Sets this channel's name. The name must be alphanumeric with dashes, unless this is a voice channel (then there are no limitations)
@@ -743,7 +743,7 @@ module OnyxCord
         thing = Overwrite.new(thing, allow: allow_bits, deny: deny_bits)
       end
 
-      API::Channel.update_permission(@bot.token, @id, thing.id, thing.allow.bits, thing.deny.bits, thing.type, reason)
+      REST::Channel.update_permission(@bot.token, @id, thing.id, thing.allow.bits, thing.deny.bits, thing.type, reason)
     end
 
     # Deletes a permission overwrite for this channel
@@ -752,7 +752,7 @@ module OnyxCord
     def delete_overwrite(target, reason = nil)
       raise 'Tried deleting a overwrite for an invalid target' unless target.respond_to?(:resolve_id)
 
-      API::Channel.delete_permission(@bot.token, @id, target.resolve_id, reason)
+      REST::Channel.delete_permission(@bot.token, @id, target.resolve_id, reason)
     end
 
     # The list of users currently in this channel. For a voice channel, it will return all the members currently
@@ -780,7 +780,7 @@ module OnyxCord
     #   last_ten_messages = channel.history(10, message.id)
     # @return [Array<Message>] the retrieved messages.
     def history(amount, before_id = nil, after_id = nil, around_id = nil)
-      logs = API::Channel.messages(@bot.token, @id, amount, before_id, after_id, around_id)
+      logs = REST::Channel.messages(@bot.token, @id, amount, before_id, after_id, around_id)
       JSON.parse(logs).map { |message| Message.new(message, @bot) }
     end
 
@@ -788,7 +788,7 @@ module OnyxCord
     # @note For internal use only
     # @!visibility private
     def history_ids(amount, before_id = nil, after_id = nil, around_id = nil)
-      logs = API::Channel.messages(@bot.token, @id, amount, before_id, after_id, around_id)
+      logs = REST::Channel.messages(@bot.token, @id, amount, before_id, after_id, around_id)
       JSON.parse(logs).map { |message| message['id'].to_i }
     end
 
@@ -798,7 +798,7 @@ module OnyxCord
     def load_message(message_id)
       raise ArgumentError, 'message_id cannot be nil' if message_id.nil?
 
-      response = API::Channel.message(@bot.token, @id, message_id)
+      response = REST::Channel.message(@bot.token, @id, message_id)
       Message.new(JSON.parse(response), @bot)
     rescue OnyxCord::Errors::UnknownMessage
       nil
@@ -811,7 +811,7 @@ module OnyxCord
     # @return [Array<Message>] the messages pinned in the channel.
     def pins(limit: 50)
       get_pins = proc do |fetch_limit, before = nil|
-        resp = API::Channel.pinned_messages(@bot.token, @id, fetch_limit, before&.iso8601)
+        resp = REST::Channel.pinned_messages(@bot.token, @id, fetch_limit, before&.iso8601)
         JSON.parse(resp)['items'].map { |pin| Message.new(pin['message'].merge({ 'pinned_at' => pin['pinned_at'] }), @bot) }
       end
 
@@ -853,7 +853,7 @@ module OnyxCord
       when 0
         0
       when 1
-        API::Channel.delete_message(@bot.token, @id, messages.first, reason)
+        REST::Channel.delete_message(@bot.token, @id, messages.first, reason)
         1
       else
         bulk_delete(messages, strict, reason)
@@ -904,7 +904,7 @@ module OnyxCord
     # @param reason [String] The reason the for the creation of this invite.
     # @return [Invite] the created invite.
     def make_invite(max_age = 0, max_uses = 0, temporary = false, unique = false, reason = nil)
-      response = API::Channel.create_invite(@bot.token, @id, max_age, max_uses, temporary, unique, reason)
+      response = REST::Channel.create_invite(@bot.token, @id, max_age, max_uses, temporary, unique, reason)
       Invite.new(JSON.parse(response), @bot)
     end
 
@@ -916,7 +916,7 @@ module OnyxCord
     # @example Send a typing indicator for the bot in a given channel.
     #   channel.start_typing()
     def start_typing
-      API::Channel.start_typing(@bot.token, @id)
+      REST::Channel.start_typing(@bot.token, @id)
     end
 
     # Creates a webhook in this channel
@@ -928,7 +928,7 @@ module OnyxCord
     def create_webhook(name, avatar = nil, reason = nil)
       raise ArgumentError, 'Tried to create a webhook in a non-server channel' unless server
 
-      response = API::Channel.create_webhook(@bot.token, @id, name, avatar, reason)
+      response = REST::Channel.create_webhook(@bot.token, @id, name, avatar, reason)
       Webhook.new(JSON.parse(response), @bot)
     end
 
@@ -937,7 +937,7 @@ module OnyxCord
     def webhooks
       raise 'Tried to request webhooks from a non-server channel' unless server
 
-      webhooks = JSON.parse(API::Channel.webhooks(@bot.token, @id))
+      webhooks = JSON.parse(REST::Channel.webhooks(@bot.token, @id))
       webhooks.map { |webhook_data| Webhook.new(webhook_data, @bot) }
     end
 
@@ -946,7 +946,7 @@ module OnyxCord
     def invites
       raise 'Tried to request invites from a non-server channel' unless server
 
-      invites = JSON.parse(API::Channel.invites(@bot.token, @id))
+      invites = JSON.parse(REST::Channel.invites(@bot.token, @id))
       invites.map { |invite_data| Invite.new(invite_data, @bot) }
     end
 
@@ -957,7 +957,7 @@ module OnyxCord
     def follow(target, reason: nil)
       raise 'Cannot follow a non-announcement channel' unless news?
 
-      JSON.parse(API::Channel.follow_channel(@bot.token, @id, target.resolve_id, reason))['webhook_id'].to_i
+      JSON.parse(REST::Channel.follow_channel(@bot.token, @id, target.resolve_id, reason))['webhook_id'].to_i
     end
 
     # Returns the last message or forum post created in this channel.
@@ -985,9 +985,9 @@ module OnyxCord
       type = TYPES[type] || type
 
       data = if message
-               API::Channel.start_thread_with_message(@bot.token, @id, message_id, name, auto_archive_duration)
+               REST::Channel.start_thread_with_message(@bot.token, @id, message_id, name, auto_archive_duration)
              else
-               API::Channel.start_thread_without_message(@bot.token, @id, name, auto_archive_duration, type)
+               REST::Channel.start_thread_without_message(@bot.token, @id, name, auto_archive_duration, type)
              end
 
       @bot.ensure_channel(JSON.parse(data))
@@ -1026,7 +1026,7 @@ module OnyxCord
       builder = builder.to_json_hash
 
       message = { content: builder[:content], embeds: builder[:embeds], allowed_mentions: builder[:allowed_mentions], components: components, sticker_ids: stickers&.map(&:resolve_id), flags: flags }
-      response = JSON.parse(API::Channel.start_thread_in_forum_or_media_channel(@bot.token, @id, name, message.compact, attachments, rate_limit_per_user, auto_archive_duration, tags&.map(&:resolve_id), reason))
+      response = JSON.parse(REST::Channel.start_thread_in_forum_or_media_channel(@bot.token, @id, name, message.compact, attachments, rate_limit_per_user, auto_archive_duration, tags&.map(&:resolve_id), reason))
 
       Message.new(response['message'].merge!('channel_id' => response['id'], 'thread' => response), @bot)
     end
@@ -1207,7 +1207,7 @@ module OnyxCord
         data[:flags] = ((@flags & ~to_flags.call(remove_flags)) | to_flags.call(add_flags))
       end
 
-      update_data(JSON.parse(API::Channel.update!(@bot.token, @id, **data, reason: reason)))
+      update_data(JSON.parse(REST::Channel.update!(@bot.token, @id, **data, reason: reason)))
       nil
     end
 
@@ -1249,7 +1249,7 @@ module OnyxCord
     # @note For internal use only
     # @!visibility private
     def update_data(new_data = nil)
-      new_data ||= JSON.parse(API::Channel.resolve(@bot.token, @id))
+      new_data ||= JSON.parse(REST::Channel.resolve(@bot.token, @id))
       @type = new_data['type'] || 0
       @topic = new_data['topic']
       @bitrate = new_data['bitrate']
@@ -1316,7 +1316,7 @@ module OnyxCord
         true
       end
 
-      API::Channel.bulk_delete_messages(@bot.token, @id, ids, reason)
+      REST::Channel.bulk_delete_messages(@bot.token, @id, ids, reason)
       ids.size
     end
 

data/lib/onyxcord/{data → models}/collectibles.rb

@@ -40,7 +40,7 @@ module OnyxCord
       #   nameplate instead of the animated URL.
       # @return [String] The CDN url of this nameplate.
       def url(static: false)
-        static ? API.static_nameplate_url(@asset) : API.nameplate_url(@asset)
+        static ? REST.static_nameplate_url(@asset) : REST.nameplate_url(@asset)
       end
     end
   end

data/lib/onyxcord/{data → models}/emoji.rb

@@ -79,7 +79,7 @@ module OnyxCord
 
     # @return [String] the icon URL of the emoji
     def icon_url
-      API.emoji_icon_url(id)
+      REST.emoji_icon_url(id)
     end
 
     # The inspect method is overwritten to give more useful output