onyxcord 2.1.0 → 3.2.1

data/lib/onyxcord/events/handlers/scheduled_events.rb

@@ -0,0 +1,243 @@
+# frozen_string_literal: true
+
+module OnyxCord
+  module EventContainer
+    # This **event** is raised whenever a user votes on a poll.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, User, Member] :user A user to match against.
+    # @option attributes [String, Integer, Channel] :channel A channel to match against.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @option attributes [String, Integer, Message] :message A message to match against.
+    # @option attributes [String, Integer, Answer] :answer A poll answer to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [PollVoteAddEvent] The event that was raised.
+    # @return [PollVoteAddEventHandler] The event handler that was registered.
+    def poll_vote_add(attributes = {}, &block)
+      register_event(PollVoteAddEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever a user removes their vote on a poll.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, User, Member] :user A user to match against.
+    # @option attributes [String, Integer, Channel] :channel A channel to match against.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @option attributes [String, Integer, Message] :message A message to match against.
+    # @option attributes [String, Integer, Answer] :answer A poll answer to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [PollVoteRemoveEvent] The event that was raised.
+    # @return [PollVoteRemoveEventHandler] The event handler that was registered.
+
+    # This **event** is raised whenever a user removes their vote on a poll.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, User, Member] :user A user to match against.
+    # @option attributes [String, Integer, Channel] :channel A channel to match against.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @option attributes [String, Integer, Message] :message A message to match against.
+    # @option attributes [String, Integer, Answer] :answer A poll answer to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [PollVoteRemoveEvent] The event that was raised.
+    # @return [PollVoteRemoveEventHandler] The event handler that was registered.
+    def poll_vote_remove(attributes = {}, &block)
+      register_event(PollVoteRemoveEvent, attributes, block)
+    end
+
+    # This **event** is raised when a scheduled event is created.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer] :server Matches the scheduled event's server.
+    # @option attributes [String, Integer, ScheduledEvent] :id Matches the scheduled event.
+    # @option attributes [String, Integer, User, Member] :creator Matches the scheduled event's creator.
+    # @option attributes [String, Integer, Channel] :channel Matches the scheduled event's channel.
+    # @option attributes [Integer, Symbol, String] :status Matches the status of the scheduled event.
+    # @option attributes [Integer, String] :entity_id Matches the entity ID of the scheduled event.
+    # @option attributes [Integer, Symbol, String] :entity_type Matches the entity type of the scheduled event.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ScheduledEventCreateEvent] The event that was raised.
+    # @return [ScheduledEventCreateEventHandler] the event handler that was registered.
+
+    # This **event** is raised when a scheduled event is created.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer] :server Matches the scheduled event's server.
+    # @option attributes [String, Integer, ScheduledEvent] :id Matches the scheduled event.
+    # @option attributes [String, Integer, User, Member] :creator Matches the scheduled event's creator.
+    # @option attributes [String, Integer, Channel] :channel Matches the scheduled event's channel.
+    # @option attributes [Integer, Symbol, String] :status Matches the status of the scheduled event.
+    # @option attributes [Integer, String] :entity_id Matches the entity ID of the scheduled event.
+    # @option attributes [Integer, Symbol, String] :entity_type Matches the entity type of the scheduled event.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ScheduledEventCreateEvent] The event that was raised.
+    # @return [ScheduledEventCreateEventHandler] the event handler that was registered.
+    def scheduled_event_create(attributes = {}, &block)
+      register_event(ScheduledEventCreateEvent, attributes, block)
+    end
+
+    # This **event** is raised when a scheduled event is updated.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Server] :server Matches the scheduled event's server.
+    # @option attributes [String, Integer, ScheduledEvent] :id Matches the scheduled event.
+    # @option attributes [String, Integer, User, Member] :creator Matches the scheduled event's creator.
+    # @option attributes [String, Integer, Channel] :channel Matches the scheduled event's channel.
+    # @option attributes [Integer, Symbol, String] :status Matches the status of the scheduled event.
+    # @option attributes [Integer, String] :entity_id Matches the entity ID of the scheduled event.
+    # @option attributes [Integer, Symbol, String] :entity_type Matches the entity type of the scheduled event.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ScheduledEventUpdateEvent] The event that was raised.
+    # @return [ScheduledEventUpdateEventHandler] the event handler that was registered.
+
+    # This **event** is raised when a scheduled event is updated.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Server] :server Matches the scheduled event's server.
+    # @option attributes [String, Integer, ScheduledEvent] :id Matches the scheduled event.
+    # @option attributes [String, Integer, User, Member] :creator Matches the scheduled event's creator.
+    # @option attributes [String, Integer, Channel] :channel Matches the scheduled event's channel.
+    # @option attributes [Integer, Symbol, String] :status Matches the status of the scheduled event.
+    # @option attributes [Integer, String] :entity_id Matches the entity ID of the scheduled event.
+    # @option attributes [Integer, Symbol, String] :entity_type Matches the entity type of the scheduled event.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ScheduledEventUpdateEvent] The event that was raised.
+    # @return [ScheduledEventUpdateEventHandler] the event handler that was registered.
+    def scheduled_event_update(attributes = {}, &block)
+      register_event(ScheduledEventUpdateEvent, attributes, block)
+    end
+
+    # This **event** is raised when a scheduled event is deleted.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Server] :server Matches the scheduled event's server.
+    # @option attributes [String, Integer, ScheduledEvent] :id Matches the scheduled event.
+    # @option attributes [String, Integer, User, Member] :creator Matches the scheduled event's creator.
+    # @option attributes [String, Integer, Channel] :channel Matches the scheduled event's channel.
+    # @option attributes [Integer, Symbol, String] :status Matches the status of the scheduled event.
+    # @option attributes [Integer, String] :entity_id Matches the entity ID of the scheduled event.
+    # @option attributes [Integer, Symbol, String] :entity_type Matches the entity type of the scheduled event.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ScheduledEventDeleteEvent] The event that was raised.
+    # @return [ScheduledEventDeleteEventHandler] the event handler that was registered.
+
+    # This **event** is raised when a scheduled event is deleted.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Server] :server Matches the scheduled event's server.
+    # @option attributes [String, Integer, ScheduledEvent] :id Matches the scheduled event.
+    # @option attributes [String, Integer, User, Member] :creator Matches the scheduled event's creator.
+    # @option attributes [String, Integer, Channel] :channel Matches the scheduled event's channel.
+    # @option attributes [Integer, Symbol, String] :status Matches the status of the scheduled event.
+    # @option attributes [Integer, String] :entity_id Matches the entity ID of the scheduled event.
+    # @option attributes [Integer, Symbol, String] :entity_type Matches the entity type of the scheduled event.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ScheduledEventDeleteEvent] The event that was raised.
+    # @return [ScheduledEventDeleteEventHandler] the event handler that was registered.
+    def scheduled_event_delete(attributes = {}, &block)
+      register_event(ScheduledEventDeleteEvent, attributes, block)
+    end
+
+    # This **event** is raised when a user is added to a scheduled event.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Server] :server Matches the scheduled event's server.
+    # @option attributes [String, Integer, ScheduledEvent] :scheduled_event Matches the scheduled event.
+    # @option attributes [String, Integer, User, Member] :user Matches the user that was added.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ScheduledEventUserAddEvent] The event that was raised.
+    # @return [ScheduledEventUserAddEventHandler] the event handler that was registered.
+
+    # This **event** is raised when a user is added to a scheduled event.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Server] :server Matches the scheduled event's server.
+    # @option attributes [String, Integer, ScheduledEvent] :scheduled_event Matches the scheduled event.
+    # @option attributes [String, Integer, User, Member] :user Matches the user that was added.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ScheduledEventUserAddEvent] The event that was raised.
+    # @return [ScheduledEventUserAddEventHandler] the event handler that was registered.
+    def scheduled_event_user_add(attributes = {}, &block)
+      register_event(ScheduledEventUserAddEvent, attributes, block)
+    end
+
+    # This **event** is raised when a user is removed from a scheduled event.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Server] :server Matches the scheduled event's server.
+    # @option attributes [String, Integer, ScheduledEvent] :scheduled_event Matches the scheduled event.
+    # @option attributes [String, Integer, User, Member] :user Matches the user that was removed.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ScheduledEventUserRemoveEvent] The event that was raised.
+    # @return [ScheduledEventUserRemoveEventHandler] the event handler that was registered.
+
+    # This **event** is raised when a user is removed from a scheduled event.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Server] :server Matches the scheduled event's server.
+    # @option attributes [String, Integer, ScheduledEvent] :scheduled_event Matches the scheduled event.
+    # @option attributes [String, Integer, User, Member] :user Matches the user that was removed.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ScheduledEventUserRemoveEvent] The event that was raised.
+    # @return [ScheduledEventUserRemoveEventHandler] the event handler that was registered.
+    def scheduled_event_user_remove(attributes = {}, &block)
+      register_event(ScheduledEventUserRemoveEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an integration is added to a server.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Integration] :id An integration to match against.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @option attributes [String, Integer, Application] :application An application to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [IntegrationCreateEvent] The event that was raised.
+    # @return [IntegrationCreateEventHandler] The event handler that was registered.
+
+    # This **event** is raised whenever an integration is added to a server.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Integration] :id An integration to match against.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @option attributes [String, Integer, Application] :application An application to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [IntegrationCreateEvent] The event that was raised.
+    # @return [IntegrationCreateEventHandler] The event handler that was registered.
+    def integration_create(attributes = {}, &block)
+      register_event(IntegrationCreateEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an integration is updated in a server.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Integration] :id An integration to match against.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @option attributes [String, Integer, Application] :application An application to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [IntegrationUpdateEvent] The event that was raised.
+    # @return [IntegrationUpdateEventHandler] The event handler that was registered.
+
+    # This **event** is raised whenever an integration is updated in a server.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Integration] :id An integration to match against.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @option attributes [String, Integer, Application] :application An application to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [IntegrationUpdateEvent] The event that was raised.
+    # @return [IntegrationUpdateEventHandler] The event handler that was registered.
+    def integration_update(attributes = {}, &block)
+      register_event(IntegrationUpdateEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an integration is removed from a server.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Integration] :id An integration to match against.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @option attributes [String, Integer, Application] :application An application to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [IntegrationDeleteEvent] The event that was raised.
+    # @return [IntegrationDeleteEventHandler] The event handler that was registered.
+
+    # This **event** is raised whenever an integration is removed from a server.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Integration] :id An integration to match against.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @option attributes [String, Integer, Application] :application An application to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [IntegrationDeleteEvent] The event that was raised.
+    # @return [IntegrationDeleteEventHandler] The event handler that was registered.
+    def integration_delete(attributes = {}, &block)
+      register_event(IntegrationDeleteEvent, attributes, block)
+    end
+
+    # This **event** is raised for every dispatch received over the gateway, whether supported by onyxcord or not.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Symbol, Regexp] :type Matches the event type of the dispatch.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [RawEvent] The event that was raised.
+    # @return [RawEventHandler] The event handler that was registered.
+  end
+end

