Register api (#73)

* ✨ Ajout des events et listeners pour la creation de compte

* 🗃️ refactoring et ajout du seeder pour le role company

* 👽 Ajout de l'api de creation de compte simple et via google

Author: mckenziearts

app/Events/ApiRegistered.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Events;
+
+use App\Models\User;
+use Illuminate\Queue\SerializesModels;
+
+class ApiRegistered
+{
+    use SerializesModels;
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct(public User $user)
+    {
+    }
+}

app/Http/Controllers/Api/Auth/LoginController.php

@@ -16,6 +16,7 @@ class LoginController extends Controller
 {
     public function login(LoginRequest $request): JsonResponse
     {
+        /** @var User $user */
         $user = User::query()
             ->with(['roles', 'permissions'])
             ->where('email', strtolower($request->input('email')))
@@ -27,7 +28,7 @@ public function login(LoginRequest $request): JsonResponse
         ];
 
         if (empty($user) || !Auth::attempt($sanitized)) {
-            throw  ValidationException::withMessages([
+            throw ValidationException::withMessages([
                 'email' => 'Les informations d\'identification fournies sont incorrectes.',
             ]);
         }

app/Http/Controllers/Api/Auth/RegisterController.php

@@ -0,0 +1,97 @@
+<?php
+
+namespace App\Http\Controllers\Api\Auth;
+
+use App\Events\ApiRegistered;
+use App\Http\Controllers\Controller;
+use App\Http\Requests\Api\RegisterRequest;
+use App\Http\Resources\AuthenticateUserResource;
+use App\Models\SocialAccount;
+use App\Models\User;
+use Carbon\Carbon;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Hash;
+
+class RegisterController extends Controller
+{
+    public function register(RegisterRequest $request): JsonResponse
+    {
+        /** @var User $user */
+        $user = User::query()->create([
+            'name' => $request->input('name'),
+            'username' => $request->input('name'),
+            'email' => strtolower($request->input('email')),
+            'password' => Hash::make($request->input('password')),
+        ]);
+
+        $user->assignRole('company');
+
+        //TODO: Send new company registration notification on Slack
+        event(new ApiRegistered($user));
+
+        return response()->json(array_merge(
+                ['message' => 'Votre compte a été créé avec succès. Un e-mail de vérification vous a été envoyé.'],
+                $this->userMetaData($user)
+            )
+        );
+    }
+
+    public function googleAuthenticator(Request $request): JsonResponse
+    {
+        $socialUser = $request->input('socialUser');
+
+        $user = User::query()->where('email', $socialUser['email'])->first();
+
+        if (! $user) {
+            /** @var User $user */
+            $user = User::query()->create([
+                'name' => $socialUser['name'],
+                'email' => $socialUser['email'],
+                'username' => $socialUser['id'],
+                'email_verified_at' => now(),
+                'avatar_type' => strtolower($socialUser['provider']),
+            ]);
+
+            $user->assignRole('company');
+        }
+
+        if ($user->hasRole('user')) {
+            return response()->json(['error' => 'Vous n\'êtes pas autorisé à accéder à cette section avec cette adresse e-mail.'], 401);
+        }
+
+        if (! $user->hasProvider($socialUser['provider'])) {
+            $user->providers()->save(new SocialAccount([
+                'provider' => $socialUser['provider'],
+                'provider_id' => $socialUser['id'],
+                'token' => $socialUser['idToken'],
+                'avatar' => $socialUser['photoUrl'],
+            ]));
+        }
+
+        $user->providers()->update([
+            'token' => $socialUser['idToken'],
+            'avatar' => $socialUser['photoUrl'],
+        ]);
+
+        //TODO: Send welcome email to user 1 hour after registration
+
+        //TODO: Send new company registration notification on Slack
+
+        $user->last_login_at = Carbon::now();
+        $user->last_login_ip = $request->ip();
+        $user->save();
+
+        return response()->json($this->userMetaData($user));
+    }
+
+    private function userMetaData(User $user): array
+    {
+        return [
+            'user' => new AuthenticateUserResource($user),
+            'token' => $user->createToken($user->email)->plainTextToken,
+            'roles' => $user->roles()->pluck('name'),
+            'permissions' => $user->permissions()->pluck('name'),
+        ];
+    }
+}

app/Http/Controllers/Api/Auth/VerifyEmailController.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace App\Http\Controllers\Api\Auth;
+
+use App\Http\Controllers\Controller;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+use Illuminate\Auth\Events\Verified;
+use Illuminate\Http\RedirectResponse;
+use App\Models\User;
+
+class VerifyEmailController extends Controller
+{
+    public function verify(Request $request): RedirectResponse
+    {
+        /** @var User $user */
+        $user = User::find($request->route('id'));
+
+        if ($user->hasVerifiedEmail()) {
+            return redirect(env('FRONTEND_APP_URL') . '/email/verify/already-success');
+        }
+
+        if ($user->markEmailAsVerified()) {
+            event(new Verified($user));
+        }
+
+        return redirect(env('FRONTEND_APP_URL') . '/email/verify/success');
+    }
+
+    public function resend(Request $request): JsonResponse
+    {
+        $request->user()->sendEmailVerificationNotification();
+
+        return response()->json(['message', 'Un nouveau lien de Verification a été envoyé!']);
+    }
+}

app/Http/Requests/Api/RegisterRequest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace App\Http\Requests\Api;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class RegisterRequest extends FormRequest
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+    public function authorize(): bool
+    {
+        return true;
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array<string, mixed>
+     */
+    public function rules(): array
+    {
+        return [
+            'name' => 'required|string|max:255',
+            'email' => 'required|email|max:255|unique:users',
+            'password' => 'required|min:6',
+        ];
+    }
+}

app/Listeners/SendCompanyEmailVerificationNotification.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Listeners;
+
+use App\Events\ApiRegistered;
+use App\Models\User;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Queue\InteractsWithQueue;
+
+final class SendCompanyEmailVerificationNotification implements ShouldQueue
+{
+    use InteractsWithQueue;
+
+    /**
+     * Handle the event.
+     *
+     * @param  ApiRegistered  $event
+     * @return void
+     */
+    public function handle(ApiRegistered $event): void
+    {
+        $user = $event->user;
+    }
+}

app/Listeners/SendWelcomeCompanyNotification.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace App\Listeners;
+
+use App\Events\ApiRegistered;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Queue\InteractsWithQueue;
+
+class SendWelcomeCompanyNotification implements ShouldQueue
+{
+    use InteractsWithQueue;
+
+    /**
+     * Handle the event.
+     *
+     * @param  ApiRegistered  $event
+     * @return void
+     */
+    public function handle(ApiRegistered $event): void
+    {
+        $user = $event->user;
+    }
+}

app/Models/User.php

@@ -3,6 +3,7 @@
 namespace App\Models;
 
 use App\Traits\HasProfilePhoto;
+use App\Traits\HasUsername;
 use App\Traits\Reacts;
 use Illuminate\Contracts\Auth\MustVerifyEmail;
 use Illuminate\Database\Eloquent\Builder;
@@ -34,6 +35,7 @@ class User extends Authenticatable implements MustVerifyEmail, HasMedia
     use InteractsWithMedia;
     use Notifiable;
     use Reacts;
+    use HasUsername;
 
     /**
      * The attributes that are mass assignable.
@@ -149,17 +151,12 @@ public function registerMediaCollections(): void
             ->acceptsMimeTypes(['image/jpg', 'image/jpeg', 'image/png', 'image/gif']);
     }
 
-    public static function findByUsername(string $username): self
-    {
-        return static::where('username', $username)->firstOrFail();
-    }
-
     public static function findByEmailAddress(string $emailAddress): self
     {
         return static::where('email', $emailAddress)->firstOrFail();
     }
 
-    public static function findOrCreateSocialUserProvider($socialUser, string $provider): self
+    public static function findOrCreateSocialUserProvider($socialUser, string $provider, string $role = 'user'): self
     {
         $socialEmail = $socialUser->email ?? "{$socialUser->id}@{$provider}.com";
 
@@ -176,7 +173,7 @@ public static function findOrCreateSocialUserProvider($socialUser, string $provi
                 'avatar_type' => $provider,
             ]);
 
-            $user->assignRole('user');
+            $user->assignRole($role);
         }
 
         return $user;

app/Providers/EventServiceProvider.php

@@ -2,16 +2,19 @@
 
 namespace App\Providers;
 
+use App\Events\ApiRegistered;
 use App\Events\ArticleWasSubmittedForApproval;
 use App\Events\CommentWasAdded;
 use App\Events\ReplyWasCreated;
 use App\Events\ThreadWasCreated;
 use App\Listeners\NotifyMentionedUsers;
 use App\Listeners\PostNewThreadNotification;
+use App\Listeners\SendCompanyEmailVerificationNotification;
 use App\Listeners\SendNewArticleNotification;
 use App\Listeners\SendNewCommentNotification;
 use App\Listeners\SendNewReplyNotification;
 use App\Listeners\SendNewThreadNotification;
+use App\Listeners\SendWelcomeCompanyNotification;
 use App\Listeners\SendWelcomeMailNotification;
 use Illuminate\Auth\Events\Registered;
 use Illuminate\Auth\Listeners\SendEmailVerificationNotification;
@@ -46,5 +49,10 @@ class EventServiceProvider extends ServiceProvider
         \SocialiteProviders\Manager\SocialiteWasCalled::class => [
             \SocialiteProviders\Twitter\TwitterExtendSocialite::class.'@handle',
         ],
+
+        ApiRegistered::class => [
+            SendCompanyEmailVerificationNotification::class,
+            SendWelcomeCompanyNotification::class,
+        ],
     ];
 }

app/Traits/HasUsername.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace App\Traits;
+
+use Illuminate\Support\Str;
+
+trait HasUsername
+{
+    public function username(): string
+    {
+        return $this->username;
+    }
+
+    public function setUsernameAttribute(string $username): void
+    {
+        $this->attributes['username'] = $this->generateUniqueUsername($username);
+    }
+
+    public static function findByUsername(string $username): self
+    {
+        return static::where('username', $username)->firstOrFail();
+    }
+
+    private function generateUniqueUsername(string $value): string
+    {
+        $username = $originalUsername = $value ?: Str::random(6);
+        $counter = 0;
+
+        while ($this->usernameExists($username, $this->exists ? $this->id : null)) {
+            $counter++;
+            $username = $originalUsername.$counter;
+        }
+
+        return $username;
+    }
+
+    private function usernameExists(string $username, int $ignoreId = null): bool
+    {
+        $query = $this->where('username', $username);
+
+        if ($ignoreId) {
+            $query->where('id', '!=', $ignoreId);
+        }
+
+        return $query->exists();
+    }
+}

database/seeders/AddEnterpriseRoleSeeder.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Database\Seeders;
+
+use Illuminate\Database\Console\Seeds\WithoutModelEvents;
+use Illuminate\Database\Seeder;
+use Spatie\Permission\Models\Role;
+
+class AddEnterpriseRoleSeeder extends Seeder
+{
+    /**
+     * Run the database seeds.
+     *
+     * @return void
+     */
+    public function run(): void
+    {
+        Role::create(['name' => 'company']);
+    }
+}