Refactor to single implementation for upserting logic

Author: kberzinch

app/Http/Controllers/AttendanceController.php

@@ -12,10 +12,10 @@
 use App\Jobs\PushToJedi;
 use App\Models\AccessCard;
 use App\Models\Attendance;
-use App\Models\Device;
 use App\Models\Team;
 use App\Models\User;
 use App\Util\AuthorizeInclude;
+use App\Util\DeviceInventory;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
@@ -90,37 +90,7 @@ public function store(StoreAttendanceRequest $request): JsonResponse
         // Upsert the device if a reader is provided
         $device = null;
         if ($request->has('reader')) {
-            $reader = $request->input('reader');
-            $recordingUser = $request->user();
-
-            if (! $recordingUser instanceof User) {
-                return response()->json([
-                    'status' => 'error',
-                    'message' => 'A user token is required.',
-                ], 401);
-            }
-
-            $ipAddress = $request->ip();
-
-            if ($ipAddress === null) {
-                return response()->json([
-                    'status' => 'error',
-                    'message' => 'last_seen_ip_address is required.',
-                ], 422);
-            }
-
-            $device = Device::updateOrCreate(
-                ['serial_number' => $reader['serial_number']],
-                [
-                    'hardware_version' => $reader['hardware_version'],
-                    'software_version' => $reader['software_version'],
-                    'firmware_version' => $reader['firmware_version'],
-                    'battery_percentage' => $reader['battery_percentage'],
-                    'last_seen_user_id' => $recordingUser->id,
-                    'last_seen_at' => now(),
-                    'last_seen_ip_address' => $ipAddress,
-                ]
-            );
+            $device = DeviceInventory::upsert($request, $request->input('reader'));
         }
 
         $attendanceData = $request->validated();

app/Http/Controllers/DeviceController.php

@@ -6,8 +6,7 @@
 
 use App\Http\Requests\StoreDeviceRequest;
 use App\Http\Resources\Device as DeviceResource;
-use App\Models\Device;
-use App\Models\User;
+use App\Util\DeviceInventory;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Routing\Controllers\HasMiddleware;
 use Illuminate\Routing\Controllers\Middleware;
@@ -27,37 +26,7 @@ public static function middleware(): array
      */
     public function inventory(StoreDeviceRequest $request): JsonResponse
     {
-        $user = $request->user();
-
-        if (! $user instanceof User) {
-            return response()->json([
-                'status' => 'error',
-                'message' => 'A user token is required.',
-            ], 401);
-        }
-
-        $ipAddress = $request->ip();
-
-        if ($ipAddress === null) {
-            return response()->json([
-                'status' => 'error',
-                'message' => 'last_seen_ip_address is required.',
-            ], 422);
-        }
-
-        $validated = $request->validated();
-
-        $device = Device::updateOrCreate(
-            ['serial_number' => $validated['serial_number']],
-            array_merge(
-                $validated,
-                [
-                    'last_seen_user_id' => $user->id,
-                    'last_seen_at' => now(),
-                    'last_seen_ip_address' => $ipAddress,
-                ]
-            )
-        );
+        $device = DeviceInventory::upsert($request, $request->validated());
 
         $code = $device->wasRecentlyCreated ? 201 : 200;
 

app/Util/DeviceInventory.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Util;
+
+use App\Models\Device;
+use App\Models\User;
+use Illuminate\Http\Exceptions\HttpResponseException;
+use Illuminate\Http\Request;
+
+class DeviceInventory
+{
+    /**
+     * Upsert a Device from an inventory report.
+     *
+     * Validates the requester is a User and the request has an IP address,
+     * then updates or creates the device with the provided data and request metadata.
+     *
+     * @param  array<string, string|int>  $data
+     *
+     * @throws HttpResponseException
+     */
+    public static function upsert(Request $request, array $data): Device
+    {
+        $user = $request->user();
+
+        if (! $user instanceof User) {
+            throw new HttpResponseException(response()->json([
+                'status' => 'error',
+                'message' => 'A user token is required.',
+            ], 401));
+        }
+
+        $ipAddress = $request->ip();
+
+        if ($ipAddress === null) {
+            throw new HttpResponseException(response()->json([
+                'status' => 'error',
+                'message' => 'last_seen_ip_address is required.',
+            ], 422));
+        }
+
+        return Device::updateOrCreate(
+            ['serial_number' => $data['serial_number']],
+            array_merge(
+                $data,
+                [
+                    'last_seen_user_id' => $user->id,
+                    'last_seen_at' => now(),
+                    'last_seen_ip_address' => $ipAddress,
+                ]
+            )
+        );
+    }
+}