discorb 0.12.4 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb6441bf1c3ae4d181aa1a6048b72bc60bea0d0894e1da00c79a2648dd59c13e
-  data.tar.gz: 835bb57c283b00f9e4863f026f6500ddd81345d51f3b1482ac1c68e23f3debdd
+  metadata.gz: 54c0aa4482415e2d38abe5adf4765ec71681d7f0874a5208b868797c4ebc4626
+  data.tar.gz: 6d15fbcc255d6fddb22e4d8b73f6a7fee40b3690a2f79b4356adcec029d1e90c
 SHA512:
-  metadata.gz: 1af485b0c8476e5e538c70d146ef2819587148a813a31d55cefe7d727e6060462b9e063ab8eb7fad8e1249d0e6d77214a65d4aa7b8843e149b38bc4c21d588b4
-  data.tar.gz: f50a9468ceed0d21e753867a5c42177022792a1550477272843d1a26fa5339d59b3b2c0cf1493edc84627856258aea05a8342531fc620b27c02c149e696169a2
+  metadata.gz: d866205f326de7437f2f8464e0e69fa14c024cd2427507b428507249352902c84003d741265e1b40b86e545435362fd001d949ebe2d9828216bcb5440f93eee3
+  data.tar.gz: 1b2797ea34e32198aa660486771db933ea6893b9542e30a813ce14c2d4b49299ef24c4ecc7ea052dbd7260c5eabe728b120026f543aca49ecc0f2040450741bc

data/Changelog.md

@@ -2,6 +2,16 @@
 
 # Changelog
 
+## v0.13
+
+### v0.13.0
+
+- Change!: Event is now EventHandler.
+- Add: Support for scheduled events.
+- Fix: Fix bug in sticker initialization.
+- Add: Support application flags
+- Add: Add `#inspect` method to many classes.
+
 ## v0.12
 
 ### v0.12.4

data/docs/application_command.md

@@ -49,6 +49,8 @@ client.run(ENV["DISCORD_BOT_TOKEN"])
 | `guild_ids` | The ID of the guild to register the command in. |
 | `block` | A block that will be called when the command is invoked. |
 
