discorb 0.12.2 → 0.13.1

data/lib/discorb/application.rb

@@ -27,7 +27,8 @@ module Discorb
     # @return [Boolean] Whether the application's bot requires a code grant.
     attr_reader :bot_require_code_grant
     alias bot_require_code_grant? bot_require_code_grant
-
+    # @return [Discorb::Application::Flag] The application's flags.
+    attr_reader :flags
     # @private
     def initialize(client, data)
       @client = client
@@ -42,6 +43,7 @@ module Discorb
       @verify_key = data[:verify_key]
       @owner = @client.users[data[:owner][:id]] || User.new(@client, data[:owner])
       @team = data[:team] && Team.new(@client, data[:team])
+      @flags = Flag.new(data[:flags])
     end
 
     def inspect
@@ -52,6 +54,34 @@ module Discorb
 
     alias require_code_grant? bot_require_code_grant?
 
+    #
+    # Represents a flag for an application.
+    # ## Flag fields
+    #
+    # | Field|Value|
+    # |---|---|
+    # | `1 << 12` | `:gateway_presence` |
+    # | `1 << 13` | `:gateway_presence_limited` |
+    # | `1 << 14` | `:gateway_guild_members` |
+    # | `1 << 15` | `:gateway_guild_members_limited` |
+    # | `1 << 16` | `:verification_pending_guild_limit` |
+    # | `1 << 17` | `:embedded` |
+    # | `1 << 18` | `:gateway_message_content` |
+    # | `1 << 19` | `:gateway_message_content_limited` |
+    #
+    class Flag < Discorb::Flag
+      @bits = {
+        gateway_presence: 12,
+        gateway_presence_limited: 13,
+        gateway_guild_members: 14,
+        gateway_guild_members_limited: 15,
+        verification_pending_guild_limit: 16,
+        embedded: 17,
+        gateway_message_content: 18,
+        gateway_message_content_limited: 19,
+      }
+    end
+
     #
     # Represents a team for an application.
     #
@@ -101,7 +131,7 @@ module Discorb
         # @return [:invited, :accepted] The member's membership state.
         attr_reader :membership_state
         alias state membership_state
-        # @return [Array<Permissions>] The permissions of the member.
+        # @return [Array<Symbol>] The permissions of the member.
         # @note This always return `:*`.
         attr_reader :permissions
 

data/lib/discorb/audit_logs.rb

@@ -90,6 +90,9 @@ module Discorb
       # * `:sticker_create`
       # * `:sticker_update`
       # * `:sticker_delete`
+      # * `:guild_scheduled_event_create`
+      # * `:guild_scheduled_event_update`
+      # * `:guild_scheduled_event_delete`
       # * `:thread_create`
       # * `:thread_update`
       # * `:thread_delete`
@@ -148,9 +151,12 @@ module Discorb
         90 => :sticker_create,
         91 => :sticker_update,
         92 => :sticker_delete,
+        100 => :guild_scheduled_event_create,
+        101 => :guild_scheduled_event_update,
+        102 => :guild_scheduled_event_delete,
         110 => :thread_create,
         111 => :thread_update,
-        112 => :thread_delete
+        112 => :thread_delete,
       }.freeze
 
       # @private
@@ -160,7 +166,7 @@ module Discorb
         role: ->(client, id, guild_id) { client.guilds[guild_id]&.roles&.[](id) },
         member: ->(client, id, guild_id) { client.guilds[guild_id]&.members&.[](id) },
         guild: ->(client, id, _guild_id) { client.guilds[id] },
-        message: ->(client, id, _guild_id) { client.messages[id] }
+        message: ->(client, id, _guild_id) { client.messages[id] },
       }
 
       # @private
@@ -171,15 +177,15 @@ module Discorb
         @user_id = Snowflake.new(data[:user_id])
         @target_id = Snowflake.new(data[:target_id])
         @type = self.class.events[data[:action_type]]
-        @target = self.class.converts[@type.to_s.split('_')[0].to_sym]&.call(client, @target_id, @gui)
+        @target = self.class.converts[@type.to_s.split("_")[0].to_sym]&.call(client, @target_id, @gui)
         @target ||= Snowflake.new(data[:target_id])
         @changes = data[:changes] && Changes.new(data[:changes])
         @reason = data[:reason]
         data[:options]&.each do |option, value|
           define_singleton_method(option) { value }
