soheilkhaledabadi/hoshpoint-backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add ApiResponse trait for standardized API responses

Browse Source 
chore: update composer dependencies to include phppresentation

chore: update composer.lock after adding phppresentation

feat: create categories migration for category management

feat: create templates migration for template storage

feat: create template generations migration for tracking template usage

feat: create template keys migration for template customization

feat: create notifications migration for user notifications

feat: update API routes for categories, templates, and user profile management

docs: update API documentation to include new endpoints for profile and wallet
This commit is contained in:
soheil khaledabadi
2026-07-07 01:03:12 +03:30
parent cf0e6f82fd
commit ae974c2afa
68 changed files with 3594 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
app/Http/Controllers/Api/AuthController.php
View File

@@ -7,6 +7,7 @@ use App\Http\Requests\Auth\LoginRequest;
use App\Http\Requests\Auth\RegisterRequest;
use App\Http\Resources\UserResource;
use App\Models\User;
use App\Traits\ApiResponse;
use Illuminate\Http\JsonResponse;
use Illuminate\Support\Facades\Hash;
use Illuminate\Support\Str;
@@ -14,6 +15,8 @@ use OpenApi\Attributes as OA;
class AuthController extends Controller
{
use ApiResponse;
#[OA\Post(
path: '/auth/register',
description: 'Register a new user account',
@@ -64,12 +67,9 @@ class AuthController extends Controller
$token = $user->createToken('auth-token')->plainTextToken;
return response()->json([
'message' => 'ثبت‌نام با موفقیت انجام شد.',
'data' => [
'user' => new UserResource($user),
'token' => $token,
],
return $this->success('ثبت‌نام با موفقیت انجام شد.', [
'user' => new UserResource($user),
'token' => $token,
], 201);
}
@@ -121,22 +121,16 @@ class AuthController extends Controller
->first();
if (! $user || ! Hash::check($request->validated('password'), $user->password)) {
return response()->json([
'message' => 'اطلاعات ورود نادرست است.',
'errors' => [
'login' => ['ایمیل یا نام کاربری یا رمز عبور اشتباه است.'],
],
], 422);
return $this->error('اطلاعات ورود نادرست است.', [
'login' => ['ایمیل یا نام کاربری یا رمز عبور اشتباه است.'],
]);
}
$token = $user->createToken('auth-token')->plainTextToken;
return response()->json([
'message' => 'ورود با موفقیت انجام شد.',
'data' => [
'user' => new UserResource($user),
'token' => $token,
],
return $this->success('ورود با موفقیت انجام شد.', [
'user' => new UserResource($user),
'token' => $token,
]);
}
@@ -147,7 +141,7 @@ class AuthController extends Controller
$counter = 1;
while (User::query()->where('username', $username)->exists()) {
$username = $base.$counter;
$username = $base . $counter;
$counter++;
}

52
app/Http/Controllers/Api/CategoryController.php Normal file
View File

@@ -0,0 +1,52 @@
<?php
namespace App\Http\Controllers\Api;
use App\Http\Controllers\Controller;
use App\Http\Resources\CategoryResource;
use App\Models\Category;
use App\Traits\ApiResponse;
use Illuminate\Http\JsonResponse;
use OpenApi\Attributes as OA;
class CategoryController extends Controller
{
use ApiResponse;
#[OA\Get(
path: '/categories',
description: 'List active template categories',
summary: 'List categories',
tags: ['Templates'],
responses: [
new OA\Response(
response: 200,
description: 'Categories fetched successfully',
content: new OA\JsonContent(
properties: [
new OA\Property(property: 'message', type: 'string', example: 'دسته‌بندی‌ها با موفقیت دریافت شد.'),
new OA\Property(
property: 'data',
properties: [
new OA\Property(
property: 'categories',
type: 'array',
items: new OA\Items(ref: '#/components/schemas/Category')
),
],
type: 'object'
),
]
)
),
]
)]
public function index(): JsonResponse
{
$categories = Category::query()->where('is_active', true)->orderBy('name')->get();
return $this->success('دسته‌بندی‌ها با موفقیت دریافت شد.', [
'categories' => CategoryResource::collection($categories),
]);
}
}

89
app/Http/Controllers/Api/NotificationController.php Normal file
View File

@@ -0,0 +1,89 @@
<?php
namespace App\Http\Controllers\Api;
use App\Http\Controllers\Controller;
use App\Http\Resources\NotificationResource;
use App\Services\NotificationService;
use App\Traits\ApiResponse;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use OpenApi\Attributes as OA;
class NotificationController extends Controller
{
use ApiResponse;
public function __construct(private readonly NotificationService $notificationService) {}
#[OA\Get(
path: '/notifications',
description: 'Get the authenticated user notifications',
summary: 'List notifications',
security: [['sanctum' => []]],
tags: ['Notifications'],
parameters: [
new OA\Parameter(name: 'per_page', description: 'Items per page', in: 'query', schema: new OA\Schema(type: 'integer', example: 15)),
],
responses: [
new OA\Response(
response: 200,
description: 'Notifications fetched successfully',
content: new OA\JsonContent(
properties: [
new OA\Property(property: 'message', type: 'string', example: 'نوتیفیکیشن‌ها با موفقیت دریافت شد.'),
new OA\Property(
property: 'data',
properties: [
new OA\Property(
property: 'notifications',
type: 'array',
items: new OA\Items(ref: '#/components/schemas/Notification')
),
],
type: 'object'
),
]
)
),
new OA\Response(response: 401, description: 'Unauthenticated'),
]
)]
public function index(Request $request): JsonResponse
{
$perPage = min(max((int) $request->integer('per_page', 15), 1), 100);
$notifications = $request->user()->notifications()->paginate($perPage);
return $this->success('نوتیفیکیشن‌ها با موفقیت دریافت شد.', [
'notifications' => NotificationResource::collection($notifications)->response()->getData(true),
]);
}
#[OA\Post(
path: '/notifications/read-all',
description: 'Mark all the authenticated user notifications as read',
summary: 'Mark all notifications as read',
security: [['sanctum' => []]],
tags: ['Notifications'],
responses: [
new OA\Response(
response: 200,
description: 'Notifications marked as read successfully',
content: new OA\JsonContent(
properties: [
new OA\Property(property: 'message', type: 'string', example: 'همه نوتیفیکیشن‌ها خوانده شد.'),
new OA\Property(property: 'data', type: 'object'),
]
)
),
new OA\Response(response: 401, description: 'Unauthenticated'),
]
)]
public function markAllAsRead(Request $request): JsonResponse
{
$this->notificationService->markAllAsRead($request->user());
return $this->success('همه نوتیفیکیشن‌ها خوانده شد.');
}
}

