discorb 0.5.5 → 0.7.0

data/lib/discorb/color.rb

@@ -130,35 +130,65 @@ module Discorb
     #
     # Create a color from a Discord's color.
     # Currently these colors are supported:
-    #   - teal (0x1abc9c)
-    #   - dark_teal (0x11806a)
-    #   - green (0x2ecc71)
-    #   - dark_green (0x1f8b4c)
-    #   - blue (0x3498db)
-    #   - dark_blue (0x206694)
-    #   - purple (0x9b59b6)
-    #   - dark_purple (0x71368a)
-    #   - magenta (0xe91e63)
-    #   - dark_magenta (0xad1457)
-    #   - gold (0xf1c40f)
-    #   - dark_gold (0xc27c0e)
-    #   - orange (0xe67e22)
-    #   - dark_orange (0xa84300)
-    #   - red (0xe74c3c)
-    #   - dark_red (0x992d22)
-    #   - lighter_grey (0x95a5a6)
-    #   - lighter_gray (0x95a5a6)
-    #   - dark_grey (0x607d8b)
-    #   - dark_gray (0x607d8b)
-    #   - light_grey (0x979c9f)
-    #   - light_gray (0x979c9f)
-    #   - darker_grey (0x546e7a)
-    #   - darker_gray (0x546e7a)
-    #   - og_blurple (0x7289da)
-    #   - blurple (0x5865f2)
-    #   - greyple (0x99aab5)
-    #   - dark_theme (0x36393f)
-    #   - fuchsia (0xeb459e)
+    # | Color Name | Hexadecimal |
+    # |------------|------------|
+    # | `:teal` | `#1abc9c` |
+    # | `:dark_teal` | `#11806a` |
+    # | `:green` | `#2ecc71` |
+    # | `:dark_green` | `#1f8b4c` |
+    # | `:blue` | `#3498db` |
+    # | `:dark_blue` | `#206694` |
+    # | `:purple` | `#9b59b6` |
+    # | `:dark_purple` | `#71368a` |
+    # | `:magenta` | `#e91e63` |
+    # | `:dark_magenta` | `#ad1457` |
+    # | `:gold` | `#f1c40f` |
+    # | `:dark_gold` | `#c27c0e` |
+    # | `:orange` | `#e67e22` |
+    # | `:dark_orange` | `#a84300` |
+    # | `:red` | `#e74c3c` |
+    # | `:dark_red` | `#992d22` |
+    # | `:lighter_grey` | `#95a5a6` |
+    # | `:lighter_gray` | `#95a5a6` |
+    # | `:dark_grey` | `#607d8b` |
+    # | `:dark_gray` | `#607d8b` |
+    # | `:light_grey` | `#979c9f` |
+    # | `:light_gray` | `#979c9f` |
+    # | `:darker_grey` | `#546e7a` |
+    # | `:darker_gray` | `#546e7a` |
+    # | `:og_blurple` | `#7289da` |
+    # | `:blurple` | `#5865f2` |
+    # | `:greyple` | `#99aab5` |
+    # | `:dark_theme` | `#36393f` |
+    # | `:fuchsia` | `#eb459e` |
+    # | `:dark_teal` | `#11806a` |
+    # | `:green` | `#2ecc71` |
+    # | `:dark_green` | `#1f8b4c` |
+    # | `:blue` | `#3498db` |
+    # | `:dark_blue` | `#206694` |
+    # | `:purple` | `#9b59b6` |
+    # | `:dark_purple` | `#71368a` |
+    # | `:magenta` | `#e91e63` |
+    # | `:dark_magenta` | `#ad1457` |
+    # | `:gold` | `#f1c40f` |
+    # | `:dark_gold` | `#c27c0e` |
+    # | `:orange` | `#e67e22` |
+    # | `:dark_orange` | `#a84300` |
+    # | `:red` | `#e74c3c` |
+    # | `:dark_red` | `#992d22` |
+    # | `:lighter_grey` | `#95a5a6` |
+    # | `:lighter_gray` | `#95a5a6` |
+    # | `:dark_grey` | `#607d8b` |
+    # | `:dark_gray` | `#607d8b` |
+    # | `:light_grey` | `#979c9f` |
+    # | `:light_gray` | `#979c9f` |
+    # | `:darker_grey` | `#546e7a` |
+    # | `:darker_gray` | `#546e7a` |
+    # | `:og_blurple` | `#7289da` |
+    # | `:blurple` | `#5865f2` |
+    # | `:greyple` | `#99aab5` |
+    # | `:dark_theme` | `#36393f` |
+    # | `:fuchsia` | `#eb459e` |
     #
     # @param [Symbol] color A Discord color name.
     #

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