data/lib/onyxcord/events/handlers/voice.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module OnyxCord
+  module EventContainer
+    # This **event** is raised when a user's voice state changes. This includes when a user joins, leaves, or
+    # moves between voice channels, as well as their mute and deaf status for themselves and on the server.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, User] :from Matches the user that raised the event.
+    # @option attributes [String, Integer, Channel] :channel Matches the voice channel the user has joined.
+    # @option attributes [String, Integer, Channel] :old_channel Matches the voice channel the user was in previously.
+    # @option attributes [true, false] :mute Matches whether or not the user is muted server-wide.
+    # @option attributes [true, false] :deaf Matches whether or not the user is deafened server-wide.
+    # @option attributes [true, false] :self_mute Matches whether or not the user is muted by the bot.
+    # @option attributes [true, false] :self_deaf Matches whether or not the user is deafened by the bot.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [VoiceStateUpdateEvent] The event that was raised.
+    # @return [VoiceStateUpdateEventHandler] the event handler that was registered.
+    def voice_state_update(attributes = {}, &block)
+      register_event(VoiceStateUpdateEvent, attributes, block)
+    end
+
+    # This **event** is raised when first connecting to a server's voice channel.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, User] :from Matches the server that the update is for.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [VoiceServerUpdateEvent] The event that was raised.
+    # @return [VoiceServerUpdateEventHandler] The event handler that was registered.
+
+    # This **event** is raised when first connecting to a server's voice channel.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, User] :from Matches the server that the update is for.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [VoiceServerUpdateEvent] The event that was raised.
+    # @return [VoiceServerUpdateEventHandler] The event handler that was registered.
+    def voice_server_update(attributes = {}, &block)
+      register_event(VoiceServerUpdateEvent, attributes, block)
+    end
+
+    # This **event** is raised when a new user joins a server.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String] :username Matches the username of the joined user.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ServerMemberAddEvent] The event that was raised.
+    # @return [ServerMemberAddEventHandler] the event handler that was registered.
+  end
+end

