discorb 0.5.6 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8484feb78582222a91d4fee1225fe649edc6a24a4c6c77eb83fa6c3094b3935d
-  data.tar.gz: 7597101823bd4f3f6900636af7f06320d9c296659069ff69bc829b7528171372
+  metadata.gz: aec8518b5159a98382c8f9ddcc4ca5818e0be6e364ef5e8d2a623e8395b5f078
+  data.tar.gz: 4b93ab7afc612c550e19a8d7ba1fac48f0613b760f38bcd1ba2b4387e20b2435
 SHA512:
-  metadata.gz: e6a690ccd8d95f66db74cafd22a430472841183d3048b10529009a0a64a1ba4c21f553fe83746c7356b3069c87badd3768c88834a34cecb0194ccf818a128947
-  data.tar.gz: cd46b4dd261aea5d4f9b2257e1cb81f07b377922364080863cce61551293dbb08ded110d15bac44812307d7846edb7a77787ef2e3f003bcb1ae977f8c35545b6
+  metadata.gz: b73524dd2de6c337d42ad82f83c95d960e936ad554ebf6fb9cad6c96b06d4779b862339d319d2d0d42ba498ce6cfa536f5adc48eb801bb42e1ba4dd133c72976
+  data.tar.gz: 1ff54afd40c0731e2726236d18633bd1a9039ae4c98129765f64a0d96f4491cf282f3f4a9872a195d20403160dcdab4ed0832d923533462f088694015bcf5dc9

data/Changelog.md

@@ -138,3 +138,10 @@
 - Add: Raise error when intents are invalid
 - Fix: Fix Emoji#==
 
+## 0.6.0
+
+- Fix: Fix issue with client with no guilds
+- Add: Add rbs (experimental)
+- Add: Add `-t`, `--token` option to `discorb run`
+- Add: Add `-g`, `--guild` option to `discorb setup`
+- Change: Use `Async::Task<R>` instead of `R` in return value

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    discorb (0.5.6)
+    discorb (0.6.0)
       async (~> 1.30.1)
       async-http (~> 0.56.5)
       async-websocket (~> 0.19.0)

data/docs/cli/run.md

@@ -17,6 +17,8 @@ discorb run [options] [script]
 
 The script to run. Defaults to `main.rb`.
 
+### Options
+
 #### `-d`, `--deamon`
 
 Run the client in deamon mode.
@@ -43,4 +45,12 @@ You can use `stdout` to write to the standard output, and `stderr` to write to t
 Whether to colorize the log output.
 If not specified, the default will be:
 - `true` if the file to write logs to is `stdout` or `stderr`.
-- `false` otherwise.
+- `false` otherwise.
+
+#### `-s`, `--setup`
+
+Whether to setup application commands.
+
+#### `-t`, `--token`
+
+The name of the environment variable to use for token, or just `-t` or `--token` for intractive prompt.

data/docs/cli/setup.md

@@ -7,7 +7,7 @@ This command will setup application commands.
 ## Usage
 
 ```
-discorb setup [script]
+discorb setup [options] [script]
 ```
 
 ### Arguments
@@ -15,3 +15,9 @@ discorb setup [script]
 #### `script`
 
 The script to setup. Defaults to `main.rb`.
+
+### Options
+
+#### `-g`, `--guild`
+
+Guild IDs to use as default. Can be specified multiple IDs by using `,` as delimiter.

data/lib/discorb/channel.rb

@@ -171,7 +171,7 @@ module Discorb
     #
     # @param [String] reason The reason of deleting the channel.
     #
-    # @return [self] The deleted channel.
+    # @return [Async::Task<self>] The deleted channel.
     #
     def delete!(reason: nil)
       Async do
@@ -194,7 +194,7 @@ module Discorb
     # @param [Discorb::CategoryChannel] parent The parent of channel.
     # @param [String] reason The reason of moving the channel.
     #
-    # @return [self] The moved channel.
+    # @return [Async::Task<self>] The moved channel.
     #
     def move(position, lock_permissions: false, parent: :unset, reason: nil)
       Async do
@@ -273,7 +273,7 @@ module Discorb
     # @param [Integer] archive_in Alias of `default_auto_archive_duration`.
     # @param [String] reason The reason of editing the channel.
     #
-    # @return [self] The edited channel.
+    # @return [Async::Task<self>] The edited channel.
     #
     def edit(name: :unset, position: :unset, category: :unset, parent: :unset,
              topic: :unset, nsfw: :unset, announce: :unset,
@@ -310,7 +310,7 @@ module Discorb
     # @param [String] name The name of the webhook.
     # @param [Discorb::Image] avatar The avatar of the webhook.
     #
-    # @return [Discorb::Webhook::IncomingWebhook] The created webhook.
+    # @return [Async::Task<Discorb::Webhook::IncomingWebhook>] The created webhook.
     #
     def create_webhook(name, avatar: nil)
       Async do
@@ -327,7 +327,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::Webhook>] The webhooks in the channel.
+    # @return [Async::Task<Array<Discorb::Webhook>>] The webhooks in the channel.
     #
     def fetch_webhooks
       Async do
