@fleetbase/fleetops-engine 0.6.58 → 0.6.59

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

@@ -22,7 +22,7 @@ class MetricsController extends Controller
         $discover = $request->array('discover', []);
 
         try {
-            $data = Metrics::forCompany($request->user()->company, $start, $end)->with($discover)->get();
+            $data = $this->metricsForCompany($request->user()->company, $start, $end)->with($discover)->get();
         } catch (\Exception $e) {
             return response()->error($e->getMessage());
         }
@@ -42,14 +42,14 @@ class MetricsController extends Controller
      */
     public function show(Request $request, string $slug)
     {
-        $class = Registry::resolve($slug);
+        $class = $this->resolveMetricClass($slug);
         if ($class === null) {
             return response()->json(['error' => "Unknown metric: {$slug}"], 404);
         }
 
         [$start, $end] = $this->resolvePeriod($request);
 
-        $metric = $class::forCompany($request->user()->company)->between($start, $end);
+        $metric = $this->metricForCompany($class, $request->user()->company)->between($start, $end);
 
         if ($request->boolean('compare', true)) {
             $duration     = $end->getTimestamp() - $start->getTimestamp();
@@ -66,11 +66,26 @@ class MetricsController extends Controller
         return response()->json($metric->get());
     }
 
+    protected function metricsForCompany($company, $start, $end)
+    {
+        return Metrics::forCompany($company, $start, $end);
+    }
+
+    protected function resolveMetricClass(string $slug): ?string
+    {
+        return Registry::resolve($slug);
+    }
+
+    protected function metricForCompany(string $class, $company)
+    {
+        return $class::forCompany($company);
+    }
+
     /**
      * Parse ?period=7d/30d/90d into a [start, end] pair, falling back to
      * explicit ?start=&end= ISO dates, then to a 30-day default.
      */
-    private function resolvePeriod(Request $request): array
+    protected function resolvePeriod(Request $request): array
     {
         $period = $request->string('period')->toString();
 
@@ -93,17 +108,11 @@ class MetricsController extends Controller
             }
         }
 
+        // $request->date() yields a Carbon (a DateTime) or null, and both
+        // fallbacks are DateTime, so these are always DateTime instances
         $start = $request->date('start') ?? Carbon::now()->subDays(30)->toDateTime();
         $end   = $request->date('end') ?? Carbon::now()->toDateTime();
 
-        if (!$start instanceof \DateTime) {
-            $start = Carbon::parse($start)->toDateTime();
-        }
-
-        if (!$end instanceof \DateTime) {
-            $end = Carbon::parse($end)->toDateTime();
-        }
-
         return [$start, $end];
     }
 }

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

@@ -32,14 +32,14 @@ class MorphController extends Controller
         $type           = Str::lower($request->segment(4));
         $resourceType   = Str::lower(Utils::singularize($type));
 
-        $contactsQuery = Contact::select('*')
+        $contactsQuery = $this->newContactQuery()
             ->searchWhere('name', $query)
             ->where('type', $resourceType === 'customer' ? '=' : '!=', 'customer')
             ->where('company_uuid', session('company'))
             ->applyDirectivesForPermissions('fleet-ops list contact')
             ->filter(new ContactFilter($request));
 
-        $vendorsQuery = Vendor::select('*')
+        $vendorsQuery = $this->newVendorQuery()
             ->searchWhere('name', $query)
             ->where('company_uuid', session('company'))
             ->applyDirectivesForPermissions('fleet-ops list vendor')