data/lib/onyxcord/events/integration/base.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'onyxcord/models'
+require 'onyxcord/events/generic'
+
+module OnyxCord::Events
+  # Generic superclass for integration events.
+  class IntegrationEvent < Event
+    # @return [Server] the server associated with the event.
+    attr_reader :server
+
+    # @return [Integration] the integration associated with the event.
+    attr_reader :integration
+
+    # @!visibility private
+    def initialize(data, bot)
+      @bot = bot
+      @server = bot.server(data['guild_id'].to_i)
+      @integration = OnyxCord::Integration.new(data, @bot, @server)
+    end
+  end
+
+  # Generic event handler for integration events.
+  class IntegrationEventHandler < EventHandler
+    # @!visibility private
+    def matches?(event)
+      # Check for the proper event type.
+      return false unless event.is_a?(IntegrationEvent)
+
+      [
+        matches_all(@attributes[:server], event.server) do |a, e|
+          a&.resolve_id == e&.resolve_id
+        end,
+
+        matches_all(@attributes[:id], event.integration) do |a, e|
+          a&.resolve_id == e&.resolve_id
+        end,
+
+        matches_all(@attributes[:application], event.integration) do |a, e|
+          a&.resolve_id == e.application&.resolve_id
+        end
+      ].reduce(true, &:&)
+    end
+  end
+end