@@ -419,7 +419,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::Invite>] The invites in the channel.
+    # @return [Async::Task<Array<Discorb::Invite>>] The invites in the channel.
     #
     def fetch_invites
       Async do
@@ -440,7 +440,7 @@ module Discorb
     #   @note if it's `false` it may return existing invite.
     # @param [String] reason The reason of creating the invite.
     #
-    # @return [Invite] The created invite.
+    # @return [Async::Task<Invite>] The created invite.
     #
     def create_invite(max_age: nil, max_uses: nil, temporary: false, unique: false, reason: nil)
       Async do
@@ -487,7 +487,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::Message>] The pinned messages in the channel.
+    # @return [Async::Task<Array<Discorb::Message>>] The pinned messages in the channel.
     #
     def fetch_pins
       Async do
@@ -535,7 +535,7 @@ module Discorb
     # @param [Boolean] public Whether the thread is public.
     # @param [String] reason The reason of starting the thread.
     #
-    # @return [Discorb::ThreadChannel] The started thread.
+    # @return [Async::Task<Discorb::ThreadChannel>] The started thread.
     #
     def start_thread(name, message: nil, auto_archive_duration: 1440, public: true, reason: nil)
       Async do
@@ -560,7 +560,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::ThreadChannel>] The archived threads in the channel.
+    # @return [Async::Task<Array<Discorb::ThreadChannel>>] The archived threads in the channel.
     #
     def fetch_archived_public_threads
       Async do
@@ -574,7 +574,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::ThreadChannel>] The archived private threads in the channel.
+    # @return [Async::Task<Array<Discorb::ThreadChannel>>] The archived private threads in the channel.
     #
     def fetch_archived_private_threads
       Async do
@@ -591,7 +591,7 @@ module Discorb
     # @param [Integer] limit The limit of threads to fetch.
     # @param [Time] before <description>
     #
-    # @return [Array<Discorb::ThreadChannel>] The joined archived private threads in the channel.
+    # @return [Async::Task<Array<Discorb::ThreadChannel>>] The joined archived private threads in the channel.
     #
     def fetch_joined_archived_private_threads(limit: nil, before: nil)
       Async do
@@ -660,7 +660,7 @@ module Discorb
     # @param [Symbol] rtc_region The region of the voice channel.
     # @param [String] reason The reason of editing the voice channel.
     #
-    # @return [self] The edited voice channel.
+    # @return [Async::Task<self>] The edited voice channel.
     #
     def edit(name: :unset, position: :unset, bitrate: :unset, user_limit: :unset, rtc_region: :unset, reason: nil)
       Async do
@@ -728,7 +728,7 @@ module Discorb
     # @param [Symbol] rtc_region The region of the stage channel.
     # @param [String] reason The reason of editing the stage channel.
     #
-    # @return [self] The edited stage channel.
+    # @return [Async::Task<self>] The edited stage channel.
     #
     def edit(name: :unset, position: :unset, bitrate: :unset, rtc_region: :unset, reason: nil)
       Async do
@@ -753,7 +753,7 @@ module Discorb
     # @param [Boolean] public Whether the stage instance is public or not.
     # @param [String] reason The reason of starting the stage instance.
     #
-    # @return [Discorb::StageInstance] The started stage instance.
+    # @return [Async::Task<Discorb::StageInstance>] The started stage instance.
     #
     def start(topic, public: false, reason: nil)
       Async do
@@ -767,8 +767,8 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [StageInstance] The current stage instance.
-    # @return [nil] If there is no current stage instance.
+    # @return [Async::Task<StageInstance>] The current stage instance.
+    # @return [Async::Task<nil>] If there is no current stage instance.
     #
     def fetch_stage_instance
       Async do
@@ -853,7 +853,7 @@ module Discorb
     # @param [Boolean] locked Whether the thread is locked or not.
     # @param [String] reason The reason of editing the thread.
     #
-    # @return [self] The edited thread.
+    # @return [Async::Task<self>] The edited thread.
     #
     # @see #archive
     # @see #lock

data/lib/discorb/client.rb

@@ -202,7 +202,7 @@ module Discorb
     #
     # @param [#to_s] id <description>
     #
-    # @return [Discorb::User] The user.
+    # @return [Async::Task<Discorb::User>] The user.
     #
     # @raise [Discorb::NotFoundError] If the user doesn't exist.
     #
@@ -220,7 +220,7 @@ module Discorb
     #
     # @param [#to_s] id The ID of the channel.
     #
