Implement status API endpoint

Author: jbrooksuk

resources/views/components/status-bar.blade.php

@@ -1,15 +1,15 @@
 <div {{ $attributes->class(['rounded-md p-4 bg-custom-200 dark:bg-custom-400 border border-custom-400'])->style([
     Illuminate\Support\Arr::toCssStyles([
         \Filament\Support\get_color_css_variables(
-            $color,
+            $status->getColor(),
             shades: [100, 200, 400, 800],
         ),
     ]),
 ]) }}>
     <div class="flex sm:items-center gap-3">
         @svg($status->getIcon(), 'size-5 text-custom-800')
         <div class="flex flex-1 justify-between items-center">
-            <p class="text-sm md:text-base text-custom-800">{{ $label }}</p>
+            <p class="text-sm md:text-base text-custom-800">{{ $status->getLabel() }}</p>
 {{--            <p class="mt-2 sm:mt-3 text-xs sm:text-sm md:ml-6 md:mt-0 text-custom-800">--}}
 {{--                Updated <time datetime="2008-02-14 20:00" title="2008-02-14 20:00" class="underline decoration-dotted underline-offset-2 cursor-help">10 minutes</time> ago--}}
 {{--            </p>--}}

routes/api.php

@@ -9,6 +9,7 @@
 use Cachet\Http\Controllers\Api\MetricController;
 use Cachet\Http\Controllers\Api\MetricPointController;
 use Cachet\Http\Controllers\Api\ScheduleController;
+use Cachet\Http\Controllers\Api\StatusController;
 use Illuminate\Support\Facades\Route;
 
 Route::apiResources([
@@ -30,3 +31,4 @@
 
 Route::get('/ping', [GeneralController::class, 'ping'])->name('ping');
 Route::get('/version', [GeneralController::class, 'version'])->name('version');
+Route::get('/status', StatusController::class)->name('status');

src/Http/Controllers/Api/GeneralController.php

@@ -27,17 +27,4 @@ public function version(): JsonResponse
             ],
         ]);
     }
-
-    /**
-     * Get the Cachet status and message.
-     */
-    public function status(): JsonResponse
-    {
-        return response()->json([
-            'data' => [
-                //                'status' => Cachet::status(),
-                //                'message' => Cachet::statusMessage(),
-            ],
-        ]);
-    }
 }

src/Http/Controllers/Api/StatusController.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Cachet\Http\Controllers\Api;
+
+use Cachet\Status;
+
+class StatusController
+{
+    /**
+     * Get the current system status.
+     */
+    public function __invoke(Status $status)
+    {
+        return response()->json([
+            'data' => [
+                'status' => $status->current()->name,
+                'message' => $status->current()->getLabel(),
+            ],
+        ]);
+    }
+}

src/Status.php

@@ -17,37 +17,25 @@ class Status
     protected ?object $incidents = null;
 
     /**
-     * @return array{status: string, label: string, color: string}
+     * Get the current system status as an enum.
      */
-    public function current(): array
+    public function current(): SystemStatusEnum
     {
         $components = $this->components();
 
         if ($this->majorOutage()) {
-            return [
-                'status' => SystemStatusEnum::major_outage,
-                'label' => SystemStatusEnum::major_outage->getLabel(),
-                'color' => SystemStatusEnum::major_outage->getColor(),
-            ];
+            return SystemStatusEnum::major_outage;
         }
 
         if ((int) $components->total - (int) $components->operational === 0) {
             $incidents = $this->incidents();
 
             if ((int) $incidents->total === 0 || ((int) $incidents->total > 0 && (int) $incidents->unresolved === 0)) {
-                return [
-                    'status' => SystemStatusEnum::operational,
-                    'label' => SystemStatusEnum::operational->getLabel(),
-                    'color' => SystemStatusEnum::operational->getColor(),
-                ];
+                return SystemStatusEnum::operational;
             }
         }
 
-        return [
-            'status' => SystemStatusEnum::partial_outage,
-            'label' => SystemStatusEnum::partial_outage->getLabel(),
-            'color' => SystemStatusEnum::partial_outage->getColor(),
-        ];
+        return SystemStatusEnum::partial_outage;
     }
 
     /**

src/View/Components/StatusBar.php

@@ -9,13 +9,21 @@
 
 class StatusBar extends ViewComponent
 {
+    /**
+     * Create a new component instance.
+     */
+    public function __construct(protected readonly Status $status)
+    {
+        //
+    }
+
     /**
      * Get the view / contents that represent the component.
      */
     public function render(): View|Closure|string
     {
         return view('cachet::components.status-bar', [
-            ...app(Status::class)->current(),
+            'status' => $this->status->current(),
         ]);
     }
 }