-          if option.end_with?('_id')
-            define_singleton_method(option.to_s.sub('_id', '')) do
-              self.class.converts[option.to_s.split('_')[0].to_sym]&.call(client, value, @guild_id)
+          if option.end_with?("_id")
+            define_singleton_method(option.to_s.sub("_id", "")) do
+              self.class.converts[option.to_s.split("_")[0].to_sym]&.call(client, value, @guild_id)
             end
           end
         end
@@ -203,7 +209,7 @@ module Discorb
       end
 
       def inspect
-        "#<#{self.class} #{@changes&.data&.length || 'No'} changes>"
+        "#<#{self.class} #{@changes&.data&.length || "No"} changes>"
       end
 
       class << self
@@ -268,15 +274,21 @@ module Discorb
         def initialize(data)
           @key = data[:key].to_sym
           method = case @key.to_s
-                   when /.*_id$/, 'id'
-                     ->(v) { Snowflake.new(v) }
-                   when 'permissions'
-                     ->(v) { Discorb::Permission.new(v.to_i) }
-                   else
-                     ->(v) { v }
-                   end
-          @old_value = data[:old_value].then(&method)
-          @new_value = data[:new_value].then(&method)
+            when /.*_id$/, "id"
+              ->(v) { Snowflake.new(v) }
+            when "permissions"
+              ->(v) { Discorb::Permission.new(v.to_i) }
+            when "status"
+              ->(v) { Discorb::ScheduledEvent.status[v] }
+            when "entity_type"
+              ->(v) { Discorb::ScheduledEvent.entity_type[v] }
+            when "privacy_level"
+              ->(v) { Discorb::StageInstance.privacy_level[v] || Discorb::ScheduledEvent.privacy_level[v] }
+            else
+              ->(v) { v }
+            end
+          @old_value = method.(data[:old_value])
+          @new_value = method.(data[:new_value])
         end
 
         #

data/lib/discorb/channel.rb

@@ -166,8 +166,7 @@ module Discorb
 
     #
     # Deletes the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] reason The reason of deleting the channel.
     #
@@ -186,8 +185,7 @@ module Discorb
 
     #
     # Moves the channel to another position.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Integer] position The position to move the channel.
     # @param [Boolean] lock_permissions Whether to lock the permissions of the channel.
@@ -196,13 +194,13 @@ module Discorb
     #
     # @return [Async::Task<self>] The moved channel.
     #
-    def move(position, lock_permissions: false, parent: :unset, reason: nil)
+    def move(position, lock_permissions: false, parent: Discorb::Unset, reason: nil)
       Async do
         payload = {
           position: position,
         }
         payload[:lock_permissions] = lock_permissions
-        payload[:parent_id] = parent&.id if parent != :unset
+        payload[:parent_id] = parent&.id if parent != Discorb::Unset
         @client.http.patch("/guilds/#{@guild_id}/channels", payload, audit_log_reason: reason).wait
       end
     end
@@ -256,8 +254,7 @@ module Discorb
 
     #
     # Edits the channel.
-    # @macro async
-    # @macro http
+    # @async
     # @macro edit
     #
     # @param [String] name The name of the channel.
@@ -275,25 +272,25 @@ module Discorb
     #
     # @return [Async::Task<self>] The edited channel.
     #
-    def edit(name: :unset, position: :unset, category: :unset, parent: :unset,
-             topic: :unset, nsfw: :unset, announce: :unset,
-             rate_limit_per_user: :unset, slowmode: :unset, default_auto_archive_duration: :unset,
-             archive_in: :unset, reason: nil)
+    def edit(name: Discorb::Unset, position: Discorb::Unset, category: Discorb::Unset, parent: Discorb::Unset,
+             topic: Discorb::Unset, nsfw: Discorb::Unset, announce: Discorb::Unset,
+             rate_limit_per_user: Discorb::Unset, slowmode: Discorb::Unset, default_auto_archive_duration: Discorb::Unset,
+             archive_in: Discorb::Unset, reason: nil)
       Async do
         payload = {}
