onyxcord 1.1.0

data/lib/onyxcord/events/scheduled_events.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+require 'onyxcord/data'
+require 'onyxcord/events/generic'
+
+module OnyxCord::Events
+  # Generic superclass for scheduled events.
+  class ScheduledEventEvent < Event
+    # @return [Server] the server associated with the event.
+    attr_reader :server
+
+    # @return [ScheduledEvent] the scheduled event associated with the event.
+    attr_reader :scheduled_event
+
+    # @!visibility private
+    def initialize(data, bot)
+      @bot = bot
+      @server = bot.server(data['guild_id'].to_i)
+      @scheduled_event = @server&.scheduled_event(data['id'].to_i)
+    end
+  end
+
+  # Raised whenever a scheduled event is created.
+  class ScheduledEventCreateEvent < ScheduledEventEvent; end
+
+  # Raised whenever a scheduled event is updated.
+  class ScheduledEventUpdateEvent < ScheduledEventEvent; end
+
+  # Raised whenever a scheduled event is deleted.
+  class ScheduledEventDeleteEvent < ScheduledEventEvent
+    # @!visibility private
+    def initialize(data, bot)
+      @bot = bot
+      @server = bot.server(data['guild_id'].to_i)
+      @scheduled_event = OnyxCord::ScheduledEvent.new(data, @server, @bot)
+    end
+  end
+
+  # Generic superclass for scheduled event user events.
+  class ScheduledEventUserEvent < Event
+    # @!visibility private
+    attr_reader :user_id
+
+    # @!visibility private
+    attr_reader :server_id
+
+    # @!visibility private
+    attr_reader :scheduled_event_id
+
+    # @!visibility private
+    def initialize(data, bot)
+      @bot = bot
+      @user_id = data['user_id'].to_i
+      @server_id = data['guild_id'].to_i
+      @scheduled_event_id = data['guild_scheduled_event_id'].to_i
+    end
+
+    # Get the server the scheduled event in question is from.
+    # @return [Server] the server the scheduled event is associated with.
+    def server
+      @bot.server(@server_id)
+    end
+
+    # Get the scheduled event that the user was added to or removed from.
+    # @return [ScheduledEvent] the scheduled event that the user was actioned on.
+    def scheduled_event
+      server.scheduled_event(@scheduled_event_id)
+    end
+
+    # Get the user that was added to or removed from the scheduled event.
+    # @return [Member, User] the server member that was added to or removed from the
+    #   scheduled event, or a user if the member cannot be accessed by the bot.
+    def member
+      server.member(@user_id) || @bot.user(@user_id)
+    end
+
+    alias_method :user, :member
+  end
+
+  # Raised whenever a user is added to a scheduled event.
+  class ScheduledEventUserAddEvent < ScheduledEventUserEvent; end
+
+  # Raised whenever a user is removed from a scheduled event.
+  class ScheduledEventUserRemoveEvent < ScheduledEventUserEvent; end
+
+  # Generic event handler for scheduled event.
+  class ScheduledEventEventHandler < EventHandler
+    # @!visibility private
+    def matches?(event)
+      # Check for the proper event type.
+      return false unless event.is_a?(ScheduledEventEvent)
+
+      [
+        matches_all(@attributes[:server], event.server) do |a, e|
+          a&.resolve_id == e&.resolve_id
+        end,
+
+        matches_all(@attributes[:id], event.scheduled_event) do |a, e|
+          a&.resolve_id == e&.resolve_id
+        end,
+
+        matches_all(@attributes[:creator], event.scheduled_event.creator) do |a, e|
+          a&.resolve_id == e&.resolve_id
+        end,
+
+        matches_all(@attributes[:channel], event.scheduled_event.channel) do |a, e|
+          a&.resolve_id == e&.resolve_id
+        end,
+
+        matches_all(@attributes[:entity_id], event.scheduled_event.entity_id) do |a, e|
+          a&.resolve_id == e&.resolve_id
+        end,
+
+        matches_all(@attributes[:entity_type], event.scheduled_event.entity_type) do |a, e|
+          case a
+          when Symbol, String
+            OnyxCord::ScheduledEvent::ENTITY_TYPES[a.to_sym] == e
+          else
+            a == e
+          end
+        end,
+
+        matches_all(@attributes[:status], event.scheduled_event.status) do |a, e|
+          case a
+          when Symbol, String
+            OnyxCord::ScheduledEvent::STATUSES[a.to_sym] == e
+          else
+            a == e
+          end
+        end
+      ].reduce(true, &:&)
+    end
+  end
+
+  # Event handler for :GUILD_SCHEDULED_EVENT_CREATE events.
+  class ScheduledEventCreateEventHandler < ScheduledEventEventHandler; end
+
+  # Event handler for :GUILD_SCHEDULED_EVENT_UPDATE events.
+  class ScheduledEventUpdateEventHandler < ScheduledEventEventHandler; end
+
+  # Event handler for :GUILD_SCHEDULED_EVENT_DELETE events.
+  class ScheduledEventDeleteEventHandler < ScheduledEventEventHandler; end
+
+  # Generic event handler for scheduled event user events.
+  class ScheduledEventUserEventHandler < EventHandler
+    # @!visibility private
+    def matches?(event)
+      return false unless event.is_a?(ScheduledEventUserEvent)
+
+      [
+        matches_all(@attributes[:user], event.user_id) do |a, e|
+          a.resolve_id == e.resolve_id
+        end,
+
+        matches_all(@attributes[:server], event.server_id) do |a, e|
+          a.resolve_id == e.resolve_id
+        end,
+
+        matches_all(@attributes[:scheduled_event], event.scheduled_event_id) do |a, e|
+          a.resolve_id == e.resolve_id
+        end
+      ].reduce(true, &:&)
+    end
+  end
+
+  # Event handler for :GUILD_SCHEDULED_EVENT_USER_ADD events.
+  class ScheduledEventUserAddEventHandler < ScheduledEventUserEventHandler; end
+
+  # Event handler for :GUILD_SCHEDULED_EVENT_USER_REMOVE events.
+  class ScheduledEventUserRemoveEventHandler < ScheduledEventUserEventHandler; end
+end

