discorb 0.17.0 → 0.18.1

data/lib/discorb/interaction/root.rb

@@ -25,6 +25,8 @@ module Discorb
     # @return [Symbol] The locale of the guild that created the interaction.
     # @note This modifies the language code, `-` will be replaced with `_`.
     attr_reader :guild_locale
+    # @return [Discorb::Permission] The permissions of the bot.
+    attr_reader :app_permissions
 
     # @!attribute [r] guild
     #   @macro client_cache
@@ -62,6 +64,7 @@ module Discorb
       @token = data[:token]
       @locale = data[:locale].to_s.gsub("-", "_").to_sym
       @guild_locale = data[:guild_locale].to_s.gsub("-", "_").to_sym
+      @app_permissions = data[:app_permissions] && Permission.new(data[:app_permissions].to_i)
       @version = data[:version]
       @defered = false
       @responded = false

data/lib/discorb/member.rb

@@ -52,10 +52,10 @@ module Discorb
     #   @return [Discorb::Presence] The presence of the member.
     # @!attribute [r] activity
     #   @macro client_cache
-    #   @return [Discorb::Activity] The activity of the member. It's from the {#presence}.
+    #   @return [Discorb::Presence::Activity] The activity of the member. It's from the {#presence}.
     # @!attribute [r] activities
     #   @macro client_cache
-    #   @return [Array<Discorb::Activity>] The activities of the member. It's from the {#presence}.
+    #   @return [Array<Discorb::Presence::Activity>] The activities of the member. It's from the {#presence}.
     # @!attribute [r] status
     #   @macro client_cache
     #   @return [Symbol] The status of the member. It's from the {#presence}.
@@ -303,7 +303,7 @@ module Discorb
       @deaf = member_data[:deaf]
       @custom_avatar = member_data[:avatar] && Asset.new(self, member_data[:avatar])
       super(user_data)
-      @display_avatar = @avatar || @custom_avatar
+      @display_avatar = @custom_avatar || @avatar
       @client.guilds[@guild_id].members[@id] = self unless @guild_id.nil? || @client.guilds[@guild_id].nil?
       @_member_data.update(member_data)
     end

data/lib/discorb/message.rb

@@ -7,7 +7,7 @@ module Discorb
   class Message < DiscordModel
     # @return [Discorb::Snowflake] The ID of the message.
     attr_reader :id
-    # @return [Discorb::User, Discorb::Member] The user that sent the message.
+    # @return [Discorb::User, Discorb::Member, Webhook::Message::Author] The user that sent the message.
     attr_reader :author
     # @return [String] The content of the message.
     attr_reader :content
@@ -217,8 +217,8 @@ module Discorb
       end
       if role
         ret.gsub!(/<@&(\d+)>/) do |_match|
-          role = guild&.roles&.[]($1)
-          role ? "@#{role.name}" : "@Unknown Role"
+          r = guild&.roles&.[]($1)
+          r ? "@#{r.name}" : "@Unknown Role"
         end
       end
       if emoji
@@ -293,15 +293,17 @@ module Discorb
     #
     # @param [Boolean] fail_if_not_exists Whether to raise an error if the message does not exist.
     #
-    # @return [Hash] The reference object.
+    # @return [Discorb::Message::Reference] The reference object.
     #
     def to_reference(fail_if_not_exists: true)
-      {
-        message_id: @id,
-        channel_id: @channel_id,
-        guild_id: @guild_id,
-        fail_if_not_exists: fail_if_not_exists,
-      }
+      Reference.from_hash(
+        {
+          message_id: @id,
+          channel_id: @channel_id,
+          guild_id: @guild_id,
+          fail_if_not_exists: fail_if_not_exists,
+        }
+      )
     end
 
     def embed
@@ -400,7 +402,7 @@ module Discorb
     # Fetch reacted users of reaction.
     # @async
     #