-        payload[:name] = name if name != :unset
-        payload[:announce] = announce ? 5 : 0 if announce != :unset
-        payload[:position] = position if position != :unset
-        payload[:topic] = topic || "" if topic != :unset
-        payload[:nsfw] = nsfw if nsfw != :unset
+        payload[:name] = name if name != Discorb::Unset
+        payload[:announce] = announce ? 5 : 0 if announce != Discorb::Unset
+        payload[:position] = position if position != Discorb::Unset
+        payload[:topic] = topic || "" if topic != Discorb::Unset
+        payload[:nsfw] = nsfw if nsfw != Discorb::Unset
 
-        slowmode = rate_limit_per_user if slowmode == :unset
-        payload[:rate_limit_per_user] = slowmode || 0 if slowmode != :unset
-        parent = category if parent == :unset
-        payload[:parent_id] = parent&.id if parent != :unset
+        slowmode = rate_limit_per_user if slowmode == Discorb::Unset
+        payload[:rate_limit_per_user] = slowmode || 0 if slowmode != Discorb::Unset
+        parent = category if parent == Discorb::Unset
+        payload[:parent_id] = parent&.id if parent != Discorb::Unset
 
         default_auto_archive_duration ||= archive_in
-        payload[:default_auto_archive_duration] = default_auto_archive_duration if default_auto_archive_duration != :unset
+        payload[:default_auto_archive_duration] = default_auto_archive_duration if default_auto_archive_duration != Discorb::Unset
 
         @client.http.patch("/channels/#{@id}", payload, audit_log_reason: reason).wait
         self
@@ -304,8 +301,7 @@ module Discorb
 
     #
     # Create webhook in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] name The name of the webhook.
     # @param [Discorb::Image] avatar The avatar of the webhook.
@@ -324,8 +320,7 @@ module Discorb
 
     #
     # Fetch webhooks in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::Webhook>>] The webhooks in the channel.
     #
@@ -338,12 +333,13 @@ module Discorb
 
     #
     # Bulk delete messages in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::Message] messages The messages to delete.
     # @param [Boolean] force Whether to ignore the validation for message (14 days limit).
     #
+    # @return [Async::Task<void>] The task.
+    #
     def delete_messages!(*messages, force: false)
       Async do
         messages = messages.first if messages.length == 1 && messages.first.is_a?(Array)
@@ -367,12 +363,13 @@ module Discorb
 
     #
     # Set the channel's permission overwrite.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::Role, Discorb::Member] target The target of the overwrite.
     # @param [String] reason The reason of setting the overwrite.
-    # @param [Symbol => Boolean] perms The permission overwrites to replace.
+    # @param [{Symbol => Boolean}] perms The permission overwrites to replace.
+    #
+    # @return [Async::Task<void>] The task.
     #
     def set_permissions(target, reason: nil, **perms)
       Async do
@@ -398,12 +395,13 @@ module Discorb
 
     #
     # Delete the channel's permission overwrite.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::Role, Discorb::Member] target The target of the overwrite.
     # @param [String] reason The reason of deleting the overwrite.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def delete_permissions(target, reason: nil)
       Async do
         @client.http.delete("/channels/#{@id}/permissions/#{target.id}", audit_log_reason: reason).wait
@@ -416,8 +414,7 @@ module Discorb
 
     #
     # Fetch the channel's invites.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::Invite>>] The invites in the channel.
     #
@@ -430,8 +427,7 @@ module Discorb
 
     #
     # Create an invite in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Integer] max_age The max age of the invite.
     # @param [Integer] max_uses The max uses of the invite.
@@ -456,12 +452,13 @@ module Discorb
 
     #
     # Follow the existing announcement channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::NewsChannel] target The channel to follow.
     # @param [String] reason The reason of following the channel.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def follow_from(target, reason: nil)
       Async do
         @client.http.post("/channels/#{target.id}/followers", { webhook_channel_id: @id }, audit_log_reason: reason).wait
@@ -470,12 +467,13 @@ module Discorb
 
     #
     # Follow the existing announcement channel from self.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::TextChannel] target The channel to follow to.
     # @param [String] reason The reason of following the channel.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def follow_to(target, reason: nil)
       Async do
         @client.http.post("/channels/#{@id}/followers", { webhook_channel_id: target.id }, audit_log_reason: reason).wait
@@ -484,24 +482,30 @@ module Discorb
 
     #
     # Start thread in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] name The name of the thread.
     # @param [Discorb::Message] message The message to start the thread.
     # @param [Integer] auto_archive_duration The duration of auto-archiving.
     # @param [Boolean] public Whether the thread is public.
