discorb 0.18.1 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d310d54f09cb9be975ba75c37a717b159f3f4b2996686a5f40b7b86329657ab
-  data.tar.gz: 81ed8d1d40aa4bb851e018c56672e24d8346ee2c3544d44ebc48a5583e6b6b46
+  metadata.gz: 99a6cb7f4f4f1d7c657209570f1327f6a847b7d7db3fb031c645ca4b0a4464af
+  data.tar.gz: f207685f5153f73dba3c66f40aaf4ef100063f31746874d57c31b119f5fcb009
 SHA512:
-  metadata.gz: feed366d2ae2614f6c08a891f697245304047a4a1447fd2e5cdbed17829aea950e4b8fb6677b70e993bd613c6be3f1db880061f4fa77024bae6ce4caaf11683c
-  data.tar.gz: 5be8aa8414d67a58cf591f87b13b2ae5d0d8f17de8dc6399d9ef370967c79e39400596192e3ebb016934e36c69c2aae4dc19b0b0c4e86eb0903ddfb5e5495902
+  metadata.gz: bd641beb11497865a97e267ef1558d1f5162323713f623fcd5109e9e25a7bb41d25e1a59111b0c3b5dcbe43f77a54531973f5874b5d82927956a1ad5f1e4ea03
+  data.tar.gz: 8d25ed7b8604b59c4a4f3f8467a268472749ccbc010d216787091ea3da60e24e0ddde95add2dc30f6d40637650d19cd9ef22e54dc2141637ac2e96cd4d55ece1

data/Changelog.md

@@ -4,6 +4,15 @@
 
 # Changelog
 
+## v0.19
+
+### v0.19.0
+
+- Change!: All bang methods don't have bang anymore. (ex: `Message#delete!`)
+- Add: Add `%a{pure}` annotation to rbs.
+- Add: Add low level APIs to Interaction.
+- Update: Update IDENTIFY key.
+
 ## v0.18
 
 ### v0.18.1

data/Gemfile

@@ -18,7 +18,7 @@ gem "parallel_tests", "~> 3.8"
 gem "rspec", "~> 3.11"
 
 # Typecheck
-gem "steep", "~> 1.0"
+gem "steep", "~> 1.1"
 
 # Other development tools
 gem "lefthook", "~> 0.7.7"
@@ -32,6 +32,6 @@ group :docs, optional: true do
   gem "rubyzip", "~> 2.3"
   gem "yard", "~> 0.9.26"
 end
-
-gem "syntax_tree", "~> 2.8"
-gem "syntax_tree-rbs", "~> 0.4.0"
+
+gem "syntax_tree", "~> 2.8"
+gem "syntax_tree-rbs", "~> 0.5.0"

data/Rakefile

@@ -236,6 +236,7 @@ desc "Generate rbs file"
 namespace :rbs do
   desc "Generate event signature"
   task :event do
+    require "syntax_tree/rbs"
     client_rbs = File.read("sig/discorb/client.rbs")
     extension_rbs = File.read("sig/discorb/extension.rbs")
     event_document = File.read("./docs/events.md")