@@ -67,7 +67,7 @@ class MorphController extends Controller
 
         // insert integrated vendors if user has any
         if ($resourceType === 'facilitator') {
-            $integratedVendors = IntegratedVendor::where('company_uuid', session('company'))->get();
+            $integratedVendors = $this->newIntegratedVendorQuery(session('company'))->get();
 
             if ($integratedVendors->count()) {
                 $integratedVendors->each(
@@ -81,7 +81,7 @@ class MorphController extends Controller
 
         // if requesting single resource
         if ($single === true) {
-            return response()->json($results->first());
+            return $this->jsonResponse($results->first());
         }
 
         // set resource type
@@ -94,12 +94,12 @@ class MorphController extends Controller
         );
 
         // Create a LengthAwarePaginator instance
-        $results = new LengthAwarePaginator(
+        $results = $this->newLengthAwarePaginator(
             $results->forPage($page, $limit),
             $total,
             $limit,
             $page,
-            ['path' => URL::current()]
+            ['path' => $this->currentUrl()]
         );
 
         // Manually structure the response
@@ -117,7 +117,7 @@ class MorphController extends Controller
             ],
         ];
 
-        return response()->json($response);
+        return $this->jsonResponse($response);
     }
 
     public function queryCustomers(Request $request)
@@ -125,23 +125,23 @@ class MorphController extends Controller
         $query           = $request->input('query');
         $limit           = $request->input('limit', 12);
         $single          = $request->boolean('single');
-        $columns         = $request->array('columns');
+        $columns         = $this->arrayInput($request, 'columns');
         $type            = $request->input('type', 'contact');
 
         if ($type === 'vendor') {
-            $builder = Vendor::select('*')
+            $builder = $this->newVendorQuery()
                 ->searchWhere('name', $query)
                 ->where(['type' => 'customer', 'company_uuid' => session('company')])
                 ->applyDirectivesForPermissions('fleet-ops list vendor')
                 ->filter(new VendorFilter($request));
         } else {
-            $builder = Contact::select('*')
+            $builder = $this->newContactQuery()
                 ->where(['type' => 'customer', 'company_uuid' => session('company')])
                 ->applyDirectivesForPermissions('fleet-ops list contact')
                 ->filter(new ContactFilter($request));
 
             if ($request->has('user_uuid') || $request->has('user')) {
-                $userId = $request->or(['user_uuid', 'user']);
+                $userId = $this->firstInput($request, ['user_uuid', 'user']);
                 if ($userId) {
                     $builder->where('user_uuid', $userId);
                 }
@@ -161,10 +161,10 @@ class MorphController extends Controller
         }));
 
         if ($single) {
-            return $type === 'vendor' ? new VendorResource($results->first()) : new ContactResource($results->first());
+            return $type === 'vendor' ? $this->vendorResource($results->first()) : $this->contactResource($results->first());
         }
 
-        return $type === 'vendor' ? VendorResource::collection($results) : ContactResource::collection($results);
+        return $type === 'vendor' ? $this->vendorResourceCollection($results) : $this->contactResourceCollection($results);
     }
 
     public function queryFacilitators(Request $request)
@@ -172,17 +172,17 @@ class MorphController extends Controller
         $query           = $request->input('query');
         $limit           = $request->input('limit', 12);
         $single          = $request->boolean('single');
-        $columns         = $request->array('columns');
+        $columns         = $this->arrayInput($request, 'columns');
         $type            = $request->input('type', 'vendor');
 
         if ($type === 'contact') {
-            $builder = Contact::select('*')
+            $builder = $this->newContactQuery()
                 ->searchWhere('name', $query)
                 ->where(['type' => 'facilitator', 'company_uuid' => session('company')])
                 ->applyDirectivesForPermissions('fleet-ops list contact')
                 ->filter(new ContactFilter($request));
         } else {
-            $builder = Vendor::select('*')
+            $builder = $this->newVendorQuery()
                 ->searchWhere('name', $query)
                 ->where(['type' => 'facilitator', 'company_uuid' => session('company')])
                 ->applyDirectivesForPermissions('fleet-ops list vendor')
@@ -198,9 +198,81 @@ class MorphController extends Controller
         }));
 
         if ($single) {
-            return $type === 'contact' ? new ContactResource($results->first()) : new VendorResource($results->first());
+            return $type === 'contact' ? $this->contactResource($results->first()) : $this->vendorResource($results->first());
         }
 