data/lib/onyxcord/events/threads.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# Generic subclass for threads
+module OnyxCord::Events
+  # Raised when a thread is created
+  class ThreadCreateEvent < Event
+    # @return [Channel] the thread in question.
+    attr_reader :thread
+
+    delegate :name, :server, :owner, :parent_channel, :thread_metadata, to: :thread
+
+    # @!visibility private
+    def initialize(data, bot)
+      @bot = bot
+      @thread = data.is_a?(OnyxCord::Channel) ? data : bot.channel(data['id'].to_i)
+    end
+  end
+
+  # Event handler for ChannelCreateEvent
+  class ThreadCreateEventHandler < EventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? ThreadCreateEvent
+
+      [
+        matches_all(@attributes[:name], event.name) do |a, e|
+          a == if a.is_a? String
+                 e.to_s
+               else
+                 e
+               end
+        end,
+        matches_all(@attributes[:server], event.server) do |a, e|
+          a.resolve_id == e.resolve_id
+        end,
+        matches_all(@attributes[:invitable], event.thread.invitable) do |a, e|
+          a == e
+        end,
+        matches_all(@attributes[:owner], event.thread.owner) do |a, e|
+          a.resolve_id == e.resolve_id
+        end,
+        matches_all(@attributes[:channel], event.thread.parent) do |a, e|
+          a.resolve_id == e.resolve_id
+        end
+      ].reduce(true, &:&)
+    end
+  end
+
+  # Raised when a thread is updated (e.g. name changes)
+  class ThreadUpdateEvent < ThreadCreateEvent; end
+
+  # Event handler for ThreadUpdateEvent
+  class ThreadUpdateEventHandler < ThreadCreateEventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? ThreadUpdateEvent
+
+      super
+    end
+  end
+
+  # Raised when members are added or removed from a thread.
+  class ThreadMembersUpdateEvent < Event
+    # @return [Channel]
+    attr_reader :thread
+
+    # @return [Array<Integer>]
+    attr_reader :removed_member_ids
+
+    # @return [Integer]
+    attr_reader :member_count
+
+    delegate :name, :server, :owner, :parent_channel, :thread_metadata, to: :thread
+
+    # @!visibility private
+    def initialize(data, bot)
+      @bot = bot
+      @server = bot.server(data['guild_id'].to_i) if data['guild_id']
+      @thread = data.is_a?(OnyxCord::Channel) ? data : bot.channel(data['id'].to_i)
+      @added_member_ids = data['added_members']&.map { |m| m['user_id']&.to_i } || []
+      @removed_member_ids = data['removed_member_ids']&.map(&:resolve_id) || []
+      @member_count = data['member_count']
+    end
+  end
+
+  # @return [Array<Member, User>] the members that were added to the thread
+  def added_members
+    @added_members ||= @added_member_ids&.map { |id| @server&.member(id) || @bot.user(id) }
+  end
+
+  # Event handler for ThreadMembersUpdateEvent
+  class ThreadMembersUpdateEventHandler < ThreadCreateEventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? ThreadMembersUpdateEvent
+
+      super
+    end
+  end
+end

