Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions app/Http/Controllers/Api/V1/Category/GetCategoriesController.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<?php

declare(strict_types=1);

namespace App\Http\Controllers\Api\V1\Category;

use App\Http\Controllers\Controller;
use App\Http\Resources\Api\V1\Category\CategoryResource;
use App\Services\ArticleService;
use Dedoc\Scramble\Attributes\Group;
use Illuminate\Http\JsonResponse;
use Symfony\Component\HttpFoundation\Response;

#[Group('Categories', weight: 2)]
class GetCategoriesController extends Controller
{
public function __construct(private readonly ArticleService $articleService) {}

/**
* Get All Categories
*
* @unauthenticated
*
* @response array{status: true, message: string, data: CategoryResource[]}
*/
public function __invoke(): JsonResponse
{
try {
$categories = $this->articleService->getAllCategories();

return response()->apiSuccess(
CategoryResource::collection($categories),
__('common.success')
);
} catch (\Throwable $e) {
return response()->apiError(
__('common.error'),
Response::HTTP_INTERNAL_SERVER_ERROR,
null,
$e->getMessage()
);
}
}
}
44 changes: 44 additions & 0 deletions app/Http/Controllers/Api/V1/Tag/GetTagsController.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<?php

declare(strict_types=1);

namespace App\Http\Controllers\Api\V1\Tag;

use App\Http\Controllers\Controller;
use App\Http\Resources\Api\V1\Tag\TagResource;
use App\Services\ArticleService;
use Dedoc\Scramble\Attributes\Group;
use Illuminate\Http\JsonResponse;
use Symfony\Component\HttpFoundation\Response;

#[Group('Tags', weight: 2)]
class GetTagsController extends Controller
{
public function __construct(private readonly ArticleService $articleService) {}

/**
* Get All Tags
*
* @unauthenticated
*
* @response array{status: true, message: string, data: TagResource[]}
*/
public function __invoke(): JsonResponse
{
try {
$tags = $this->articleService->getAllTags();

return response()->apiSuccess(
TagResource::collection($tags),
__('common.success')
);
} catch (\Throwable $e) {
return response()->apiError(
__('common.error'),
Response::HTTP_INTERNAL_SERVER_ERROR,
null,
$e->getMessage()
);
}
}
}
28 changes: 28 additions & 0 deletions app/Http/Resources/Api/V1/Category/CategoryResource.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?php

declare(strict_types=1);

namespace App\Http\Resources\Api\V1\Category;

use Illuminate\Http\Resources\Json\JsonResource;

/**
* @mixin \App\Models\Category
*/
class CategoryResource extends JsonResource
{
/**
* Transform the resource into an array.
*
* @param \Illuminate\Http\Request $request
* @return array<string, mixed>
*/
public function toArray($request): array
{
return [
'id' => $this->id,
'name' => $this->name,
'slug' => $this->slug,
];
}
}
28 changes: 28 additions & 0 deletions app/Http/Resources/Api/V1/Tag/TagResource.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?php

declare(strict_types=1);

namespace App\Http\Resources\Api\V1\Tag;

use Illuminate\Http\Resources\Json\JsonResource;

/**
* @mixin \App\Models\Tag
*/
class TagResource extends JsonResource
{
/**
* Transform the resource into an array.
*
* @param \Illuminate\Http\Request $request
* @return array<string, mixed>
*/
public function toArray($request): array
{
return [
'id' => $this->id,
'name' => $this->name,
'slug' => $this->slug,
];
}
}
22 changes: 22 additions & 0 deletions app/Services/ArticleService.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
namespace App\Services;

use App\Models\Article;
use App\Models\Category;
use App\Models\Tag;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Pagination\LengthAwarePaginator;

Expand Down Expand Up @@ -123,4 +125,24 @@ private function applyFilters(Builder $query, array $params): void
->where('published_at', '<=', now());
}
}

/**
* Get all categories
*
* @return \Illuminate\Database\Eloquent\Collection<int, Category>
*/
public function getAllCategories()
{
return Category::query()->get(['id', 'name', 'slug']);
}

/**
* Get all tags
*
* @return \Illuminate\Database\Eloquent\Collection<int, Tag>
*/
public function getAllTags()
{
return Tag::query()->get(['id', 'name', 'slug']);
}
}
6 changes: 6 additions & 0 deletions routes/api_v1.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,10 @@
Route::get('/', \App\Http\Controllers\Api\V1\Article\GetArticlesController::class)->name('api.v1.articles.index');
Route::get('/{slug}', \App\Http\Controllers\Api\V1\Article\ShowArticleController::class)->name('api.v1.articles.show');
});

// Category Routes (Public)
Route::get('categories', \App\Http\Controllers\Api\V1\Category\GetCategoriesController::class)->name('api.v1.categories.index');

// Tag Routes (Public)
Route::get('tags', \App\Http\Controllers\Api\V1\Tag\GetTagsController::class)->name('api.v1.tags.index');
});
45 changes: 45 additions & 0 deletions tests/Feature/API/V1/Category/GetCategoriesControllerTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<?php

declare(strict_types=1);

use App\Models\Category;

describe('API/V1/Category/GetCategoriesController', function () {
it('can get all categories', function () {
Category::factory()->count(3)->create();

$response = $this->getJson('/api/v1/categories');

$response->assertStatus(200)
->assertJson(['status' => true])
->assertJson(['message' => __('common.success')])
->assertJsonStructure([
'data' => [
'*' => [
'id',
'name',
'slug',
],
],
]);

expect($response->json('data'))->toHaveCount(3);
});

it('returns error if service throws', function () {
$this->mock(\App\Services\ArticleService::class, function ($mock) {
$mock->shouldReceive('getAllCategories')
->andThrow(new Exception('fail'));
});

$response = $this->getJson('/api/v1/categories');

$response->assertStatus(500)
->assertJson(['status' => false])
->assertJson(['message' => __('common.error')])
->assertJsonStructure([
'data',
'error',
]);
});
});
45 changes: 45 additions & 0 deletions tests/Feature/API/V1/Tag/GetTagsControllerTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<?php

declare(strict_types=1);

use App\Models\Tag;

describe('API/V1/Tag/GetTagsController', function () {
it('can get all tags', function () {
Tag::factory()->count(4)->create();

$response = $this->getJson('/api/v1/tags');

$response->assertStatus(200)
->assertJson(['status' => true])
->assertJson(['message' => __('common.success')])
->assertJsonStructure([
'data' => [
'*' => [
'id',
'name',
'slug',
],
],
]);

expect($response->json('data'))->toHaveCount(4);
});

it('returns error if service throws', function () {
$this->mock(\App\Services\ArticleService::class, function ($mock) {
$mock->shouldReceive('getAllTags')
->andThrow(new Exception('fail'));
});

$response = $this->getJson('/api/v1/tags');

$response->assertStatus(500)
->assertJson(['status' => false])
->assertJson(['message' => __('common.error')])
->assertJsonStructure([
'data',
'error',
]);
});
});