discorb 0.14.0 → 0.16.0

data/lib/discorb/rate_limit.rb

@@ -6,7 +6,12 @@ module Discorb
   # @private
   #
   class RatelimitHandler
+    #
+    # Initialize a rate limit handler.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    #
     def initialize(client)
       @client = client
       @path_ratelimit_bucket = {}
@@ -27,7 +32,7 @@ module Discorb
       # return if path.url.start_with?("https://")
       if @global && @global > Time.now.to_f
         time = @global - Time.now.to_f
-        @client.log.info("global rate limit reached, waiting #{time} seconds")
+        @client.logger.info("global rate limit reached, waiting #{time} seconds")
         sleep(time)
         @global = false
       end
@@ -43,7 +48,7 @@ module Discorb
       return if (bucket[:remaining]).positive?
 
       time = bucket[:reset_at] - Time.now.to_f
-      @client.log.info("rate limit for #{path.identifier} with #{path.major_param} reached, waiting #{time.round(4)} seconds")
+      @client.logger.info("rate limit for #{path.identifier} with #{path.major_param} reached, waiting #{time.round(4)} seconds")
       sleep(time)
     end
 

data/lib/discorb/reaction.rb

@@ -16,7 +16,13 @@ module Discorb
     alias me? me
     alias reacted? me
 
+    #
+    # Initialize a new reaction.
     # @private
+    #
+    # @param [Discorb::Message] message The message that this reaction is on.
+    # @param [Hash] data The data of the reaction.
+    #
     def initialize(message, data)
       @message = message
       _set_data(data)

data/lib/discorb/role.rb

@@ -42,7 +42,14 @@ module Discorb
 
     include Comparable
 
+    #
+    # Initializes a new role.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Discorb::Guild] guild The guild the role belongs to.
+    # @param [Hash] data The data of the role.
+    #
     def initialize(client, guild, data)
       @client = client
       @guild = guild
@@ -176,7 +183,12 @@ module Discorb
       # @!attribute [r] integration?
       #   @return [Boolean] Whether the role is an integration role.
 
+      #
+      # Initializes a new tag.
       # @private
+      #
+      # @param [Hash] data The data of the tag.
+      #
       def initialize(data)
         @bot_id = Snowflake.new(data[:bot_id])
         @integration_id = Snowflake.new(data[:integration_id])

data/lib/discorb/shard.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Discorb
+  #
+  # Represents a shard.
+  #
+  class Shard
+    # @return [Integer] The ID of the shard.
+    attr_reader :id
+    # @return [Thread] The thread of the shard.
+    attr_reader :thread
+    # @return [Logger] The logger of the shard.
+    attr_reader :logger
+    # @private
+    # @return [Integer] The internal index of the shard.
+    attr_reader :index
+    # @private
+    attr_accessor :status, :connection, :session_id, :next_shard, :main_task
+
+    #
+    # Initializes a new shard.
+    # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Integer] id The ID of the shard.
+    # @param [Integer] count The number of shards.
+    # @param [Integer] index The index of the shard.
+    #
+    def initialize(client, id, count, index)
+      @client = client
+      @id = id
+      @shard_count = count
+      @status = :idle
+      @index = index
+      @session_id = nil
+      @next_shard = nil
+      @main_task = nil
+      @logger = client.logger.dup.tap { |l| l.progname = "discorb: shard #{id}" }
+      @thread = Thread.new do
+        Thread.current.thread_variable_set("shard_id", id)
+        Thread.current.thread_variable_set("shard", self)
+        if @index.positive?
+          Thread.stop
+          sleep 5  # Somehow discord disconnects the shard without a little sleep.
+        end
+        client.send(:main_loop, id)
+      end
+    end
+
+    #
+    # Starts the shard.
+    #
+    # @return [void]
+    #
+    def start
+      @thread.wakeup
+    end
+
+    #
+    # Stops the shard.
+    #
+    # @return [void]
+    #
+    def close!
+      @status = :closed
+      @main_task&.stop
+      @thread.kill
+    end
+
+    def inspect
+      "#<#{self.class} #{id}/#{@shard_count} #{@status}>"
+    end
+  end
+end

data/lib/discorb/sticker.rb

@@ -29,16 +29,27 @@ module Discorb
     attr_reader :available
     alias available? available
 