98
app/Http/Controllers/Api/ProfileController.php Normal file
View File

@@ -0,0 +1,98 @@
<?php
namespace App\Http\Controllers\Api;
use App\Http\Controllers\Controller;
use App\Http\Requests\Profile\UpdateProfileRequest;
use App\Http\Resources\UserResource;
use App\Traits\ApiResponse;
use Illuminate\Http\JsonResponse;
use OpenApi\Attributes as OA;
class ProfileController extends Controller
{
use ApiResponse;
#[OA\Get(
path: '/profile',
description: 'Get the authenticated user profile',
summary: 'Show profile',
security: [['sanctum' => []]],
tags: ['Profile'],
responses: [
new OA\Response(
response: 200,
description: 'Profile fetched successfully',
content: new OA\JsonContent(
properties: [
new OA\Property(property: 'message', type: 'string', example: 'اطلاعات پروفایل با موفقیت دریافت شد.'),
new OA\Property(
property: 'data',
properties: [
new OA\Property(property: 'user', ref: '#/components/schemas/User'),
],
type: 'object'
),
]
)
),
new OA\Response(response: 401, description: 'Unauthenticated'),
]
)]
public function show(): JsonResponse
{
return $this->success('اطلاعات پروفایل با موفقیت دریافت شد.', [
'user' => new UserResource(request()->user()),
]);
}
#[OA\Put(
path: '/profile',
description: 'Update the authenticated user profile',
summary: 'Update profile',
security: [['sanctum' => []]],
tags: ['Profile'],
requestBody: new OA\RequestBody(
required: true,
content: new OA\JsonContent(
properties: [
new OA\Property(property: 'name', type: 'string', example: 'علی رضایی'),
new OA\Property(property: 'username', type: 'string', example: 'ali'),
new OA\Property(property: 'email', type: 'string', format: 'email', example: 'ali@example.com'),
new OA\Property(property: 'mobile', type: 'string', example: '09123456789'),
new OA\Property(property: 'password', type: 'string', format: 'password', example: 'password123'),
]
)
),
responses: [
new OA\Response(
response: 200,
description: 'Profile updated successfully',
content: new OA\JsonContent(
properties: [
new OA\Property(property: 'message', type: 'string', example: 'پروفایل با موفقیت به‌روزرسانی شد.'),
new OA\Property(
property: 'data',
properties: [
new OA\Property(property: 'user', ref: '#/components/schemas/User'),
],
type: 'object'
),
]
)
),
new OA\Response(response: 401, description: 'Unauthenticated'),
new OA\Response(response: 422, description: 'Validation error'),
]
)]
public function update(UpdateProfileRequest $request): JsonResponse
{
$user = $request->user();
$user->update($request->validated());
return $this->success('پروفایل با موفقیت به‌روزرسانی شد.', [
'user' => new UserResource($user->fresh()),
]);
}
}

