#80 - Inviting to quizzes - Backend

app/Actions/AssignToQuizAction.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Actions;
+
+use App\Models\Quiz;
+use App\Models\User;
+use Illuminate\Support\Collection;
+
+class AssignToQuizAction
+{
+    /**
+     * @param Collection<User> $users
+     */
+    public function execute(Quiz $quiz, Collection $users): void
+    {
+        $assignedUsers = $quiz->assignedUsers;
+        $users = User::query()->whereIn("id", $users)->get();
+
+        $users = $users->filter(fn(User $user) => !$assignedUsers->contains($user));
+        $quiz->assignedUsers()->attach($users);
+    }
+}

app/Actions/UnassignToQuizAction.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Actions;
+
+use App\Models\Quiz;
+use App\Models\User;
+use Illuminate\Support\Collection;
+
+class UnassignToQuizAction
+{
+    /**
+     * @param Collection<User> $users
+     */
+    public function execute(Quiz $quiz, Collection $users): void
+    {
+        $assignedUsers = $quiz->assignedUsers;
+        $users = User::query()->whereIn("id", $users)->get();
+        $users = $users->filter(fn(User $user) => $assignedUsers->contains($user));
+        $quiz->assignedUsers()->detach($users);
+    }
+}

app/Helpers/SortHelper.php

@@ -0,0 +1,70 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Helpers;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Http\Request;
+use Illuminate\Pagination\LengthAwarePaginator;
+use Illuminate\Support\Facades\Lang;
+use Symfony\Component\HttpFoundation\Response as Status;
+
+class SortHelper
+{
+    public function __construct(
+        private Request $request,
+    ) {}
+
+    /**
+     * @param array<string> $allowedFields
+     * @param array<string> $ignoredFields
+     */
+    public function sort(Builder $query, array $allowedFields, array $ignoredFields): Builder
+    {
+        [$field, $order] = $this->getSortParameters();
+
+        if (!in_array($field, $allowedFields, true)) {
+            if (in_array($field, $ignoredFields, true)) {
+                return $query;
+            }
+
+            abort(Status::HTTP_BAD_REQUEST, Lang::get("validation.custom.sorting.unsupported_field", ["attribute" => $field]));
+        }
+
+        return $query->orderBy($field, $order);
+    }
+
+    /**
+     * @return array<string>
+     */
+    public function getSortParameters(): array
+    {
+        $field = $this->request->query("sort", "id");
+        $ascending = $this->request->query("order", "asc") === "asc";
+
+        return [$field, $ascending ? "asc" : "desc"];
+    }
+
+    public function search(Builder $query, string $field): Builder
+    {
+        $searchText = $this->request->query("search");
+
+        if ($searchText) {
+            return $query->where($field, "ilike", "%$searchText%");
+        }
+
+        return $query;
+    }
+
+    public function paginate(Builder $query): LengthAwarePaginator
+    {
+        $limit = (int)$this->request->query("limit", "50");
+
+        if (!$limit || $limit < 0) {
+            $limit = 50;
+        }
+
+        return $query->paginate($limit);
+    }
+}

app/Http/Controllers/InviteController.php