data/lib/onyxcord/events/integration/create.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'onyxcord/events/integration/base'
+
+module OnyxCord::Events
+  # Raised whenever an integration is created.
+  class IntegrationCreateEvent < IntegrationEvent; end
+
+  # Event handler for INTEGRATION_CREATE events.
+  class IntegrationCreateEventHandler < IntegrationEventHandler; end
+end

data/lib/onyxcord/events/integration/delete.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'onyxcord/events/generic'
+
+module OnyxCord::Events
+  # Raised whenever an integration is deleted.
+  class IntegrationDeleteEvent < Event
+    # @return [Server] the server associated with the event.
+    attr_reader :server
+
+    # @return [Integer] the ID of the integration that was removed.
+    attr_reader :integration_id
+
+    # @return [Integer, nil] the ID of the application that was removed.
+    attr_reader :application_id
+
+    # @!visibility private
+    def initialize(data, bot)
+      @bot = bot
+      @server = bot.server(data['guild_id'].to_i)
+      @integration_id = data['id'].to_i
+      @application_id = data['application_id']&.to_i
+    end
+  end
+
+  # Event handler for INTEGRATION_DELETE events.
+  class IntegrationDeleteEventHandler < EventHandler
+    # @!visibility private
+    def matches?(event)
+      # Check for the proper event type.
+      return false unless event.is_a?(IntegrationDeleteEvent)
+
+      [
+        matches_all(@attributes[:server], event.server) do |a, e|
+          a&.resolve_id == e&.resolve_id
+        end,
+
+        matches_all(@attributes[:id], event.integration_id) do |a, e|
+          a&.resolve_id == e&.resolve_id
+        end,
+
+        matches_all(@attributes[:application], event.application_id) do |a, e|
+          a&.resolve_id == e&.resolve_id
+        end
+      ].reduce(true, &:&)
+    end
+  end
+end