104
app/Http/Controllers/Api/TemplateController.php Normal file
View File

@@ -0,0 +1,104 @@
<?php
namespace App\Http\Controllers\Api;
use App\Http\Controllers\Controller;
use App\Http\Resources\TemplateResource;
use App\Models\Template;
use App\Traits\ApiResponse;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use OpenApi\Attributes as OA;
class TemplateController extends Controller
{
use ApiResponse;
#[OA\Get(
path: '/templates',
description: 'List active templates, optionally filtered by category',
summary: 'List templates',
tags: ['Templates'],
parameters: [
new OA\Parameter(name: 'category', description: 'Category slug', in: 'query', schema: new OA\Schema(type: 'string')),
],
responses: [
new OA\Response(
response: 200,
description: 'Templates fetched successfully',
content: new OA\JsonContent(
properties: [
new OA\Property(property: 'message', type: 'string', example: 'قالب‌ها با موفقیت دریافت شد.'),
new OA\Property(
property: 'data',
properties: [
new OA\Property(
property: 'templates',
type: 'array',
items: new OA\Items(ref: '#/components/schemas/Template')
),
],
type: 'object'
),
]
)
),
]
)]
public function index(Request $request): JsonResponse
{
$templates = Template::query()
->with('category')
->where('is_active', true)
->when(
$request->string('category')->isNotEmpty(),
fn ($query) => $query->whereHas(
'category',
fn ($categoryQuery) => $categoryQuery->where('slug', $request->string('category'))
)
)
->orderBy('title')
->get();
return $this->success('قالب‌ها با موفقیت دریافت شد.', [
'templates' => TemplateResource::collection($templates),
]);
}
#[OA\Get(
path: '/templates/{slug}',
description: 'Get a template details including its fillable keys',
summary: 'Show template',
tags: ['Templates'],
parameters: [
new OA\Parameter(name: 'slug', description: 'Template slug', in: 'path', required: true, schema: new OA\Schema(type: 'string')),
],
responses: [
new OA\Response(
response: 200,
description: 'Template fetched successfully',
content: new OA\JsonContent(
properties: [
new OA\Property(property: 'message', type: 'string', example: 'قالب با موفقیت دریافت شد.'),
new OA\Property(
property: 'data',
properties: [
new OA\Property(property: 'template', ref: '#/components/schemas/Template'),
],
type: 'object'
),
]
)
),
new OA\Response(response: 404, description: 'Template not found'),
]
)]
public function show(Template $template): JsonResponse
{
$template->load('category', 'keys');
return $this->success('قالب با موفقیت دریافت شد.', [
'template' => new TemplateResource($template),
]);
}
}

