Skip to content

fix: Update CRUD implementation for categories #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 25, 2025
Merged

fix: Update CRUD implementation for categories #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
41a193a
fix: Fixed Categories
kofimokome Jan 25, 2025
5577eac
refactor: Merge IncomeCategory and ExpenseCategory into Category
kofimokome Jan 25, 2025
7ba494a
feat: add slug to categories table
kofimokome Jan 25, 2025
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
110 changes: 35 additions & 75 deletions .../API/v1/TransactionCategoryController.php → ...Controllers/API/v1/CategoryController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,18 @@
namespace App\Http\Controllers\API\v1;

use App\Http\Controllers\API\ApiController;
use App\Models\ExpenseCategory;
use App\Models\IncomeCategory;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Validator;
use OpenApi\Attributes as OA;

#[OA\Tag(name: 'Transaction Categories', description: 'Endpoints for managing transaction categories')]
class TransactionCategoryController extends ApiController
#[OA\Tag(name: 'Categories', description: 'Endpoints for managing transaction categories')]
class CategoryController extends ApiController
{
#[OA\Get(
path: '/categories',
summary: 'List all categories',
tags: ['Transaction Categories'],
tags: ['Categories'],
parameters: [
new OA\Parameter(
name: 'type',
Expand All @@ -30,7 +28,7 @@ class TransactionCategoryController extends ApiController
new OA\Response(
response: 200,
description: 'Successful operation',
content: new OA\JsonContent(type: 'array', items: new OA\Items(ref: '#/components/schemas/TransactionCategory'))
content: new OA\JsonContent(type: 'array', items: new OA\Items(ref: '#/components/schemas/Category'))
),
new OA\Response(
response: 500,
Expand All @@ -40,38 +38,38 @@ class TransactionCategoryController extends ApiController
)]
public function index(Request $request): JsonResponse
{
$type = $request->query('type');

if ($type === 'income') {
$categories = IncomeCategory::paginate(20);
} elseif ($type === 'expense') {
$categories = ExpenseCategory::paginate(20);
} else {
return $this->failure('Invalid category type', 400);
$user = $request->user();
$categories = $user->categories();
if ($request->has('type') && $request->type == 'income') {
$categories = $categories->where('type', 'income');
} elseif ($request->has('type') && $request->type == 'expense') {
$categories = $categories->where('type', 'expense');
}
$categories = $categories->paginate(20);

return $this->success($categories);
}

#[OA\Post(
path: '/categories',
summary: 'Create a new category',
tags: ['Transaction Categories'],
tags: ['Categories'],
requestBody: new OA\RequestBody(
required: true,
content: new OA\JsonContent(
required: ['type', 'name'],
properties: [
new OA\Property(property: 'type', type: 'string', enum: ['income', 'expense'], description: 'Type of the category'),
new OA\Property(property: 'name', type: 'string', description: 'Name of the category'),
new OA\Property(property: 'description', type: 'string', description: 'The description of the category'),
]
)
),
responses: [
new OA\Response(
response: 201,
description: 'Category created successfully',
content: new OA\JsonContent(ref: '#/components/schemas/TransactionCategory')
content: new OA\JsonContent(ref: '#/components/schemas/Category')
),
new OA\Response(
response: 400,
Expand All @@ -88,28 +86,29 @@ public function store(Request $request): JsonResponse
$validator = Validator::make($request->all(), [
'type' => 'required|string|in:income,expense',
'name' => 'required|string|max:255',
'description' => 'nullable|string',
]);

if ($validator->fails()) {
return $this->failure('Validation error', 400, $validator->errors()->all());
}

$data = $validator->validated();
$category = null;

if ($data['type'] === 'income') {
$category = IncomeCategory::create(['name' => $data['name']]);
} elseif ($data['type'] === 'expense') {
$category = ExpenseCategory::create(['name' => $data['name']]);
$user = $request->user();
$data['user_id'] = $user->id;
$category_exists = $user->categories()->where('name', $data['name'])->where('user_id', $user->id)->first();
if ($category_exists) {
return $this->failure('Category already exists', 400);
}
$category = $user->categories()->firstOrCreate($data);

return $this->success($category, 'Category created successfully', 201);
}

#[OA\Get(
path: '/categories/{id}',
summary: 'Get a specific category',
tags: ['Transaction Categories'],
tags: ['Categories'],
parameters: [
new OA\Parameter(
name: 'id',
Expand All @@ -118,19 +117,12 @@ public function store(Request $request): JsonResponse
schema: new OA\Schema(type: 'integer'),
description: 'ID of the category'
),
new OA\Parameter(
name: 'type',
in: 'query',
required: true,
schema: new OA\Schema(type: 'string', enum: ['income', 'expense']),
description: 'Type of the category (income or expense)'
),
],
responses: [
new OA\Response(
response: 200,
description: 'Successful operation',
content: new OA\JsonContent(ref: '#/components/schemas/TransactionCategory')
content: new OA\JsonContent(ref: '#/components/schemas/Category')
),
new OA\Response(
response: 404,
Expand All @@ -144,15 +136,8 @@ public function store(Request $request): JsonResponse
)]
public function show(Request $request, int $id): JsonResponse
{
$type = $request->query('type');

if ($type === 'income') {
$category = IncomeCategory::find($id);
} elseif ($type === 'expense') {
$category = ExpenseCategory::find($id);
} else {
return $this->failure('Invalid category type', 400);
}
$user = $request->user();
$category = $user->categories()->find($id);

if (! $category) {
return $this->failure('Category not found', 404);
Expand All @@ -164,7 +149,7 @@ public function show(Request $request, int $id): JsonResponse
#[OA\Put(
path: '/categories/{id}',
summary: 'Update a specific category',
tags: ['Transaction Categories'],
tags: ['Categories'],
parameters: [
new OA\Parameter(
name: 'id',
Expand All @@ -173,27 +158,21 @@ public function show(Request $request, int $id): JsonResponse
schema: new OA\Schema(type: 'integer'),
description: 'ID of the category'
),
new OA\Parameter(
name: 'type',
in: 'query',
required: true,
schema: new OA\Schema(type: 'string', enum: ['income', 'expense']),
description: 'Type of the category (income or expense)'
),
],
requestBody: new OA\RequestBody(
required: true,
content: new OA\JsonContent(
properties: [
new OA\Property(property: 'name', type: 'string', description: 'Name of the category'),
new OA\Property(property: 'description', type: 'string', description: 'The description of the category'),
]
)
),
responses: [
new OA\Response(
response: 200,
description: 'Category updated successfully',
content: new OA\JsonContent(ref: '#/components/schemas/TransactionCategory')
content: new OA\JsonContent(ref: '#/components/schemas/Category')
),
new OA\Response(
response: 404,
Expand All @@ -214,36 +193,31 @@ public function update(Request $request, int $id): JsonResponse
$validator = Validator::make($request->all(), [
'type' => 'required|string|in:income,expense',
'name' => 'sometimes|required|string|max:255',
'description' => 'nullable|string',
]);

if ($validator->fails()) {
return $this->failure('Validation error', 400, $validator->errors()->all());
}

$data = $validator->validated();
$category = null;
$user = $request->user();

if ($data['type'] === 'income') {
$category = IncomeCategory::find($id);
} elseif ($data['type'] === 'expense') {
$category = ExpenseCategory::find($id);
} else {
return $this->failure('Invalid category type', 400);
}
$category = $user->categories()->find($id);

if (! $category) {
return $this->failure('Category not found', 404);
}

$category->update(['name' => $data['name']]);
$category->update($data);

return $this->success($category, 'Category updated successfully');
}

#[OA\Delete(
path: '/categories/{id}',
summary: 'Delete a specific category',
tags: ['Transaction Categories'],
tags: ['Categories'],
parameters: [
new OA\Parameter(
name: 'id',
Expand All @@ -252,13 +226,6 @@ public function update(Request $request, int $id): JsonResponse
schema: new OA\Schema(type: 'integer'),
description: 'ID of the category'
),
new OA\Parameter(
name: 'type',
in: 'query',
required: true,
schema: new OA\Schema(type: 'string', enum: ['income', 'expense']),
description: 'Type of the category (income or expense)'
),
],
responses: [
new OA\Response(
Expand All @@ -281,15 +248,8 @@ public function update(Request $request, int $id): JsonResponse
)]
public function destroy(Request $request, int $id): JsonResponse
{
$type = $request->query('type');

if ($type === 'income') {
$category = IncomeCategory::find($id);
} elseif ($type === 'expense') {
$category = ExpenseCategory::find($id);
} else {
return $this->failure('Invalid category type', 400);
}
$user = $request->user();
$category = $user->categories()->find($id);

if (! $category) {
return $this->failure('Category not found', 404);
Expand Down
43 changes: 43 additions & 0 deletions app/Models/Category.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<?php

namespace App\Models;

use Cviebrock\EloquentSluggable\Sluggable;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use OpenApi\Attributes as OA;

#[OA\Schema(
schema: 'Category',
type: 'object',
properties: [
new OA\Property(property: 'id', type: 'integer', description: 'ID of the category'),
new OA\Property(property: 'name', type: 'string', description: 'Name of the category'),
new OA\Property(property: 'description', type: 'string', description: 'Description of the category'),
new OA\Property(property: 'type', type: 'string', description: 'Type of the category (income or expense)'),
]
)]
class Category extends Model
{
use HasFactory, Sluggable;

protected $fillable = [
'name',
'description',
'type',
'user_id',
'slug',
];

/**
* Return the sluggable configuration array for this model.
*/
public function sluggable(): array
{
return [
'slug' => [
'source' => 'name',
],
];
}
}
21 changes: 0 additions & 21 deletions app/Models/ExpenseCategory.php
View file
Open in desktop

This file was deleted.

21 changes: 0 additions & 21 deletions app/Models/IncomeCategory.php
View file
Open in desktop

This file was deleted.

21 changes: 0 additions & 21 deletions app/Models/TransactionCategory.php
View file
Open in desktop

This file was deleted.

5 changes: 5 additions & 0 deletions app/Models/User.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,9 @@ class User extends Authenticatable
'email_verified_at' => 'datetime',
'password' => 'hashed',
];

public function categories()
{
return $this->hasMany(Category::class);
}
}
1 change: 1 addition & 0 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"license": "MIT",
"require": {
"php": "^8.1",
"cviebrock/eloquent-sluggable": "^10.0",
"guzzlehttp/guzzle": "^7.2",
"laravel/framework": "^10.10",
"laravel/sanctum": "^3.3",
Expand Down
Loading
Loading