data/lib/onyxcord/events/typing.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'onyxcord/events/generic'
+
+module OnyxCord::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 [User, Member, Recipient] the user that started typing.
+    attr_reader :user
+    alias_method :member, :user
+
+    # @return [Time] when the typing happened.
+    attr_reader :timestamp
+
+    # @!visibility private
+    def initialize(data, bot)
+      @bot = bot
+
+      @user_id = data['user_id'].to_i
+
+      @channel_id = data['channel_id'].to_i
+      @channel = bot.channel(@channel_id)
+
+      @user = if channel.pm?
+                channel.recipient
+              elsif channel.group?
+                bot.user(@user_id)
+              else
+                bot.member(@channel.server.id, @user_id)
+              end
+
+      @timestamp = Time.at(data['timestamp'].to_i)
+    end
+  end
+
+  # Event handler for TypingEvent
+  class TypingEventHandler < EventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? TypingEvent
+
+      [
+        matches_all(@attributes[:in], event.channel) do |a, e|
+          case a
+          when String
+            a.delete('#') == e.name
+          when Integer
+            a == e.id
+          else
+            a == e
+          end
+        end,
+        matches_all(@attributes[:from], event.user) do |a, e|
+          a == case a
+               when String
+                 e.name
+               when Integer
+                 e.id
+               else
+                 e
+               end
+        end,
+        matches_all(@attributes[:after], event.timestamp) { |a, e| a > e },
+        matches_all(@attributes[:before], event.timestamp) { |a, e| a < e }
+      ].reduce(true, &:&)
+    end
+  end
+end

data/lib/onyxcord/events/voice_server_update.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'onyxcord/events/generic'
+require 'onyxcord/data'
+
+module OnyxCord::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
+
+    # @!visibility private
+    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/onyxcord/events/voice_state_update.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require 'onyxcord/events/generic'
+require 'onyxcord/data'
+
+module OnyxCord::Events
+  # Event raised when a user's voice state updates
+  class VoiceStateUpdateEvent < Event
+    attr_reader :user, :token, :suppress, :session_id, :self_mute, :self_deaf, :mute, :deaf, :server, :channel
+
+    # @return [Channel, nil] the old channel this user was on, or nil if the user is newly joining voice.
+    attr_reader :old_channel
+
+    # @!visibility private
+    def initialize(data, old_channel_id, bot)
+      @bot = bot
+
+      @token = data['token']
+      @suppress = data['suppress']
+      @session_id = data['session_id']
+      @self_mute = data['self_mute']
+      @self_deaf = data['self_deaf']
+      @mute = data['mute']
+      @deaf = data['deaf']
+      @server = bot.server(data['guild_id'].to_i)
+      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
+
+  # Event handler for VoiceStateUpdateEvent
+  class VoiceStateUpdateEventHandler < EventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? VoiceStateUpdateEvent
+
+      [
+        matches_all(@attributes[:from], event.user) do |a, e|
+          a == case a
+               when String
+                 e.name
+               when Integer
+                 e.id
+               else
+                 e
+               end
+        end,
+        matches_all(@attributes[:mute], event.mute) do |a, e|
+          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? String
+                 e.to_s
+               else
+                 e
+               end
+        end,
+        matches_all(@attributes[:self_mute], event.self_mute) do |a, e|
+          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? String
+                 e.to_s
+               else
+                 e
+               end
+        end,
+        matches_all(@attributes[:channel], event.channel) do |a, e|
+          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
+               when Integer
+                 e.id
+               else
+                 e
+               end
+        end
+      ].reduce(true, &:&)
+    end
+  end
+end

data/lib/onyxcord/events/webhooks.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'onyxcord/events/generic'
+require 'onyxcord/data'
+
+module OnyxCord::Events
+  # Event raised when a webhook is updated
+  class WebhookUpdateEvent < Event
+    # @return [Server] the server where the webhook updated
+    attr_reader :server
+
+    # @return [Channel] the channel the webhook is associated to
+    attr_reader :channel
+
+    # @!visibility private
+    def initialize(data, bot)
+      @bot = bot
+
+      @server = bot.server(data['guild_id'].to_i)
+      @channel = bot.channel(data['channel_id'].to_i)
+    end
+  end
+
+  # Event handler for {WebhookUpdateEvent}
+  class WebhookUpdateEventHandler < EventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? WebhookUpdateEvent
+
+      [
+        matches_all(@attributes[:server], event.server) do |a, e|
+          a == case a
+               when String
+                 e.name
+               when Integer
+                 e.id
+               else
+                 e
+               end
+        end,
+        matches_all(@attributes[:channel], 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[:webhook], event) do |a, e|
+          a == case a
+               when String
+                 e.name
+               when Integer
+                 e.id
+               else
+                 e
+               end
+        end
+      ].reduce(true, &:&)
+    end
+  end
+end