-        return $type === 'contact' ? ContactResource::collection($results) : VendorResource::collection($results);
+        return $type === 'contact' ? $this->contactResourceCollection($results) : $this->vendorResourceCollection($results);
+    }
+
+    protected function newContactQuery()
+    {
+        return Contact::select('*');
+    }
+
+    protected function newVendorQuery()
+    {
+        return Vendor::select('*');
+    }
+
+    protected function newIntegratedVendorQuery(string $companyUuid)
+    {
+        return IntegratedVendor::where('company_uuid', $companyUuid);
+    }
+
+    protected function newLengthAwarePaginator($items, int $total, int $limit, int $page, array $options)
+    {
+        return new LengthAwarePaginator($items, $total, $limit, $page, $options);
+    }
+
+    protected function arrayInput(Request $request, string $key): array
+    {
+        $value = $request->input($key, []);
+
+        if ($value === null) {
+            return [];
+        }
+
+        return is_array($value) ? $value : [$value];
+    }
+
+    protected function firstInput(Request $request, array $keys): mixed
+    {
+        foreach ($keys as $key) {
+            if ($request->filled($key)) {
+                return $request->input($key);
+            }
+        }
+
+        return null;
+    }
+
+    protected function currentUrl(): string
+    {
+        return URL::current();
+    }
+
+    protected function jsonResponse(mixed $data)
+    {
+        return response()->json($data);
+    }
+
+    protected function contactResource($resource)
+    {
+        return new ContactResource($resource);
+    }
+
+    protected function vendorResource($resource)
+    {
+        return new VendorResource($resource);
+    }
+
+    protected function contactResourceCollection($resource)
+    {
+        return ContactResource::collection($resource);
+    }
+
+    protected function vendorResourceCollection($resource)
+    {
+        return VendorResource::collection($resource);
     }
 }

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