155
app/Http/Controllers/Api/TemplateGenerationController.php Normal file
View File

@@ -0,0 +1,155 @@
<?php
namespace App\Http\Controllers\Api;
use App\Enums\TemplateGenerationStatus;
use App\Enums\TemplateKeyType;
use App\Http\Controllers\Controller;
use App\Http\Requests\Api\GenerateTemplateRequest;
use App\Http\Resources\TemplateGenerationResource;
use App\Jobs\GenerateTemplateJob;
use App\Models\Template;
use App\Models\TemplateGeneration;
use App\Traits\ApiResponse;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Response;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Str;
use OpenApi\Attributes as OA;
use Symfony\Component\HttpFoundation\StreamedResponse;
class TemplateGenerationController extends Controller
{
use ApiResponse;
#[OA\Post(
path: '/templates/{slug}/generate',
description: 'Start generating a filled presentation from a template',
summary: 'Generate presentation',
security: [['sanctum' => []]],
tags: ['Templates'],
parameters: [
new OA\Parameter(name: 'slug', description: 'Template slug', in: 'path', required: true, schema: new OA\Schema(type: 'string')),
],
responses: [
new OA\Response(
response: 202,
description: 'Generation started',
content: new OA\JsonContent(
properties: [
new OA\Property(property: 'message', type: 'string', example: 'درخواست تولید پاورپوینت ثبت شد.'),
new OA\Property(
property: 'data',
properties: [
new OA\Property(property: 'generation', ref: '#/components/schemas/TemplateGeneration'),
],
type: 'object'
),
]
)
),
new OA\Response(response: 401, description: 'Unauthenticated'),
new OA\Response(response: 422, description: 'Validation error'),
]
)]
public function store(GenerateTemplateRequest $request, Template $template): JsonResponse
{
$uuid = (string) Str::uuid();
$values = $request->validated('values', []);
$storedValues = [];
foreach ($template->keys as $key) {
if (! array_key_exists($key->key, $values)) {
continue;
}
if ($key->type === TemplateKeyType::Image) {
$storedValues[$key->key] = $request->file('values.'.$key->key)
->store('templates/generations/inputs/'.$uuid, 'local');
continue;
}
$storedValues[$key->key] = $values[$key->key];
}
$generation = TemplateGeneration::query()->create([
'template_id' => $template->id,
'uuid' => $uuid,
'status' => TemplateGenerationStatus::Pending,
'values' => $storedValues,
'requested_by' => $request->user()->id,
]);
GenerateTemplateJob::dispatch($generation);
return $this->success('درخواست تولید پاورپوینت ثبت شد.', [
'generation' => new TemplateGenerationResource($generation),
], 202);
}
#[OA\Get(
path: '/generations/{uuid}',
description: 'Get the status of a presentation generation request',
summary: 'Show generation status',
security: [['sanctum' => []]],
tags: ['Templates'],
parameters: [
new OA\Parameter(name: 'uuid', description: 'Generation uuid', in: 'path', required: true, schema: new OA\Schema(type: 'string')),
],
responses: [
new OA\Response(
response: 200,
description: 'Generation status fetched successfully',
content: new OA\JsonContent(
properties: [
new OA\Property(property: 'message', type: 'string', example: 'وضعیت تولید با موفقیت دریافت شد.'),
new OA\Property(
property: 'data',
properties: [
new OA\Property(property: 'generation', ref: '#/components/schemas/TemplateGeneration'),
],
type: 'object'
),
]
)
),
new OA\Response(response: 401, description: 'Unauthenticated'),
new OA\Response(response: 403, description: 'Forbidden'),
new OA\Response(response: 404, description: 'Not found'),
]
)]
public function show(TemplateGeneration $generation): JsonResponse
{
abort_if($generation->requested_by !== request()->user()->id, 403);
return $this->success('وضعیت تولید با موفقیت دریافت شد.', [
'generation' => new TemplateGenerationResource($generation),
]);
}
#[OA\Get(
path: '/generations/{uuid}/download',
description: 'Download the generated presentation file',
summary: 'Download generated presentation',
security: [['sanctum' => []]],
tags: ['Templates'],
parameters: [
new OA\Parameter(name: 'uuid', description: 'Generation uuid', in: 'path', required: true, schema: new OA\Schema(type: 'string')),
],
responses: [
new OA\Response(response: 200, description: 'File download'),
new OA\Response(response: 401, description: 'Unauthenticated'),
new OA\Response(response: 403, description: 'Forbidden'),
new OA\Response(response: 404, description: 'Not found or not ready'),
]
)]
public function download(TemplateGeneration $generation): StreamedResponse
{
abort_if($generation->requested_by !== request()->user()->id, Response::HTTP_FORBIDDEN);
abort_if($generation->status !== TemplateGenerationStatus::Completed || ! $generation->output_path, Response::HTTP_NOT_FOUND);
return Storage::disk('local')->download($generation->output_path, $generation->template->slug.'.pptx');
}
}

