WIP: Introduce "Automations"

README.md

@@ -107,7 +107,7 @@ To add a bot you need to link your app with the bot twitch account.
 
 1. Open `${APP_URL}/connection/bot/redirect` with your laravel-app.
 2. Login into your Twitch-Bot account with your Twitch Application.
-3. After redirect you need to manually connect your laravel-Account with a bot.
+3. After redirect, you need to manually connect your laravel-Account with a bot.
 4. Open Your Database table "bot_connections" and connect your bot with your user.
 5. Restart the Bot Artisan Bot
 

composer.json

@@ -12,6 +12,7 @@
     "homepage": "https://github.com/redbeed/openoverlay",
     "keywords": ["Laravel", "OpenOverlay", "twitch", "Eventsub", "Bot", "IRC"],
     "require": {
+        "php": "^8.0",
         "illuminate/support": "~8|~9",
         "guzzlehttp/guzzle": "^7.2",
         "ext-json": "*",
@@ -23,9 +24,13 @@
     "require-dev": {
         "phpunit/phpunit": "~9.0",
         "orchestra/testbench": "~5|~6",
-        "nunomaduro/phpinsights": "^1.14"
+        "nunomaduro/phpinsights": "^1.14",
+        "laravel/pint": "^0.2.3"
     },
     "autoload": {
+        "files": [
+            "src/Support/helpers.php"
+        ],
         "psr-4": {
             "Redbeed\\OpenOverlay\\": "src/",
             "Redbeed\\OpenOverlay\\Database\\": "database/"
@@ -47,5 +52,10 @@
         }
     },
     "minimum-stability": "dev",
-    "prefer-stable": true
+    "prefer-stable": true,
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
+    }
 }

config/openoverlay.php

@@ -33,12 +33,12 @@
          * You can use :username, :twitchUrl and :gameName for your message.
          */
         \Redbeed\OpenOverlay\Listeners\AutoShoutOutRaid::class => [
-            'message' => 'Follow :username over at :twitchUrl. They were last playing :gameName'
+            'message' => 'Follow :username over at :twitchUrl. They were last playing :gameName',
         ],
 
         \Redbeed\OpenOverlay\Support\ViewerInChat::class => [
-            'reset' => -1
-        ]
+            'reset' => -1,
+        ],
     ],
 
     'webhook' => [
@@ -55,7 +55,7 @@
 
             /**
              * Your personal and unique secret is used to validate a twitch callback
-             * If you change your secret all previous configures webhook callbacks will be end as invalid
+             * If you change your secret all previous configures webhook callbacks will be ended as invalid
              */
             'secret' => env('OVERLAY_SECRET'),
 
@@ -72,20 +72,8 @@
     ],
 
     'bot' => [
-        'commands' => [
-
-            'simple' => [
-                '!hello' => 'Hello %username%! How are you doing?',
-            ],
-
-            'advanced' => [
-                \Redbeed\OpenOverlay\ChatBot\Commands\HelloWorldBotCommand::class,
-                \Redbeed\OpenOverlay\ChatBot\Commands\ShoutOutBotCommand::class,
-            ]
-        ],
-
         'schedules' => [
             \Redbeed\OpenOverlay\Console\Scheduling\MadeWithChatBotScheduling::class,
-        ]
-    ]
+        ],
+    ],
 ];

database/Factories/EventSubEventsFactory.php

@@ -7,11 +7,10 @@
 
 class EventSubEventsFactory extends Factory
 {
-
     protected $model = EventSubEvents::class;
 
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     public function definition()
     {

database/migrations/2020_12_17_000001_create_user_bots_enabled_table.php

@@ -14,7 +14,6 @@ class CreateUserBotsEnabledTable extends Migration
     public function up()
     {
         Schema::create('users_bots_enabled', function (Blueprint $table) {
-
             $table->unsignedBigInteger('user_id');
             $table->unsignedBigInteger('bot_id');
             $table->timestamps();

routes/openoverlay.php

@@ -1,7 +1,6 @@
 <?php
 
 use Illuminate\Support\Facades\Route;
-
 use Redbeed\OpenOverlay\Http\Controllers\Api\Connection\WebhookController;
 use Redbeed\OpenOverlay\Http\Controllers\Connection\AppTokenController;
 use Redbeed\OpenOverlay\Http\Controllers\Connection\AuthController;
@@ -11,9 +10,7 @@
 
     // prefix: /connection
     Route::prefix('connection')->group(function () {
-
         Route::middleware(['web', 'auth'])->group(function () {
-
             Route::get('/redirect')->uses([AuthController::class, 'redirect'])
                 ->name('connection.redirect');
 
@@ -27,7 +24,6 @@
 
                 Route::get('/callback')->uses([AppTokenController::class, 'handleProviderCallback'])
                     ->name('connection.app-token.callback');
-
             });
 
             // prefix: /connection/bot
@@ -37,14 +33,12 @@
 
                 Route::get('/callback')->uses([BotAuthController::class, 'handleProviderCallback'])
                     ->name('connection.bot.callback');
-
             });
         });
 
         Route::middleware(['api'])->group(function () {
             Route::any('/webhook')->uses([WebhookController::class, 'handleProviderCallback'])
                 ->name('connection.webhook');
         });
-
     });
 });

src/Actions/RegisterUserTwitchWebhooks.php