data/lib/onyxcord/events/integration/update.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'onyxcord/events/integration/base'
+
+module OnyxCord::Events
+  # Raised whenever an integration is updated.
+  class IntegrationUpdateEvent < IntegrationEvent; end
+
+  # Event handler for INTEGRATION_UPDATE events.
+  class IntegrationUpdateEventHandler < IntegrationEventHandler; end
+end

data/lib/onyxcord/events/integrations.rb

@@ -1,100 +1,6 @@
 # frozen_string_literal: true
 
-require 'onyxcord/data'
-require 'onyxcord/events/generic'
-
-module OnyxCord::Events
-  # Generic superclass for integration events.
-  class IntegrationEvent < Event
-    # @return [Server] the server associated with the event.
-    attr_reader :server
-
-    # @return [Integration] the integration associated with the event.
-    attr_reader :integration
-
-    # @!visibility private
-    def initialize(data, bot)
-      @bot = bot
-      @server = bot.server(data['guild_id'].to_i)
-      @integration = OnyxCord::Integration.new(data, @bot, @server)
-    end
-  end
-
-  # Raised whenever an integration is created.
-  class IntegrationCreateEvent < IntegrationEvent; end
-
-  # Raised whenever an integration is updated.
-  class IntegrationUpdateEvent < IntegrationEvent; end
-
-  # Raised whenever an integration is deleted.
-  class IntegrationDeleteEvent < Event
-    # @return [Server] the server associated with the event.
-    attr_reader :server
-
-    # @return [Integer] the ID of the integration that was removed.
-    attr_reader :integration_id
-
-    # @return [Integer, nil] the ID of the application that was removed.
-    attr_reader :application_id
-
-    # @!visibility private
-    def initialize(data, bot)
-      @bot = bot
-      @server = bot.server(data['guild_id'].to_i)
-      @integration_id = data['id'].to_i
-      @application_id = data['application_id']&.to_i
-    end
-  end
-
-  # Generic event handler for integration events.
-  class IntegrationEventHandler < EventHandler
-    # @!visibility private
-    def matches?(event)
-      # Check for the proper event type.
-      return false unless event.is_a?(IntegrationEvent)
-
-      [
-        matches_all(@attributes[:server], event.server) do |a, e|
-          a&.resolve_id == e&.resolve_id
-        end,
-
-        matches_all(@attributes[:id], event.integration) do |a, e|
-          a&.resolve_id == e&.resolve_id
-        end,
-
-        matches_all(@attributes[:application], event.integration) do |a, e|
-          a&.resolve_id == e.application&.resolve_id
-        end
-      ].reduce(true, &:&)
-    end
-  end
-
-  # Event handler for INTEGRATION_CREATE events.
-  class IntegrationCreateEventHandler < IntegrationEventHandler; end
-
-  # Event handler for INTEGRATION_UPDATE events.
-  class IntegrationUpdateEventHandler < IntegrationEventHandler; end
-
-  # Event handler for INTEGRATION_DELETE events.
-  class IntegrationDeleteEventHandler < EventHandler
-    # @!visibility private
-    def matches?(event)
-      # Check for the proper event type.
-      return false unless event.is_a?(IntegrationDeleteEvent)
-
-      [
-        matches_all(@attributes[:server], event.server) do |a, e|
-          a&.resolve_id == e&.resolve_id
-        end,
-
-        matches_all(@attributes[:id], event.integration_id) do |a, e|
-          a&.resolve_id == e&.resolve_id
-        end,
-
-        matches_all(@attributes[:application], event.application_id) do |a, e|
-          a&.resolve_id == e&.resolve_id
-        end
-      ].reduce(true, &:&)
-    end
-  end
-end
+require 'onyxcord/events/integration/base'
+require 'onyxcord/events/integration/create'
+require 'onyxcord/events/integration/update'
+require 'onyxcord/events/integration/delete'