From 4a573074bee39a9c0f4a51762ace96be82ce4f2c Mon Sep 17 00:00:00 2001
From: Maciej Rymarz <59456825+mako321@users.noreply.github.com>
Date: Mon, 21 Mar 2022 12:04:10 +0100
Subject: [PATCH] Add ManuallyTrigeredEvent (#31)

* Add ManuallyTrigeredEvent

* fix

* Remove course base_price
---
 src/Core/UserVariables.php                    | 63 +++++++++++++++++++
 ...EscolaLmsTemplatesEmailServiceProvider.php |  2 +
 src/Providers/TemplateServiceProvider.php     | 21 +++++++
 tests/Api/CoursesTest.php                     |  2 -
 tests/Api/TemplateApiTest.php                 | 51 +++++++++++++++
 5 files changed, 137 insertions(+), 2 deletions(-)
 create mode 100644 src/Core/UserVariables.php
 create mode 100644 src/Providers/TemplateServiceProvider.php
 create mode 100644 tests/Api/TemplateApiTest.php

diff --git a/src/Core/UserVariables.php b/src/Core/UserVariables.php
new file mode 100644
index 0000000..1138abf
--- /dev/null
+++ b/src/Core/UserVariables.php
@@ -0,0 +1,63 @@
+<?php
+
+namespace EscolaLms\TemplatesEmail\Core;
+
+use EscolaLms\Core\Models\User;
+use EscolaLms\Templates\Events\EventWrapper;
+use Illuminate\Support\Facades\Lang;
+
+class UserVariables extends EmailVariables
+{
+    const VAR_USER_NAME = '@VarUserName';
+
+    public static function mockedVariables(?User $user = null): array
+    {
+        $faker = \Faker\Factory::create();
+        return array_merge(parent::mockedVariables(), [
+            self::VAR_USER_NAME => $faker->name(),
+        ]);
+    }
+
+    public static function variablesFromEvent(EventWrapper $event): array
+    {
+        return array_merge(parent::variablesFromEvent($event), [
+            self::VAR_USER_NAME => $event->getUser()->name,
+        ]);
+    }
+
+    public static function requiredVariables(): array
+    {
+        return [
+            self::VAR_USER_NAME,
+        ];
+    }
+
+    public static function requiredVariablesInSection(string $sectionKey): array
+    {
+        if ($sectionKey === 'content') {
+            [
+                self::VAR_USER_NAME,
+            ];
+        }
+        return [];
+    }
+
+    public static function defaultSectionsContent(): array
+    {
+        return [
+            'title' => Lang::get('User variables'),
+            'content' => self::wrapWithMjml(
+                '<mj-text>'
+                . '<p>'
+                . Lang::get('Custom mail to :user', ['user' => self::VAR_USER_NAME])
+                . '</p>'
+                . '</mj-text>'
+            )
+        ];
+    }
+
+    public static function assignableClass(): ?string
+    {
+        return null;
+    }
+}
diff --git a/src/EscolaLmsTemplatesEmailServiceProvider.php b/src/EscolaLmsTemplatesEmailServiceProvider.php
index 7de8ed1..8853db2 100644
--- a/src/EscolaLmsTemplatesEmailServiceProvider.php
+++ b/src/EscolaLmsTemplatesEmailServiceProvider.php
@@ -18,6 +18,7 @@
 use EscolaLms\TemplatesEmail\Providers\ConsultationTemplatesServiceProvider;
 use EscolaLms\TemplatesEmail\Providers\CourseTemplatesServiceProvider;
 use EscolaLms\TemplatesEmail\Providers\CsvUsersTemplatesServiceProvider;
+use EscolaLms\TemplatesEmail\Providers\TemplateServiceProvider;
 use EscolaLms\TemplatesEmail\Rules\MjmlRule;
 use EscolaLms\TemplatesEmail\Services\Contracts\MjmlServiceContract;
 use EscolaLms\TemplatesEmail\Services\MjmlService;
@@ -64,6 +65,7 @@ class_exists(EscolaLmsTemplatesServiceProvider::class) &&
         if (class_exists(EscolaLmsConsultationsServiceProvider::class)) {
             $this->app->register(ConsultationTemplatesServiceProvider::class);
         }
+        $this->app->register(TemplateServiceProvider::class);
     }
 
     public function boot()
