discorb 0.5.6 → 0.6.0

data/lib/discorb/emoji.rb

@@ -86,7 +86,7 @@ module Discorb
     # @param [Array<Discorb::Role>] roles The new roles that can use this emoji.
     # @param [String] reason The reason for editing the emoji.
     #
-    # @return [self] The edited emoji.
+    # @return [Async::Task<self>] The edited emoji.
     #
     def edit(name: :unset, roles: :unset, reason: nil)
       Async do
@@ -107,7 +107,7 @@ module Discorb
     #
     # @param [String] reason The reason for deleting the emoji.
     #
-    # @return [self] The deleted emoji.
+    # @return [Async::Task<self>] The deleted emoji.
     #
     def delete!(reason: nil)
       Async do

data/lib/discorb/error.rb

@@ -67,6 +67,12 @@ module Discorb
     end
   end
 
+  #
+  # Represents a 401 error.
+  #
+  class UnauthorizedError < HTTPError
+  end
+
   #
   # Represents a 403 error.
   #

data/lib/discorb/exe/run.rb

@@ -2,6 +2,7 @@
 require "optparse"
 require "json"
 require "discorb/utils/colored_puts"
+require "io/console"
 
 ARGV.delete_at 0
 # @!visibility private
@@ -20,6 +21,7 @@ options = {
   log_file: nil,
   log_color: nil,
   setup: nil,
+  token: false,
 }
 opt.on("-d", "--deamon", "Run as a daemon.") { |v| options[:daemon] = v }
 opt.on("-l", "--log-level LEVEL", "Log level.") do |v|
@@ -33,6 +35,7 @@ end
 opt.on("-f", "--log-file FILE", "File to write log to.") { |v| options[:log_file] = v }
 opt.on("-c", "--[no-]log-color", "Whether to colorize log output.") { |v| options[:log_color] = v }
 opt.on("-s", "--setup", "Whether to setup application commands.") { |v| options[:setup] = v }
+opt.on("-t", "--token [ENV]", "The name of the environment variable to use for token, or just `-t` or `--token` for intractive prompt.") { |v| options[:token] = v }
 opt.parse!(ARGV)
 
 script = ARGV[0]
@@ -42,6 +45,15 @@ script ||= "main.rb"
 ENV["DISCORB_CLI_FLAG"] = "run"
 ENV["DISCORB_CLI_OPTIONS"] = JSON.generate(options)
 
+if options[:token]
+  ENV["DISCORB_CLI_TOKEN"] = ENV[options[:token]]
+  raise "#{options[:token]} is not set." if ENV["DISCORB_CLI_TOKEN"].nil?
+elsif options[:token].nil? || options[:token] == "-"
+  print "\e[90mPlease enter your token: \e[m"
+  ENV["DISCORB_CLI_TOKEN"] = $stdin.noecho(&:gets).chomp
+  puts ""
+end
+
 begin
   load script
 rescue LoadError

data/lib/discorb/exe/setup.rb

@@ -4,19 +4,32 @@ require "discorb/utils/colored_puts"
 
 ARGV.delete_at 0
 
+options = {
+  guilds: nil,
+}
+
 opt = OptionParser.new <<~BANNER
                          This command will setup application commands.
 
-                         Usage: discorb setup [script]
+                         Usage: discorb setup [options] [script]
 
                                    script                     The script to setup.
                        BANNER
+opt.on("-g", "--guild ID", Array, "The guild ID to setup, use comma for setup commands in multiple guilds, or `global` for setup global commands.") { |v| options[:guilds] = v }
 opt.parse!(ARGV)
 
 script = ARGV[0]
 script ||= "main.rb"
 ENV["DISCORB_CLI_FLAG"] = "setup"
 
+if options[:guilds] == ["global"]
+  ENV["DISCORB_SETUP_GUILDS"] = "global"
+elsif options[:guilds]
+  ENV["DISCORB_SETUP_GUILDS"] = options[:guilds].join(",")
+else
+  ENV["DISCORB_SETUP_GUILDS"] = nil
+end
+
 begin
   load script
 rescue LoadError

data/lib/discorb/extension.rb

@@ -49,7 +49,7 @@ module Discorb
 
     # @return [Hash{Symbol => Array<Discorb::Event>}] The events of the extension.
     attr_reader :events