@@ -36,7 +36,7 @@ public static function registerAll(Connection $connection, bool $clearBeforeRegi
 
     public function clearBroadcasterSubscriptions()
     {
-        $this->apiClient->deleteSubByBroadcasterId((string)$this->connection->service_user_id);
+        $this->apiClient->deleteSubByBroadcasterId((string) $this->connection->service_user_id);
     }
 
     public function register(string $type): bool
@@ -61,7 +61,7 @@ public function register(string $type): bool
 
     private function registerCondition($type): array
     {
-        $broadcasterId = (string)$this->connection->service_user_id;
+        $broadcasterId = (string) $this->connection->service_user_id;
 
         if ($type === 'channel.raid') {
             return ['to_broadcaster_user_id' => $broadcasterId];

src/Automations/Actions/TwitchChatBotMessage.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Redbeed\OpenOverlay\Automations\Actions;
+
+use Illuminate\Support\Facades\Artisan;
+use Redbeed\OpenOverlay\Console\Commands\ChatBot\SendMessageCommand;
+use Redbeed\OpenOverlay\Models\User\Connection;
+
+class TwitchChatBotMessage
+{
+    use UseVariables;
+    use UseTwitchChatMessage;
+
+    public static string $name = 'Send chat message';
+
+    public static string $description = 'Send chat message via bot';
+
+    private Connection $connection;
+
+    private string $message;
+
+    public function __construct(string $message)
+    {
+        $this->message = $message;
+    }
+
+    public function handle()
+    {
+        Artisan::queue(SendMessageCommand::class, [
+            'userId' => $this->getUser()->id,
+            '--botId' => $this->getBot()->id,
+            'message' => $this->replaceInString($this->message),
+        ]);
+    }
+}

src/Automations/Actions/TwitchRandomChatBotMessage.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Redbeed\OpenOverlay\Automations\Actions;
+
+use Illuminate\Support\Arr;
+use Illuminate\Support\Facades\Artisan;
+use Redbeed\OpenOverlay\Console\Commands\ChatBot\SendMessageCommand;
+use Redbeed\OpenOverlay\Models\User\Connection;
+
+class TwitchRandomChatBotMessage
+{
+    use UseVariables;
+    use UseTwitchChatMessage;
+
+    public static string $name = 'Send one of the random chat messages';
+
+    public static string $description = 'Send one of the random chat messages via bot';
+
+    private Connection $connection;
+
+    /** @var string[] */
+    private array $messages;
+
+    public function __construct(array $messages)
+    {
+        $this->messages = $messages;
+    }
+
+    public function handle()
+    {
+        Artisan::queue(SendMessageCommand::class, [
+            'userId' => $this->getUser()->id,
+            '--botId' => $this->getBot()->id,
+            'message' => $this->replaceInString(Arr::random($this->messages)),
+        ]);
+    }
+}

src/Automations/Actions/UseTwitchChatMessage.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Redbeed\OpenOverlay\Automations\Actions;
+
+use Illuminate\Foundation\Auth\User;
+use Redbeed\OpenOverlay\ChatBot\Twitch\ChatMessage;
+use Redbeed\OpenOverlay\Models\BotConnection;
+
+trait UseTwitchChatMessage
+{
+    private ChatMessage $chatMessage;
+
+    private ?BotConnection $botConnection = null;
+
+    private ?User $user = null;
+
+    public function setChatMessage(ChatMessage $chatMessage): void
+    {
+        $this->chatMessage = $chatMessage;
+    }
+
+    public function setBotConnection(BotConnection $botConnection): void
+    {
+        $this->botConnection = $botConnection;
+    }
+
+    public function setUser(User $user): void
+    {
+        $this->user = $user;
+    }
+
+    protected function getBot(): ?BotConnection
+    {
+        return $this->botConnection ?: $this->chatMessage?->bot;
+    }
+
+    protected function getUser(): ?User
+    {
+        return $this->user ?: $this->chatMessage?->channelUser;
+    }
+}

src/Automations/Actions/UseVariables.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace Redbeed\OpenOverlay\Automations\Actions;
+
+use Illuminate\Support\Str;
+
+trait UseVariables
+{
+    private array $variables = [];
+
+    public function addVariables(array $variables): void
+    {
+        $this->variables = array_merge_recursive($this->variables, $variables);
+    }
+
+    public function getVariables($filterName = ''): array
+    {
+        if ($filterName) {
+            return $this->filterVariables($filterName);
+        }
+
+        return $this->variables;
+    }
+
+    private function filterVariables(string $filterName): array
+    {
+        $filtered = [];
+        foreach ($this->variables as $name => $value) {
+            if (str_contains($name, $filterName)) {
+                $filtered[$name] = $value;
+            }
+        }
+
+        return $filtered;
+    }
+
+    protected function replaceInString(string $string): string
+    {
+        return strtr($string, $this->makeReplacements($string));
+    }
+
+    protected function makeReplacements(string $string): array
+    {
+        $replacements = [];
+        foreach ($this->variables as $key => $value) {
+            $keyPattern = ':'.$key;
+
+            if (Str::contains($string, $keyPattern)) {
+                if ($this->variables[$key] instanceof \Closure) {
+                    // If the variable is a closure, we will execute it and replace the key with the result.
+                    $this->variables[$key] = $this->variables[$key]();
+                }
+
+                $replacements[$keyPattern] = $this->variables[$key];
+            }
+        }
+
+        return $replacements;
+    }
+}