Merge branch 'master' into feat/message-components

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 - Present Ragnarök
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

examples/01-ping-pong-bot.php

@@ -1,7 +1,7 @@
 <?php
 
 use Exan\Fenrir\Bitwise\Bitwise;
-use Exan\Fenrir\Const\Events;
+use Exan\Fenrir\Constants\Events;
 use Exan\Fenrir\Discord;
 use Exan\Fenrir\Enums\Gateway\Intents;
 use Exan\Fenrir\Rest\Helpers\Channel\MessageBuilder;

examples/02-listening-to-raw-events.md

@@ -4,4 +4,4 @@ While Fenrir should cover most Events out of the box, you can also opt to listen
 
 You can enable the emitting of raw events by passing the setting in the `option` param of the `Exan\Fenrir\Discord` constructor.
 
-You can then set a listener for these events using `Exan\Fenrir\Const\Events::raw`. The handler receives a `Exan\Fenrir\Websocket\Objects\Payload` as its only parameter.
+You can then set a listener for these events using `Exan\Fenrir\Constants\Events::raw`. The handler receives a `Exan\Fenrir\Websocket\Objects\Payload` as its only parameter.

examples/02-listening-to-raw-events.php

@@ -1,7 +1,7 @@
 <?php
 
 use Exan\Fenrir\Bitwise\Bitwise;
-use Exan\Fenrir\Const\Events;
+use Exan\Fenrir\Constants\Events;
 use Exan\Fenrir\Discord;
 use Exan\Fenrir\Websocket\Objects\Payload;
 

examples/04-async-in-order.php

@@ -1,7 +1,7 @@
 <?php
 
 use Exan\Fenrir\Bitwise\Bitwise;
-use Exan\Fenrir\Const\Events;
+use Exan\Fenrir\Constants\Events;
 use Exan\Fenrir\Discord;
 use Exan\Fenrir\Enums\Gateway\Intents;
 use Exan\Fenrir\Rest\Helpers\Channel\MessageBuilder;

examples/05-filtered-event-listener.php

@@ -1,7 +1,7 @@
 <?php
 
 use Exan\Fenrir\Bitwise\Bitwise;
-use Exan\Fenrir\Const\Events;
+use Exan\Fenrir\Constants\Events;
 use Exan\Fenrir\Discord;
 use Exan\Fenrir\Enums\Gateway\Intents;
 use Exan\Fenrir\FilteredEventEmitter;

readme.md