data/lib/discorb/embed.rb

@@ -93,18 +93,18 @@ module Discorb
     # @return [Hash] Converted embed.
     #
     def to_hash
-      {
-        title: @title,
-        description: @description,
-        url: @url,
-        timestamp: @timestamp&.iso8601,
-        color: @color&.to_i,
-        footer: @footer&.to_hash,
-        image: @image&.to_hash,
-        thumbnail: @thumbnail&.to_hash,
-        author: @author&.to_hash,
-        fields: @fields&.map { |f| f.to_hash },
-      }
+      ret = { type: "rich" }
+      ret[:title] = @title if @title
+      ret[:description] = @description if @description
+      ret[:url] = @url if @url
+      ret[:timestamp] = @timestamp&.iso8601 if @timestamp
+      ret[:color] = @color&.to_i if @color
+      ret[:footer] = @footer&.to_hash if @footer
+      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
     end
 
     #

data/lib/discorb/emoji.rb

@@ -6,6 +6,13 @@ module Discorb
   # Represents a Discord emoji.
   # @abstract
   class Emoji
+    def eql?(other)
+      other.is_a?(self.class) && other.to_uri == to_uri
+    end
+
+    def ==(other)
+      eql?(other)
+    end
   end
 
   # Represents a custom emoji in discord.
@@ -79,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
@@ -100,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.
   #
@@ -88,7 +94,7 @@ module Discorb
       @client.close!
       DiscorbError.instance_method(:initialize).bind(self).call(<<~MESSAGE)
         The client is banned from CloudFlare.
-        Hint: Try to increase the number of requests per second, e.g. Use sleep in between requests.
+        Hint: Try to decrease the number of requests per second, e.g. Use sleep in between requests.
       MESSAGE
     end
   end

data/lib/discorb/event.rb

@@ -11,17 +11,17 @@ module Discorb
     attr_reader :block
     # @return [Symbol] the event id.
     attr_reader :id
-    # @return [Hash] the event discriminator.
-    attr_reader :discriminator
+    # @return [Hash] the event metadata.
+    attr_reader :metadata
     # @return [Boolean] whether the event is once or not.
     attr_reader :once
     alias once? once
 
-    def initialize(block, id, discriminator)
+    def initialize(block, id, metadata)
       @block = block
       @id = id
-      @once = discriminator.fetch(:once, false)
-      @discriminator = discriminator
+      @once = metadata.fetch(:once, false)
+      @metadata = metadata
       @rescue = nil
     end
 

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

@@ -8,7 +8,7 @@ module Discorb
   # @abstract
   #
   module Extension
-    include Discorb::Command::Handler
+    include Discorb::ApplicationCommand::Handler
     undef setup_commands
 
     @events = {}
@@ -19,18 +19,18 @@ module Discorb
     #
     # @param [Symbol] event_name The name of the event.
     # @param [Symbol] id The id of the event. Used to delete the event.
-    # @param [Hash] discriminator Other discriminators.
+    # @param [Hash] metadata Other metadata.
     # @param [Proc] block The block to execute when the event is triggered.
     #
     # @return [Discorb::Event] The event.
     #
-    def event(event_name, id: nil, **discriminator, &block)
+    def event(event_name, id: nil, **metadata, &block)
       raise ArgumentError, "Event name must be a symbol" unless event_name.is_a?(Symbol)
       raise ArgumentError, "block must be a Proc" unless block.is_a?(Proc)
 
       @events[event_name] ||= []
-      discriminator[:extension] = self.name
-      @events[event_name] << Discorb::Event.new(block, id, discriminator)
+      metadata[:extension] = self.name
+      @events[event_name] << Discorb::Event.new(block, id, metadata)
     end
 
     #
@@ -38,18 +38,18 @@ module Discorb
     #
     # @param [Symbol] event_name The name of the event.
     # @param [Symbol] id The id of the event. Used to delete the event.
-    # @param [Hash] discriminator Other discriminators.
+    # @param [Hash] metadata Other metadata.
     # @param [Proc] block The block to execute when the event is triggered.
     #
     # @return [Discorb::Event] The event.
     #
