@fleetbase/fleetops-engine 0.6.58 → 0.6.60

package/server/src/Http/Controllers/Internal/v1/PartController.php

@@ -30,7 +30,7 @@ class PartController extends FleetOpsController
         $selections = $request->array('selections');
         $fileName   = trim(Str::slug('parts-' . date('Y-m-d-H:i')) . '.' . $format);
 
-        return Excel::download(new PartExport($selections), $fileName);
+        return $this->downloadExport(new PartExport($selections), $fileName);
     }
 
     /**
@@ -46,8 +46,8 @@ class PartController extends FleetOpsController
 
         foreach ($files as $file) {
             try {
-                $import = new PartImport();
-                Excel::import($import, $file->path, $disk);
+                $import = $this->createImport();
+                $this->importFile($import, $file->path, $disk);
                 $importedCount += $import->imported;
             } catch (\Throwable $e) {
                 return response()->error('Invalid file, unable to process.');
@@ -56,4 +56,19 @@ class PartController extends FleetOpsController
 
         return response()->json(['status' => 'ok', 'message' => 'Import completed', 'imported' => $importedCount]);
     }
+
+    protected function downloadExport(PartExport $export, string $fileName)
+    {
+        return Excel::download($export, $fileName);
+    }
+
+    protected function createImport(): PartImport
+    {
+        return new PartImport();
+    }
+
+    protected function importFile(PartImport $import, string $path, string $disk): void
+    {
+        Excel::import($import, $path, $disk);
+    }
 }

package/server/src/Http/Controllers/Internal/v1/PaymentController.php

@@ -21,14 +21,14 @@ class PaymentController extends Controller
      */
     public function hasStripeConnectAccount()
     {
-        $company = Auth::getCompany();
+        $company = $this->getCompany();
         if ($company) {
-            return response()->json([
-                'hasStripeConnectAccount' => !empty($company->stripe_connect_id) && Str::startsWith($company->stripe_connect_id, 'acct_'),
+            return $this->jsonResponse([
+                'hasStripeConnectAccount' => $this->hasStripeConnectId($company->stripe_connect_id),
             ]);
         }
 
-        return response()->json([
+        return $this->jsonResponse([
             'hasStripeConnectAccount' => false,
         ]);
     }
@@ -43,7 +43,7 @@ class PaymentController extends Controller
      */
     public function getStripeAccount()
     {
-        $stripe = Payment::getStripeClient();
+        $stripe = $this->stripeClient();
 
         try {
             $account = $stripe->accounts->create([
@@ -61,14 +61,14 @@ class PaymentController extends Controller
             ]);
 
             // Save account ID to current company session
-            $company = Auth::getCompany();
+            $company = $this->getCompany();
             if ($company) {
                 $company->update(['stripe_connect_id' => $account->id]);
             }
 
-            return response()->json(['account' => $account->id]);
+            return $this->jsonResponse(['account' => $account->id]);
         } catch (\Exception $e) {
-            return response()->error($e->getMessage());
+            return $this->errorResponse($e->getMessage());
         }
     }
 
@@ -84,8 +84,8 @@ class PaymentController extends Controller
      */
     public function getStripeAccountSession(Request $request)
     {
-        $stripe  = Payment::getStripeClient();
-        $company = Auth::getCompany();
+        $stripe  = $this->stripeClient();
+        $company = $this->getCompany();
 
         try {
             $accountSession = $stripe->accountSessions->create([
@@ -97,11 +97,11 @@ class PaymentController extends Controller
                 ],
             ]);
 
-            return response()->json([
+            return $this->jsonResponse([
                 'clientSecret' => $accountSession->client_secret,
             ]);
         } catch (\Exception $e) {
-            return response()->error($e->getMessage());
+            return $this->errorResponse($e->getMessage());
         }
     }
 
@@ -160,8 +160,40 @@ class PaymentController extends Controller
         $paymentsCollection         = $query->get();
 
         // Calculate totals grouped by currency
+        $totals = $this->totalsByServiceQuoteCurrency($paymentsCollection);
+
+        return FleetbaseResource::collection($payments)->additional(['amount_totals' => $totals]);
+    }
+
+    protected function hasStripeConnectId(?string $stripeConnectId): bool
+    {
+        return !empty($stripeConnectId) && Str::startsWith($stripeConnectId, 'acct_');
+    }
+
+    protected function getCompany(): mixed
+    {
+        return Auth::getCompany();
+    }
+
+    protected function stripeClient(): mixed
+    {
+        return Payment::getStripeClient();
+    }
+
+    protected function jsonResponse(array $payload)
+    {
+        return response()->json($payload);
+    }
+
+    protected function errorResponse(string $message)
+    {
+        return response()->error($message);
+    }
+
+    protected function totalsByServiceQuoteCurrency(iterable $payments): array
+    {
         $totals = [];
-        foreach ($paymentsCollection as $payment) {
+        foreach ($payments as $payment) {
             $currency = $payment->serviceQuote->currency;
             $amount   = $payment->serviceQuote->amount;
             if (!isset($totals[$currency])) {
@@ -171,6 +203,6 @@ class PaymentController extends Controller
             $totals[$currency] += $amount;
         }
 
-        return FleetbaseResource::collection($payments)->additional(['amount_totals' => $totals]);
+        return $totals;
     }
 }

package/server/src/Http/Controllers/Internal/v1/PlaceController.php

@@ -30,7 +30,7 @@ class PlaceController extends FleetOpsController
     {
         $customFieldValues = $request->array('place.custom_field_values');
         if ($customFieldValues) {
-            $place->syncCustomFieldValues($customFieldValues);
+            $this->syncCustomFieldValues($place, $customFieldValues);
         }
     }
 
@@ -47,11 +47,12 @@ class PlaceController extends FleetOpsController
         $latitude    = $request->input('latitude');
         $longitude   = $request->input('longitude');
 
-        $query = Place::where('company_uuid', session('company'))
+        $query = $this->newPlaceQuery()
+            ->where('company_uuid', session('company'))
             ->whereNull('deleted_at')
             ->applyDirectivesForPermissions('fleet-ops list place');
 
-        $results = PlaceSearch::search($query, $searchQuery, [
+        $results = $this->searchPlaces($query, $searchQuery, [
             'limit'          => $limit,
             'geo'            => $geo,
             'latitude'       => $latitude,
@@ -72,7 +73,7 @@ class PlaceController extends FleetOpsController
         $searchQuery = $request->searchQuery();
         $latitude    = $request->input('latitude', false);
         $longitude   = $request->input('longitude', false);
-        $results     = PlaceSearch::geocode($searchQuery, $latitude, $longitude);
+        $results     = $this->geocodePlaces($searchQuery, $latitude, $longitude);
 
         return response()->json($results)->withHeaders(['Cache-Control' => 'no-cache']);
     }
@@ -98,7 +99,7 @@ class PlaceController extends FleetOpsController
      */
     public function avatars()
     {
-        $options = Place::getAvatarOptions();
+        $options = $this->avatarOptions();
 
         return response()->json($options);
     }
@@ -126,4 +127,29 @@ class PlaceController extends FleetOpsController
 
         return response()->json(['status' => 'ok', 'message' => 'Import completed', 'imported' => $importedCount]);
     }
+
+    protected function syncCustomFieldValues(Place $place, array $customFieldValues): void
+    {
+        $place->syncCustomFieldValues($customFieldValues);
+    }
+
+    protected function newPlaceQuery()
+    {
+        return Place::query();
+    }
+
+    protected function searchPlaces($query, ?string $searchQuery, array $options)
+    {
+        return PlaceSearch::search($query, $searchQuery, $options);
+    }
+
+    protected function geocodePlaces(?string $searchQuery, mixed $latitude, mixed $longitude)
+    {
+        return PlaceSearch::geocode($searchQuery, $latitude, $longitude);
+    }
+
+    protected function avatarOptions(): array
+    {
+        return Place::getAvatarOptions()->all();
+    }
 }

package/server/src/Http/Controllers/Internal/v1/ProofController.php

@@ -31,28 +31,16 @@ class ProofController extends FleetOpsController
         $code = $request->input('code');
         $type = $request->input('type', strtok($publicId, '_'));
 
-        switch ($type) {
-            case 'order':
-                $subject = Order::where('uuid', $code)->withoutGlobalScopes()->first();
-                break;
-
-            case 'waypoint':
-                $subject = Waypoint::where('uuid', $code)->withoutGlobalScopes()->first();
-                break;
-
-            case 'entity':
-                $subject = Entity::where('uuid', $code)->withoutGlobalScopes()->first();
-                break;
-        }
+        $subject = $this->findQrSubject($type, $code);
 
         if (!$subject) {
-            return response()->error('Unable to validate QR code data.');
+            return $this->errorResponse('Unable to validate QR code data.');
         }
 
         // validate
         if ($publicId === $subject->public_id) {
             // create verification proof
-            $proof = Proof::create([
+            $proof = $this->createProof([
                 'company_uuid' => session('company'),
                 'subject_uuid' => $subject->uuid,
                 'subject_type' => Utils::getModelClassName($subject),
@@ -61,13 +49,10 @@ class ProofController extends FleetOpsController
                 'data'         => $request->input('data'),
             ]);
 
-            return response()->json([
-                'status' => 'success',
-                'proof'  => $proof->public_id,
-            ]);
+            return $this->jsonResponse($this->proofSuccessPayload($proof));
         }
 
-        return response()->error('Unable to validate QR code data.');
+        return $this->errorResponse('Unable to validate QR code data.');
     }
 
     /**
@@ -80,26 +65,14 @@ class ProofController extends FleetOpsController
         $signature = $request->input('signature');
         $type      = $request->input('type', strtok($publicId, '_'));
 
-        switch ($type) {
-            case 'order':
-                $subject = Order::where('public_id', $publicId)->withoutGlobalScopes()->first();
-                break;
-
-            case 'waypoint':
-                $subject = Waypoint::where('public_id', $publicId)->withoutGlobalScopes()->first();
-                break;
-
-            case 'entity':
-                $subject = Entity::where('public_id', $publicId)->withoutGlobalScopes()->first();
-                break;
-        }
+        $subject = $this->findPublicSubject($type, $publicId);
 
         if (!$subject) {
-            return response()->error('Unable to capture signature data.');
+            return $this->errorResponse('Unable to capture signature data.');
         }
 
         // create proof instance
-        $proof = Proof::create([
+        $proof = $this->createProof([
             'company_uuid' => session('company'),
             'subject_uuid' => $subject->uuid,
             'subject_type' => Utils::getModelClassName($subject),
@@ -108,13 +81,89 @@ class ProofController extends FleetOpsController
         ]);
 
         // set the signature storage path
-        $path = 'uploads/' . session('company') . '/signatures/' . $proof->public_id . '.png';
+        $path = $this->signatureStoragePath($proof);
 
         // upload signature
-        Storage::disk('s3')->put($path, base64_decode($signature), 'public');
+        $this->storeSignature($path, base64_decode($signature), 'public');
 
         // create file record for upload
-        $file = File::create([
+        $file = $this->createSignatureFile($path, $signature, $proof);
+
+        // set file to proof
+        $proof->file_uuid = $file->uuid;
+        $proof->save();
+
+        return $this->jsonResponse($this->proofSuccessPayload($proof));
+    }
+
+    protected function findQrSubject(string $type, ?string $code): mixed
+    {
+        return match ($type) {
+            'order'    => Order::where('uuid', $code)->withoutGlobalScopes()->first(),
+            'waypoint' => Waypoint::where('uuid', $code)->withoutGlobalScopes()->first(),
+            'entity'   => Entity::where('uuid', $code)->withoutGlobalScopes()->first(),
+            default    => null,
+        };
+    }
+
+    protected function findPublicSubject(string $type, string $publicId): mixed
+    {
+        return match ($type) {
+            'order'    => Order::where('public_id', $publicId)->withoutGlobalScopes()->first(),
+            'waypoint' => Waypoint::where('public_id', $publicId)->withoutGlobalScopes()->first(),
+            'entity'   => Entity::where('public_id', $publicId)->withoutGlobalScopes()->first(),
+            default    => null,
+        };
+    }
+
+    protected function createProof(array $attributes): Proof
+    {
+        return Proof::create($attributes);
+    }
+
+    protected function storeSignature(string $path, string|false $contents, string $visibility): void
+    {
+        Storage::disk('s3')->put($path, $contents, $visibility);
+    }
+
+    /**
+     * Not exercisable in this harness: File::create() resolves a disk, an asset
+     * url and app()->environment(), so it needs a real Illuminate\Foundation\Application
+     * rather than the bare container the test bootstrap builds.
+     */
+    // @codeCoverageIgnoreStart
+    protected function createSignatureFile(string $path, string $signature, Proof $proof): File
+    {
+        return File::create($this->signatureFileAttributes($path, $signature))->setKey($proof);
+    }
+    // @codeCoverageIgnoreEnd
+
+    protected function jsonResponse(array $payload)
+    {
+        return response()->json($payload);
+    }
+
+    protected function errorResponse(string $message)
+    {
+        return response()->error($message);
+    }
+
+    protected function proofSuccessPayload(Proof $proof): array
+    {
+        return [
+            'status' => 'success',
+            'proof'  => $proof->public_id,
+        ];
+    }
+
+    protected function signatureStoragePath(Proof $proof): string
+    {
+        return 'uploads/' . session('company') . '/signatures/' . $proof->public_id . '.png';
+    }
+
+    protected function signatureFileAttributes(string $path, string $signature): array
+    {
+        return [
             'company_uuid'      => session('company'),
             'uploader_uuid'     => session('user'),
             'name'              => basename($path),
@@ -125,15 +174,6 @@ class ProofController extends FleetOpsController
             'bucket'            => config('filesystems.disks.s3.bucket'),
             'type'              => 'signature',
             'size'              => Utils::getBase64ImageSize($signature),
-        ])->setKey($proof);
-
-        // set file to proof
-        $proof->file_uuid = $file->uuid;
-        $proof->save();
-
-        return response()->json([
-            'status' => 'success',
-            'proof'  => $proof->public_id,
-        ]);
+        ];
     }
 }

package/server/src/Http/Controllers/Internal/v1/SearchController.php

@@ -473,7 +473,7 @@ class SearchController extends Controller
         ]);
     }
 
-    private function searchGeneric(string $modelClass, array $columns, string $query, int $limit, callable $mapper): Collection
+    protected function searchGeneric(string $modelClass, array $columns, string $query, int $limit, callable $mapper): Collection
     {
         return $modelClass::where('company_uuid', session('company'))
             ->where(function (Builder $builder) use ($columns, $query) {

package/server/src/Http/Controllers/Internal/v1/SensorController.php

@@ -28,7 +28,7 @@ class SensorController extends FleetOpsController
         $selections = $request->array('selections');
         $fileName   = trim(Str::slug('sensors-' . date('Y-m-d-H:i')) . '.' . $format);
 
-        return Excel::download(new SensorExport($selections), $fileName);
+        return $this->downloadExport(new SensorExport($selections), $fileName);
     }
 
     /**
@@ -41,4 +41,9 @@ class SensorController extends FleetOpsController
     {
         $query->with(['telematic', 'device', 'warranty']);
     }
+
+    protected function downloadExport(SensorExport $export, string $fileName)
+    {
+        return Excel::download($export, $fileName);
+    }
 }

package/server/src/Http/Controllers/Internal/v1/ServiceAreaController.php

@@ -41,6 +41,11 @@ class ServiceAreaController extends FleetOpsController
         $selections   = $request->array('selections');
         $fileName     = trim(Str::slug('service-areas-' . date('Y-m-d-H:i')) . '.' . $format);
 
-        return Excel::download(new ServiceAreaExport($selections), $fileName);
+        return static::downloadExport(new ServiceAreaExport($selections), $fileName);
+    }
+
+    protected static function downloadExport(ServiceAreaExport $export, string $fileName)
+    {
+        return Excel::download($export, $fileName);
     }
 }