-    @sticker_type = {
+    # @private
+    # @return [{Integer => Symbol}] The mapping of sticker types.
+    STICKER_TYPE = {
       1 => :official,
       2 => :guild,
     }.freeze
-    @sticker_format = {
+
+    # @private
+    # @return [{Integer => Symbol}] The mapping of sticker format.
+    STICKER_FORMAT = {
       1 => :png,
       2 => :apng,
       3 => :lottie,
-    }
+    }.freeze
+    #
+    # Initialize a new sticker.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The sticker data.
+    #
     def initialize(client, data)
       @client = client
       _set_data(data)
@@ -51,15 +62,6 @@ module Discorb
       # @!attribute [r] guild
       #   @macro client_cache
       #   @return [Discorb::Guild] The guild the sticker is in.
-      @sticker_type = {
-        1 => :official,
-        2 => :guild,
-      }.freeze
-      @sticker_format = {
-        1 => :png,
-        2 => :apng,
-        3 => :lottie,
-      }
 
       def guild
         @client.guilds[@guild_id]
@@ -121,7 +123,13 @@ module Discorb
       # @return [Discorb::Asset] The banner of the pack.
       attr_reader :banner
 
+      #
+      # Initialize a new sticker pack.
       # @private
+      #
+      # @param [Discorb::Client] client The client.
+      # @param [Hash] data The sticker pack data.
+      #
       def initialize(client, data)
         @client = client
         @id = Snowflake.new(data[:id])
@@ -141,8 +149,8 @@ module Discorb
       @id = Snowflake.new(data[:id])
       @name = data[:name]
       @tags = data[:tags].split(",")
-      @type = self.class.sticker_type[data[:type]]
-      @format = self.class.sticker_format[data[:format]]
+      @type = STICKER_TYPE[data[:type]]
+      @format = STICKER_FORMAT[data[:format]]
       @description = data[:description]
       @available = data[:available]
       if @type == :official

data/lib/discorb/user.rb

@@ -29,7 +29,13 @@ module Discorb
     # @!attribute [r] mention
     #   @return [String] The user's mention.
 
+    #
+    # Initializes a new user.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The user data.
+    #
     def initialize(client, data)
       @client = client
       @data = {}
@@ -79,7 +85,12 @@ module Discorb
 
     alias app_owner? bot_owner?
 
+    #
+    # Returns the dm channel id of the user.
     # @private
+    #
+    # @return [Async::Task<Discorb::Snowflake>] A task that resolves to the channel id.
+    #
     def channel_id
       Async do
         next @dm_channel_id if @dm_channel_id

data/lib/discorb/voice_state.rb

@@ -46,7 +46,13 @@ module Discorb
     #   @macro client_cache
     #   @return [Discorb::User] The user this voice state is for.
 
+    #
+    # Initialize a new voice state.
     # @private
+    #
+    # @param [Discorb::Client] client The client this voice state belongs to.
+    # @param [Hash] data The data of the voice state.
+    #
     def initialize(client, data)
       @client = client
       _set_data(data)
@@ -135,7 +141,14 @@ module Discorb
       2 => :guild_only,
     }
 
+    #
+    # Initialize a new instance of the StageInstance class.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data of the stage instance.
+    # @param [Boolean] no_cache Whether to disable caching.
+    #
     def initialize(client, data, no_cache: false)
       @client = client
       @data = data
@@ -182,7 +195,7 @@ module Discorb
       Async do
         payload = {}
         payload[:topic] = topic if topic != Discorb::Unset
-        payload[:privacy_level] = self.class.privacy_level.key(privacy_level) if privacy_level != Discorb::Unset
+        payload[:privacy_level] = PRIVACY_LEVEL.key(privacy_level) if privacy_level != Discorb::Unset
         @client.http.request(
           Route.new("/stage-instances/#{@channel_id}", "//stage-instances/:channel_id", :patch), payload, audit_log_reason: reason,
         ).wait
@@ -216,7 +229,7 @@ module Discorb
       @guild_id = Snowflake.new(data[:guild_id])
       @channel_id = Snowflake.new(data[:channel_id])
       @topic = data[:topic]
-      @privacy_level = self.class.privacy_level[data[:privacy_level]]
+      @privacy_level = PRIVACY_LEVEL[data[:privacy_level]]
       @discoverable_disabled = data[:discoverable_disabled]
     end
 
@@ -246,7 +259,12 @@ module Discorb
     attr_reader :custom
     alias custom? custom
 
+    #
+    # Initialize a new instance of the VoiceRegion class.
     # @private
+    #
+    # @param [Hash] data The data of the voice region.
+    #
     def initialize(data)
       @id = data[:id]
       @name = data[:name]

data/lib/discorb/webhook.rb

@@ -22,7 +22,13 @@ module Discorb
     # @return [String] The URL of the webhook.
     attr_reader :token
 
+    #
+    # Initializes a webhook.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data of the webhook.
+    #
     def initialize(client, data)
       @name = data[:name]
       @guild_id = data[:guild_id] && Snowflake.new(data[:guild_id])
@@ -200,7 +206,13 @@ module Discorb
       # @!attribute [r] url
       #   @return [String] The URL of the webhook.
 
+      #
+      # Initializes the incoming webhook.
       # @private
+      #
+      # @param [Discorb::Client] client The client.
+      # @param [String] url The URL of the webhook.
+      #
       def initialize(client, data)
         super
         @token = data[:token]
