feat(api): Implement API Resource Standard compliance
- Create BaseResource with formatDate() and formatDecimal() utilities - Create 11 API Resource classes for all models - Update all 6 controllers to return wrapped responses via wrapResource() - Update frontend API client with unwrapResponse() helper - Update all 63+ backend tests to expect 'data' wrapper - Regenerate Scribe API documentation BREAKING CHANGE: All API responses now wrap data in 'data' key per architecture spec. Backend Tests: 70 passed, 5 failed (unrelated to data wrapper) Frontend Unit: 10 passed E2E Tests: 102 passed, 20 skipped API Docs: Generated successfully Refs: openspec/changes/api-resource-standard
This commit is contained in:
32
backend/tests/Unit/Resources/HolidayResourceTest.php
Normal file
32
backend/tests/Unit/Resources/HolidayResourceTest.php
Normal file
@@ -0,0 +1,32 @@
|
||||
<?php
|
||||
|
||||
use App\Http\Resources\HolidayResource;
|
||||
use App\Models\Holiday;
|
||||
use Illuminate\Foundation\Testing\RefreshDatabase;
|
||||
use Illuminate\Http\Request;
|
||||
use Tests\TestCase;
|
||||
|
||||
uses(TestCase::class, RefreshDatabase::class);
|
||||
|
||||
test('holiday resource wraps data', function () {
|
||||
$holiday = Holiday::create([
|
||||
'date' => '2026-02-14',
|
||||
'name' => 'Test Holiday',
|
||||
'description' => 'Description',
|
||||
]);
|
||||
|
||||
$response = (new HolidayResource($holiday))->toResponse(Request::create('/'));
|
||||
$payload = $response->getData(true);
|
||||
|
||||
expect($payload['data']['name'])->toBe('Test Holiday');
|
||||
});
|
||||
|
||||
test('holiday resource collection uses data wrapper', function () {
|
||||
Holiday::create(['date' => '2026-02-14', 'name' => 'Day One', 'description' => null]);
|
||||
Holiday::create(['date' => '2026-03-01', 'name' => 'Day Two', 'description' => null]);
|
||||
|
||||
$response = HolidayResource::collection(Holiday::limit(2)->get())->toResponse(Request::create('/'));
|
||||
$payload = $response->getData(true);
|
||||
|
||||
expect($payload['data'])->toHaveCount(2);
|
||||
});
|
||||
31
backend/tests/Unit/Resources/ProjectResourceTest.php
Normal file
31
backend/tests/Unit/Resources/ProjectResourceTest.php
Normal file
@@ -0,0 +1,31 @@
|
||||
<?php
|
||||
|
||||
use App\Http\Resources\ProjectResource;
|
||||
use App\Models\Project;
|
||||
use Illuminate\Foundation\Testing\RefreshDatabase;
|
||||
use Illuminate\Http\Request;
|
||||
use Tests\TestCase;
|
||||
|
||||
uses(TestCase::class, RefreshDatabase::class);
|
||||
|
||||
test('project resource includes expected fields inside data wrapper', function () {
|
||||
$project = Project::factory()->approved()->create();
|
||||
$project->load(['status', 'type']);
|
||||
|
||||
$response = (new ProjectResource($project))->toResponse(Request::create('/'));
|
||||
$payload = $response->getData(true);
|
||||
|
||||
expect($payload)->toHaveKey('data');
|
||||
expect($payload['data'])->toHaveKey('status');
|
||||
expect($payload['data'])->toHaveKey('type');
|
||||
expect($payload['data'])->toHaveKey('approved_estimate');
|
||||
});
|
||||
|
||||
test('project resource collection wraps multiple entries', function () {
|
||||
$projects = Project::factory()->count(2)->create();
|
||||
|
||||
$response = ProjectResource::collection($projects)->toResponse(Request::create('/'));
|
||||
$payload = $response->getData(true);
|
||||
|
||||
expect($payload['data'])->toHaveCount(2);
|
||||
});
|
||||
56
backend/tests/Unit/Resources/PtoResourceTest.php
Normal file
56
backend/tests/Unit/Resources/PtoResourceTest.php
Normal file
@@ -0,0 +1,56 @@
|
||||
<?php
|
||||
|
||||
use App\Http\Resources\PtoResource;
|
||||
use App\Models\Pto;
|
||||
use App\Models\Role;
|
||||
use App\Models\TeamMember;
|
||||
use Illuminate\Foundation\Testing\RefreshDatabase;
|
||||
use Illuminate\Http\Request;
|
||||
use Tests\TestCase;
|
||||
|
||||
uses(TestCase::class, RefreshDatabase::class);
|
||||
|
||||
test('pto resource returns wrapped data with team member', function () {
|
||||
$role = Role::factory()->create();
|
||||
$teamMember = TeamMember::factory()->create(['role_id' => $role->id]);
|
||||
|
||||
$pto = Pto::create([
|
||||
'team_member_id' => $teamMember->id,
|
||||
'start_date' => '2026-02-10',
|
||||
'end_date' => '2026-02-12',
|
||||
'reason' => 'Travel',
|
||||
'status' => 'pending',
|
||||
]);
|
||||
$pto->load('teamMember');
|
||||
|
||||
$response = (new PtoResource($pto))->toResponse(Request::create('/'));
|
||||
$payload = $response->getData(true);
|
||||
|
||||
expect($payload['data']['team_member_id'])->toBe($teamMember->id);
|
||||
expect($payload['data']['team_member']['id'])->toBe($teamMember->id);
|
||||
});
|
||||
|
||||
test('pto resource collection keeps data wrapper', function () {
|
||||
$role = Role::factory()->create();
|
||||
$member = TeamMember::factory()->create(['role_id' => $role->id]);
|
||||
|
||||
Pto::create([
|
||||
'team_member_id' => $member->id,
|
||||
'start_date' => '2026-02-10',
|
||||
'end_date' => '2026-02-10',
|
||||
'reason' => 'Travel',
|
||||
'status' => 'approved',
|
||||
]);
|
||||
Pto::create([
|
||||
'team_member_id' => $member->id,
|
||||
'start_date' => '2026-03-10',
|
||||
'end_date' => '2026-03-12',
|
||||
'reason' => 'Rest',
|
||||
'status' => 'approved',
|
||||
]);
|
||||
|
||||
$response = PtoResource::collection(Pto::limit(2)->get())->toResponse(Request::create('/'));
|
||||
$payload = $response->getData(true);
|
||||
|
||||
expect($payload['data'])->toHaveCount(2);
|
||||
});
|
||||
28
backend/tests/Unit/Resources/RoleResourceTest.php
Normal file
28
backend/tests/Unit/Resources/RoleResourceTest.php
Normal file
@@ -0,0 +1,28 @@
|
||||
<?php
|
||||
|
||||
use App\Http\Resources\RoleResource;
|
||||
use App\Models\Role;
|
||||
use Illuminate\Foundation\Testing\RefreshDatabase;
|
||||
use Illuminate\Http\Request;
|
||||
use Tests\TestCase;
|
||||
|
||||
uses(TestCase::class, RefreshDatabase::class);
|
||||
|
||||
test('role resource returns wrapped data', function () {
|
||||
$role = Role::factory()->create();
|
||||
|
||||
$response = (new RoleResource($role))->toResponse(Request::create('/'));
|
||||
$payload = $response->getData(true);
|
||||
|
||||
expect($payload)->toHaveKey('data');
|
||||
expect($payload['data']['id'])->toBe($role->id);
|
||||
});
|
||||
|
||||
test('role resource collection keeps data wrapper', function () {
|
||||
$roles = Role::factory()->count(2)->create();
|
||||
|
||||
$response = RoleResource::collection($roles)->toResponse(Request::create('/'));
|
||||
$payload = $response->getData(true);
|
||||
|
||||
expect($payload['data'])->toHaveCount(2);
|
||||
});
|
||||
32
backend/tests/Unit/Resources/TeamMemberResourceTest.php
Normal file
32
backend/tests/Unit/Resources/TeamMemberResourceTest.php
Normal file
@@ -0,0 +1,32 @@
|
||||
<?php
|
||||
|
||||
use App\Http\Resources\TeamMemberResource;
|
||||
use App\Models\Role;
|
||||
use App\Models\TeamMember;
|
||||
use Illuminate\Foundation\Testing\RefreshDatabase;
|
||||
use Illuminate\Http\Request;
|
||||
use Tests\TestCase;
|
||||
|
||||
uses(TestCase::class, RefreshDatabase::class);
|
||||
|
||||
test('team member resource wraps data and includes role when loaded', function () {
|
||||
$role = Role::factory()->create();
|
||||
$teamMember = TeamMember::factory()->create(['role_id' => $role->id]);
|
||||
$teamMember->load('role');
|
||||
|
||||
$response = (new TeamMemberResource($teamMember))->toResponse(Request::create('/'));
|
||||
$payload = $response->getData(true);
|
||||
|
||||
expect($payload['data']['id'])->toBe($teamMember->id);
|
||||
expect($payload['data']['role']['id'])->toBe($role->id);
|
||||
});
|
||||
|
||||
test('team member resource collection keeps data wrapper', function () {
|
||||
$role = Role::factory()->create();
|
||||
$teamMembers = TeamMember::factory()->count(2)->create(['role_id' => $role->id]);
|
||||
|
||||
$response = TeamMemberResource::collection($teamMembers)->toResponse(Request::create('/'));
|
||||
$payload = $response->getData(true);
|
||||
|
||||
expect($payload['data'])->toHaveCount(2);
|
||||
});
|
||||
30
backend/tests/Unit/Resources/UserResourceTest.php
Normal file
30
backend/tests/Unit/Resources/UserResourceTest.php
Normal file
@@ -0,0 +1,30 @@
|
||||
<?php
|
||||
|
||||
use App\Http\Resources\UserResource;
|
||||
use App\Models\User;
|
||||
use Illuminate\Foundation\Testing\RefreshDatabase;
|
||||
use Illuminate\Http\Request;
|
||||
use Tests\TestCase;
|
||||
|
||||
uses(TestCase::class, RefreshDatabase::class);
|
||||
|
||||
test('user resource wraps response with data', function () {
|
||||
$user = User::factory()->create();
|
||||
|
||||
$response = (new UserResource($user))->toResponse(Request::create('/'));
|
||||
$payload = $response->getData(true);
|
||||
|
||||
expect(array_key_exists('data', $payload))->toBeTrue();
|
||||
expect($payload['data']['id'])->toBe($user->id);
|
||||
expect($payload['data'])->toHaveKey('email');
|
||||
});
|
||||
|
||||
test('user resource collection honors data wrapper', function () {
|
||||
$users = User::factory()->count(2)->create();
|
||||
|
||||
$response = UserResource::collection($users)->toResponse(Request::create('/'));
|
||||
$payload = $response->getData(true);
|
||||
|
||||
expect($payload['data'])->toHaveCount(2);
|
||||
expect($payload['data'][0])->toHaveKey('id');
|
||||
});
|
||||
Reference in New Issue
Block a user