feat(Links): add index endpoint

Author: José Postiga

domains/Links/Controllers/LinksIndexController.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Domains\Links\Controllers;
+
+use App\Http\Controllers\Controller;
+use Domains\Links\Models\Link;
+use Domains\Links\Resources\LinkResource;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Http\Request;
+use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
+
+class LinksIndexController extends Controller
+{
+    private Link $links;
+
+    public function __construct(Link $links)
+    {
+        $this->links = $links;
+    }
+
+    public function __invoke(Request $request): AnonymousResourceCollection
+    {
+        $links = $this->links
+            ->when($request->input('include'), static function (Builder $query, string $includes) {
+                return $query->with(
+                    explode(',', $includes)
+                );
+            })
+            ->approved()
+            ->simplePaginate();
+
+        return LinkResource::collection($links);
+    }
+}

domains/Links/Database/Factories/LinkFactory.php

@@ -1,6 +1,7 @@
 <?php
 
 use Domains\Links\Models\Link;
+use Domains\Tags\Models\Tag;
 use Illuminate\Database\Eloquent\Factory;
 use Illuminate\Http\UploadedFile;
 use Illuminate\Support\Carbon;
@@ -15,3 +16,14 @@
     'created_at' => Carbon::now(),
     'approved_at' => null,
 ]);
+
+$factory->afterCreating(Link::class, static function (Link $link) {
+    $link->tags()
+        ->attach(
+            factory(Tag::class)->create()
+        );
+});
+
+$factory->state(Link::class, 'approved', static fn () => [
+    'approved_at' => Carbon::now(),
+]);

domains/Links/Models/Link.php

@@ -3,6 +3,7 @@
 namespace Domains\Links\Models;
 
 use Domains\Tags\Models\Tag;
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\SoftDeletes;
@@ -23,4 +24,9 @@ public function tags(): BelongsToMany
     {
         return $this->belongsToMany(Tag::class);
     }
+
+    public function scopeApproved(Builder $query): Builder
+    {
+        return $query->whereNotNull('approved_at');
+    }
 }

domains/Links/Resources/LinkResource.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Domains\Links\Resources;
+
+use Domains\Tags\Resources\TagResource;
+use Illuminate\Http\Resources\Json\JsonResource;
+
+class LinkResource extends JsonResource
+{
+    public function toArray($request): array
+    {
+        return [
+            'id' => $this->id,
+            'link' => $this->link,
+            'description' => $this->description,
+            'author_name' => $this->author_name,
+            'author_email' => $this->author_email,
+            'cover_image' => $this->cover_image,
+            'created_at' => $this->created_at,
+            'updated_at' => $this->updated_at,
+            'approved_at' => $this->approved_at,
+            'tags' => TagResource::collection(
+                $this->whenLoaded('tags')
+            ),
+        ];
+    }
+}

domains/Links/Routes/api.php

@@ -1,5 +1,7 @@
 <?php
 
+use Domains\Links\Controllers\LinksIndexController;
 use Domains\Links\Controllers\LinksStoreController;
 
+Route::get('/links', LinksIndexController::class)->name('links.index');
 Route::post('/links', LinksStoreController::class)->name('links.store');

domains/Links/Tests/Feature/LinksIndexTest.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace Domains\Links\Tests\Feature;
+
+use Domains\Links\Models\Link;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Tests\TestCase;
+
+class LinksIndexTest extends TestCase
+{
+    use RefreshDatabase;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        factory(Link::class, 20)->state('approved')->create();
+    }
+
+    /** @test */
+    public function it_lists_resources(): void
+    {
+        $this->getJson('/links')
+            ->assertSuccessful()
+            ->assertJsonStructure([
+                'data' => [
+                    [
+                        'id', 'link', 'description', 'cover_image', 'author_name', 'author_email', 'created_at',
+                    ],
+                ],
+                'links' => [
+                    'first', 'last', 'prev', 'next',
+                ],
+            ]);
+    }
+
+    /** @test */
+    public function it_includes_tags_relation(): void
+    {
+        $this->getJson('/links?include=tags')
+            ->assertSuccessful()
+            ->assertJsonStructure([
+                'data' => [
+                    [
+                        'tags',
+                    ],
+                ],
+            ])
+            ->assertJsonCount(1, 'data.0.tags');
+    }
+
+    /** @test */
+    public function it_doesnt_include_relations_if_not_required(): void
+    {
+        $response = $this->getJson('/links')
+            ->assertSuccessful()
+            ->decodeResponseJson();
+
+        $this->assertArrayNotHasKey('tags', $response['data'][0]);
+    }
+
+    /** @test */
+    public function it_supports_pagination_navigation(): void
+    {
+        $this->getJson('/links?page=2')
+            ->assertSuccessful()
+            ->assertJsonPath('meta.current_page', 2);
+    }
+}

domains/Links/Tests/Unit/LinkModelTest.php

@@ -62,4 +62,10 @@ public function it_has_tags_relation(): void
     {
         $this->assertInstanceOf(Tag::class, $this->model->tags()->getModel());
     }
+
+    /** @test */
+    public function it_has_approved_scope(): void
+    {
+        $this->assertTrue(method_exists($this->model, 'scopeApproved'));
+    }
 }