-    # @param [Discorb::Emoji] emoji The emoji to fetch.
+    # @param [Discorb::Emoji, Discorb::PartialEmoji] emoji The emoji to fetch.
     # @param [Integer, nil] limit The maximum number of users to fetch. `nil` for no limit.
     # @param [Discorb::Snowflake, nil] after The ID of the user to start fetching from.
     #

data/lib/discorb/message_meta.rb

@@ -76,8 +76,6 @@ module Discorb
         }
       end
 
-      alias to_reference to_hash
-
       #
       # Initialize a new reference from a hash.
       #
@@ -141,7 +139,8 @@ module Discorb
       def initialize(client, data)
         @id = Snowflake.new(data[:id])
         @name = data[:name]
-        @type = Discorb::Interaction.descendants.find { |c| c.interaction_type == data[:type] }
+        @type = (Discorb::Interaction.descendants.find { |c| c.interaction_type == data[:type] } or
+                 raise "Unknown interaction type: #{data[:type]}")
         @user = client.users[data[:user][:id]] || User.new(client, data[:user])
       end
 

data/lib/discorb/modules.rb

@@ -44,7 +44,7 @@ module Discorb
         payload[:embeds] = tmp_embed.map(&:to_hash) if tmp_embed
         payload[:allowed_mentions] =
           allowed_mentions ? allowed_mentions.to_hash(@client.allowed_mentions) : @client.allowed_mentions.to_hash
-        payload[:message_reference] = reference.to_reference if reference
+        payload[:message_reference] = reference.to_reference.to_hash if reference
         payload[:components] = Component.to_payload(components) if components
         attachments ||= attachment ? [attachment] : []
 
@@ -265,10 +265,11 @@ module Discorb
               sleep(5)
             end
           end
-          yield
+          ret = yield
         ensure
           post_task.stop
         end
+        ret
       else
         Async do |_task|
           @client.http.request(Route.new("/channels/#{@id}/typing", "//channels/:channel_id/typing", :post), {})

data/lib/discorb/presence.rb

@@ -113,8 +113,8 @@ module Discorb
         @details = data[:details]
         @state = data[:state]
         @emoji = if data[:emoji]
-                   data[:emoji][:id].nil? ? UnicodeEmoji.new(data[:emoji][:name]) : PartialEmoji.new(data[:emoji])
-        end
+            data[:emoji][:id].nil? ? UnicodeEmoji.new(data[:emoji][:name]) : PartialEmoji.new(data[:emoji])
+          end
         @party = data[:party] && Party.new(data[:party])
         @assets = data[:assets] && Asset.new(data[:assets])
         @instance = data[:instance]
@@ -141,6 +141,8 @@ module Discorb
           "#{@emoji} #{@state}"
         when :competing
           "Competing in #{@name}"
+        else
+          raise "Unknown activity type: #{@type}"
         end
       end
 

data/lib/discorb/reaction.rb

@@ -7,7 +7,7 @@ module Discorb
   class Reaction < DiscordModel
     # @return [Integer] The number of users that have reacted with this emoji.
     attr_reader :count
-    # @return [Discorb::Emoji] The emoji that was reacted with.
+    # @return [Discorb::Emoji, Discorb::PartialEmoji] The emoji that was reacted with.
     attr_reader :emoji
     # @return [Discorb::Message] The message that this reaction is on.
     attr_reader :message
@@ -33,7 +33,7 @@ module Discorb
     #
     # @param (see Message#fetch_reacted_users)
     #
-    # @return [Array<Discorb::User>] The users that reacted with this emoji.
+    # @return [Async::Task<Array<Discorb::User>>] The users that reacted with this emoji.
     #
     def fetch_users(...)
       message.fetch_reacted_users(@emoji, ...)
@@ -45,10 +45,10 @@ module Discorb
       @count = data[:count]
       @me = data[:me]
       @emoji = if data[:emoji][:id].nil?