-    # @return [Array<Discorb::Command::Command] The commands of the extension.
+    # @return [Array<Discorb::Command::Command>] The commands of the extension.
     attr_reader :commands
     # @private
     attr_reader :bottom_commands

data/lib/discorb/gateway.rb

@@ -90,7 +90,7 @@ module Discorb
       #
       # @param [Boolean] force Whether to force fetching the message.
       #
-      # @return [Discorb::Message] The message.
+      # @return [Async::Task<Discorb::Message>] The message.
       def fetch_message(force: false)
         Async do
           next @message if !force && @message
@@ -139,7 +139,7 @@ module Discorb
       #
       # @param [Boolean] force Whether to force fetching the message.
       #
-      # @return [Discorb::Message] The message.
+      # @return [Async::Task<Discorb::Message>] The message.
       def fetch_message(force: false)
         Async do
           next @message if !force && @message
@@ -191,7 +191,7 @@ module Discorb
       #
       # @param [Boolean] force Whether to force fetching the message.
       #
-      # @return [Discorb::Message] The message.
+      # @return [Async::Task<Discorb::Message>] The message.
       def fetch_message(force: false)
         Async do
           next @message if !force && @message
@@ -265,7 +265,7 @@ module Discorb
       # @macro async
       # @macro http
       #
-      # @return [Discorb::Message] The message.
+      # @return [Async::Task<Discorb::Message>] The message.
       def fetch_message
         Async do
           channel.fetch_message(@id).wait
@@ -584,6 +584,11 @@ module Discorb
           @session_id = data[:session_id]
           @user = ClientUser.new(self, data[:user])
           @uncached_guilds = data[:guilds].map { |g| g[:id] }
+          if @uncached_guilds == []
+            @ready = true
+            dispatch(:ready)
+            @log.info("Guilds were cached")
+          end
           @tasks << handle_heartbeat(@heartbeat_interval)
         when "GUILD_CREATE"
           if @uncached_guilds.include?(data[:id])

data/lib/discorb/guild.rb

@@ -175,7 +175,7 @@ module Discorb
     # @macro http
     # @note This querys the API every time. We recommend using {#emojis} instead.
     #
-    # @return [Discorb::Dictionary{Discorb::Snowflake => Discorb::CustomEmoji}] A dictionary of emoji in the guild.
+    # @return [Async::Task<Discorb::Dictionary{Discorb::Snowflake => Discorb::CustomEmoji}>] A dictionary of emoji in the guild.
     #
     def fetch_emoji_list
       Async do
@@ -201,7 +201,7 @@ module Discorb
     #
     # @param [#to_s] id The emoji id.
     #
-    # @return [Discorb::CustomEmoji] The emoji with the given id.
+    # @return [Async::Task<Discorb::CustomEmoji>] The emoji with the given id.
     #
     def fetch_emoji(id)
       _resp, data = @client.http.get("/guilds/#{@id}/emojis/#{id}").wait
@@ -217,7 +217,7 @@ module Discorb
     # @param [Discorb::Image] image The image of the emoji.
     # @param [Array<Discorb::Role>] roles A list of roles to give the emoji.
     #
-    # @return [Discorb::CustomEmoji] The created emoji.
+    # @return [Async::Task<Discorb::CustomEmoji>] The created emoji.
     #
     def create_emoji(name, image, roles: [])
       _resp, data = @client.http.post(
@@ -236,7 +236,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::Webhook>] A list of webhooks in the guild.
+    # @return [Async::Task<Array<Discorb::Webhook>>] A list of webhooks in the guild.
     #
     def fetch_webhooks
       Async do
@@ -250,7 +250,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Discorb::AuditLog] The audit log of the guild.
+    # @return [Async::Task<Discorb::AuditLog>] The audit log of the guild.
     #
     def fetch_audit_log
       Async do
@@ -264,7 +264,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::Channel>] A list of channels in the guild.
+    # @return [Async::Task<Array<Discorb::Channel>>] A list of channels in the guild.
     #
     def fetch_channels
       Async do
@@ -288,7 +288,7 @@ module Discorb
     # @param [Discorb::CategoryChannel] parent The parent of the channel.
     # @param [String] reason The reason for creating the channel.
     #