diff --git a/src/Providers/TemplateServiceProvider.php b/src/Providers/TemplateServiceProvider.php
new file mode 100644
index 0000000..4c17e3d
--- /dev/null
+++ b/src/Providers/TemplateServiceProvider.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace EscolaLms\TemplatesEmail\Providers;
+
+use EscolaLms\Templates\Events\ManuallyTriggeredEvent;
+use EscolaLms\Templates\Facades\Template;
+use EscolaLms\TemplatesEmail\Core\EmailChannel;
+use EscolaLms\TemplatesEmail\Core\UserVariables;
+use Illuminate\Support\ServiceProvider;
+
+class TemplateServiceProvider extends ServiceProvider
+{
+    public function boot()
+    {
+        Template::register(
+            ManuallyTriggeredEvent::class,
+            EmailChannel::class,
+            UserVariables::class
+        );
+    }
+}
diff --git a/tests/Api/CoursesTest.php b/tests/Api/CoursesTest.php
index c6372c2..78be41d 100644
--- a/tests/Api/CoursesTest.php
+++ b/tests/Api/CoursesTest.php
@@ -88,7 +88,6 @@ public function testUserAssignedToCourseNotification()
 
         $course = Course::factory()->create([
             'author_id' => $admin->id,
-            'base_price' => 1337,
             'status' => CourseStatusEnum::PUBLISHED
         ]);
 
@@ -125,7 +124,6 @@ public function testUserUnassignedFromCourseNotification()
 
         $course = Course::factory()->create([
             'author_id' => $admin->id,
-            'base_price' => 1337,
             'status' => CourseStatusEnum::PUBLISHED
         ]);
         $student = User::factory()->create();
diff --git a/tests/Api/TemplateApiTest.php b/tests/Api/TemplateApiTest.php
new file mode 100644
index 0000000..046571b
--- /dev/null
+++ b/tests/Api/TemplateApiTest.php
@@ -0,0 +1,51 @@
+<?php
+
+namespace EscolaLms\TemplatesEmail\Tests\Api;
+
+use EscolaLms\Core\Tests\CreatesUsers;
+use EscolaLms\Templates\Database\Seeders\PermissionTableSeeder;
+use EscolaLms\Templates\Events\ManuallyTriggeredEvent;
+use EscolaLms\Templates\Listeners\TemplateEventListener;
+use EscolaLms\TemplatesEmail\Core\EmailMailable;
+use EscolaLms\TemplatesEmail\Tests\TestCase;
+use Illuminate\Foundation\Testing\DatabaseTransactions;
+use Illuminate\Support\Facades\Event;
+use Illuminate\Support\Facades\Mail;
+
+class TemplateApiTest extends TestCase
+{
+    use DatabaseTransactions, CreatesUsers;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+        $this->seed(PermissionTableSeeder::class);
+    }
+
+    public function testManuallyTriggeredEvent(): void
+    {
+        Event::fake(ManuallyTriggeredEvent::class);
+        Mail::fake();
+
+        $admin = $this->makeAdmin();
+        $student = $this->makeStudent();
+
+        $this->response = $this->actingAs($admin, 'api')->postJson(
+            '/api/admin/events/trigger-manually',
+            ['users' => [$student->getKey()]]
+        )->assertOk();
+
+        Event::assertDispatched(ManuallyTriggeredEvent::class, function (ManuallyTriggeredEvent $event) use ($student) {
+            $this->assertEquals($student->getKey(), $event->getUser()->getKey());
+            return true;
+        });
+
+        $listener = app(TemplateEventListener::class);
+        $listener->handle(new ManuallyTriggeredEvent($student));
+
+        Mail::assertSent(EmailMailable::class, function (EmailMailable $mailable) use ($student) {
+            $this->assertTrue($mailable->hasTo($student->email));
+            return true;
+        });
+    }
+}