feat(api): add API_GetUserSetRequests

app/Models/UserGameListEntry.php

@@ -5,12 +5,17 @@
 namespace App\Models;
 
 use App\Support\Database\Eloquent\BaseModel;
+use Database\Factories\UserGameListEntryFactory;
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Support\Carbon;
 
 class UserGameListEntry extends BaseModel
 {
+    /** @use HasFactory<UserGameListEntryFactory> */
+    use HasFactory;
+
     // TODO rename SetRequest to user_game_list_entry or integrate into player_games table
     // TODO rename GameID to game_id
     // TODO drop user_game_list_entry_username_game_id_type_unique
@@ -29,6 +34,11 @@ class UserGameListEntry extends BaseModel
         'GameID' => 'integer',
     ];
 
+    protected static function newFactory(): UserGameListEntryFactory
+    {
+        return UserGameListEntryFactory::new();
+    }
+
     // helpers
 
     public static function getUserSetRequestsInformation(User $user): array

database/factories/UserGameListEntryFactory.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Database\Factories;
+
+use App\Models\Game;
+use App\Models\User;
+use App\Models\UserGameListEntry;
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+/**
+ * @extends Factory<UserGameListEntry>
+ */
+class UserGameListEntryFactory extends Factory
+{
+    protected $model = UserGameListEntry::class;
+
+    public function definition(): array
+    {
+        return [
+            'user_id' => User::factory(),
+            'type' => 'achievement_set_request',
+            'GameID' => Game::factory(),
+        ];
+    }
+}

public/API/API_GetUserSetRequests.php

@@ -0,0 +1,76 @@
+<?php
+
+/*
+ *  API_GetUserSetRequests - gets user's set request list
+ *    u : username
+ *    t : type. 0 = only active, 1 = all requests including completed ones (default: 0)
+ *
+ *  array      RequestedSets
+ *    object     [value]
+ *      int        GameID                     unique identifier of the game
+ *      string     Title                      set title
+ *      int        ConsoleID                  the id of the console that the set is for
+ *      string     ConsoleName                the name of the console that the set is for
+ *      string     ImageIcon                  the url of the sets icon
+ *  int        TotalRequests              maximum number of requests a user has
+ *  int        PointsForNext              number of points remaining until maximum request increase
+ */
+
+use App\Models\User;
+use App\Models\UserGameListEntry;
+use App\Support\Rules\CtypeAlnum;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Facades\Validator;
+
+$input = Validator::validate(Arr::wrap(request()->query()), [
+    'u' => ['required', 'min:2', 'max:20', new CtypeAlnum()],
+    't' => ['nullable', 'in:0,1'],
+]);
+
+$user = User::firstWhere('User', request()->query('u'));
+if (!$user) {
+    return response()->json([], 404);
+}
+
+$type = (int) request()->query('t');
+
+if ($type === 1) {
+    $requestedSets = UserGameListEntry::select([
+        'GameData.id as GameID',
+        'GameData.Title',
+        'GameData.ImageIcon',
+        'GameData.ConsoleID',
+        'Console.Name as ConsoleName',
+    ])
+        ->join('GameData', 'SetRequest.GameID', '=', 'GameData.ID')
+        ->join('Console', 'GameData.ConsoleID', '=', 'Console.ID')
+        ->where('SetRequest.user_id', $user->id)
+        ->where('type', 'achievement_set_request')
+        ->orderBy('GameData.sort_title')
+        ->get()
+        ->toArray();
+} else {
+    $requestedSets = UserGameListEntry::select([
+        'GameData.id as GameID',
+        'GameData.Title',
+        'GameData.ImageIcon',
+        'GameData.ConsoleID',
+        'Console.Name as ConsoleName',
+    ])
+        ->join('GameData', 'SetRequest.GameID', '=', 'GameData.ID')
+        ->join('Console', 'GameData.ConsoleID', '=', 'Console.ID')
+        ->where('SetRequest.user_id', $user->id)
+        ->where('type', 'achievement_set_request')
+        ->where('GameData.achievements_published', '=', '0')
+        ->orderBy('GameData.sort_title')
+        ->get()
+        ->toArray();
+}
+
+$userRequestInfo = UserGameListEntry::getUserSetRequestsInformation($user);
+
+return response()->json([
+    'RequestedSets' => $requestedSets,
+    'TotalRequests' => $userRequestInfo['total'],
+    'PointsForNext' => $userRequestInfo['pointsForNext'],
+]);

tests/Feature/Api/V1/UserSetRequestsTest.php

