discordrb 3.1.1 → 3.4.0

data/lib/discordrb/events/presence.rb

@@ -15,11 +15,16 @@ module Discordrb::Events
     # @return [Symbol] the new status.
     attr_reader :status
 
+    # @return [Hash<Symbol, Symbol>] the current online status (`:online`, `:idle` or `:dnd`) of the user
+    #   on various device types (`:desktop`, `:mobile`, or `:web`). The value will be `nil` if the user is offline or invisible.
+    attr_reader :client_status
+
     def initialize(data, bot)
       @bot = bot
 
       @user = bot.user(data['user']['id'].to_i)
       @status = data['status'].to_sym
+      @client_status = user.client_status
       @server = bot.server(data['guild_id'].to_i)
     end
   end
@@ -32,9 +37,10 @@ module Discordrb::Events
 
       [
         matches_all(@attributes[:from], event.user) do |a, e|
-          a == if a.is_a? String
+          a == case a
+               when String
                  e.name
-               elsif a.is_a? Fixnum
+               when Integer
                  e.id
                else
                  e
@@ -65,17 +71,22 @@ module Discordrb::Events
     # @return [String] the URL to the stream
     attr_reader :url
 
+    # @return [String] what the player is currently doing (ex. game being streamed)
+    attr_reader :details
+
     # @return [Integer] the type of play. 0 = game, 1 = Twitch
     attr_reader :type
 
     def initialize(data, bot)
       @bot = bot
 
+      @server = bot.server(data['guild_id'].to_i)
       @user = bot.user(data['user']['id'].to_i)
       @game = data['game'] ? data['game']['name'] : nil
-      @server = bot.server(data['guild_id'].to_i)
-      @url = data['game'] ? data['game']['url'] : nil
       @type = data['game'] ? data['game']['type'].to_i : nil
+      # Handle optional 'game' fields safely
+      @url = data['game'] && data['game']['url'] ? data['game']['url'] : nil
+      @details = data['game'] && data['game']['details'] ? data['game']['details'] : nil
     end
   end
 
@@ -87,27 +98,23 @@ module Discordrb::Events
 
       [
         matches_all(@attributes[:from], event.user) do |a, e|
-          a == if a.is_a? String
+          a == case a
+               when String
                  e.name
-               elsif a.is_a? Fixnum
+               when Integer
                  e.id
                else
                  e
                end
         end,
         matches_all(@attributes[:game], event.game) do |a, e|
-          a == if a.is_a? String
-                 e.name
-               else
-                 e
-               end
+          a == e
         end,
         matches_all(@attributes[:type], event.type) do |a, e|
-          a == if a.is_a? Integer
-                 e.type
-               else
-                 e
-               end
+          a == e
+        end,
+        matches_all(@attributes[:client_status], event.client_status) do |a, e|
+          e.slice(a.keys) == a
         end
       ].reduce(true, &:&)
     end

data/lib/discordrb/events/raw.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'discordrb/events/generic'
+
+# Event classes and handlers
+module Discordrb::Events
+  # Event raised when any dispatch is received
+  class RawEvent < Event
+    # @return [Symbol] the type of this dispatch.
+    attr_reader :type
+    alias_method :t, :type
+
+    # @return [Hash] the data of this dispatch.
+    attr_reader :data
+    alias_method :d, :data
+
+    def initialize(type, data, bot)
+      @type = type
+      @data = data
+      @bot = bot
+    end
+  end
+
+  # Event handler for {RawEvent}
+  class RawEventHandler < EventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? RawEvent
+
+      [
+        matches_all(@attributes[:type] || @attributes[:t], event.type) do |a, e|
+          if a.is_a? Regexp
+            a.match?(e)
+          else
+            e.to_s.casecmp(a.to_s).zero?
+          end
+        end
+      ].reduce(true, &:&)
+    end
+  end
+
+  # Event raised when an unknown dispatch is received
+  class UnknownEvent < RawEvent; end
+
+  # Event handler for {UnknownEvent}
+  class UnknownEventHandler < RawEventHandler; end
+end

data/lib/discordrb/events/reactions.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require 'discordrb/events/generic'
+require 'discordrb/data'
+
+module Discordrb::Events
+  # Generic superclass for events about adding and removing reactions
+  class ReactionEvent < Event
+    include Respondable
+
+    # @return [Emoji] the emoji that was reacted with.
+    attr_reader :emoji
+
+    # @!visibility private
+    attr_reader :message_id
+
+    def initialize(data, bot)
+      @bot = bot
+
+      @emoji = Discordrb::Emoji.new(data['emoji'], bot, nil)
+      @user_id = data['user_id'].to_i
+      @message_id = data['message_id'].to_i
+      @channel_id = data['channel_id'].to_i
+    end
+
+    # @return [User, Member] the user that reacted to this message, or member if a server exists.
+    def user
+      # Cache the user so we don't do requests all the time
+      @user ||= if server
+                  @server.member(@user_id)
+                else
+                  @bot.user(@user_id)
+                end
+    end
+
+    # @return [Message] the message that was reacted to.
+    def message
+      @message ||= channel.load_message(@message_id)
+    end
+
+    # @return [Channel] the channel that was reacted in.
+    def channel
+      @channel ||= @bot.channel(@channel_id)
+    end
+
+    # @return [Server, nil] the server that was reacted in. If reacted in a PM channel, it will be nil.
+    def server
+      @server ||= channel.server
+    end
+  end
+
+  # Generic superclass for event handlers pertaining to adding and removing reactions
+  class ReactionEventHandler < EventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? ReactionEvent
+
+      [
+        matches_all(@attributes[:emoji], event.emoji) do |a, e|
+          case a
+          when Integer
+            e.id == a
+          when String
+            e.name == a || e.name == a.delete(':') || e.id == a.resolve_id
+          else
+            e == a
+          end
+        end,
+        matches_all(@attributes[:message], event.message_id) do |a, e|
+          a == e
+        end,
+        matches_all(@attributes[:in], event.channel) do |a, e|
+          case a
+          when String
+            # Make sure to remove the "#" from channel names in case it was specified
+            a.delete('#') == e.name
+          when Integer
+            a == e.id
+          else
+            a == e
+          end
+        end,
+        matches_all(@attributes[:from], event.user) do |a, e|
+          case a
+          when String
+            a == e.name
+          when :bot
+            e.current_bot?
+          else
+            a == e
+          end
+        end
+      ].reduce(true, &:&)
+    end
+  end
+
+  # Event raised when somebody reacts to a message
+  class ReactionAddEvent < ReactionEvent; end
+
+  # Event handler for {ReactionAddEvent}
+  class ReactionAddEventHandler < ReactionEventHandler; end
+
+  # Event raised when somebody removes a reaction to a message
+  class ReactionRemoveEvent < ReactionEvent; end
+
+  # Event handler for {ReactionRemoveEvent}
+  class ReactionRemoveEventHandler < ReactionEventHandler; end
+
+  # Event raised when somebody removes all reactions from a message
+  class ReactionRemoveAllEvent < Event
+    include Respondable
+
+    # @!visibility private
+    attr_reader :message_id
+
+    def initialize(data, bot)
+      @bot = bot
+
+      @message_id = data['message_id'].to_i
+      @channel_id = data['channel_id'].to_i
+    end
+
+    # @return [Channel] the channel where the removal occurred.
+    def channel
+      @channel ||= @bot.channel(@channel_id)
+    end
+
+    # @return [Message] the message all reactions were removed from.
+    def message
+      @message ||= channel.load_message(@message_id)
+    end
+  end
+
+  # Event handler for {ReactionRemoveAllEvent}
+  class ReactionRemoveAllEventHandler < EventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? ReactionRemoveAllEvent
+
+      # No attributes yet as there is no property available on the event that doesn't involve doing a resolution request
+      [
+        matches_all(@attributes[:message], event.message_id) do |a, e|
+          a == e
+        end,
+        matches_all(@attributes[:in], event.channel) do |a, e|
+          case a
+          when String
+            # Make sure to remove the "#" from channel names in case it was specified
+            a.delete('#') == e.name
+          when Integer
+            a == e.id
+          else
+            a == e
+          end
+        end
+      ].reduce(true, &:&)
+    end
+  end
+end

data/lib/discordrb/events/roles.rb

@@ -12,6 +12,11 @@ module Discordrb::Events
     # @return [Server] the server on which a role got created
     attr_reader :server
 
+    # @!attribute [r] name
+    #   @return [String] this role's name
+    #   @see Role#name
+    delegate :name, to: :role
+
     def initialize(data, bot)
       @bot = bot
 
@@ -68,12 +73,8 @@ module Discordrb::Events
       return false unless event.is_a? ServerRoleDeleteEvent
 
       [
-        matches_all(@attributes[:name], event.name) do |a, e|
-          a == if a.is_a? String
-                 e.to_s
-               else
-                 e
-               end
+        matches_all(@attributes[:id], event.id) do |a, e|
+          a.resolve_id == e.resolve_id
         end
       ].reduce(true, &:&)
     end

data/lib/discordrb/events/typing.rb

@@ -5,10 +5,12 @@ require 'discordrb/events/generic'
 module Discordrb::Events
   # Event raised when a user starts typing
   class TypingEvent < Event
+    include Respondable
+
     # @return [Channel] the channel on which a user started typing.
     attr_reader :channel
 
-    # @return [Member] the user that started typing.
+    # @return [User, Member, Recipient] the user that started typing.
     attr_reader :user
     alias_method :member, :user
 
@@ -43,18 +45,20 @@ module Discordrb::Events
 
       [
         matches_all(@attributes[:in], event.channel) do |a, e|
-          if a.is_a? String
+          case a
+          when String
             a.delete('#') == e.name
-          elsif a.is_a? Fixnum
+          when Integer
             a == e.id
           else
             a == e
           end
         end,
         matches_all(@attributes[:from], event.user) do |a, e|
-          a == if a.is_a? String
+          a == case a
+               when String
                  e.name
-               elsif a.is_a? Fixnum
+               when Integer
                  e.id
                else
                  e

data/lib/discordrb/events/voice_server_update.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'discordrb/events/generic'
+require 'discordrb/data'
+
+module Discordrb::Events
+  # Event raised when a server's voice server is updating.
+  # Sent when initially connecting to voice and when a voice instance fails
+  # over to a new server.
+  # This event is exposed for use with library agnostic interfaces like telecom and
+  # lavalink.
+  class VoiceServerUpdateEvent < Event
+    # @return [String] The voice connection token
+    attr_reader :token
+
+    # @return [Server] The server this update is for.
+    attr_reader :server
+
+    # @return [String] The voice server host.
+    attr_reader :endpoint
+
+    def initialize(data, bot)
+      @bot = bot
+
+      @token = data['token']
+      @endpoint = data['endpoint']
+      @server = bot.server(data['guild_id'])
+    end
+  end
+
+  # Event handler for VoiceServerUpdateEvent
+  class VoiceServerUpdateEventHandler < EventHandler
+    def matches?(event)
+      return false unless event.is_a? VoiceServerUpdateEvent
+
+      [
+        matches_all(@attributes[:from], event.server) do |a, e|
+          a == if a.is_a? String
+                 e.name
+               else
+                 e
+               end
+        end
+      ]
+    end
+  end
+end

data/lib/discordrb/events/voice_state_update.rb

@@ -8,7 +8,10 @@ module Discordrb::Events
   class VoiceStateUpdateEvent < Event
     attr_reader :user, :token, :suppress, :session_id, :self_mute, :self_deaf, :mute, :deaf, :server, :channel
 
-    def initialize(data, bot)
+    # @return [Channel, nil] the old channel this user was on, or nil if the user is newly joining voice.
+    attr_reader :old_channel
+
+    def initialize(data, old_channel_id, bot)
       @bot = bot
 
       @token = data['token']
@@ -22,6 +25,7 @@ module Discordrb::Events
       return unless @server
 
       @channel = bot.channel(data['channel_id'].to_i) if data['channel_id']
+      @old_channel = bot.channel(old_channel_id) if old_channel_id
       @user = bot.user(data['user_id'].to_i)
     end
   end
@@ -34,46 +38,62 @@ module Discordrb::Events
 
       [
         matches_all(@attributes[:from], event.user) do |a, e|
-          a == if a.is_a? String
+          a == case a
+               when String
                  e.name
-               elsif a.is_a? Integer
+               when Integer
                  e.id
                else
                  e
                end
         end,
         matches_all(@attributes[:mute], event.mute) do |a, e|
-          a == if a.is_a?(TrueClass) || a.is_a?(FalseClass)
+          a == if a.is_a? String
                  e.to_s
                else
                  e
                end
         end,
         matches_all(@attributes[:deaf], event.deaf) do |a, e|
-          a == if a.is_a?(TrueClass) || a.is_a?(FalseClass)
+          a == if a.is_a? String
                  e.to_s
                else
                  e
                end
         end,
         matches_all(@attributes[:self_mute], event.self_mute) do |a, e|
-          a == if a.is_a?(TrueClass) || a.is_a?(FalseClass)
+          a == if a.is_a? String
                  e.to_s
                else
                  e
                end
         end,
         matches_all(@attributes[:self_deaf], event.self_deaf) do |a, e|
-          a == if a.is_a?(TrueClass) || a.is_a?(FalseClass)
+          a == if a.is_a? String
                  e.to_s
                else
                  e
                end
         end,
         matches_all(@attributes[:channel], event.channel) do |a, e|
-          a == if a.is_a? String
+          next unless e # Don't bother if the channel is nil
+
+          a == case a
+               when String
+                 e.name
+               when Integer
+                 e.id
+               else
+                 e
+               end
+        end,
+        matches_all(@attributes[:old_channel], event.old_channel) do |a, e|
+          next unless e # Don't bother if the channel is nil
+
+          a == case a
+               when String
                  e.name
-               elsif a.is_a? Fixnum
+               when Integer
                  e.id
                else
                  e