-    def once_event(event_name, id: nil, **discriminator, &block)
-      event(event_name, id: id, once: true, **discriminator, &block)
+    def once_event(event_name, id: nil, **metadata, &block)
+      event(event_name, id: id, once: true, **metadata, &block)
     end
 
     # @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::ApplicationCommand::Command>] The commands of the extension.
     attr_reader :commands
     # @private
     attr_reader :bottom_commands

data/lib/discorb/gateway.rb

@@ -53,6 +53,12 @@ module Discorb
       attr_reader :member
       # @return [Discorb::UnicodeEmoji, Discorb::PartialEmoji] The emoji that was reacted with.
       attr_reader :emoji
+      # @macro client_cache
+      # @return [Discorb::Member, Discorb::User] The user or member who reacted.
+      attr_reader :fired_by
+
+      alias reactor fired_by
+      alias from fired_by
 
       # @!visibility private
       def initialize(client, data)
@@ -79,6 +85,8 @@ module Discorb
             end
         end
 
+        @fired_by = @member || @user || @client.users[data[:user_id]]
+
         @message = client.messages[data[:message_id]]
         @emoji = data[:emoji][:id].nil? ? UnicodeEmoji.new(data[:emoji][:name]) : PartialEmoji.new(data[:emoji])
       end
@@ -90,7 +98,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 +147,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 +199,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 +273,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
@@ -355,6 +363,9 @@ module Discorb
     class TypingStartEvent < GatewayEvent
       # @return [Discorb::Snowflake] The ID of the channel the user is typing in.
       attr_reader :user_id
+      # @macro client_cache
+      # @return [Discorb::Member] The member that is typing.
+      attr_reader :member
 
       # @!attribute [r] channel
       #   @macro client_cache
@@ -365,6 +376,9 @@ module Discorb
       # @!attribute [r] user
       #   @macro client_cache
       #   @return [Discorb::User] The user that is typing.
+      # @!attribute [r] fired_by
+      #   @macro client_cache
+      #   @return [Discorb::Member, Discorb::User] The member or user that started typing.
 
       # @!visibility private
       def initialize(client, data)
@@ -388,6 +402,12 @@ module Discorb
       def guild
         @client.guilds[@guild_id]
       end
+
+      def fired_by
+        @member || user
+      end
+
+      alias from fired_by
     end
 
     #
@@ -513,7 +533,6 @@ module Discorb
           case payload[:op]
           when 10
             @heartbeat_interval = data[:heartbeat_interval]
-            @tasks << handle_heartbeat(@heartbeat_interval)
             if @first
               payload = {
                 token: @token,
@@ -523,6 +542,13 @@ module Discorb
               }
               payload[:presence] = @identify_presence if @identify_presence
               send_gateway(2, **payload)
+              Async do
+                sleep 2
+                next unless @uncached_guilds.nil?
+
+                raise ClientError, "Failed to connect to gateway.\nHint: This usually means that your intents are invalid."
+                exit 1
+              end
             else
               payload = {
                 token: @token,
@@ -540,7 +566,7 @@ module Discorb
               connect_gateway(false)
             else
               @log.info "Connection is not resumable, reconnecting with opcode 2"
-              task.sleep(2)
+              sleep(2)
               @connection.close
               connect_gateway(true)
             end
@@ -555,7 +581,7 @@ module Discorb
 
       def handle_heartbeat(interval)
         Async do |task|
-          task.sleep((interval / 1000.0 - 1) * rand)
+          sleep((interval / 1000.0 - 1) * rand)
           loop do
             @heartbeat_before = Time.now.to_f
             @connection.write({ op: 1, d: @last_s }.to_json)
@@ -578,6 +604,12 @@ module Discorb
           @session_id = data[:session_id]
           @user = ClientUser.new(self, data[:user])
           @uncached_guilds = data[:guilds].map { |g| g[:id] }
+          if @uncached_guilds == [] or !@intents.guilds
+            @ready = true
+            dispatch(:ready)
+            @log.info("Successfully connected to Discord.")
+          end
+          @tasks << handle_heartbeat(@heartbeat_interval)
         when "GUILD_CREATE"
           if @uncached_guilds.include?(data[:id])
             Guild.new(self, data, true)
@@ -585,7 +617,7 @@ module Discorb
             if @uncached_guilds == []
               @ready = true
               dispatch(:ready)
-              @log.info("Guilds were cached")
+              @log.info("Successfully connected to Discord, and cached all guilds.")
             end
           elsif @guilds.has?(data[:id])
             @guilds[data[:id]].send(:_set_data, data)