@@ -0,0 +1,111 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http\Controllers;
+
+use App\Actions\AssignToQuizAction;
+use App\Actions\UnassignToQuizAction;
+use App\Helpers\SortHelper;
+use App\Http\Requests\InviteQuizRequest;
+use App\Http\Resources\QuizResource;
+use App\Http\Resources\SchoolResource;
+use App\Http\Resources\UserResource;
+use App\Models\Quiz;
+use App\Models\School;
+use App\Models\User;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Http\RedirectResponse;
+use Illuminate\Http\Request;
+use Inertia\Inertia;
+use Inertia\Response;
+
+class InviteController extends Controller
+{
+    public function index(Quiz $quiz, SortHelper $sort, Request $request): Response
+    {
+        $this->authorize("invite", $quiz);
+        $query = User::query()->role("user")->with("school")->whereNotNull("email_verified_at");
+        $query = $sort->sort($query, ["id"], ["name", "school"]);
+        $query = $this->sortByName($query, $sort);
+        $query = $this->sortBySchool($query, $sort);
+        $query = $this->filterByName($query, $request);
+        $query = $this->filterBySchool($query, $request);
+        $schools = SchoolResource::collection(School::all());
+
+        return Inertia::render("Admin/Invite", [
+            "users" => UserResource::collection($sort->paginate($query)),
+            "quiz" => QuizResource::make($quiz),
+            "schools" => $schools,
+            "assigned" => $quiz->assignedUsers->pluck("id"),
+        ]);
+    }
+
+    public function assign(Quiz $quiz, InviteQuizRequest $request, AssignToQuizAction $assignAction): RedirectResponse
+    {
+        $this->authorize("invite", $quiz);
+
+        $assignAction->execute($quiz, collect($request->input("ids")));
+
+        return redirect()
+            ->back()
+            ->with("status", "Użytkownicy zostali przypisani do quizu.");
+    }
+
+    public function unassign(Quiz $quiz, InviteQuizRequest $request, UnassignToQuizAction $unassignAction): RedirectResponse
+    {
+        $this->authorize("invite", $quiz);
+
+        $unassignAction->execute($quiz, collect($request->input("ids")));
+
+        return redirect()
+            ->back()
+            ->with("status", "Użytkownicy zostali wypisani z quizu.");
+    }
+
+    private function filterByName(Builder $query, Request $request): Builder
+    {
+        $searchName = $request->query("search");
+
+        if ($searchName) {
+            return $query->where("users.name", "ilike", "%$searchName%")
+                ->orWhere("users.surname", "ilike", "%$searchName%");
+        }
+
+        return $query;
+    }
+
+    private function filterBySchool(Builder $query, Request $request): Builder
+    {
+        $searchSchool = $request->query("schoolId");
+
+        if ($searchSchool) {
+            return $query->where("school_id", $searchSchool);
+        }
+
+        return $query;
+    }
+
+    private function sortByName(Builder $query, SortHelper $sorter): Builder
+    {
+        [$field, $order] = $sorter->getSortParameters();
+
+        if ($field === "name") {
+            return $query->orderBy("surname", $order)
+                ->orderBy("name", $order);
+        }
+
+        return $query;
+    }
+
+    private function sortBySchool(Builder $query, SortHelper $sorter): Builder
+    {
+        [$field, $order] = $sorter->getSortParameters();
+
+        if ($field === "schoolId") {
+            return $query->orderBy("school.name", $order);
+        }
+
+        return $query;
+    }
+}

app/Http/Requests/InviteQuizRequest.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http\Requests;
+
+use Illuminate\Contracts\Validation\ValidationRule;
+use Illuminate\Foundation\Http\FormRequest;
+
+class InviteQuizRequest extends FormRequest
+{
+    public function authorize(): bool
+    {
+        return true;
+    }
+
+    /**
+     * @return array<string, ValidationRule|array|string>
+     */
+    public function rules(): array
+    {
+        return [
+            "ids.*" => ["required", "integer"],
+        ];
+    }
+}

app/Http/Resources/InviteResource.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http\Resources;
+
+use Illuminate\Http\Request;
+use Illuminate\Http\Resources\Json\JsonResource;
+
+class InviteResource extends JsonResource
+{
+    /**
+     * @return array<string, mixed>
+     */
+    public function toArray(Request $request): array
+    {
+        return [
+            "user" => [
+                "id" => $this->user->id,
+                "name" => $this->user->name,
+                "surname" => $this->user->surname,
+                "school" => $this->user->school,
+            ],
+            "points" => $this->points,
+        ];
+    }
+}

app/Jobs/SendInviteJob.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Jobs;
+
+use App\Models\Quiz;
+use App\Models\User;
+use App\Notifications\InviteUserNotification;
+use Illuminate\Bus\Batchable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Foundation\Queue\Queueable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+
+class SendInviteJob implements ShouldQueue
+{
+    use Dispatchable;
+    use InteractsWithQueue;
+    use Queueable;
+    use SerializesModels;
+    use Batchable;
+
+    public function __construct(
+        protected User $user,
+        protected Quiz $quiz,
+    ) {}
+
+    public function handle(): void
+    {
+        $this->user->notify(new InviteUserNotification($this->quiz));
+    }
+}

app/Jobs/SendPasswordResetJob.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Jobs;
+
+use App\Models\User;
+use App\Notifications\ResetPasswordNotification;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Foundation\Queue\Queueable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+
+class SendPasswordResetJob implements ShouldQueue
+{
+    use Dispatchable;
+    use InteractsWithQueue;
+    use Queueable;
+    use SerializesModels;
+
+    public function __construct(
+        protected User $user,
+        protected string $token,
+    ) {}
+
+    public function handle(): void
+    {
+        $this->user->notify(new ResetPasswordNotification($this->token));
+    }
+}

app/Jobs/SendVerificationEmailJob.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Jobs;
+
+use App\Models\User;
+use App\Notifications\SendVerificationEmail;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Foundation\Queue\Queueable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+
+class SendVerificationEmailJob implements ShouldQueue
+{
+    use Dispatchable;
+    use InteractsWithQueue;
+    use Queueable;
+    use SerializesModels;
+
+    public function __construct(
+        protected User $user,
+    ) {}
+
+    public function handle(): void
+    {
+        $this->user->notify(new SendVerificationEmail());
+    }
+}