@@ -296,41 +297,35 @@ namespace :rbs do
         | (:#{event[:name]} event_name, ?id: Symbol?, **untyped metadata) { (#{sig}) -> void } -> void
       RBS
     end
+    event_sig << <<~RBS
+      | (Symbol event_name, ?id: Symbol?, **untyped metadata) { (*untyped) -> void } -> Discorb::EventHandler
+    RBS
+    event_lock_sig << <<~RBS
+      | (Symbol event, ?Integer? timeout) { (*untyped) -> boolish } -> Async::Task[untyped]
+    RBS
+    extension_sig << <<~RBS
+      | (Symbol event_name, ?id: Symbol?, **untyped metadata) { (*untyped) -> void } -> void
+    RBS
     event_sig.sub!("| ", "  ").rstrip!
     event_lock_sig.sub!("| ", "  ").rstrip!
     extension_sig.sub!("| ", "  ").rstrip!
-    res = client_rbs.gsub!(/\# marker: on\n(?:[\s\S]*?\n)?( +)\# endmarker: on\n/) do
-      indent = Regexp.last_match(1)
-      "# marker: on\n#{event_sig.gsub(/^/, "#{indent}      ")}\n#{indent}# endmarker: on\n"
-    end
+    res = client_rbs.gsub!(/(?<=def on:\n)(?:[\s\S]*?)(?=\n\n)/, event_sig)
     raise "Failed to generate Client#on" unless res
 
-    res = client_rbs.gsub!(/\# marker: once\n(?:[\s\S]*?\n)?( +)\# endmarker: once\n/) do
-      indent = Regexp.last_match(1)
-      "# marker: once\n#{event_sig.gsub(/^/, "#{indent}        ")}\n#{indent}# endmarker: once\n"
-    end
+    res = client_rbs.gsub!(/(?<=def once:\n)(?:[\s\S]*?)(?=\n\n)/, event_sig)
     raise "Failed to generate Client#once" unless res
 
-    res = client_rbs.gsub!(/\# marker: event_lock\n(?:[\s\S]*?\n)?( +)\# endmarker: event_lock\n/) do
-      indent = Regexp.last_match(1)
-      "# marker: event_lock\n#{event_lock_sig.gsub(/^/, "#{indent}       ")}\n#{indent}# endmarker: event_lock\n"
-    end
+    res = client_rbs.gsub!(/(?<=def event_lock:\n)(?:[\s\S]*?)(?=\n\n)/, event_lock_sig)
     raise "Failed to generate Client#event_lock" unless res
 
-    res = extension_rbs.gsub!(/\# marker: event\n(?:[\s\S]*?\n)?( +)\# endmarker: event\n/) do
-      indent = Regexp.last_match(1)
-      "# marker: event\n#{extension_sig.gsub(/^/, "#{indent}       ")}\n#{indent}# endmarker: event\n"
-    end
+    res = extension_rbs.gsub!(/(?<=def event:\n)(?:[\s\S]*?)(?=\n\n)/, extension_sig)
     raise "Failed to generate Extension.event" unless res
 
-    res = extension_rbs.gsub!(/\# marker: once_event\n(?:[\s\S]*?\n)?( +)\# endmarker: once_event\n/) do
-      indent = Regexp.last_match(1)
-      "# marker: once_event\n#{extension_sig.gsub(/^/, "#{indent}       ")}\n#{indent}# endmarker: once_event\n"
-    end
+    res = extension_rbs.gsub!(/(?<=def once_event:\n)(?:[\s\S]*?)(?=\n\n)/, extension_sig)
     raise "Failed to generate Extension.once_event" unless res
 
-    File.write("sig/discorb/client.rbs", client_rbs, mode: "wb")
-    File.write("sig/discorb/extension.rbs", extension_rbs, mode: "wb")
+    File.write("sig/discorb/client.rbs", SyntaxTree::RBS.format(client_rbs), mode: "wb")
+    File.write("sig/discorb/extension.rbs", SyntaxTree::RBS.format(extension_rbs), mode: "wb")
   end
 
   desc "Generate rbs file using sord"

data/Steepfile

@@ -15,14 +15,16 @@ target :lib do
     config[D::Ruby::UnexpectedSuper] = nil
     config[D::Ruby::UnexpectedPositionalArgument] = nil
     config[D::Ruby::InsufficientPositionalArguments] = nil
+    config[D::Ruby::UnknownInstanceVariable] = nil
+    config[D::Ruby::UnknownGlobalVariable] = nil
   end
 end
 
-target :test do
-  signature "sig"
-  signature "examples/sig"
+# target :test do
+#   signature "sig"
+#   signature "examples/sig"
 
-  check "examples/**/*.rb"
+#   check "examples/**/*.rb"
 
-  library "net-http", "timeout"
-end
+#   library "net-http", "timeout"
+# end

data/docs/events.md

@@ -563,9 +563,9 @@ Fires when a select menu is selected.
 | ------------- | -------------------------------------------------- | ----------------------- |
 | `interaction` | {Discorb::MessageComponentInteraction::SelectMenu} | The interaction object. |
 
-#### `form_submit(interaction)`
+#### `modal_submit(interaction)`
 
-Fires when a form is submitted.
+Fires when a modal is submitted.
 
 | Parameter     | Type                        | Description             |
 | ------------- | --------------------------- | ----------------------- |

data/docs/voice_events.md

@@ -12,7 +12,7 @@ Fires when someone joins a voice channel.
 
 | Parameter | Type                  | Description                              |
 | --------- | --------------------- | ---------------------------------------- |
-| state     | {Discorb::VoiceState} | The voice state of the user that joined. |
+| `state`   | {Discorb::VoiceState} | The voice state of the user that joined. |
 
 #### `voice_channel_disconnect(state)`
 
@@ -20,7 +20,7 @@ Fires when someone leaves a voice channel.
 
 | Parameter | Type                  | Description                            |
 | --------- | --------------------- | -------------------------------------- |
-| state     | {Discorb::VoiceState} | The voice state of the user that left. |
+| `state`   | {Discorb::VoiceState} | The voice state of the user that left. |
 
 #### `voice_channel_move(before, after)`
 
@@ -28,8 +28,8 @@ Fires when someone moves to a different voice channel.
 
 | Parameter | Type                  | Description                                  |
 | --------- | --------------------- | -------------------------------------------- |
-| before    | {Discorb::VoiceState} | The voice state of the user before the move. |
-| after     | {Discorb::VoiceState} | The voice state of the user after the move.  |
+| `before`  | {Discorb::VoiceState} | The voice state of the user before the move. |
+| `after`   | {Discorb::VoiceState} | The voice state of the user after the move.  |
 
 #### `voice_channel_update(before, after)`
 
@@ -37,8 +37,8 @@ Fires when a voice channel is connected, disconnected, or updated.
 
 | Parameter | Type                  | Description                        |
 | --------- | --------------------- | ---------------------------------- |
-| before    | {Discorb::VoiceState} | The voice state before the update. |
-| after     | {Discorb::VoiceState} | The voice state after the update.  |
+| `before`  | {Discorb::VoiceState} | The voice state before the update. |
+| `after`   | {Discorb::VoiceState} | The voice state after the update.  |
 
 ### Mute Events
 

data/lib/discorb/automod.rb

@@ -154,7 +154,7 @@ module Discorb
     #
     # @return [Async::Task<void>] The task.
     #
-    def delete!(reason: nil)
+    def delete(reason: nil)
       Async do
         @client.http.request(
           Route.new(

data/lib/discorb/channel/guild.rb

@@ -89,7 +89,7 @@ module Discorb
     #
     # @return [Async::Task<self>] The deleted channel.
     #
-    def delete!(reason: nil)
+    def delete(reason: nil)
       Async do
         @client.http.request(Route.new(base_url.wait.to_s, "//webhooks/:webhook_id/:token", :delete), {},
                              audit_log_reason: reason).wait
@@ -98,8 +98,8 @@ module Discorb
       end
     end
 
-    alias close! delete!
-    alias destroy! delete!
+    alias close delete
+    alias destroy delete
 
     #
     # Moves the channel to another position.

data/lib/discorb/channel/text.rb

@@ -135,7 +135,7 @@ module Discorb
     #
     # @return [Async::Task<void>] The task.
     #
-    def delete_messages!(*messages, force: false)
+    def delete_messages(*messages, force: false)
       Async do
         messages = messages.flatten
         unless force
@@ -156,8 +156,8 @@ module Discorb
       end
     end
 
-    alias bulk_delete! delete_messages!
-    alias destroy_messages! delete_messages!
+    alias bulk_delete delete_messages
+    alias destroy_messages delete_messages
 
     #
     # Follow the existing announcement channel.

data/lib/discorb/client.rb

@@ -473,9 +473,9 @@ module Discorb
     #
     # Stops the client.
     #
-    def close!
+    def close
       if @shards.any?
-        @shards.each_value(&:close!)
+        @shards.each_value(&:close)
       else
         @connection.send_close
       end
@@ -521,9 +521,7 @@ module Discorb
       setup_commands(token, guild_ids: guild_ids).wait
       clear_commands(token, ENV.fetch("DISCORB_SETUP_CLEAR_GUILDS", "").split(","))
       if ENV.fetch("DISCORB_SETUP_SCRIPT", nil) == "true"
-        @events[:setup]&.each do |event|
-          event.call
-        end
+        @events[:setup]&.each(&:call)
         self.on_setup if respond_to? :on_setup
       end
     end
@@ -567,7 +565,7 @@ module Discorb
       Signal.trap(:SIGINT) do
         logger.info "SIGINT received, closing..."
         Signal.trap(:SIGINT, "DEFAULT")
-        close!
+        close
       end
       if shards.nil?
         main_loop(nil)

data/lib/discorb/common.rb

@@ -4,7 +4,7 @@ module Discorb
   # @return [String] The API base URL.
   API_BASE_URL = "https://discord.com/api/v10"
   # @return [String] The version of discorb.
-  VERSION = "0.18.1"
+  VERSION = "0.19.0"
   # @return [Array<Integer>] The version array of discorb.
   VERSION_ARRAY = VERSION.split(".").map(&:to_i).freeze
   # @return [String] The user agent for the bot.

data/lib/discorb/embed.rb

@@ -124,7 +124,7 @@ module Discorb
       ret[:image] = @image&.to_hash if @image
       ret[:thumbnail] = @thumbnail&.to_hash if @thumbnail
       ret[:author] = @author&.to_hash if @author
-      ret[:fields] = @fields&.map { |f| f.to_hash } if @fields.any?
+      ret[:fields] = @fields&.map(&:to_hash) if @fields.any?
       ret
     end
 

data/lib/discorb/emoji.rb

@@ -121,7 +121,7 @@ module Discorb
     #
     # @return [Async::Task<self>] The deleted emoji.
     #
-    def delete!(reason: nil)
+    def delete(reason: nil)
       Async do
         @client.http.request(
           Route.new("/guilds/#{@guild.id}/emojis/#{@id}", "//guilds/:guild_id/emojis/:emoji_id",
@@ -132,7 +132,7 @@ module Discorb
       end
     end
 
-    alias destroy! delete!
+    alias destroy delete
 
     #
     # Converts the object to a hash.

data/lib/discorb/event.rb

@@ -224,14 +224,14 @@ module Discorb
     #
     # @return [Async::Task<void>] The task.
     #
-    def delete!
+    def delete
       Async do
         @client.http.request(Route.new("/guilds/#{@guild_id}/scheduled-events/#{@id}",
                                        "//guilds/:guild_id/scheduled-events/:scheduled_event_id", :delete)).wait
       end
     end
 
-    alias destroy! delete!
+    alias destroy delete
 
     #
     # Fetches the event users.

data/lib/discorb/gateway.rb

@@ -48,11 +48,21 @@ module Discorb
               alpn_protocols: Async::HTTP::Protocol::HTTP11.names,
             )
             begin
-              self.connection = Async::WebSocket::Client.connect(
-                endpoint,
-                headers: [["User-Agent", Discorb::USER_AGENT]],
-                handler: RawConnection,
-              )
+              reconnect_count = 0
+              begin
+                self.connection = Async::WebSocket::Client.connect(
+                  endpoint,
+                  headers: [["User-Agent", Discorb::USER_AGENT]],
+                  handler: RawConnection,
+                )
+              rescue Async::WebSocket::ProtocolError => e
+                raise if reconnect_count > 3
+
+                logger.info "Failed to connect to gateway, retrying...: #{e.message}"
+                reconnect_count += 1
+                sleep 2 ** reconnect_count
+                retry
+              end
               con = self.connection
               zlib_stream = Zlib::Inflate.new(Zlib::MAX_WBITS)
               buffer = +""
@@ -82,7 +92,7 @@ module Discorb
                      IOError => e
                 next if @status == :closed
 
-                logger.error "Gateway connection closed accidentally: #{e.class}: #{e.message}"
+                logger.info "Gateway connection closed, reconnecting: #{e.class}: #{e.message}"
                 con.force_close
                 connect_gateway(true)
                 next
@@ -163,7 +173,7 @@ module Discorb
                 token: @token,
                 intents: @intents.value,
                 compress: false,
-                properties: { "$os" => RUBY_PLATFORM, "$browser" => "discorb", "$device" => "discorb" },
+                properties: { "os" => RUBY_PLATFORM, "browser" => "discorb", "device" => "discorb" },
               }
               payload[:shard] = [shard_id, @shard_count] if shard_id
               payload[:presence] = @identify_presence if @identify_presence

data/lib/discorb/guild.rb

@@ -179,7 +179,7 @@ module Discorb
     #
     # @return [Async::Task<void>] The task.
     #
-    def leave!
+    def leave
       Async do
         @client.http.request(Route.new("/users/@me/guilds/#{@id}", "//users/@me/guilds/:guild_id", :delete)).wait
         @client.guilds.delete(@id)
@@ -1188,7 +1188,7 @@ module Discorb
       name,
       trigger_type,
       actions,
-      event_type = :send_message,
+      event_type = :message_send,
       enabled: false,
       exempt_roles: [],
       exempt_channels: [],
@@ -1203,7 +1203,7 @@ module Discorb
           trigger_type: Discorb::AutoModRule::TRIGGER_TYPES.key(trigger_type),
           metadata: {
             keyword_filter: keyword_filter,
-            presets: Discorb::AutoModRule::PRESET_TYPES.key(presets),
+            presets: presets && Discorb::AutoModRule::PRESET_TYPES.key(presets),
           },
           actions: actions.map(&:to_hash),
           enabled: enabled,
@@ -1381,7 +1381,7 @@ module Discorb
       #
       # @return [String] The url of the banner.
       #
-      def banner(guild_id, style: "banner")
+      def banner(guild_id, style: :banner)
         "#{Discorb::API_BASE_URL}/guilds/#{guild_id}/widget.png&style=#{style}"
       end
     end

data/lib/discorb/guild_template.rb

@@ -93,14 +93,14 @@ module Discorb
     #
     # @return [Async::Task<void>] The task.
     #
-    def delete!
+    def delete
       Async do
         @client.http.request(Route.new("/guilds/#{@source_guild_id}/templates/#{@code}",
                                        "//guilds/:guild_id/templates/:code", :delete)).wait
       end
     end
 
-    alias destroy! delete!
+    alias destroy delete
 
     #
     # Represents a guild in guild template.

data/lib/discorb/integration.rb

@@ -72,7 +72,7 @@ module Discorb
     #
     # @return [Async::Task<void>] The task.
     #
-    def delete!(reason: nil)
+    def delete(reason: nil)
       Async do
         @client.http.request(
           Route.new("/guilds/#{@guild}/integrations/#{@id}", "//guilds/:guild_id/integrations/:integration_id",
@@ -81,7 +81,7 @@ module Discorb
       end
     end
 
-    alias destroy! delete!
+    alias destroy delete
 
     private
 

data/lib/discorb/interaction/response.rb

@@ -125,86 +125,86 @@ module Discorb
           ret
         end
       end
+    end
 
+    #
+    # Represents of a callback message of interaction.
+    #
+    class CallbackMessage
       #
-      # Represents of a callback message of interaction.
-      #
-      class CallbackMessage
-        #
-        # Initializes a new instance of CallbackMessage.
-        # @private
-        #
-        # @param [Client] client The client.
-        # @param [Hash] data The payload.
-        # @param [String] application_id The application ID.
-        # @param [String] token The token.
-        #
-        def initialize(client, data, application_id, token)
-          @client = client
-          @data = data
-          @application_id = application_id
-          @token = token
-        end
+      # Initializes a new instance of CallbackMessage.
+      # @private
+      #
+      # @param [Client] client The client.
+      # @param [Hash] data The payload.
+      # @param [String] application_id The application ID.
+      # @param [String] token The token.
+      #
+      def initialize(client, data, application_id, token)
+        @client = client
+        @data = data
+        @application_id = application_id
+        @token = token
+      end
 
-        #
-        # Edits the callback message.
-        # @async
-        # @macro edit
-        #
-        # @param [String] content The new content of the message.
-        # @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::Attachment] file The file to send.
-        # @param [Array<Discorb::Attachment>] files The files to send.
-        #
-        # @return [Async::Task<void>] The task.
-        #
-        def edit(
-          content = Discorb::Unset,
-          embed: Discorb::Unset, embeds: Discorb::Unset,
-          file: Discorb::Unset, files: Discorb::Unset,
-          attachments: Discorb::Unset
-        )
-          Async do
-            payload = {}
-            payload[:content] = content if content != Discorb::Unset
-            payload[:embeds] = embed ? [embed.to_hash] : [] if embed != Discorb::Unset
-            payload[:embeds] = embeds.map(&:to_hash) if embeds != Discorb::Unset
-            payload[:attachments] = attachments.map(&:to_hash) if attachments != Discorb::Unset
-            files = [file] if file != Discorb::Unset
-            files = [] if files == Discorb::Unset
-            @client.http.multipart_request(
-              Route.new(
-                "/webhooks/#{@application_id}/#{@token}/messages/@original",
-                "//webhooks/:webhook_id/:token/messages/@original",
-                :patch
-              ),
-              payload,
-              files,
-            ).wait
-          end
+      #
+      # Edits the callback message.
+      # @async
+      # @macro edit
+      #
+      # @param [String] content The new content of the message.
+      # @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::Attachment] file The file to send.
+      # @param [Array<Discorb::Attachment>] files The files to send.
+      #
+      # @return [Async::Task<void>] The task.
+      #
+      def edit(
+        content = Discorb::Unset,
+        embed: Discorb::Unset, embeds: Discorb::Unset,
+        file: Discorb::Unset, files: Discorb::Unset,
+        attachments: Discorb::Unset
+      )
+        Async do
+          payload = {}
+          payload[:content] = content if content != Discorb::Unset
+          payload[:embeds] = embed ? [embed.to_hash] : [] if embed != Discorb::Unset
+          payload[:embeds] = embeds.map(&:to_hash) if embeds != Discorb::Unset
+          payload[:attachments] = attachments.map(&:to_hash) if attachments != Discorb::Unset
+          files = [file] if file != Discorb::Unset
+          files = [] if files == Discorb::Unset
+          @client.http.multipart_request(
+            Route.new(
+              "/webhooks/#{@application_id}/#{@token}/messages/@original",
+              "//webhooks/:webhook_id/:token/messages/@original",
+              :patch
+            ),
+            payload,
+            files,
+          ).wait
         end
+      end
 
-        alias modify edit
+      alias modify edit
 
-        #
-        # Deletes the callback message.
-        # @async
-        # @note This will fail if the message is ephemeral.
-        #
-        # @return [Async::Task<void>] The task.
-        #
-        def delete!
-          Async do
-            @client.http.request(Route.new("/webhooks/#{@application_id}/#{@token}/messages/@original",
-                                           "//webhooks/:webhook_id/:token/messages/@original", :delete)).wait
-          end
+      #
+      # Deletes the callback message.
+      # @async
+      # @note This will fail if the message is ephemeral.
+      #
+      # @return [Async::Task<void>] The task.
+      #
+      def delete
+        Async do
+          @client.http.request(Route.new("/webhooks/#{@application_id}/#{@token}/messages/@original",
+                                         "//webhooks/:webhook_id/:token/messages/@original", :delete)).wait
         end
+      end
 
-        def inspect
-          "#<#{self.class.name} application_id=#{@application_id}"
-        end
+      def inspect
+        "#<#{self.class.name} application_id=#{@application_id}"
       end
     end
 
@@ -313,11 +313,17 @@ module Discorb
       # @return [Async::Task<void>] The task.
       #
       def show_modal(title, custom_id, components)
-        payload = { title: title, custom_id: custom_id, components: Component.to_payload(components) }
-        @client.http.request(
-          Route.new("/interactions/#{@id}/#{@token}/callback", "//interactions/:interaction_id/:token/callback", :post),
-          { type: 9, data: payload }
-        ).wait
+        Async do
+          payload = { title: title, custom_id: custom_id, components: Component.to_payload(components) }
+          @client.http.request(
+            Route.new(
+              "/interactions/#{@id}/#{@token}/callback",
+              "//interactions/:interaction_id/:token/callback",
+              :post
+            ),
+            { type: 9, data: payload }
+          ).wait
+        end
       end
     end