@@ -0,0 +1,141 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Feature\Api\V1;
+
+use App\Models\Game;
+use App\Models\System;
+use App\Models\User;
+use App\Models\UserGameListEntry;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Tests\TestCase;
+
+class UserSetRequestsTest extends TestCase
+{
+    use RefreshDatabase;
+    use BootstrapsApiV1;
+
+    /**
+     * Test that the API returns an empty response for a non-existent user.
+     */
+    public function testGetUserSetRequestsUnknownUser(): void
+    {
+        $this->get($this->apiUrl('GetUserSetRequests', ['u' => 'nonExistant']))
+            ->assertStatus(404)
+            ->assertJson([]);
+    }
+
+    /**
+     * Test that the API returns all set requests for an existing user.
+     */
+    public function testGetAllUserSetRequests(): void
+    {
+        $system = System::factory()->create();
+        $game = Game::factory()->create([
+            'ConsoleID' => $system->ID,
+            'ImageIcon' => '/Images/001234.png',
+            'achievements_published' => 0,
+
+        ]);
+        $game2 = Game::factory()->create([
+            'Title' => '~Hack~ Test Case',
+            'ConsoleID' => $system->ID,
+            'ImageIcon' => '/Images/001235.png',
+            'achievements_published' => 12,
+        ]);
+
+        $user = User::factory()->create([
+            'RAPoints' => 1501, // enough points to set request total to 1
+        ]);
+
+        // Create the first user game list entry for the set request
+        UserGameListEntry::factory()->create([
+            'user_id' => $user->ID,
+            'type' => 'achievement_set_request',
+            'GameID' => $game->ID,
+        ]);
+        // Create the second user game list entry for the set request
+        UserGameListEntry::factory()->create([
+            'user_id' => $user->ID,
+            'type' => 'achievement_set_request',
+            'GameID' => $game2->ID,
+        ]);
+
+        $this->get($this->apiUrl('GetUserSetRequests', ['u' => $user->User, 't' => 1]))
+            ->assertSuccessful()
+            ->assertJson([
+                'RequestedSets' => [
+                    [
+                        'GameID' => $game->ID,
+                        'Title' => $game->Title,
+                        'ConsoleID' => $game->ConsoleID,
+                        'ConsoleName' => $system->Name,
+                        'ImageIcon' => $game->ImageIcon,
+                    ],
+                    [
+                        'GameID' => $game2->ID,
+                        'Title' => $game2->Title,
+                        'ConsoleID' => $game2->ConsoleID,
+                        'ConsoleName' => $system->Name,
+                        'ImageIcon' => $game2->ImageIcon,
+                    ],
+                ],
+                'TotalRequests' => 1,
+                'PointsForNext' => 999,
+            ]);
+    }
+
+    /**
+     * Test that the API returns only set requests with no published achievements for an existing user.
+     */
+    public function testGetUserSetRequests(): void
+    {
+        $system = System::factory()->create();
+        $game = Game::factory()->create([
+            'ConsoleID' => $system->ID,
+            'ImageIcon' => '/Images/001234.png',
+            'achievements_published' => 4,
+        ]);
+        $game2 = Game::factory()->create([
+            'Title' => '~Hack~ Test Case',
+            'ConsoleID' => $system->ID,
+            'ImageIcon' => '/Images/001235.png',
+            'achievements_published' => 0,
+        ]);
+
+        $user = User::factory()->create([
+            'RAPoints' => 1501, // enough points to set request total to 1
+        ]);
+
+        // Create the first user game list entry for the set request
+        UserGameListEntry::factory()->create([
+            'user_id' => $user->ID,
+            'type' => 'achievement_set_request',
+            'GameID' => $game->ID,
+        ]);
+        // Create the second user game list entry for the set request
+        UserGameListEntry::factory()->create([
+            'user_id' => $user->ID,
+            'type' => 'achievement_set_request',
+            'GameID' => $game2->ID,
+        ]);
+
+        // Note that only the second game is present in the assert. The  code will find the first game as well but only return the game with no published achievements.
+        $this->get($this->apiUrl('GetUserSetRequests', ['u' => $user->User, 't' => 0]))
+            ->assertSuccessful()
+            ->assertJson([
+                'RequestedSets' => [
+                    [
+                        'GameID' => $game2->ID,
+                        'Title' => $game2->Title,
+                        'ConsoleID' => $game2->ConsoleID,
+                        'ConsoleName' => $system->Name,
+                        'ImageIcon' => $game2->ImageIcon,
+                    ],
+                ],
+                'TotalRequests' => 1,
+                'PointsForNext' => 999,
+            ]);
+    }
+}