-    # @return [Discorb::Channel] The channel.
+    # @return [Async::Task<Discorb::Channel>] The channel.
     #
     # @raise [Discorb::NotFoundError] If the channel doesn't exist.
     #
@@ -238,7 +238,7 @@ module Discorb
     #
     # @param [#to_s] id <description>
     #
-    # @return [Discorb::Guild] The guild.
+    # @return [Async::Task<Discorb::Guild>] The guild.
     #
     # @raise [Discorb::NotFoundError] If the guild doesn't exist.
     #
@@ -258,7 +258,7 @@ module Discorb
     # @param [Boolean] with_count Whether to include the count of the invite.
     # @param [Boolean] with_expiration Whether to include the expiration of the invite.
     #
-    # @return [Discorb::Invite] The invite.
+    # @return [Async::Task<Discorb::Invite>] The invite.
     #
     def fetch_invite(code, with_count: false, with_expiration: false)
       Async do
@@ -275,7 +275,7 @@ module Discorb
     #
     # @param [Boolean] force Whether to force the fetch.
     #
-    # @return [Discorb::Application] The application.
+    # @return [Async::Task<Discorb::Application>] The application.
     #
     def fetch_application(force: false)
       Async do
@@ -292,7 +292,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::Sticker::Pack>] The packs.
+    # @return [Async::Task<Array<Discorb::Sticker::Pack>>] The packs.
     #
     def fetch_nitro_sticker_packs
       Async do
@@ -398,9 +398,13 @@ module Discorb
     # @note This method behavior will change by CLI.
     # @see file:docs/cli.md
     #
-    # @param [String] token The token to use.
+    # @param [String, nil] token The token to use.
     #
-    def run(token)
+    # @note If the token is nil, you should use `discorb run` with the `-t` or `--token` option.
+    #
+    def run(token = nil)
+      token ||= ENV["DISCORB_CLI_TOKEN"]
+      raise ArgumentError, "Token is not specified, and -t/--token is not specified" if token.nil?
       case ENV["DISCORB_CLI_FLAG"]
       when nil
         start_client(token)
@@ -436,7 +440,14 @@ module Discorb
         end
         start_client(token)
       when "setup"
-        setup_commands(token)
+        guild_ids = "global"
+        if guilds = ENV["DISCORB_SETUP_GUILDS"]
+          guild_ids = guilds.split(",")
+        end
+        if guild_ids == ["global"]
+          guild_ids = false
+        end
+        setup_commands(token, guild_ids: guild_ids).wait
       end
     end
 

data/lib/discorb/command.rb

@@ -24,14 +24,15 @@ module Discorb
       #   | `:type` | `Object` | Type of the option. |
       #   | `:choice` | `Hash{String => String, Integer, Float}` | Type of the option. |
       #
-      # @param [Array<#to_s>] guild_ids Guild IDs to restrict the command to.
+      # @param [Array<#to_s>, false, nil] guild_ids Guild IDs to set the command to. `false` to global command, `nil` to use default.
       # @param [Proc] block Command block.
       #
       # @return [Discorb::Command::Command::SlashCommand]
       #
       # @see file:docs/application_command.md#register-slash-command
+      # @see file:docs/cli/setup.md
       #
-      def slash(command_name, description, options = {}, guild_ids: [], &block)
+      def slash(command_name, description, options = {}, guild_ids: nil, &block)
         command = Discorb::Command::Command::SlashCommand.new(command_name, description, options, guild_ids, block, 1, "")
         @commands << command
         @bottom_commands << command
@@ -43,7 +44,7 @@ module Discorb
       #
       # @param [String] command_name Command name.
       # @param [String] description Command description.
-      # @param [Array<#to_s>] guild_ids Guild IDs to restrict the command to.
+      # @param [Array<#to_s>, false, nil] guild_ids Guild IDs to set the command to. `false` to global command, `nil` to use default.
       #
       # @yield Block to execute as the command. It can be used to define sub-commands.
       # @yieldself [Discorb::Command::Command::GroupCommand] Group command.
@@ -51,8 +52,9 @@ module Discorb
       # @return [Discorb::Command::Command::GroupCommand] Command object.
       #
       # @see file:docs/slash_command.md
+      # @see file:docs/cli/setup.md
       #
-      def slash_group(command_name, description, guild_ids: [], &block)
+      def slash_group(command_name, description, guild_ids: nil, &block)
         command = Discorb::Command::Command::GroupCommand.new(command_name, description, guild_ids, nil, self)
         command.instance_eval(&block) if block_given?
         @commands << command
@@ -63,15 +65,15 @@ module Discorb
       # Add message context menu command.
       #
       # @param [String] command_name Command name.
