[2.x] Events for Two Factor Authentication (#162)

* added events

* dispatch events

* added tests for events

* Style CI fixes

* rename events

* fix usages

src/Actions/DisableTwoFactorAuthentication.php

@@ -2,6 +2,8 @@
 
 namespace Laravel\Fortify\Actions;
 
+use Laravel\Fortify\Events\TwoFactorAuthenticationDisabled;
+
 class DisableTwoFactorAuthentication
 {
     /**
@@ -16,5 +18,7 @@ public function __invoke($user)
             'two_factor_secret' => null,
             'two_factor_recovery_codes' => null,
         ])->save();
+
+        TwoFactorAuthenticationDisabled::dispatch($user);
     }
 }

src/Actions/EnableTwoFactorAuthentication.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Support\Collection;
 use Laravel\Fortify\Contracts\TwoFactorAuthenticationProvider;
+use Laravel\Fortify\Events\TwoFactorAuthenticationEnabled;
 use Laravel\Fortify\RecoveryCode;
 
 class EnableTwoFactorAuthentication
@@ -40,5 +41,7 @@ public function __invoke($user)
                 return RecoveryCode::generate();
             })->all())),
         ])->save();
+
+        TwoFactorAuthenticationEnabled::dispatch($user);
     }
 }

src/Actions/GenerateNewRecoveryCodes.php

@@ -3,6 +3,7 @@
 namespace Laravel\Fortify\Actions;
 
 use Illuminate\Support\Collection;
+use Laravel\Fortify\Events\RecoveryCodesGenerated;
 use Laravel\Fortify\RecoveryCode;
 
 class GenerateNewRecoveryCodes
@@ -20,5 +21,7 @@ public function __invoke($user)
                 return RecoveryCode::generate();
             })->all())),
         ])->save();
+
+        RecoveryCodesGenerated::dispatch($user);
     }
 }

src/Events/RecoveryCodesGenerated.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Laravel\Fortify\Events;
+
+use Illuminate\Foundation\Events\Dispatchable;
+
+class RecoveryCodesGenerated
+{
+    use Dispatchable;
+
+    /**
+     * The user instance.
+     *
+     * @var \App\Models\User
+     */
+    public $user;
+
+    /**
+     * Create a new event instance.
+     *
+     * @param  \App\Models\User  $user
+     * @return void
+     */
+    public function __construct($user)
+    {
+        $this->user = $user;
+    }
+}

src/Events/TwoFactorAuthenticationDisabled.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Laravel\Fortify\Events;
+
+class TwoFactorAuthenticationDisabled extends TwoFactorAuthenticationEvent
+{
+    //
+}

src/Events/TwoFactorAuthenticationEnabled.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Laravel\Fortify\Events;
+
+class TwoFactorAuthenticationEnabled extends TwoFactorAuthenticationEvent
+{
+    //
+}

src/Events/TwoFactorAuthenticationEvent.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Laravel\Fortify\Events;
+
+use Illuminate\Foundation\Events\Dispatchable;
+
+abstract class TwoFactorAuthenticationEvent
+{
+    use Dispatchable;
+
+    /**
+     * The user instance.
+     *
+     * @var \App\Models\User
+     */
+    public $user;
+
+    /**
+     * Create a new event instance.
+     *
+     * @param  \App\Models\User  $user
+     * @return void
+     */
+    public function __construct($user)
+    {
+        $this->user = $user;
+    }
+}

tests/RecoveryCodeControllerTest.php

@@ -3,12 +3,16 @@
 namespace Laravel\Fortify\Tests;
 
 use Illuminate\Foundation\Auth\User;
+use Illuminate\Support\Facades\Event;
+use Laravel\Fortify\Events\RecoveryCodesGenerated;
 use Laravel\Fortify\FortifyServiceProvider;
 
 class RecoveryCodeControllerTest extends OrchestraTestCase
 {
     public function test_new_recovery_codes_can_be_generated()
     {
+        Event::fake();
+
         $this->loadLaravelMigrations(['--database' => 'testbench']);
         $this->artisan('migrate', ['--database' => 'testbench'])->run();
 
@@ -24,6 +28,8 @@ public function test_new_recovery_codes_can_be_generated()
 
         $response->assertStatus(200);
 
+        Event::assertDispatched(RecoveryCodesGenerated::class);
+
         $user->fresh();
 
         $this->assertNotNull($user->two_factor_recovery_codes);

tests/TwoFactorAuthenticationControllerTest.php

@@ -3,13 +3,18 @@
 namespace Laravel\Fortify\Tests;
 
 use Illuminate\Foundation\Auth\User;
+use Illuminate\Support\Facades\Event;
+use Laravel\Fortify\Events\TwoFactorAuthenticationDisabled;
+use Laravel\Fortify\Events\TwoFactorAuthenticationEnabled;
 use Laravel\Fortify\FortifyServiceProvider;
 use Laravel\Fortify\TwoFactorAuthenticatable;
 
 class TwoFactorAuthenticationControllerTest extends OrchestraTestCase
 {
     public function test_two_factor_authentication_can_be_enabled()
     {
+        Event::fake();
+
         $this->loadLaravelMigrations(['--database' => 'testbench']);
         $this->artisan('migrate', ['--database' => 'testbench'])->run();
 
@@ -25,6 +30,8 @@ public function test_two_factor_authentication_can_be_enabled()
 
         $response->assertStatus(200);
 
+        Event::assertDispatched(TwoFactorAuthenticationEnabled::class);
+
         $user->fresh();
 
         $this->assertNotNull($user->two_factor_secret);
@@ -35,6 +42,8 @@ public function test_two_factor_authentication_can_be_enabled()
 
     public function test_two_factor_authentication_can_be_disabled()
     {
+        Event::fake();
+
         $this->loadLaravelMigrations(['--database' => 'testbench']);
         $this->artisan('migrate', ['--database' => 'testbench'])->run();
 
@@ -52,6 +61,8 @@ public function test_two_factor_authentication_can_be_disabled()
 
         $response->assertStatus(200);
 
+        Event::assertDispatched(TwoFactorAuthenticationDisabled::class);
+
         $user->fresh();
 
         $this->assertNull($user->two_factor_secret);