-                 UnicodeEmoji.new(data[:emoji][:name])
-               else
-                 PartialEmoji.new(data[:emoji])
-      end
+          UnicodeEmoji.new(data[:emoji][:name])
+        else
+          PartialEmoji.new(data[:emoji])
+        end
     end
   end
 end

data/lib/discorb/role.rb

@@ -69,7 +69,7 @@ module Discorb
     # @return [Integer] -1 if the other role is higher, 0 if they are equal, 1 if the other role is lower.
     #
     def <=>(other)
-      return false unless other.is_a?(Role)
+      return nil unless other.is_a?(Role)
 
       @position <=> other.position
     end

data/lib/discorb/sticker.rb

@@ -17,7 +17,7 @@ module Discorb
     attr_reader :format
     # @return [String] The URL of the sticker.
     attr_reader :description
-    # @return [Discorb::Sticker] The ID of the sticker pack.
+    # @return [Discorb::Snowflake] The ID of the sticker pack.
     attr_reader :pack_id
     # @return [Integer] The sort value of the sticker.
     attr_reader :sort_value
@@ -87,7 +87,7 @@ module Discorb
           payload[:tags] = tag.name unless tag == Discorb::Unset
           @client.http.request(
             Route.new("/guilds/#{@guild_id}/stickers/#{@id}", "//guilds/:guild_id/stickers/:sticker_id",
-                      :patch), payload, audit_log_reason: reason
+                      :patch), payload, audit_log_reason: reason,
           ).wait
         end
       end
@@ -104,7 +104,7 @@ module Discorb
         Async do
           @client.http.request(
             Route.new("/guilds/#{@guild_id}/stickers/#{@id}", "//guilds/:guild_id/stickers/:sticker_id",
-                      :delete), {}, audit_log_reason: reason
+                      :delete), {}, audit_log_reason: reason,
           ).wait
         end
       end

data/lib/discorb/user.rb

@@ -16,7 +16,7 @@ module Discorb
     attr_reader :flag
     # @return [String] The user's discriminator.
     attr_reader :discriminator
-    # @return [Discorb::Asset] The user's avatar.
+    # @return [Discorb::Asset, Discorb::DefaultAvatar] The user's avatar.
     attr_reader :avatar
     # @return [Boolean] Whether the user is a bot.
     attr_reader :bot
@@ -147,7 +147,7 @@ module Discorb
       @flag = User::Flag.new(data[:public_flags] | (data[:flags] || 0))
       @discriminator = data[:discriminator]
       @avatar = data[:avatar] ? Asset.new(self, data[:avatar]) : DefaultAvatar.new(data[:discriminator])
-      @bot = data[:bot]
+      @bot = data[:bot] || false
       @raw_data = data
       @client.users[@id] = self unless data[:no_cache]
       @created_at = @id.timestamp

data/lib/discorb/voice_state.rb

@@ -95,10 +95,10 @@ module Discorb
       @user_id = data[:user_id]
       unless guild.nil?
         @member = if data.key?(:member)
-                    guild.members[data[:user_id]] || Member.new(@client, @guild_id, data[:member][:user], data[:member])
-                  else
-                    guild.members[data[:user_id]]
-        end
+            guild.members[data[:user_id]] || Member.new(@client, @guild_id, data[:member][:user], data[:member])
+          else
+            guild.members[data[:user_id]]
+          end
       end
       @session_id = data[:session_id]
       @deaf = data[:deaf]
@@ -217,7 +217,7 @@ module Discorb
       Async do
         @client.http.request(
           Route.new("/stage-instances/#{@channel_id}", "//stage-instances/:stage_instance_id",
-                    :delete), {}, audit_log_reason: reason
+                    :delete), {}, audit_log_reason: reason,
         ).wait
         self
       end

data/lib/discorb/webhook.rb