-      # @param [Array<#to_s>] guild_ids Guild IDs to restrict the command to.
+      # @param [Array<#to_s>, false, nil] guild_ids Guild IDs to set the command to. `false` to global command, `nil` to use default.
       # @param [Proc] block Command block.
       # @yield [interaction, message] Block to execute.
-      # @yieldparam [Discorb::CommandInteraction::UserMenuCommand] Interaction object.
-      # @yieldparam [Discorb::Message] user Message object.
+      # @yieldparam [Discorb::CommandInteraction::UserMenuCommand] interaction Interaction object.
+      # @yieldparam [Discorb::Message] message Message object.
       #
       # @return [Discorb::Command::Command] Command object.
       #
-      def message_command(command_name, guild_ids: [], &block)
+      def message_command(command_name, guild_ids: nil, &block)
         command = Discorb::Command::Command.new(command_name, guild_ids, block, 3)
         @commands << command
         command
@@ -81,15 +83,15 @@ module Discorb
       # Add user context menu command.
       #
       # @param [String] command_name Command name.
-      # @param [Array<#to_s>] guild_ids Guild IDs to restrict the command to.
+      # @param [Array<#to_s>, false, nil] guild_ids Guild IDs to set the command to. `false` to global command, `nil` to use default.
       # @param [Proc] block Command block.
       # @yield [interaction, user] Block to execute.
-      # @yieldparam [Discorb::CommandInteraction::UserMenuCommand] Interaction object.
+      # @yieldparam [Discorb::CommandInteraction::UserMenuCommand] interaction Interaction object.
       # @yieldparam [Discorb::User] user User object.
       #
       # @return [Discorb::Command::Command] Command object.
       #
-      def user_command(command_name, guild_ids: [], &block)
+      def user_command(command_name, guild_ids: nil, &block)
         command = Discorb::Command::Command.new(command_name, guild_ids, block, 2)
         @commands << command
         command
@@ -100,20 +102,32 @@ module Discorb
       # @see Client#initialize
       #
       # @param [String] token Bot token.
+      # @param [Array<#to_s>, false, nil] guild_ids Guild IDs to use as default. If `false` is given, it will be global command.
+      #
       # @note `token` parameter only required if you don't run client.
       #
-      def setup_commands(token = nil)
+      def setup_commands(token = nil, guild_ids: nil)
         Async do
           @token ||= token
           @http = HTTP.new(self)
-          global_commands = @commands.select { |c| c.guild_ids.empty? }
-          guild_ids = Set[*@commands.map(&:guild_ids).flatten]
+          global_commands = @commands.select { |c| c.guild_ids == false or c.guild_ids == [] }
+          local_commands = @commands.select { |c| c.guild_ids.is_a?(Array) and c.guild_ids.any? }
+          default_commands = @commands.select { |c| c.guild_ids.nil? }
+          if guild_ids.is_a?(Array)
+            default_commands.each do |command|
+              command.instance_variable_set(:@guild_ids, guild_ids)
+            end
+            local_commands += default_commands
+          else
+            global_commands += default_commands
+          end
+          final_guild_ids = local_commands.map(&:guild_ids).flatten.map(&:to_s).uniq
           app_info = fetch_application.wait
           http.put("/applications/#{app_info.id}/commands", global_commands.map(&:to_hash)).wait unless global_commands.empty?
-          guild_ids.each do |guild_id|
-            commands = @commands.select { |c| c.guild_ids.include?(guild_id) }
+          final_guild_ids.each do |guild_id|
+            commands = local_commands.select { |c| c.guild_ids.include?(guild_id) }
             http.put("/applications/#{app_info.id}/guilds/#{guild_id}/commands", commands.map(&:to_hash)).wait
-          end unless guild_ids.empty?
+          end unless final_guild_ids.empty?
           @log.info "Successfully setup commands"
         end
       end
@@ -146,7 +160,7 @@ module Discorb
       # @!visibility private
       def initialize(name, guild_ids, block, type)
         @name = name
-        @guild_ids = guild_ids.map(&:to_s)
+        @guild_ids = guild_ids&.map(&:to_s)
         @block = block
         @raw_type = type
         @type = Discorb::Command::Command.types[type]
@@ -174,12 +188,8 @@ module Discorb
 
         # @!visibility private
         def initialize(name, description, options, guild_ids, block, type, parent)
+          super(name, guild_ids, block, type)
           @description = description
-          @name = name
-          @guild_ids = guild_ids.map(&:to_s)
-          @block = block
-          @type = Discorb::Command::Command.types[type]
-          @type_raw = 1
           @options = options
           @id = nil
           @parent = parent

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.5.6"
+  VERSION = "0.6.0"
   # @return [String] The user agent for the bot.
   USER_AGENT = "DiscordBot (https://github.com/discorb-lib/discorb #{VERSION}) Ruby/#{RUBY_VERSION}"