@@ -222,7 +234,13 @@ module Discorb
       #   Represents a source channel of follower webhook.
       #   @return [Discorb::Channel, Discorb::Webhook::FollowerWebhook::Channel] The source channel of follower webhook.
 
+      #
+      # Initializes the follower webhook.
       # @private
+      #
+      # @param [Discorb::Client] client The client.
+      # @param [Hash] data The data of the follower webhook.
+      #
       def initialize(client, data)
         super
         @source_guild = FollowerWebhook::Guild.new(data[:source_guild])
@@ -248,12 +266,21 @@ module Discorb
         # @return [Discorb::Asset] The icon of the guild.
         attr_reader :icon
 
+        #
+        # Initialize a new guild.
         # @private
+        #
+        # @param [Hash] data The data of the guild.
+        #
         def initialize(data)
           @id = Snowflake.new(data[:id])
           @name = data[:name]
           @icon = Asset.new(self, data[:icon])
         end
+
+        def inspect
+          "#<#{self.class.name} #{@id}: #{@name}>"
+        end
       end
 
       #
@@ -265,11 +292,20 @@ module Discorb
         # @return [String] The name of the channel.
         attr_reader :name
 
+        #
+        # Initialize a new channel.
         # @private
+        #
+        # @param [Hash] data The data of the channel.
+        #
         def initialize(data)
           @id = Snowflake.new(data[:id])
           @name = data[:name]
         end
+
+        def inspect
+          "#<#{self.class.name} #{@id}: #{@name}>"
+        end
       end
     end
 
@@ -290,7 +326,13 @@ module Discorb
       # @return [Discorb::Snowflake] The ID of the guild.
       attr_reader :guild_id
 
+      #
+      # Initializes the message.
       # @private
+      #
+      # @param [Discorb::Webhook] webhook The webhook.
+      # @param [Hash] data The data of the message.
+      # @param [Discorb::Client] client The client. This will be nil if it's created from {URLWebhook}.
       def initialize(webhook, data, client = nil)
         @client = client
         @webhook = webhook
@@ -329,12 +371,12 @@ module Discorb
 
       def _set_data(data)
         @id = Snowflake.new(data[:id])
-        @type = Discorb::Message.message_type[data[:type]]
+        @type = Discorb::Message::MESSAGE_TYPE[data[:type]]
         @content = data[:content]
         @channel_id = Snowflake.new(data[:channel_id])
         @author = Author.new(data[:author])
         @attachments = data[:attachments].map { |a| Attachment.new(a) }
-        @embeds = data[:embeds] ? data[:embeds].map { |e| Embed.new(data: e) } : []
+        @embeds = data[:embeds] ? data[:embeds].map { |e| Embed.from_hash(e) } : []
         @mentions = data[:mentions].map { |m| Mention.new(m) }
         @mention_roles = data[:mention_roles].map { |m| Snowflake.new(m) }
         @mention_everyone = data[:mention_everyone]
@@ -364,7 +406,12 @@ module Discorb
         # @return [String] The discriminator of the author.
         attr_reader :discriminator
 
+        #
+        # Initializes the author.
         # @private
+        #
+        # @param [Hash] data The data of the author.
+        #
         def initialize(data)
           @data = data
           @bot = data[:bot]
@@ -384,6 +431,10 @@ module Discorb
         end
 
         alias to_s_user to_s
+
+        def inspect
+          "#<#{self.class.name} #{self}>"
+        end
       end
     end
 

data/lib/discorb.rb

@@ -4,7 +4,10 @@
 #
 # @author sevenc-nanashi
 module Discorb
+  #
+  # Method to define a macro for YARD.
   # @private
+  #
   # @!macro [new] async
   #   @note This is an asynchronous method, it will return a `Async::Task` object. Use `Async::Task#wait` to get the result.
   #
@@ -23,7 +26,6 @@ module Discorb
   #   @raise [Discorb::HTTPError] HTTP request failed.
   #
   def macro
-    # NOTE: this method is only for YARD.
     puts "Wow, You found the easter egg!\n"
     red = "\e[31m"
     reset = "\e[m"
@@ -43,10 +45,10 @@ require_order = %w[common flag dictionary error rate_limit http intents emoji_ta
                 %w[message_meta allowed_mentions] +
                 %w[user member guild emoji channel embed message] +
                 %w[application audit_logs color components event event_handler] +
-                %w[file guild_template image integration interaction invite log permission] +
+                %w[attachment guild_template image integration interaction invite permission] +
                 %w[presence reaction role sticker utils voice_state webhook] +
                 %w[gateway_requests gateway app_command] +
-                %w[asset extension client extend]
+                %w[asset extension shard client extend]
 require_order.each do |name|
   require_relative "discorb/#{name}.rb"
 end