+    # @param [Integer] rate_limit_per_user The rate limit per user.
+    # @param [Integer] slowmode Alias of `rate_limit_per_user`.
     # @param [String] reason The reason of starting the thread.
     #
     # @return [Async::Task<Discorb::ThreadChannel>] The started thread.
     #
-    def start_thread(name, message: nil, auto_archive_duration: 1440, public: true, reason: nil)
+    def start_thread(name, message: nil, auto_archive_duration: 1440, public: true, rate_limit_per_user: nil, slowmode: nil, reason: nil)
       Async do
         _resp, data = if message.nil?
-            @client.http.post("/channels/#{@id}/threads", {
-              name: name, auto_archive_duration: auto_archive_duration, type: public ? 11 : 10,
-            },
-                              audit_log_reason: reason).wait
+            @client.http.post(
+              "/channels/#{@id}/threads", {
+                name: name,
+                auto_archive_duration: auto_archive_duration,
+                type: public ? 11 : 10,
+                rate_limit_per_user: rate_limit_per_user || slowmode,
+              },
+              audit_log_reason: reason,
+            ).wait
           else
             @client.http.post("/channels/#{@id}/messages/#{Utils.try(message, :id)}/threads", {
               name: name, auto_archive_duration: auto_archive_duration,
@@ -515,8 +519,7 @@ module Discorb
 
     #
     # Fetch archived threads in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::ThreadChannel>>] The archived threads in the channel.
     #
@@ -529,8 +532,7 @@ module Discorb
 
     #
     # Fetch archived private threads in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::ThreadChannel>>] The archived private threads in the channel.
     #
@@ -543,8 +545,7 @@ module Discorb
 
     #
     # Fetch joined archived private threads in the channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Integer] limit The limit of threads to fetch.
     # @param [Time] before <description>
@@ -607,8 +608,7 @@ module Discorb
     @channel_type = 2
     #
     # Edit the voice channel.
-    # @macro async
-    # @macro http
+    # @async
     # @macro edit
     #
     # @param [String] name The name of the voice channel.
@@ -620,14 +620,14 @@ module Discorb
     #
     # @return [Async::Task<self>] The edited voice channel.
     #
-    def edit(name: :unset, position: :unset, bitrate: :unset, user_limit: :unset, rtc_region: :unset, reason: nil)
+    def edit(name: Discorb::Unset, position: Discorb::Unset, bitrate: Discorb::Unset, user_limit: Discorb::Unset, rtc_region: Discorb::Unset, reason: nil)
       Async do
         payload = {}
-        payload[:name] = name if name != :unset
-        payload[:position] = position if position != :unset
-        payload[:bitrate] = bitrate if bitrate != :unset
-        payload[:user_limit] = user_limit if user_limit != :unset
-        payload[:rtc_region] = rtc_region if rtc_region != :unset
+        payload[:name] = name if name != Discorb::Unset
+        payload[:position] = position if position != Discorb::Unset
+        payload[:bitrate] = bitrate if bitrate != Discorb::Unset
+        payload[:user_limit] = user_limit if user_limit != Discorb::Unset
+        payload[:rtc_region] = rtc_region if rtc_region != Discorb::Unset
 
         @client.http.patch("/channels/#{@id}", payload, audit_log_reason: reason).wait
         self
@@ -676,8 +676,7 @@ module Discorb
 
     #
     # Edit the stage channel.
-    # @macro async
-    # @macro http
+    # @async
     # @macro edit
     #
     # @param [String] name The name of the stage channel.
@@ -688,13 +687,13 @@ module Discorb
     #
     # @return [Async::Task<self>] The edited stage channel.
     #
-    def edit(name: :unset, position: :unset, bitrate: :unset, rtc_region: :unset, reason: nil)
+    def edit(name: Discorb::Unset, position: Discorb::Unset, bitrate: Discorb::Unset, rtc_region: Discorb::Unset, reason: nil)
       Async do
         payload = {}
-        payload[:name] = name if name != :unset
-        payload[:position] = position if position != :unset
-        payload[:bitrate] = bitrate if bitrate != :unset
-        payload[:rtc_region] = rtc_region if rtc_region != :unset
+        payload[:name] = name if name != Discorb::Unset
+        payload[:position] = position if position != Discorb::Unset
+        payload[:bitrate] = bitrate if bitrate != Discorb::Unset
+        payload[:rtc_region] = rtc_region if rtc_region != Discorb::Unset
         @client.http.patch("/channels/#{@id}", payload, audit_log_reason: reason).wait
         self
       end
@@ -704,8 +703,7 @@ module Discorb
 
     #
     # Start a stage instance.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] topic The topic of the stage instance.
     # @param [Boolean] public Whether the stage instance is public or not.
@@ -722,8 +720,7 @@ module Discorb
 
     #
     # Fetch a current stage instance.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<StageInstance>] The current stage instance.
     # @return [Async::Task<nil>] If there is no current stage instance.
@@ -785,6 +782,19 @@ module Discorb
     # @!attribute [r] parent
     #   @macro client_cache
     #   @return [Discorb::GuildChannel] The parent channel of the thread.
+    # @!attribute [r] me
+    #   @return [Discorb::ThreadChannel::Member] The bot's member in the thread.
+    #   @return [nil] If the bot is not in the thread.
+    # @!attribute [r] joined?
+    #   @return [Boolean] Whether the bot is in the thread or not.
+    # @!attribute [r] guild
+    #   @macro client_cache
+    #   @return [Discorb::Guild] The guild of the thread.
+    # @!attribute [r] owner
+    #   @macro client_cache
+    #   @macro members_intent
+    #   @return [Discorb::Member] The owner of the thread.
+
 
     include Messageable
     @channel_type = nil
@@ -800,8 +810,7 @@ module Discorb
 
     #
     # Edit the thread.
-    # @macro async
-    # @macro http
+    # @async
     # @macro edit
     #
     # @param [String] name The name of the thread.
@@ -818,14 +827,14 @@ module Discorb
     # @see #unarchive
     # @see #unlock
     #
-    def edit(name: :unset, archived: :unset, auto_archive_duration: :unset, archive_in: :unset, locked: :unset, reason: nil)
+    def edit(name: Discorb::Unset, archived: Discorb::Unset, auto_archive_duration: Discorb::Unset, archive_in: Discorb::Unset, locked: Discorb::Unset, reason: nil)
       Async do
         payload = {}
-        payload[:name] = name if name != :unset
-        payload[:archived] = archived if archived != :unset
+        payload[:name] = name if name != Discorb::Unset
+        payload[:archived] = archived if archived != Discorb::Unset
         auto_archive_duration ||= archive_in
-        payload[:auto_archive_duration] = auto_archive_duration if auto_archive_duration != :unset
-        payload[:locked] = locked if locked != :unset
+        payload[:auto_archive_duration] = auto_archive_duration if auto_archive_duration != Discorb::Unset
+        payload[:locked] = locked if locked != Discorb::Unset
         @client.http.patch("/channels/#{@id}", payload, audit_log_reason: reason).wait
         self
       end
@@ -890,7 +899,7 @@ module Discorb
     end
 
     def joined?
-      @members[@client.user.id]
+      !!me
     end
 
     def guild
@@ -905,6 +914,13 @@ module Discorb
       "#<#{self.class} \"##{@name}\" id=#{@id}>"
     end
 
+    #
+    # Add a member to the thread.
+    #
+    # @param [Discorb::Member, :me] member The member to add. If `:me` is given, the bot will be added.
+    #
+    # @return [Async::Task<void>] The task.
+    #
     def add_member(member = :me)
       Async do
         if member == :me
@@ -917,6 +933,13 @@ module Discorb
 
     alias join add_member
 
+    #
+    # Remove a member from the thread.
+    #
+    # @param [Discorb::Member, :me] member The member to remove. If `:me` is given, the bot will be removed.
+    #
+    # @return [Async::Task<void>] The task.
+    #
     def remove_member(member = :me)
       Async do
         if member == :me
@@ -929,6 +952,11 @@ module Discorb
 
     alias leave remove_member
 
+    #
+    # Fetch members in the thread.
+    #
+    # @return [Array<Discorb::ThreadChannel::Member>] The members in the thread.
+    #
     def fetch_members
       Async do
         _resp, data = @client.http.get("/channels/#{@id}/thread-members").wait
@@ -952,6 +980,9 @@ module Discorb
       attr_reader :channel_type
     end
 
+    #
+    # Repre
+    #
     class Member < DiscordModel
       attr_reader :joined_at