@@ -56,8 +56,8 @@ module Discorb
     # @param [Discorb::Embed] embed The embed to send.
     # @param [Array<Discorb::Embed>] embeds The embeds to send.
     # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions to send.
-    # @param [Discorb::File] file The file to send.
-    # @param [Array<Discorb::File>] files The files to send.
+    # @param [Discorb::Attachment] attachment The attachment to send.
+    # @param [Array<Discorb::Attachment>] attachment The attachments to send.
     # @param [String] username The username of the message.
     # @param [String] avatar_url The avatar URL of the message.
     # @param [Boolean] wait Whether to wait for the message to be sent.
@@ -65,24 +65,41 @@ module Discorb
     # @return [Discorb::Webhook::Message] The message that was sent.
     # @return [Async::Task<nil>] If `wait` is false.
     #
-    def post(content = nil, tts: false, embed: nil, embeds: nil, allowed_mentions: nil,
-             file: nil, files: nil, username: nil, avatar_url: Discorb::Unset, wait: true)
+    def post(
+      content = nil,
+      tts: false,
+      embed: nil,
+      embeds: nil,
+      allowed_mentions: nil,
+      attachment: nil,
+      attachments: nil,
+      username: nil,
+      avatar_url: Discorb::Unset,
+      wait: true
+    )
       Async do
         payload = {}
         payload[:content] = content if content
         payload[:tts] = tts
         tmp_embed = if embed
-                      [embed]
-                    elsif embeds
-                      embeds
-        end
+            [embed]
+          elsif embeds
+            embeds
+          end
         payload[:embeds] = tmp_embed.map(&:to_hash) if tmp_embed
         payload[:allowed_mentions] = allowed_mentions&.to_hash
         payload[:username] = username if username
         payload[:avatar_url] = avatar_url if avatar_url != Discorb::Unset
-        files = [file]
-        _resp, data = @http.multipart_request(Route.new("#{url}?wait=#{wait}", "//webhooks/:webhook_id/:token", :post),
-                                              files, payload, headers: headers).wait
+        attachments = [attachment] if attachment
+        _resp, data = @http.multipart_request(
+          Route.new(
+            "#{url}?wait=#{wait}",
+            "//webhooks/:webhook_id/:token",
+            :post
+          ),
+          attachments,
+          payload
+        ).wait
         data && Webhook::Message.new(self, data)
       end
     end
@@ -137,8 +154,8 @@ module Discorb
     # @param [Discorb::Embed] embed The new embed of the message.
     # @param [Array<Discorb::Embed>] embeds The new embeds of the message.
     # @param [Array<Discorb::Attachment>] attachments The attachments to remain.
-    # @param [Discorb::File] file The file to send.
-    # @param [Array<Discorb::File>] files The files to send.
+    # @param [Discorb::Attachment] file The file to send.
+    # @param [Array<Discorb::Attachment>] files The files to send.
     # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions to send.
     #
     # @return [Async::Task<void>] The task.
@@ -176,10 +193,12 @@ module Discorb
     #
     def delete_message!(message)
       Async do
-        @http.request(Route.new(
-                        "#{url}/messages/#{Utils.try(message, :id)}",
-                        "//webhooks/:webhook_id/:token/messages/:message_id", :delete
-                      )).wait
+        @http.request(
+          Route.new(
+            "#{url}/messages/#{Utils.try(message, :id)}",
+            "//webhooks/:webhook_id/:token/messages/:message_id", :delete
+          )
+        ).wait
         message
       end
     end
@@ -195,11 +214,12 @@ module Discorb
       # Initializes the webhook from URL.
       #
       # @param [String] url The URL of the webhook.
+      # @param [Discorb::Client] client The client to associate with the webhook.
       #
-      def initialize(url)
+      def initialize(url, client: nil)
         @url = url
         @token = ""
-        @http = Discorb::HTTP.new(self)
+        @http = Discorb::HTTP.new(client || Discorb::Client.new)
       end
     end
 
