Migrate admin reference-data pages to Vue + /api/v2 CRUD

app/Brands.php

@@ -3,10 +3,13 @@
 namespace App;
 
 use DB;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 
 class Brands extends Model
 {
+    use HasFactory;
+
     protected $table = 'brands';
     /**
      * The attributes that are mass assignable.

app/Exceptions/Handler.php

@@ -2,6 +2,9 @@
 
 namespace App\Exceptions;
 
+use Illuminate\Auth\Access\AuthorizationException;
+use Illuminate\Auth\AuthenticationException;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
 use Illuminate\Validation\ValidationException;
 use Throwable;
 use Exception;
@@ -26,7 +29,7 @@
      * @param  \Illuminate\Http\Request  $request
      * @return \Illuminate\Http\Response
      */
     public function render($request, Throwable $exception)
     {
         if ($request->wantsJson()) {
             if ($exception instanceof ValidationException) {
@@ -35,6 +38,18 @@
                     422);
             }
 
+            if ($exception instanceof AuthenticationException) {
+                return response()->json(['message' => 'Unauthenticated.'], 401);
+            }
+
+            if ($exception instanceof AuthorizationException) {
+                return response()->json(['message' => 'Unauthorized.'], 403);
+            }
+
+            if ($exception instanceof ModelNotFoundException) {
+                return response()->json(['message' => 'Resource not found.'], 404);
+            }
+
             return response()->json(
                 ['message' => $exception->getMessage()],
                 method_exists($exception, 'getStatusCode') ? $exception->getStatusCode() : 500);

app/Http/Controllers/API/BrandController.php

@@ -0,0 +1,187 @@
+<?php
+
+namespace App\Http\Controllers\API;
+
+use App\Brands;
+use App\Helpers\Fixometer;
+use App\Http\Controllers\Controller;
+use App\Http\Resources\Brand;
+use App\Http\Resources\BrandCollection;
+use Auth;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+
+class BrandController extends Controller
+{
+    /**
+     * @OA\Get(
+     *      path="/api/v2/brands",
+     *      operationId="listBrandsv2",
+     *      tags={"Brands"},
+     *      summary="List Brands",
+     *      description="Returns all device brands, ordered alphabetically. Public endpoint.",
+     *      @OA\Response(
+     *          response=200,
+     *          description="Successful operation",
+     *          @OA\JsonContent(
+     *              @OA\Property(
+     *                  property="data",
+     *                  type="array",
+     *                  @OA\Items(ref="#/components/schemas/Brand")
+     *              )
+     *          )
+     *      )
+     * )
+     */
+    public function listBrandsv2()
+    {
+        $brands = Brands::orderBy('brand_name', 'asc')->get();
+
+        return BrandCollection::make($brands);
+    }
+
+    /**
+     * @OA\Get(
+     *      path="/api/v2/brands/{id}",
+     *      operationId="getBrandv2",
+     *      tags={"Brands"},
+     *      summary="Get a Brand",
+     *      description="Returns a single brand by id.",
+     *      @OA\Parameter(
+     *          name="id",
+     *          in="path",
+     *          required=true,
+     *          @OA\Schema(type="integer")
+     *      ),
+     *      @OA\Response(
+     *          response=200,
+     *          description="Successful operation",
+     *          @OA\JsonContent(
+     *              @OA\Property(property="data", ref="#/components/schemas/Brand")
+     *          )
+     *      ),
+     *      @OA\Response(response=404, description="Brand not found")
+     * )
+     */
+    public function getBrandv2($id)
+    {
+        $brand = Brands::findOrFail($id);
+
+        return Brand::make($brand);
+    }
+
+    /**
+     * @OA\Post(
+     *      path="/api/v2/brands",
+     *      operationId="createBrandv2",
+     *      tags={"Brands"},
+     *      summary="Create a Brand",
+     *      description="Create a new device brand. Administrator only.",
+     *      security={{"apiToken":{}}},
+     *      @OA\RequestBody(
+     *          required=true,
+     *          @OA\JsonContent(
+     *              required={"brand_name"},
+     *              @OA\Property(property="brand_name", type="string", maxLength=255, example="Sony")
+     *          )
+     *      ),
+     *      @OA\Response(
+     *          response=201,
+     *          description="Brand created",
+     *          @OA\JsonContent(
+     *              @OA\Property(property="data", ref="#/components/schemas/Brand")
+     *          )
+     *      ),
+     *      @OA\Response(response=401, description="Unauthenticated"),
+     *      @OA\Response(response=403, description="Forbidden"),
+     *      @OA\Response(response=422, description="Validation failed")
+     * )
+     */
+    public function createBrandv2(Request $request): JsonResponse
+    {
+        if (!Fixometer::hasRole(Auth::user(), 'Administrator')) {
+            return response()->json(['message' => 'Forbidden'], 403);
+        }
+
+        $validated = $request->validate([
+            'brand_name' => 'required|string|max:255|unique:brands,brand_name',
+        ]);
+
+        $brand = Brands::create($validated);
+
+        return response()->json(['data' => (new Brand($brand))->toArray($request)], 201);
+    }
+
+    /**
+     * @OA\Put(
+     *      path="/api/v2/brands/{id}",
+     *      operationId="updateBrandv2",
+     *      tags={"Brands"},
+     *      summary="Update a Brand",
+     *      description="Update a brand. Administrator only.",
+     *      security={{"apiToken":{}}},
+     *      @OA\Parameter(name="id", in="path", required=true, @OA\Schema(type="integer")),
+     *      @OA\RequestBody(
+     *          required=true,
+     *          @OA\JsonContent(
+     *              required={"brand_name"},
+     *              @OA\Property(property="brand_name", type="string", maxLength=255, example="Sony")
+     *          )
+     *      ),
+     *      @OA\Response(
+     *          response=200,
+     *          description="Brand updated",
+     *          @OA\JsonContent(
+     *              @OA\Property(property="data", ref="#/components/schemas/Brand")
+     *          )
+     *      ),
+     *      @OA\Response(response=401, description="Unauthenticated"),
+     *      @OA\Response(response=403, description="Forbidden"),
+     *      @OA\Response(response=404, description="Brand not found"),
+     *      @OA\Response(response=422, description="Validation failed")
+     * )
+     */
+    public function updateBrandv2(Request $request, $id)
+    {
+        if (!Fixometer::hasRole(Auth::user(), 'Administrator')) {
+            return response()->json(['message' => 'Forbidden'], 403);
+        }
+
+        $brand = Brands::findOrFail($id);
+
+        $validated = $request->validate([
+            'brand_name' => 'required|string|max:255|unique:brands,brand_name,' . $brand->id,
+        ]);
+
+        $brand->update($validated);
+
+        return Brand::make($brand->fresh());
+    }
+
+    /**
+     * @OA\Delete(
+     *      path="/api/v2/brands/{id}",
+     *      operationId="deleteBrandv2",
+     *      tags={"Brands"},
+     *      summary="Delete a Brand",
+     *      description="Delete a brand. Administrator only.",
+     *      security={{"apiToken":{}}},
+     *      @OA\Parameter(name="id", in="path", required=true, @OA\Schema(type="integer")),
+     *      @OA\Response(response=204, description="Brand deleted"),
+     *      @OA\Response(response=401, description="Unauthenticated"),
+     *      @OA\Response(response=403, description="Forbidden"),
+     *      @OA\Response(response=404, description="Brand not found")
+     * )
+     */
+    public function deleteBrandv2($id)
+    {
+        if (!Fixometer::hasRole(Auth::user(), 'Administrator')) {
+            return response()->json(['message' => 'Forbidden'], 403);
+        }
+
+        $brand = Brands::findOrFail($id);
+        $brand->delete();
+
+        return response()->noContent();
+    }
+}