100
app/Http/Controllers/Api/WalletController.php Normal file
View File

@@ -0,0 +1,100 @@
<?php
namespace App\Http\Controllers\Api;
use App\Http\Controllers\Controller;
use App\Http\Resources\WalletResource;
use App\Http\Resources\WalletTransactionResource;
use App\Services\WalletService;
use App\Traits\ApiResponse;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use OpenApi\Attributes as OA;
class WalletController extends Controller
{
use ApiResponse;
public function __construct(private readonly WalletService $walletService) {}
#[OA\Get(
path: '/wallet',
description: 'Get the authenticated user wallet',
summary: 'Show wallet',
security: [['sanctum' => []]],
tags: ['Wallet'],
responses: [
new OA\Response(
response: 200,
description: 'Wallet fetched successfully',
content: new OA\JsonContent(
properties: [
new OA\Property(property: 'message', type: 'string', example: 'اطلاعات کیف پول با موفقیت دریافت شد.'),
new OA\Property(
property: 'data',
properties: [
new OA\Property(property: 'wallet', ref: '#/components/schemas/Wallet'),
],
type: 'object'
),
]
)
),
new OA\Response(response: 401, description: 'Unauthenticated'),
]
)]
public function show(Request $request): JsonResponse
{
$wallet = $this->walletService->createForUser($request->user());
return $this->success('اطلاعات کیف پول با موفقیت دریافت شد.', [
'wallet' => new WalletResource($wallet),
]);
}
#[OA\Get(
path: '/wallet/transactions',
description: 'Get the authenticated user wallet transactions',
summary: 'List wallet transactions',
security: [['sanctum' => []]],
tags: ['Wallet'],
parameters: [
new OA\Parameter(name: 'per_page', description: 'Items per page', in: 'query', schema: new OA\Schema(type: 'integer', example: 15)),
],
responses: [
new OA\Response(
response: 200,
description: 'Wallet transactions fetched successfully',
content: new OA\JsonContent(
properties: [
new OA\Property(property: 'message', type: 'string', example: 'تراکنش‌های کیف پول با موفقیت دریافت شد.'),
new OA\Property(
property: 'data',
properties: [
new OA\Property(
property: 'transactions',
type: 'array',
items: new OA\Items(ref: '#/components/schemas/WalletTransaction')
),
],
type: 'object'
),
]
)
),
new OA\Response(response: 401, description: 'Unauthenticated'),
]
)]
public function transactions(Request $request): JsonResponse
{
$wallet = $this->walletService->createForUser($request->user());
$perPage = min(max((int) $request->integer('per_page', 15), 1), 100);
$transactions = $wallet->transactions()->paginate($perPage);
return $this->success('تراکنش‌های کیف پول با موفقیت دریافت شد.', [
'transactions' => WalletTransactionResource::collection($transactions)->response()->getData(true),
]);
}
}