@@ -447,12 +467,13 @@ module Discorb
       # Creates URLWebhook.
       #
       # @param [String] url The URL of the webhook.
+      # @param [Discorb::Client] client The client to associate with the webhook.
       #
       # @return [Discorb::Webhook::URLWebhook] The URLWebhook.
       #
-      def new(url)
+      def new(url, client: nil)
         if self == Webhook
-          URLWebhook.new(url)
+          URLWebhook.new(url, client: client)
         else
           super
         end

data/lib/discorb.rb

@@ -46,10 +46,10 @@ end
 require_order = %w[common flag dictionary error rate_limit http intents emoji_table modules] +
                 %w[channel/container message_meta allowed_mentions] +
                 %w[user member guild emoji channel embed message] +
-                %w[application audit_logs color components event event_handler] +
+                %w[application audit_logs color components event event_handler automod] +
                 %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[gateway_requests gateway_events gateway app_command] +
                 %w[asset extension shard client extend]
 require_order.each do |name|
   require_relative "discorb/#{name}.rb"

data/po/yard.pot

@@ -2907,23 +2907,23 @@ msgid "### How can I send files?"
 msgstr ""
 
 #: ../docs/faq.md:65
-msgid "Use {Discorb::File} class."
+msgid "Use {Discorb::Attachment} class."
 msgstr ""
 
 #: ../docs/faq.md:67
 msgid "```ruby\n"
 "# Send a file\n"
-"message.channel.post file: Discorb::File.new(File.open(\"./README.md\"))"
+"message.channel.post file: Discorb::Attachment.new(File.open(\"./README.md\"))"
 msgstr ""
 
 #: ../docs/faq.md:71
 msgid "# Send some files with text\n"
-"message.channel.post \"File!\", files: [Discorb::File.new(File.open(\"./README.md\")), Discorb::File.new(File.open(\"./License.txt\"))]"
+"message.channel.post \"File!\", files: [Discorb::Attachment.new(File.open(\"./README.md\")), Discorb::Attachment.new(File.open(\"./License.txt\"))]"
 msgstr ""
 
 #: ../docs/faq.md:74
 msgid "# Send a string as a file\n"
-"message.channel.post file: Discorb::File.from_string(\"Hello world!\", \"hello.txt\")\n"
+"message.channel.post file: Discorb::Attachment.from_string(\"Hello world!\", \"hello.txt\")\n"
 "```"
 msgstr ""
 
@@ -9511,7 +9511,7 @@ msgstr ""
 msgid "a new instance of Attachment"
 msgstr ""
 
-# Discorb::File
+# Discorb::Attachment
 #: ../lib/discorb/file.rb:53
 msgid "Represents a file to send as an attachment."
 msgstr ""
@@ -9537,7 +9537,7 @@ msgstr ""
 msgid "The content type of the file. If not set, it is guessed from the filename."
 msgstr ""
 
-# Discorb::File#initialize
+# Discorb::Attachment#initialize
 #: ../lib/discorb/file.rb:64
 msgid "Creates a new file from IO."
 msgstr ""
@@ -9570,7 +9570,7 @@ msgstr ""
 msgid "tag|param|content_type"
 msgstr ""
 
-# Discorb::File.from_string
+# Discorb::Attachment.from_string
 #: ../lib/discorb/file.rb:79
 msgid "Creates a new file from a string."
 msgstr ""
@@ -11738,7 +11738,7 @@ msgstr ""
 msgid "A helper method to send multipart/form-data requests for creating messages."
 msgstr ""
 
-# @param [Array<Discorb::File>]
+# @param [Array<Discorb::Attachment>]
 #: ../lib/discorb/http.rb:154
 #: ../lib/discorb/interaction/response.rb:91
 #: ../lib/discorb/interaction/response.rb:115
@@ -11750,7 +11750,7 @@ msgstr ""
 msgid "tag|param|files"
 msgstr ""
 
