feat(api): Add endpoint for GetComments

app/Models/Comment.php

@@ -5,7 +5,9 @@
 namespace App\Models;
 
 use App\Support\Database\Eloquent\BaseModel;
+use Database\Factories\CommentFactory;
 use Exception;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\MorphTo;
@@ -16,6 +18,7 @@ class Comment extends BaseModel
 {
     use Searchable;
     use SoftDeletes;
+    use HasFactory;
 
     // TODO rename Comment table to comments
     // TODO rename ID column id
@@ -96,4 +99,9 @@ public function user(): BelongsTo
     {
         return $this->belongsTo(User::class, 'user_id', 'ID')->withDefault(['username' => 'Deleted User']);
     }
+
+    protected static function newFactory(): CommentFactory
+    {
+        return CommentFactory::new();
+    }
 }

app/Policies/CommentPolicy.php

@@ -26,7 +26,7 @@ public function manage(User $user): bool
 
     public function view(?User $user, Comment $comment): bool
     {
-        return true;
+        return $user->isNotBanned();
     }
 
     public function create(User $user, ?Model $commentable = null, ?int $articleType = null): bool

database/factories/CommentFactory.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Database\Factories;
+
+use App\Models\Comment;
+use App\Models\User;
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+/**
+ * @extends Factory<Comment>
+ */
+class CommentFactory extends Factory
+{
+    protected $model = Comment::class;
+
+    public function definition(): array
+    {
+        $user = User::inRandomOrder()->first();
+
+        return [
+            'Payload' => $this->faker->paragraph,
+            'Submitted' => $this->faker->dateTimeBetween('-1 year', 'now'),
+            'Edited' => $this->faker->dateTimeBetween('now', '+1 year'),
+            'user_id' => $user->ID,
+            'ArticleID' => $this->faker->numberBetween(1, 100),
+            'ArticleType' => $this->faker->numberBetween(1, 3),
+        ];
+    }
+}

public/API/API_GetComments.php

@@ -0,0 +1,85 @@
+<?php
+
+use App\Models\Achievement;
+use App\Models\Comment;
+use App\Models\User;
+use App\Policies\CommentPolicy;
+use App\Support\Rules\CtypeAlnum;
+use Illuminate\Support\Facades\Validator;
+
+/*
+*  API_GetComments - returns the comments associated to a game or achievement
+*    i : game or achievement id
+*    u : username
+*    t : 1 = game, 2 = achievement, 3 = user
+*    o : offset - number of entries to skip (default: 0)
+*    c : count - number of entries to return (default: 100, max: 500)
+*
+*  int         Count                       number of comment records returned in the response
+*  int         Total                       number of comment records the game/achievement/user actually has overall
+*  array       Results
+*   object      [value]
+*    int         User                      username of the commenter
+*    string      Submitted                 date time the comment was submitted
+*    string      CommentText               text of the comment
+*/
+
+$input = Validator::validate(Arr::wrap(request()->query()), [
+    'i' => ['sometimes', 'integer'],
+    't' => ['required', 'integer'],
+    'u' => ['sometimes', 'min:2', 'max:20', new CtypeAlnum()],
+    'o' => ['sometimes', 'integer', 'min:0', 'nullable'],
+    'c' => ['sometimes', 'integer', 'min:1', 'max:500', 'nullable'],
+]);
+
+$offset = $input['o'] ?? 0;
+$count = $input['c'] ?? 100;
+
+$gameOrAchievementId = (int) request()->query('i');
+$username = (string) request()->query('u');
+$commentType = (int) request()->query('t');
+
+$user = null;
+
+if ($username) {
+    $user = User::firstWhere('User', $username);
+    if (!$user || !$user->UserWallActive) {
+        return response()->json(['Count' => 0, 'Total' => 0, 'Results' => []]);
+    }
+}
+
+$articleId = $user ? $user->ID : $gameOrAchievementId;
+
+$comments = Comment::withTrashed()
+    ->where('ArticleType', $commentType)
+    ->where('ArticleID', $articleId)
+    ->offset($offset)
+    ->limit($count)
+    ->with('user')
+    ->get();
+
+$totalComments = Comment::withTrashed()
+    ->where('ArticleType', $commentType)
+    ->where('ArticleID', $articleId)
+    ->whereHas('user', function ($query) {
+        $query->whereNull('banned_at');
+    })
+    ->count();
+
+$policy = new CommentPolicy();
+
+$results = $comments->filter(function ($nextComment) use ($policy) {
+    return $policy->view($nextComment->user, $nextComment);
+})->map(function ($nextComment) {
+    return [
+        'User' => $nextComment->user->username,
+        'Submitted' => $nextComment->Submitted,
+        'CommentText' => $nextComment->Payload,
+    ];
+});
+
+return response()->json([
+    'Count' => $results->count(),
+    'Total' => $totalComments,
+    'Results' => $results,
+]);