@@ -19,7 +19,7 @@ Fenrir heavily relies on ReactPHP for async operations. Knowing the basics of as
 
 ```php
 use Exan\Fenrir\Bitwise\Bitwise;
-use Exan\Fenrir\Const\Events;
+use Exan\Fenrir\Constants\Events;
 use Exan\Fenrir\Discord;
 use Exan\Fenrir\Enums\Gateway\Intents;
 use Exan\Fenrir\Rest\Helpers\Channel\MessageBuilder;

src/CommandHandler.php

@@ -0,0 +1,97 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Exan\Fenrir;
+
+use Exan\Fenrir\Command\FiredCommand;
+use Exan\Fenrir\Constants\Events;
+use Exan\Fenrir\Parts\ApplicationCommand;
+use Exan\Fenrir\Rest\Helpers\Command\CommandBuilder;
+use Exan\Fenrir\Websocket\Events\InteractionCreate;
+use Exan\Fenrir\Websocket\Events\Ready;
+
+class CommandHandler
+{
+    private bool $activated = false;
+
+    /** @var array<string, callable> */
+    private array $commands = [];
+
+    private bool $devMode = false;
+
+    public function __construct(private Discord $discord, private ?string $devGuildId = null)
+    {
+        if (!is_null($this->devGuildId)) {
+            $this->devMode = true;
+        }
+    }
+
+    public function registerCommand(CommandBuilder $commandBuilder, callable $handler): void
+    {
+        if ($this->devMode) {
+            $this->registerGuildCommand($commandBuilder, $this->devGuildId, $handler);
+        } else {
+            $this->registerGlobalCommand($commandBuilder, $handler);
+        }
+    }
+
+    public function registerGuildCommand(CommandBuilder $commandBuilder, string $guildId, callable $handler): void
+    {
+        $this->activateListener();
+
+        /** Ready event includes Application ID */
+        $this->discord->gateway->events->once(
+            Events::READY,
+            function (Ready $ready) use ($commandBuilder, $guildId, $handler) {
+                $this->discord->rest->guildCommand->createApplicationCommand(
+                    $ready->user->id,
+                    $guildId,
+                    $commandBuilder
+                )->then(
+                    fn (ApplicationCommand $applicationCommand) => $this->commands[$applicationCommand->id] = $handler
+                );
+            }
+        );
+    }
+
+    public function registerGlobalCommand(CommandBuilder $commandBuilder, callable $handler): void
+    {
+        $this->activateListener();
+
+        /** Ready event includes Application ID */
+        $this->discord->gateway->events->once(Events::READY, function (Ready $ready) use ($commandBuilder, $handler) {
+            $this->discord->rest->globalCommand->createApplicationCommand(
+                $ready->user->id,
+                $commandBuilder
+            )->then(
+                fn (ApplicationCommand $applicationCommand) => $this->commands[$applicationCommand->id] = $handler
+            );
+        });
+    }
+
+    private function activateListener()
+    {
+        if ($this->activated) {
+            return;
+        }
+
+        $this->activated = true;
+
+        $this->discord->gateway->events->on(
+            Events::INTERACTION_CREATE,
+            $this->handleInteraction(...)
+        );
+    }
+
+    private function handleInteraction(InteractionCreate $interactionCreate)
+    {
+        if (!isset($this->commands[$interactionCreate->data->id])) {
+            return;
+        }
+
+        $firedCommand = new FiredCommand($interactionCreate, $this->discord);
+
+        $this->commands[$interactionCreate->data->id]($firedCommand);
+    }
+}

src/Const/Events.php → src/Constants/Events.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Exan\Fenrir\Const;
+namespace Exan\Fenrir\Constants;
 
 class Events
 {

src/Const/Validation/Command.php → src/Constants/Validation/Command.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Exan\Fenrir\Const\Validation;
+namespace Exan\Fenrir\Constants\Validation;
 
 class Command
 {

src/Const/Validation/ItemLimit.php → src/Constants/Validation/ItemLimit.php

@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Exan\Fenrir\Const\Validation;
+namespace Exan\Fenrir\Constants\Validation;
 
-use Exan\Fenrir\Const\Validation\Traits\WithinLimit;
+use Exan\Fenrir\Constants\Validation\Traits\WithinLimit;
 
 class ItemLimit
 {

src/Const/Validation/RateLimit.php → src/Constants/Validation/RateLimit.php

@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Exan\Fenrir\Const\Validation;
+namespace Exan\Fenrir\Constants\Validation;
 
-use Exan\Fenrir\Const\Validation\Traits\WithinLimit;
+use Exan\Fenrir\Constants\Validation\Traits\WithinLimit;
 
 class RateLimit
 {

src/Const/Validation/Traits/WithinLimit.php → src/Constants/Validation/Traits/WithinLimit.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Exan\Fenrir\Const\Validation\Traits;
+namespace Exan\Fenrir\Constants\Validation\Traits;
 
 trait WithinLimit
 {

src/Const/WebsocketEvents.php → src/Constants/WebsocketEvents.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Exan\Fenrir\Const;
+namespace Exan\Fenrir\Constants;
 
 class WebsocketEvents
 {

src/EventHandler.php

@@ -5,7 +5,7 @@
 namespace Exan\Fenrir;
 
 use Evenement\EventEmitter;
-use Exan\Fenrir\Const\Events;
+use Exan\Fenrir\Constants\Events;
 use Exan\Fenrir\Websocket\Objects\Payload;
 use JsonMapper;
 

src/Exceptions/Rest/Helpers/Command/InvalidCommandNameException.php

@@ -4,7 +4,7 @@
 
 namespace Exan\Fenrir\Exceptions\Rest\Helpers\Command;
 
-use Exan\Fenrir\Const\Validation\Command;
+use Exan\Fenrir\Constants\Validation\Command;
 use Exception;
 
 class InvalidCommandNameException extends Exception

src/Gateway.php

@@ -5,8 +5,8 @@
 namespace Exan\Fenrir;
 
 use Exan\Fenrir\Bitwise\Bitwise;
-use Exan\Fenrir\Const\Events as Events;
-use Exan\Fenrir\Const\WebsocketEvents;
+use Exan\Fenrir\Constants\Events as Events;
+use Exan\Fenrir\Constants\WebsocketEvents;
 use Exan\Fenrir\Enums\Gateway\StatusType;
 use Exan\Fenrir\Websocket\Helpers\ActivityBuilder;
 use Exan\Fenrir\Websocket\Objects\D\Hello;

src/Rest/Helpers/AuditLog/GetGuildAuditLogsBuilder.php

@@ -4,7 +4,7 @@
 
 namespace Exan\Fenrir\Rest\Helpers\AuditLog;
 
-use Exan\Fenrir\Const\Validation\ItemLimit;
+use Exan\Fenrir\Constants\Validation\ItemLimit;
 use Exan\Fenrir\Rest\Helpers\GetNew;
 
 class GetGuildAuditLogsBuilder

src/Rest/Helpers/Channel/Channel/Shared/SetDefaultThreadRateLimitPerUser.php

@@ -4,7 +4,7 @@
 
 namespace Exan\Fenrir\Rest\Helpers\Channel\Channel\Shared;
 
-use Exan\Fenrir\Const\Validation\RateLimit;
+use Exan\Fenrir\Constants\Validation\RateLimit;
 
 trait SetDefaultThreadRateLimitPerUser
 {

src/Rest/Helpers/Channel/Channel/Shared/SetRateLimitPerUser.php

@@ -4,7 +4,7 @@
 
 namespace Exan\Fenrir\Rest\Helpers\Channel\Channel\Shared;
 
-use Exan\Fenrir\Const\Validation\RateLimit;
+use Exan\Fenrir\Constants\Validation\RateLimit;
 
 trait SetRateLimitPerUser
 {

src/Rest/Helpers/Channel/GetMessagesBuilder.php

@@ -4,7 +4,7 @@
 
 namespace Exan\Fenrir\Rest\Helpers\Channel;
 
-use Exan\Fenrir\Const\Validation\ItemLimit;
+use Exan\Fenrir\Constants\Validation\ItemLimit;
 use Exan\Fenrir\Rest\Helpers\GetNew;
 
 class GetMessagesBuilder

src/Rest/Helpers/Channel/GetReactionsBuilder.php

@@ -4,7 +4,7 @@
 
 namespace Exan\Fenrir\Rest\Helpers\Channel;
 
-use Exan\Fenrir\Const\Validation\ItemLimit;
+use Exan\Fenrir\Constants\Validation\ItemLimit;
 use Exan\Fenrir\Rest\Helpers\GetNew;
 
 class GetReactionsBuilder

src/Rest/Helpers/Channel/StartThreadFromMessageBuilder.php

@@ -4,7 +4,7 @@
 
 namespace Exan\Fenrir\Rest\Helpers\Channel;
 
-use Exan\Fenrir\Const\Validation\RateLimit;
+use Exan\Fenrir\Constants\Validation\RateLimit;
 use Exan\Fenrir\Enums\Parts\ThreadAutoArchiveDuration;
 use Exan\Fenrir\Rest\Helpers\GetNew;
 

src/Rest/Helpers/Channel/StartThreadWithoutMessageBuilder.php

@@ -4,7 +4,7 @@
 
 namespace Exan\Fenrir\Rest\Helpers\Channel;
 
-use Exan\Fenrir\Const\Validation\RateLimit;
+use Exan\Fenrir\Constants\Validation\RateLimit;
 use Exan\Fenrir\Enums\Parts\ChannelTypes;
 use Exan\Fenrir\Enums\Parts\ThreadAutoArchiveDuration;
 use Exan\Fenrir\Rest\Helpers\GetNew;

src/Rest/Helpers/Command/CommandBuilder.php

@@ -5,7 +5,7 @@
 namespace Exan\Fenrir\Rest\Helpers\Command;
 
 use Exan\Fenrir\Bitwise\Bitwise;
-use Exan\Fenrir\Const\Validation\Command;
+use Exan\Fenrir\Constants\Validation\Command;
 use Exan\Fenrir\Enums\Parts\ApplicationCommandTypes;
 use Exan\Fenrir\Exceptions\Rest\Helpers\Command\InvalidCommandNameException;
 use Exan\Fenrir\Rest\Helpers\GetNew;

src/Websocket.php

@@ -5,8 +5,9 @@
 namespace Exan\Fenrir;
 
 use Evenement\EventEmitter;
-use Exan\Fenrir\Const\WebsocketEvents;
+use Exan\Fenrir\Constants\WebsocketEvents;
 use Exan\Fenrir\Exceptions\Websocket\ConnectionNotInitializedException;
+use JsonSerializable;
 use Psr\Log\LoggerInterface;
 use Ratchet\Client\Connector;
 use Ratchet\Client\WebSocket as RatchetWebsocket;
@@ -43,7 +44,7 @@ public function __construct(private int $timeout, private LoggerInterface $logge
     /**
      * @throws ConnectionNotInitializedException
      */
-    private function mustHaveActiveConnection()
+    private function mustHaveActiveConnection(): void
     {
         if (!isset($this->connection)) {
             throw new ConnectionNotInitializedException();
@@ -83,7 +84,7 @@ public function open(string $url): Promise
     /**
      * @throws ConnectionNotInitializedException
      */
-    public function close(int $code, string $reason)
+    public function close(int $code, string $reason): void
     {
         $this->mustHaveActiveConnection();
 
@@ -99,7 +100,7 @@ public function close(int $code, string $reason)
     /**
      * @throws ConnectionNotInitializedException
      */
-    public function send(string $message, bool $useBucket = true)
+    public function send(string $message, bool $useBucket = true): void
     {
         $this->mustHaveActiveConnection();
 
@@ -120,4 +121,12 @@ public function send(string $message, bool $useBucket = true)
             $action();
         }
     }
+
+    /**
+     * @throws ConnectionNotInitializedException
+     */
+    public function sendAsJson(array|JsonSerializable $item, bool $useBucket): void
+    {
+        $this->send(json_encode($item), $useBucket);
+    }
 }

tests/EventHandlerTest.php

@@ -4,7 +4,7 @@
 
 namespace Tests\Exan\Fenrir;
 
-use Exan\Fenrir\Const\Events;
+use Exan\Fenrir\Constants\Events;
 use Exan\Fenrir\EventHandler;
 use Exan\Fenrir\Websocket\Objects\Payload;
 use JsonMapper;