-# @param [Array<Discorb::File>] files
+# @param [Array<Discorb::Attachment>] files
 #: ../lib/discorb/http.rb:154
 #: ../lib/discorb/interaction/response.rb:91
 #: ../lib/discorb/interaction/response.rb:115
@@ -12357,7 +12357,7 @@ msgstr ""
 msgid "tag|param|attachments"
 msgstr ""
 
-# @param [Discorb::File]
+# @param [Discorb::Attachment]
 #: ../lib/discorb/interaction/response.rb:91
 #: ../lib/discorb/interaction/response.rb:115
 #: ../lib/discorb/modules.rb:25
@@ -12375,7 +12375,7 @@ msgstr ""
 msgid "The new embeds of the message."
 msgstr ""
 
-# @param [Discorb::File] file
+# @param [Discorb::Attachment] file
 #: ../lib/discorb/interaction/response.rb:91
 #: ../lib/discorb/interaction/response.rb:115
 #: ../lib/discorb/modules.rb:25

data/rbs_collection.lock.yaml

@@ -0,0 +1,88 @@
+---
+sources:
+- name: ruby/gem_rbs_collection
+  remote: https://github.com/ruby/gem_rbs_collection.git
+  revision: main
+  repo_dir: gems
+path: ".gem_rbs_collection"
+gems:
+- name: net-http
+  version: '0'
+  source:
+    type: stdlib
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: ast
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 347858a6750d478f6cf1285b4ebd6ae945af2609
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: forwardable
+  version: '0'
+  source:
+    type: stdlib
+- name: i18n
+  version: '1.10'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 347858a6750d478f6cf1285b4ebd6ae945af2609
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: listen
+  version: '3.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 347858a6750d478f6cf1285b4ebd6ae945af2609
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: minitest
+  version: '0'
+  source:
+    type: stdlib
+- name: parallel
+  version: '1.20'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 347858a6750d478f6cf1285b4ebd6ae945af2609
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: prime
+  version: '0'
+  source:
+    type: stdlib
+- name: rainbow
+  version: '3.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 347858a6750d478f6cf1285b4ebd6ae945af2609
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: singleton
+  version: '0'
+  source:
+    type: stdlib
+- name: uri
+  version: '0'
+  source:
+    type: stdlib
+- name: timeout
+  version: '0'
+  source:
+    type: stdlib
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: mutex_m
+  version: '0'
+  source:
+    type: stdlib

data/rbs_collection.yaml

@@ -0,0 +1,21 @@
+# Download sources
+sources:
+  - name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  # Skip loading rbs gem's RBS.
+  # It's unnecessary if you don't use rbs as a library.
+  - name: rbs
+    ignore: true
+  - name: discorb
+    ignore: true
+  - name: net-http
+  - name: logger
+  - name: activesupport
+    ignore: true

data/sig/async.rbs

@@ -0,0 +1,11 @@
+module Async
+  class Task[T]
+    def wait: -> T
+  end
+
+  module WebSocket
+    class Connection
+      def initialize: (untyped, ?untyped, response: untyped, **untyped) -> void
+    end
+  end
+end

data/sig/discorb/activity.rbs

@@ -0,0 +1,23 @@
+module Discorb
+  #
+  # Represents an activity for Gateway Command.
+  class Activity
+    TYPES: untyped
+
+    #
+    # Initializes a new Activity.
+    #
+    # @param [String] name The name of the activity.
+    # @param [:playing, :streaming, :listening, :watching, :competing] type The type of activity.
+    # @param [String] url The URL of the activity.
+    def initialize: (String name, ?Symbol `type`, ?String? url) -> void
+
+    #
+    # Converts the activity to a hash.
+    #
+    # @return [Hash] A hash representation of the activity.
+    def to_hash: -> Discorb::json
+
+    def inspect: -> String
+  end
+end