[Feature] Add filtering to /meta endpoint (#87)

Author: chrisjm

app/Http/Controllers/Api/V1/GetBreweriesMeta.php

@@ -3,45 +3,55 @@
 namespace App\Http\Controllers\Api\V1;
 
 use App\Http\Controllers\Controller;
+use App\Http\Requests\V1\BreweryFilterRequest;
 use App\Http\Resources\V1\BreweryMetaResource;
 use App\Models\Brewery;
-use Illuminate\Http\Request;
 use Illuminate\Http\Response;
-use Illuminate\Support\Facades\Cache;
 use Illuminate\Support\Facades\DB;
 
 class GetBreweriesMeta extends Controller
 {
     /**
      * Handle the incoming request.
      */
-    public function __invoke(Request $request)
+    public function __invoke(BreweryFilterRequest $request)
     {
-        $data = Cache::remember('brewery_meta', 300, function () {
-            $total = Brewery::count();
-
-            $byState = Brewery::query()
-                ->select('state_province', DB::raw('count(*) as count'))
-                ->whereNotNull('state_province')
-                ->groupBy('state_province')
-                ->pluck('count', 'state_province')
-                ->toArray();
-            $byType = Brewery::query()
-                ->select('brewery_type', DB::raw('count(*) as count'))
-                ->whereNotNull('brewery_type')
-                ->groupBy('brewery_type')
-                ->pluck('count', 'brewery_type')
-                ->mapWithKeys(function ($count, $type) {
-                    return [strtolower($type) => $count];
-                })
-                ->toArray();
-
-            return new BreweryMetaResource([
-                'total' => $total,
-                'by_state' => $byState,
-                'by_type' => $byType,
-            ]);
-        });
+
+        // Create a base query that applies filters
+        $baseQuery = Brewery::query()->applyFilters($request);
+
+        // Get total count with filters applied
+        $total = $baseQuery->count();
+
+        // Get by_state with filters applied
+        $byState = (clone $baseQuery)
+            ->select('state_province', DB::raw('count(*) as count'))
+            ->whereNotNull('state_province')
+            ->groupBy('state_province')
+            ->pluck('count', 'state_province')
+            ->toArray();
+
+        // Get by_type with filters applied
+        $byType = (clone $baseQuery)
+            ->select('brewery_type', DB::raw('count(*) as count'))
+            ->whereNotNull('brewery_type')
+            ->groupBy('brewery_type')
+            ->pluck('count', 'brewery_type')
+            ->mapWithKeys(function ($count, $type) {
+                return [strtolower($type) => $count];
+            })
+            ->toArray();
+
+        $page = $request->integer('page', 1);
+        $perPage = $request->integer('per_page', 50);
+
+        $data = new BreweryMetaResource([
+            'total' => $total,
+            'by_state' => $byState,
+            'by_type' => $byType,
+            'page' => $page,
+            'per_page' => $perPage,
+        ]);
 
         return response()->json(
             data: $data,

app/Http/Controllers/Api/V1/ListBreweries.php

@@ -3,36 +3,18 @@
 namespace App\Http\Controllers\Api\V1;
 
 use App\Http\Controllers\Controller;
+use App\Http\Requests\V1\BreweryFilterRequest;
 use App\Http\Resources\V1\BreweryResource;
 use App\Models\Brewery;
-use App\Rules\BreweryType as BreweryTypeRule;
-use App\Rules\Coordinates as CoordinatesRule;
-use Illuminate\Http\Request;
 use Illuminate\Http\Response;
 
 class ListBreweries extends Controller
 {
     /**
      * Handle the incoming request.
      */
-    public function __invoke(Request $request)
+    public function __invoke(BreweryFilterRequest $request)
     {
-        $request->validate([
-            'per_page' => ['sometimes', 'required', 'integer', 'min:1', 'max:200'],
-            'page' => ['integer', 'min:1'],
-            'sort' => ['string'],
-
-            // filters
-            'by_city' => ['sometimes', 'required', 'string', 'min:3', 'max:255'],
-            'by_country' => ['sometimes', 'required', 'string', 'min:3', 'max:255'],
-            'by_dist' => ['sometimes', 'required', 'string', new CoordinatesRule],
-            'by_ids' => ['sometimes', 'required', 'string', 'min:3', 'max:255'], // ! this aint right, need to validate as array and that they're uuid v4
-            'by_name' => ['sometimes', 'required', 'string', 'min:3', 'max:255'],
-            'by_postal' => ['sometimes', 'required', 'string', 'min:3', 'max:255'],
-            'by_state' => ['sometimes', 'required', 'string', 'min:3', 'max:255'],
-            'by_type' => ['sometimes', 'required', 'string', new BreweryTypeRule],
-            'exclude_types' => ['sometimes', 'required', 'string', new BreweryTypeRule],
-        ]);
 
         $breweries = Brewery::query()
             ->applyFilters($request)

app/Http/Requests/V1/BreweryFilterRequest.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace App\Http\Requests\V1;
+
+use App\Rules\BreweryType as BreweryTypeRule;
+use App\Rules\Coordinates as CoordinatesRule;
+use Illuminate\Foundation\Http\FormRequest;
+
+class BreweryFilterRequest extends FormRequest
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     */
+    public function authorize(): bool
+    {
+        return true;
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array<string, mixed>
+     */
+    public function rules(): array
+    {
+        return [
+            'per_page' => ['sometimes', 'required', 'integer', 'min:1', 'max:200'],
+            'page' => ['sometimes', 'required', 'integer', 'min:1'],
+            'sort' => ['sometimes', 'required', 'string'],
+
+            // filters
+            'by_city' => ['sometimes', 'required', 'string', 'min:3', 'max:255'],
+            'by_country' => ['sometimes', 'required', 'string', 'min:3', 'max:255'],
+            'by_dist' => ['sometimes', 'required', 'string', new CoordinatesRule],
+            'by_ids' => ['sometimes', 'required', 'string', 'min:3', 'max:255'], // TODO: validate as array of uuid v4
+            'by_name' => ['sometimes', 'required', 'string', 'min:3', 'max:255'],
+            'by_postal' => ['sometimes', 'required', 'string', 'min:3', 'max:255'],
+            'by_state' => ['sometimes', 'required', 'string', 'min:3', 'max:255'],
+            'by_type' => ['sometimes', 'required', 'string', new BreweryTypeRule],
+            'exclude_types' => ['sometimes', 'required', 'string', new BreweryTypeRule],
+        ];
+    }
+}

app/Http/Resources/V1/BreweryMetaResource.php

@@ -18,6 +18,8 @@ public function toArray(Request $request): array
             'total' => $this->resource['total'],
             'by_state' => $this->resource['by_state'],
             'by_type' => $this->resource['by_type'],
+            'page' => $this->resource['page'] ?? 1,
+            'per_page' => $this->resource['per_page'] ?? 50,
         ];
     }
 }