+Block will be called with a {Discorb::ApplicationCommand::Interaction} object and specified options.
+
 In `options`, hash should be like this:
 
 ```ruby
@@ -121,16 +123,16 @@ group.slash("message_expand", "Whether bot should expand message.", {
     type: :boolean,
     description: "Whether bot should expand message."
   }
-}) do |interaction|
+}) do |interaction, enabled|
   # ...
 end
 
-group.slash("bump_alert", "Whether bot should notify DISBOARD bump.", {
+group.slash("level", "Whether level system is enabled.", {
   "enabled" => {
     type: :boolean,
-    description: "Whether bot should notify DISBOARD bump."
+    description: "Whether level system is enabled."
   }
-}) do |interaction|
+}) do |interaction, enabled|
   # ...
 end
 
@@ -146,15 +148,15 @@ client.slash_group("settings", "Set settings of bot.") do |group|
       type: :boolean,
       description: "Whether bot should expand message."
     }
-  }) do |interaction|
+  }) do |interaction, enabled|
     # ...
   end
-  group.slash("bump_alert", "Whether bot should notify DISBOARD bump.", {
+  group.slash("bump_alert", "Whether level system is enabled.", {
     "enabled" => {
       type: :boolean,
-      description: "Whether bot should notify DISBOARD bump."
+      description: "Whether level system is enabled."
     }
-  }) do |interaction|
+  }) do |interaction, enabled|
     # ...
   end
 end

data/docs/events.md

@@ -503,7 +503,50 @@ Fires when a select menu is selected.
 
 ### Voice events
 
-It's too big, so they're documented in {file:docs/voice_events.md}
+Because it's big, it's documented in {file:docs/voice_events.md}.
+
+### Guild scheduled event events
+
+#### `scheduled_event_create(event)`
+
+Fires when a scheduled event is created.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `event`    | {Discorb::ScheduledEvent}| The created scheduled event. |
+
+#### `scheduled_event_cancel(event)`, `scheduled_event_delete(event)`
+
+Fires when a scheduled event is canceled or deleted.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `event`    | {Discorb::ScheduledEvent}| The deleted scheduled event. |
+
+#### `scheduled_event_edit(before, after)`
+
+Fires when a scheduled event is edited.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `before`   | {Discorb::ScheduledEvent}| The scheduled event before the edit. |
+| `after`    | {Discorb::ScheduledEvent}| The scheduled event after the edit. |
+
+#### `scheduled_event_start(event)`
+
+Fires when a scheduled event is started.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `event`    | {Discorb::ScheduledEvent}| The scheduled event that started. |
+
+#### `scheduled_event_end(event)`
+
+Fires when a scheduled event is ended.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `event`    | {Discorb::ScheduledEvent}| The scheduled event that ended. |
 
 ### Low-level events
 
@@ -530,3 +573,12 @@ Fires when `THREAD_CREATE` is received.
 | Parameter  | Type  | Description |
 | ---------- | ----- | ----------- |
 |`thread`    | {Discorb::ThreadChannel}| The thread of the event. |
+
+#### `scheduled_event_update(before, after)`
+
+Fires when `SCHEDULED_EVENT_UPDATE` is received.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `before` | {Discorb::ScheduledEvent}| The scheduled event before the update. |
+|`after`     | {Discorb::ScheduledEvent}| The scheduled event after the update. |

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.
     #

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

@@ -491,17 +491,24 @@ module Discorb
     # @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,

data/lib/discorb/client.rb

@@ -112,10 +112,10 @@ module Discorb
     # @param [Hash] metadata The metadata of the event.
     # @param [Proc] block The block to execute when the event is triggered.
     #
-    # @return [Discorb::Event] The event.
+    # @return [Discorb::EventHandler] The event.
     #
     def on(event_name, id: nil, **metadata, &block)
-      ne = Event.new(block, id, metadata)
+      ne = EventHandler.new(block, id, metadata)
       @events[event_name] ||= []
       @events[event_name].delete_if { |e| e.metadata[:override] }
       @events[event_name] << ne
@@ -127,7 +127,7 @@ module Discorb
     #
     # @param (see #on)
     #
-    # @return [Discorb::Event] The event.
+    # @return [Discorb::EventHandler] The event.
     #
     def once(event_name, id: nil, **metadata, &block)
       metadata[:once] = true
@@ -184,7 +184,7 @@ module Discorb
         events.each do |block|
           Async do
             Async(annotation: "Discorb event: #{event_name}") do |task|
-              if block.is_a?(Discorb::Event)
+              if block.is_a?(Discorb::EventHandler)
                 @events[event_name].delete(block) if block.metadata[:once]
               end
               block.call(*args)

data/lib/discorb/common.rb

@@ -4,7 +4,7 @@ module Discorb
   # @return [String] The API base URL.
   API_BASE_URL = "https://discord.com/api/v9"
   # @return [String] The version of discorb.
-  VERSION = "0.12.4"
+  VERSION = "0.13.0"
   # @return [String] The user agent for the bot.
   USER_AGENT = "DiscordBot (https://discorb-lib.github.io #{VERSION}) Ruby/#{RUBY_VERSION}"
 
@@ -110,6 +110,31 @@ module Discorb
       @value & 0xFFF
     end
 
+    def inspect
+      "#<#{self.class} #{to_s}>"
+    end
+
     alias id to_s
   end
+
+  Unset = Object.new
+  class << Unset
+    def method_missing(*)
+      self
+    end
+
+    def or(other)
+      other
+    end
+  end
+
+  module DefineOr
+    refine Object do
+      def or(other)
+        self
+      end
+    end
+  end
+
+  using DefineOr
 end

data/lib/discorb/components.rb

@@ -6,6 +6,10 @@ module Discorb
   # Represents a Discord component.
   #
   class Component
+    def inspect
+      "#<#{self.class}>"
+    end
+
     class << self
       #
       # Create a new component from hash data.
@@ -142,6 +146,10 @@ module Discorb
       end
     end
 
+    def inspect
+      "#<#{self.class}: #{@custom_id || @url}>"
+    end
+
     class << self
       # @private
       attr_reader :styles
@@ -218,6 +226,10 @@ module Discorb
       }
     end
 
+    def inspect
+      "#<#{self.class}: #{@custom_id}>"
+    end
+
     #
     # Represents an option of a select menu.
     #

data/lib/discorb/dictionary.rb

@@ -48,7 +48,7 @@ module Discorb
     # @param [#to_s] id The ID of the item to remove.
     #
     def remove(id)
-      @cache.remove(id.to_s)
+      @cache.delete(id.to_s)
     end
 
     #

data/lib/discorb/embed.rb

@@ -86,6 +86,10 @@ module Discorb
       @thumbnail = (value.is_a?(String)) ? Thumbnail.new(value) : value
     end
 
+    def inspect
+      "#<#{self.class} \"#{@title}\">"
+    end
+
     #
     # Convert embed to hash.
     #

data/lib/discorb/emoji.rb

@@ -13,6 +13,10 @@ module Discorb
     def ==(other)
       eql?(other)
     end
+
+    def inspect
+      "#<#{self.class}>"
+    end
   end
 
   # Represents a custom emoji in discord.