tests/Feature/Api/V1/CommentsTest.php

@@ -0,0 +1,215 @@
+<?php
+
+use App\Models\Achievement;
+use App\Models\Comment;
+use App\Models\Game;
+use App\Models\System;
+use App\Models\User;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Foundation\Testing\WithFaker;
+use Illuminate\Support\Carbon;
+use Tests\Feature\Api\V1\BootstrapsApiV1;
+use Tests\TestCase;
+
+class CommentsTest extends TestCase
+{
+    use RefreshDatabase; use WithFaker;
+    use BootstrapsApiV1;
+
+    public function testItValidates(): void
+    {
+        $this->get($this->apiUrl('GetComments', ['u' => '1', 't' => 1]))
+            ->assertJsonValidationErrors([
+                'u',
+            ]);
+    }
+
+    public function testGetCommentsUnknownUser(): void
+    {
+        $this->get($this->apiUrl('GetComments', ['u' => 'nonExistant', 't' => 3]))
+            ->assertSuccessful()
+            ->assertJson([]);
+    }
+
+    public function testGetCommentsForAchievement(): void
+    {
+        // Arrange
+        $system = System::factory()->create();
+        $game = Game::factory()->create(['ConsoleID' => $system->ID]);
+        $user1 = User::factory()->create();
+        $user2 = User::factory()->create();
+        $bannedUser = User::factory()->create(['ID' => 309, 'banned_at' => Carbon::now()->subDay()]);
+
+        $achievement = Achievement::factory()->create(['GameID' => $game->ID, 'user_id' => $user1->ID]);
+        $comment1 = Comment::factory()->create([
+            'ArticleID' => $achievement->ID,
+            'ArticleType' => 2,
+            'user_id' => $user1->ID,
+            'Payload' => 'This is a great achievement!',
+        ]);
+        $comment2 = Comment::factory()->create([
+            'ArticleID' => $achievement->ID,
+            'ArticleType' => 2,
+            'user_id' => $user2->ID,
+            'Payload' => 'I agree, this is awesome!',
+        ]);
+        $comment3 = Comment::factory()->create([
+            'ArticleID' => $achievement->ID,
+            'ArticleType' => 2,
+            'user_id' => $bannedUser->ID,
+            'Payload' => 'This comment is from a banned user!',
+        ]);
+
+        // Act
+        $response = $this->get($this->apiUrl('GetComments', ['i' => $achievement->ID, 't' => 2]))
+            ->assertSuccessful();
+
+        // Assert
+        $response->assertStatus(200);
+        $response->assertJson([
+            'Count' => 2,
+            'Total' => 2,
+            'Results' => [
+                [
+                    'User' => $user1->User,
+                    'Submitted' => $comment1->Submitted->toISOString(),
+                    'CommentText' => $comment1->Payload,
+                ],
+                [
+                    'User' => $user2->User,
+                    'Submitted' => $comment2->Submitted->toISOString(),
+                    'CommentText' => $comment2->Payload,
+                ],
+            ],
+        ]);
+    }
+
+    public function testGetCommentsForGame(): void
+    {
+        // Arrange
+        $system = System::factory()->create();
+        $game = Game::factory()->create(['ConsoleID' => $system->ID]);
+        $user1 = User::factory()->create();
+        $user2 = User::factory()->create();
+        $bannedUser = User::factory()->create(['banned_at' => Carbon::now()]);
+
+        $comment1 = Comment::factory()->create([
+            'ArticleID' => $game->ID,
+            'ArticleType' => 1,
+            'user_id' => $user1->ID,
+            'Payload' => 'This is a great achievement!',
+        ]);
+        $comment2 = Comment::factory()->create([
+            'ArticleID' => $game->ID,
+            'ArticleType' => 1,
+            'user_id' => $user2->ID,
+            'Payload' => 'I agree, this is awesome!',
+        ]);
+        $comment3 = Comment::factory()->create([
+            'ArticleID' => $game->ID,
+            'ArticleType' => 2,
+            'user_id' => $bannedUser->ID,
+            'Payload' => 'This comment is from a banned user!',
+        ]);
+
+        // Act
+        $response = $this->get($this->apiUrl('GetComments', ['i' => $game->ID, 't' => 1]))
+            ->assertSuccessful();
+
+        // Assert
+        $response->assertStatus(200);
+        $response->assertJson([
+            'Count' => 2,
+            'Total' => 2,
+            'Results' => [
+                [
+                    'User' => $user1->User,
+                    'Submitted' => $comment1->Submitted->toISOString(),
+                    'CommentText' => $comment1->Payload,
+                ],
+                [
+                    'User' => $user2->User,
+                    'Submitted' => $comment2->Submitted->toISOString(),
+                    'CommentText' => $comment2->Payload,
+                ],
+            ],
+        ]);
+    }
+
+    public function testGetCommentsForUser(): void
+    {
+        // Arrange
+        $user = User::factory()->create();
+        $user2 = User::factory()->create();
+        $bannedUser = User::factory()->create(['banned_at' => Carbon::now()]);
+
+        $comment1 = Comment::factory()->create([
+            'ArticleID' => $user->ID,
+            'ArticleType' => 3,
+            'user_id' => $user2->ID,
+            'Payload' => 'This is my first comment.',
+        ]);
+        $comment2 = Comment::factory()->create([
+            'ArticleID' => $user->ID,
+            'ArticleType' => 3,
+            'user_id' => $user2->ID,
+            'Payload' => 'This is my second comment.',
+        ]);
+        $comment3 = Comment::factory()->create([
+            'ArticleID' => $user->ID,
+            'ArticleType' => 2,
+            'user_id' => $bannedUser->ID,
+            'Payload' => 'This comment is from a banned user!',
+        ]);
+
+        // Act
+        $response = $this->get($this->apiUrl('GetComments', ['u' => $user->User, 't' => 3]))
+            ->assertSuccessful();
+
+        // Assert
+        $response->assertStatus(200);
+        $response->assertJson([
+            'Count' => 2,
+            'Total' => 2,
+            'Results' => [
+                [
+                    'User' => $user2->User,
+                    'Submitted' => $comment1->Submitted->toISOString(),
+                    'CommentText' => $comment1->Payload,
+                ],
+                [
+                    'User' => $user2->User,
+                    'Submitted' => $comment2->Submitted->toISOString(),
+                    'CommentText' => $comment2->Payload,
+                ],
+            ],
+        ]);
+    }
+
+    public function testGetCommentsForUserWithDisabledWall(): void
+    {
+        // Arrange
+        $user = User::factory()->create(['UserWallActive' => false]);
+        $user2 = User::factory()->create();
+        $comment1 = Comment::factory()->create([
+            'ArticleID' => $user->ID,
+            'ArticleType' => 3,
+            'user_id' => $user2->ID,
+            'Payload' => 'This is my first comment.',
+        ]);
+        $comment2 = Comment::factory()->create([
+            'ArticleID' => $user->ID,
+            'ArticleType' => 3,
+            'user_id' => $user2->ID,
+            'Payload' => 'This is my second comment.',
+        ]);
+
+        // Act
+        $response = $this->get($this->apiUrl('GetComments', ['u' => $user->User, 't' => 3]))
+            ->assertSuccessful();
+
+        // Assert
+        $response->assertStatus(200);
+        $response->assertJsonStructure([]);
+    }
+}