-    # @return [Discorb::TextChannel] The created text channel.
+    # @return [Async::Task<Discorb::TextChannel>] The created text channel.
     #
     def create_text_channel(
       name, topic: nil, rate_limit_per_user: nil, slowmode: nil, position: nil, nsfw: nil, permission_overwrites: nil, parent: nil, reason: nil
@@ -333,7 +333,7 @@ module Discorb
     # @param [Discorb::CategoryChannel] parent The parent of the channel.
     # @param [String] reason The reason for creating the channel.
     #
-    # @return [Discorb::VoiceChannel] The created voice channel.
+    # @return [Async::Task<Discorb::VoiceChannel>] The created voice channel.
     #
     def create_voice_channel(
       name, bitrate: 64, user_limit: nil, position: nil, permission_overwrites: nil, parent: nil, reason: nil
@@ -373,7 +373,7 @@ module Discorb
     # @param [Discorb::CategoryChannel] parent The parent of the channel.
     # @param [String] reason The reason for creating the channel.
     #
-    # @return [Discorb::CategoryChannel] The created category channel.
+    # @return [Async::Task<Discorb::CategoryChannel>] The created category channel.
     #
     def create_category_channel(name, position: nil, permission_overwrites: nil, parent: nil, reason: nil)
       Async do
@@ -412,7 +412,7 @@ module Discorb
     # @param [Discorb::CategoryChannel] parent The parent of the channel.
     # @param [String] reason The reason for creating the channel.
     #
-    # @return [Discorb::StageChannel] The created stage channel.
+    # @return [Async::Task<Discorb::StageChannel>] The created stage channel.
     #
     def create_stage_channel(name, bitrate: 64, position: nil, permission_overwrites: nil, parent: nil, reason: nil)
       Async do
@@ -453,7 +453,7 @@ module Discorb
     # @param [Discorb::CategoryChannel] parent The parent of the channel.
     # @param [String] reason The reason for creating the channel.
     #
-    # @return [Discorb::NewsChannel] The created news channel.
+    # @return [Async::Task<Discorb::NewsChannel>] The created news channel.
     #
     def create_news_channel(
       name, topic: nil, rate_limit_per_user: nil, slowmode: nil, position: nil, nsfw: nil, permission_overwrites: nil, parent: nil, reason: nil
@@ -489,7 +489,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::ThreadChannel>] The list of threads.
+    # @return [Async::Task<Array<Discorb::ThreadChannel>>] The list of threads.
     #
     def fetch_active_threads
       Async do
@@ -506,8 +506,8 @@ module Discorb
     #
     # @param [#to_s] id The ID of the member to fetch.
     #
-    # @return [Discorb::Member] The member.
-    # @return [nil] If the member is not found.
+    # @return [Async::Task<Discorb::Member>] The member.
+    # @return [Async::Task<nil>] If the member is not found.
     #
     def fetch_member(id)
       Async do
@@ -527,7 +527,7 @@ module Discorb
     # @param [String] name The name of the member to search for.
     # @param [Integer] limit The maximum number of members to return.
     #
-    # @return [Array<Discorb::Member>] The list of members.
+    # @return [Async::Task<Array<Discorb::Member>>] The list of members.
     #
     def fetch_members_named(name, limit: 1)
       Async do
@@ -541,8 +541,8 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Discorb::Member] The member.
-    # @return [nil] If the member is not found.
+    # @return [Async::Task<Discorb::Member>] The member.
+    # @return [Async::Task<nil>] If the member is not found.
     #
     def fetch_member_named(...)
       Async do
@@ -585,7 +585,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::Guild::Ban>] The list of bans.
+    # @return [Async::Task<Array<Discorb::Guild::Ban>>] The list of bans.
     #
     def fetch_bans
       Async do
@@ -601,8 +601,8 @@ module Discorb
     #
     # @param [Discorb::User] user The user to fetch.
     #
-    # @return [Discorb::Guild::Ban] The ban.
-    # @return [nil] If the ban is not found.
+    # @return [Async::Task<Discorb::Guild::Ban>] The ban.
+    # @return [Async::Task<nil>] If the ban is not found.
     #
     def fetch_ban(user)
       Async do
@@ -621,7 +621,7 @@ module Discorb
     #
     # @param [Discorb::User] user The user to check.
     #
-    # @return [Boolean] Whether the user was banned.
+    # @return [Async::Task<Boolean>] Whether the user was banned.
     #
     def banned?(user)
       Async do
@@ -638,7 +638,7 @@ module Discorb
     # @param [Integer] delete_message_days The number of days to delete messages.
     # @param [String] reason The reason for banning the member.
     #