@@ -23,31 +23,20 @@ class NavigatorController extends Controller
      */
     public function linkApp(Request $request)
     {
-        $adminUser = User::where('type', 'admin')->first();
+        $adminUser = $this->findAdminUser();
 
         if (!$adminUser || !$adminUser->company) {
             return response()->error('Organization for linking not found.');
         }
 
-        $apiCredential = ApiCredential::firstOrCreate(
-            [
-                'user_uuid'    => $adminUser->uuid,
-                'company_uuid' => $adminUser->company_uuid,
-                'name'         => 'NavigationAppLinker',
-            ],
-            [
-                'user_uuid'    => $adminUser->uuid,
-                'company_uuid' => $adminUser->company->uuid,
-                'name'         => 'NavigationAppLinker',
-            ]
-        );
+        $apiCredential = $this->firstOrCreateNavigatorCredential($adminUser);
 
         $key           = $apiCredential->key;
-        $host          = url()->secure('/');
-        $socketHost    = env('SOCKETCLUSTER_HOST', 'socket');
-        $socketPort    = env('SOCKETCLUSTER_PORT', 8000);
-        $socketSecure  = Utils::castBoolean(env('SOCKETCLUSTER_SECURE', false));
-        $appIdentifier = config('fleetops.navigator.app_identifier', 'io.fleetbase.navigator');
+        $host          = $this->secureRootUrl();
+        $socketHost    = $this->socketClusterHost();
+        $socketPort    = $this->socketClusterPort();
+        $socketSecure  = $this->socketClusterSecure();
+        $appIdentifier = $this->navigatorAppIdentifier();
 
         $deepLinkParams = http_build_query([
             'key'                  => $key,
@@ -62,13 +51,13 @@ class NavigatorController extends Controller
             // Android: Use intent:// scheme
             $intentUrl = "intent://configure?$deepLinkParams#Intent;scheme=flbnavigator;package=" . $appIdentifier . ';end';
 
-            return Redirect::away($intentUrl);
+            return $this->redirectAway($intentUrl);
         }
 
         // Default to iOS (or fallback): Use flbnavigator://
         $iosUrl = "flbnavigator://configure?$deepLinkParams";
 
-        return Redirect::away($iosUrl);
+        return $this->redirectAway($iosUrl);
     }
 
     /**
@@ -100,19 +89,7 @@ class NavigatorController extends Controller
         $connection = Str::startsWith($token, 'flb_test_') ? 'sandbox' : 'mysql';
 
         // Find the API Credential record
-        $findApKey = ApiCredential::on($connection)
-            ->where(function ($query) use ($isSecretKey, $token) {
-                if ($isSecretKey) {
-                    $query->where('secret', $token);
-                } else {
-                    $query->where('key', $token);
-                }
-            })
-            ->with(['company.owner'])
-            ->withoutGlobalScopes();
-
-        // Get the api credential model record
-        $apiCredential = $findApKey->first();
+        $apiCredential = $this->findApiCredentialForToken($token, $connection, $isSecretKey);
 
         // Handle no api credential found
         if (!$apiCredential) {
@@ -120,7 +97,7 @@ class NavigatorController extends Controller
         }
 
         // Get the organization owning the API key
-        $organization = Company::where('uuid', $apiCredential->company_uuid)->first();
+        $organization = $this->findOrganization($apiCredential->company_uuid);
 
         return new Organization($organization);
     }
@@ -132,8 +109,84 @@ class NavigatorController extends Controller
      */
     public function getDriverOnboardSettings()
     {
-        $onBoardSettings  = Setting::where('key', 'fleet-ops.driver-onboard')->value('value');
+        $onBoardSettings = $this->driverOnboardSettings();
 
         return response()->json($onBoardSettings);
     }
+
+    protected function findAdminUser(): ?User
+    {
+        return User::where('type', 'admin')->first();
+    }
+
+    protected function firstOrCreateNavigatorCredential(User $adminUser): ApiCredential
+    {
+        return ApiCredential::firstOrCreate(
+            [
+                'user_uuid'    => $adminUser->uuid,
+                'company_uuid' => $adminUser->company_uuid,
+                'name'         => 'NavigationAppLinker',
+            ],
+            [
+                'user_uuid'    => $adminUser->uuid,
+                'company_uuid' => $adminUser->company->uuid,
+                'name'         => 'NavigationAppLinker',
+            ]
+        );
+    }
+
+    protected function secureRootUrl(): string
+    {
+        return url()->secure('/');
+    }
+
+    protected function navigatorAppIdentifier(): string
+    {
+        return config('fleetops.navigator.app_identifier', 'io.fleetbase.navigator');
+    }
+
+    protected function socketClusterHost(): string
+    {
+        return env('SOCKETCLUSTER_HOST', 'socket');
+    }
+
+    protected function socketClusterPort(): int|string
+    {
+        return env('SOCKETCLUSTER_PORT', 8000);
+    }
+
+    protected function socketClusterSecure(): bool
+    {
+        return Utils::castBoolean(env('SOCKETCLUSTER_SECURE', false));
+    }
+
+    protected function redirectAway(string $url)
+    {
+        return Redirect::away($url);
+    }
+
+    protected function findApiCredentialForToken(?string $token, string $connection, bool $isSecretKey): ?ApiCredential
+    {
+        return ApiCredential::on($connection)
+            ->where(function ($query) use ($isSecretKey, $token) {
+                if ($isSecretKey) {
+                    $query->where('secret', $token);
+                } else {
+                    $query->where('key', $token);
+                }
+            })
+            ->with(['company.owner'])
+            ->withoutGlobalScopes()
+            ->first();
+    }
+
+    protected function findOrganization(string $companyUuid): ?Company
+    {
+        return Company::where('uuid', $companyUuid)->first();
+    }
+
+    protected function driverOnboardSettings(): mixed
+    {
+        return Setting::where('key', 'fleet-ops.driver-onboard')->value('value');
+    }
 }