-    # @return [Discorb::Guild::Ban] The ban.
+    # @return [Async::Task<Discorb::Guild::Ban>] The ban.
     #
     def ban_member(member, delete_message_days: 0, reason: nil)
       Async do
@@ -668,7 +668,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::Role>] The list of roles.
+    # @return [Async::Task<Array<Discorb::Role>>] The list of roles.
     #
     def fetch_roles
       Async do
@@ -688,7 +688,7 @@ module Discorb
     # @param [Boolean] mentionable Whether the role should be mentionable.
     # @param [String] reason The reason for creating the role.
     #
-    # @return [Discorb::Role] The role.
+    # @return [Async::Task<Discorb::Role>] The role.
     #
     def create_role(name = nil, color: nil, hoist: nil, mentionable: nil, reason: nil)
       Async do
@@ -712,7 +712,7 @@ module Discorb
     # @param [Integer] days The number of days to prune.
     # @param [Array<Discorb::Role>] roles The roles that include for pruning.
     #
-    # @return [Integer] The number of members that will be pruned.
+    # @return [Async::Task<Integer>] The number of members that will be pruned.
     #
     def fetch_prune(days = 7, roles: [])
       Async do
@@ -735,7 +735,7 @@ module Discorb
     # @param [Array<Discorb::Role>] roles The roles that include for pruning.
     # @param [String] reason The reason for pruning.
     #
-    # @return [Integer] The number of members that were pruned.
+    # @return [Async::Task<Integer>] The number of members that were pruned.
     #
     def prune(days = 7, roles: [], reason: nil)
       Async do
@@ -751,7 +751,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::VoiceRegion>] The available voice regions.
+    # @return [Async::Task<Array<Discorb::VoiceRegion>>] The available voice regions.
     #
     def fetch_voice_regions
       Async do
@@ -765,7 +765,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Invite>] The invites.
+    # @return [Async::Task<Array<Invite>>] The invites.
     #
     def fetch_invites
       Async do
@@ -779,7 +779,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::Integration>] The integrations.
+    # @return [Async::Task<Array<Discorb::Integration>>] The integrations.
     #
     def fetch_integrations
       Async do
@@ -793,7 +793,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Discorb::Guild::Widget] The widget.
+    # @return [Async::Task<Discorb::Guild::Widget>] The widget.
     #
     def fetch_widget
       Async do
@@ -807,7 +807,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Discorb::Guild::VanityInvite] The vanity URL.
+    # @return [Async::Task<Discorb::Guild::VanityInvite>] The vanity URL.
     #
     def fetch_vanity_invite
       Async do
@@ -821,7 +821,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Discorb::Guild::WelcomeScreen] The welcome screen.
+    # @return [Async::Task<Discorb::Guild::WelcomeScreen>] The welcome screen.
     #
     def fetch_welcome_screen
       Async do
@@ -835,7 +835,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::Sticker::GuildSticker>] The stickers.
+    # @return [Async::Task<Array<Discorb::Sticker::GuildSticker>>] The stickers.
     #
     def fetch_stickers
       Async do
@@ -851,8 +851,8 @@ module Discorb
     #
     # @param [#to_s] id The ID of the sticker.
     #
-    # @return [Discorb::Sticker::GuildSticker] The sticker.
-    # @return [nil] If the sticker does not exist.
+    # @return [Async::Task<Discorb::Sticker::GuildSticker>] The sticker.
+    # @return [Async::Task<nil>] If the sticker does not exist.
     #
     def fetch_sticker(id)
       Async do
@@ -869,7 +869,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Discorb::GuildTemplate] The templates.
+    # @return [Async::Task<Discorb::GuildTemplate>] The templates.
     #
     def fetch_templates
       Async do
@@ -882,7 +882,7 @@ module Discorb
     # Almost the same as {#fetch_templates}, but returns a single template.
     #
     # @return [Discorb::GuildTemplate] The template.
-    # @return [nil] If the template does not exist.
+    # @return [Async::Task<nil>] If the template does not exist.
     #
     def fetch_template
       Async do
@@ -897,7 +897,7 @@ module Discorb
     # @param [String] description The description of the template.
     # @param [String] reason The reason for creating the template.
     #
-    # @return [Discorb::GuildTemplate] The template.
+    # @return [Async::Task<Discorb::GuildTemplate>] The template.
     #
     def create_template(name, description = nil, reason: nil)
       Async do