@fleetbase/fleetops-engine 0.6.57 → 0.6.59

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

@@ -11,6 +11,7 @@ use Fleetbase\FleetOps\Support\PlaceSearch;
 use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Http\Controllers\Controller;
 use Fleetbase\LaravelMysqlSpatial\Types\Point;
+use Geocoder\Laravel\Facades\Geocoder;
 use Illuminate\Http\Request;
 use Illuminate\Support\Str;
 
@@ -26,30 +27,14 @@ class PlaceController extends Controller
     public function create(CreatePlaceRequest $request)
     {
         // get request input
-        $input = $request->only([
-            'name',
-            'street1',
-            'street2',
-            'city',
-            'location',
-            'province',
-            'postal_code',
-            'neighborhood',
-            'district',
-            'building',
-            'security_access_code',
-            'country',
-            'phone',
-            'type',
-            'meta',
-        ]);
+        $input = $this->placeInputFromRequest($request);
 
         // Check is missing key address attributes
-        $isNotAddressObject = $request->isNotFilled(['name', 'location', 'latititude', 'longitude', 'city', 'province', 'postal_code']);
+        $isNotAddressObject = $this->isNotAddressObject($request);
 
         // if address param is sent create from mixed
         if ($isNotAddressObject && $request->isString('address')) {
-            $place = Place::createFromGeocodingLookup($request->input('address'));
+            $place = $this->createPlaceFromGeocodingLookup($request->input('address'));
 
             if ($place instanceof Place) {
                 $input = $place->toArray();
@@ -58,7 +43,7 @@ class PlaceController extends Controller
 
         // if street1 is the only param
         if ($isNotAddressObject && $request->isString('street1')) {
-            $place = Place::createFromGeocodingLookup($request->input('street1'));
+            $place = $this->createPlaceFromGeocodingLookup($request->input('street1'));
 
             if ($place instanceof Place) {
                 $input = $place->toArray();
@@ -70,16 +55,10 @@ class PlaceController extends Controller
         $requestHasLocation    = $request->filled(['location']);
         $requestMissingStreet  = $request->missing('street1');
         if ($requestMissingStreet && ($requestHasCoordinates || $requestHasLocation)) {
-            if ($requestHasLocation) {
-                $point = Utils::getPointFromMixed($request->input('location'));
-            }
-
-            if ($requestHasCoordinates) {
-                $point = Utils::getPointFromMixed($request->only(['latitude', 'longitude']));
-            }
+            $point = $this->pointFromCoordinateRequest($request);
 
             if ($point instanceof Point) {
-                $place = Place::createFromReverseGeocodingLookup($point);
+                $place = $this->createPlaceFromReverseGeocodingLookup($point);
 
                 if ($place instanceof Place) {
                     $input = $place->toArray();
@@ -88,11 +67,7 @@ class PlaceController extends Controller
         }
 
         // latitude / longitude
-        if ($requestHasCoordinates) {
-            $input['location'] = Utils::getPointFromCoordinates($request->only(['latitude', 'longitude']));
-        } elseif ($requestHasLocation) {
-            $input['location'] = Utils::getPointFromMixed($request->input('location'));
-        }
+        $input = $this->withLocationFromRequest($input, $request);
 
         // make sure company is set
         $input['company_uuid'] = session('company');
@@ -106,7 +81,7 @@ class PlaceController extends Controller
                 $id = Str::replaceFirst('customer', 'contact', $id);
             }
 
-            $owner = Utils::getUuid(
+            $owner = $this->getUuid(
                 ['contacts', 'vendors'],
                 [
                     'public_id'    => $id,
@@ -118,16 +93,16 @@ class PlaceController extends Controller
             );
 
             if (is_array($owner)) {
-                $input['owner_uuid'] = Utils::get($owner, 'uuid');
-                $input['owner_type'] = Utils::getModelClassName(Utils::get($owner, 'table'));
+                $input['owner_uuid'] = $this->getValue($owner, 'uuid');
+                $input['owner_type'] = $this->getModelClassName($this->getValue($owner, 'table'));
             }
         }
 
         /** @var \Fleetbase\Models\Place */
-        $place = Place::firstOrNew([
+        $place = $this->firstOrNewPlace([
             'company_uuid' => session('company'),
             'owner_uuid'   => data_get($input, 'owner_uuid'),
-            'name'         => strtoupper(Utils::or($input, ['name', 'street1'])),
+            'name'         => strtoupper($this->orValue($input, ['name', 'street1'])),
             'street1'      => strtoupper($input['street1']),
         ]);
 
@@ -143,9 +118,7 @@ class PlaceController extends Controller
 
         // attempt to find and set latitude and longitude
         if ($isMissingLocation && $request->missing(['latitude', 'longitude', 'location'])) {
-            $geocoded = Geocoder::geocode($place->toAddressString(['name']))
-                ->get()
-                ->first();
+            $geocoded = $this->geocodeAddress($place->toAddressString(['name']));
 
             if ($geocoded) {
                 $place->fillWithGoogleAddress($geocoded);
@@ -157,7 +130,7 @@ class PlaceController extends Controller
         // Save place
         $place->save();
 
-        return new PlaceResource($place);
+        return $this->placeResource($place);
     }
 
     /**
@@ -171,34 +144,16 @@ class PlaceController extends Controller
     public function update($id, UpdatePlaceRequest $request)
     {
         try {
-            $place = Place::findRecordOrFail($id);
+            $place = $this->findPlaceOrFail($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->apiError('Place resource not found.');
+            return $this->apiError('Place resource not found.');
         }
 
         // get request input
-        $input = $request->only([
-            'name',
-            'street1',
-            'street2',
-            'city',
-            'location',
-            'province',
-            'postal_code',
-            'neighborhood',
-            'district',
-            'building',
-            'security_access_code',
-            'country',
-            'phone',
-            'type',
-            'meta',
-        ]);
+        $input = $this->placeInputFromRequest($request);
 
         // latitude / longitude
-        if ($request->has(['latitude', 'longitude'])) {
-            $input['location'] = Utils::getPointFromCoordinates($request->only(['latitude', 'longitude']));
-        }
+        $input = $this->withLocationFromRequest($input, $request);
 
         // owner assignment
         if ($request->has('owner')) {
@@ -217,7 +172,7 @@ class PlaceController extends Controller
                     $id = Str::replaceFirst('customer', 'contact', $id);
                 }
 
-                $owner = Utils::getUuid(
+                $owner = $this->getUuid(
                     ['contacts', 'vendors'],
                     [
                         'public_id'    => $id,
@@ -229,15 +184,15 @@ class PlaceController extends Controller
                 );
 
                 if (is_array($owner)) {
-                    $input['owner_uuid'] = Utils::get($owner, 'uuid');
-                    $input['owner_type'] = Utils::getModelClassName(Utils::get($owner, 'table'));
+                    $input['owner_uuid'] = $this->getValue($owner, 'uuid');
+                    $input['owner_type'] = $this->getModelClassName($this->getValue($owner, 'table'));
                 }
             }
         }
 
         // vendor assignment
         if ($request->has('vendor')) {
-            $input['vendor_uuid'] = Utils::getUuid('vendors', [
+            $input['vendor_uuid'] = $this->getUuid('vendors', [
                 'public_id'    => $request->input('vendor'),
                 'company_uuid' => session('company'),
             ]);
@@ -247,7 +202,7 @@ class PlaceController extends Controller
         $place->update($input);
         $place->flushAttributesCache();
 
-        return new PlaceResource($place);
+        return $this->placeResource($place);
     }
 
     /**
@@ -257,7 +212,7 @@ class PlaceController extends Controller
      */
     public function query(Request $request)
     {
-        $results = Place::queryWithRequest($request, function (&$query, $request) {
+        $results = $this->queryPlaces($request, function (&$query, $request) {
             if ($request->has('vendor')) {
                 $query->whereHas('vendor', function ($q) use ($request) {
                     $q->where('public_id', $request->input('vendor'));
@@ -267,7 +222,7 @@ class PlaceController extends Controller
 
         $results = $results->all();
 
-        return PlaceResource::collection($results);
+        return $this->placeResourceCollection($results);
     }
 
     /**
@@ -278,22 +233,13 @@ class PlaceController extends Controller
     public function search(Request $request)
     {
         $searchQuery = strtolower($request->input('query'));
-        $limit       = $request->input('limit', 10);
-        $geo         = $request->boolean('geo');
-        $latitude    = $request->input('latitude', false);
-        $longitude   = $request->input('longitude', false);
-
-        $query = Place::where('company_uuid', session('company'))->whereNull('deleted_at');
-
-        $results = PlaceSearch::search($query, $searchQuery, [
-            'limit'          => $limit,
-            'geo'            => $geo,
-            'latitude'       => $latitude,
-            'longitude'      => $longitude,
-            'no_query_order' => 'name_desc',
-        ]);
+        $options     = $this->placeSearchOptionsFromRequest($request);
 
-        return PlaceResource::collection($results);
+        $query = $this->basePlaceSearchQuery();
+
+        $results = $this->searchPlaces($query, $searchQuery, $options);
+
+        return $this->placeResourceCollection($results);
     }
 
     /**
@@ -305,12 +251,12 @@ class PlaceController extends Controller
     {
         // find for the place
         try {
-            $place = Place::findRecordOrFail($id);
+            $place = $this->findPlaceOrFail($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->apiError('Place resource not found.');
+            return $this->apiError('Place resource not found.');
         }
 
-        return new PlaceResource($place);
+        return $this->placeResource($place);
     }
 
     /**
@@ -321,13 +267,164 @@ class PlaceController extends Controller
     public function delete($id, Request $request)
     {
         try {
-            $place = Place::findRecordOrFail($id);
+            $place = $this->findPlaceOrFail($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->apiError('Place resource not found.');
+            return $this->apiError('Place resource not found.');
         }
 
         $place->delete();
 
+        return $this->deletedPlaceResource($place);
+    }
+
+    protected function placeInputFromRequest(Request $request): array
+    {
+        return $request->only([
+            'name',
+            'street1',
+            'street2',
+            'city',
+            'location',
+            'province',
+            'postal_code',
+            'neighborhood',
+            'district',
+            'building',
+            'security_access_code',
+            'country',
+            'phone',
+            'type',
+            'meta',
+        ]);
+    }
+
+    protected function isNotAddressObject(Request $request): bool
+    {
+        return $request->isNotFilled(['name', 'location', 'latititude', 'longitude', 'city', 'province', 'postal_code']);
+    }
+
+    protected function pointFromCoordinateRequest(Request $request): ?Point
+    {
+        if ($request->filled(['latitude', 'longitude'])) {
+            return $this->pointFromMixed($request->only(['latitude', 'longitude']));
+        }
+
+        if ($request->filled(['location'])) {
+            return $this->pointFromMixed($request->input('location'));
+        }
+
+        return null;
+    }
+
+    protected function withLocationFromRequest(array $input, Request $request): array
+    {
+        if ($request->has(['latitude', 'longitude'])) {
+            $input['location'] = $this->pointFromCoordinates($request->only(['latitude', 'longitude']));
+        } elseif ($request->filled(['location'])) {
+            $input['location'] = $this->pointFromMixed($request->input('location'));
+        }
+
+        return $input;
+    }
+
+    protected function placeSearchOptionsFromRequest(Request $request): array
+    {
+        return [
+            'limit'          => $request->input('limit', 10),
+            'geo'            => $request->boolean('geo'),
+            'latitude'       => $request->input('latitude', false),
+            'longitude'      => $request->input('longitude', false),
+            'no_query_order' => 'name_desc',
+        ];
+    }
+
+    protected function createPlaceFromGeocodingLookup(string $address): ?Place
+    {
+        return Place::createFromGeocodingLookup($address);
+    }
+
+    protected function createPlaceFromReverseGeocodingLookup(Point $point): ?Place
+    {
+        return Place::createFromReverseGeocodingLookup($point);
+    }
+
+    protected function getUuid(array|string $table, array $where, array $options = []): mixed
+    {
+        return Utils::getUuid($table, $where, $options);
+    }
+
+    protected function getValue(array|object $data, string $key): mixed
+    {
+        return Utils::get($data, $key);
+    }
+
+    protected function getModelClassName(?string $table): ?string
+    {
+        return $table ? Utils::getModelClassName($table) : null;
+    }
+
+    protected function orValue(array $input, array $keys): mixed
+    {
+        return Utils::or($input, $keys);
+    }
+
+    protected function firstOrNewPlace(array $attributes): Place
+    {
+        return Place::firstOrNew($attributes);
+    }
+
+    protected function geocodeAddress(string $address): mixed
+    {
+        return Geocoder::geocode($address)->get()->first();
+    }
+
+    protected function findPlaceOrFail(string $id): Place
+    {
+        return Place::findRecordOrFail($id);
+    }
+
+    protected function queryPlaces(Request $request, callable $callback): mixed
+    {
+        return Place::queryWithRequest($request, $callback);
+    }
+
+    protected function basePlaceSearchQuery(): mixed
+    {
+        return Place::where('company_uuid', session('company'))->whereNull('deleted_at');
+    }
+
+    protected function searchPlaces(mixed $query, string $searchQuery, array $options): mixed
+    {
+        return PlaceSearch::search($query, $searchQuery, $options);
+    }
+
+    protected function pointFromMixed(mixed $input): ?Point
+    {
+        return Utils::getPointFromMixed($input);
+    }
+
+    protected function pointFromCoordinates(array $coordinates): ?Point
+    {
+        return Utils::getPointFromCoordinates($coordinates);
+    }
+
+    protected function placeResource(Place $place)
+    {
+        return new PlaceResource($place);
+    }
+
+    protected function placeResourceCollection(mixed $results): mixed
+    {
+        return PlaceResource::collection($results);
+    }
+
+    protected function deletedPlaceResource(Place $place)
+    {
         return new DeletedResource($place);
     }
+
+    protected function apiError(string $message, int $status = 400)
+    {
+        return response()->apiError($message, $status);
+    }
 }

package/server/src/Http/Controllers/Api/v1/PurchaseRateController.php

@@ -11,6 +11,7 @@ use Fleetbase\FleetOps\Models\ServiceQuote;
 use Fleetbase\FleetOps\Models\ServiceRate;
 use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Http\Controllers\Controller;
+use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 
 class PurchaseRateController extends Controller
@@ -24,7 +25,7 @@ class PurchaseRateController extends Controller
      */
     public function create(CreatePurchaseRateRequest $request)
     {
-        $input       = $request->only(['meta']);
+        $input       = $this->purchaseRateInputFromRequest($request);
         $createOrder = $request->boolean('create_order', false);
         $order       = null;
 
@@ -33,7 +34,7 @@ class PurchaseRateController extends Controller
 
         // service_quote assignment
         if ($request->has('service_quote')) {
-            $input['service_quote_uuid'] = Utils::getUuid('service_quotes', [
+            $input['service_quote_uuid'] = $this->getResourceUuid('service_quotes', [
                 'public_id'    => $request->input('service_quote'),
                 'company_uuid' => session('company'),
             ]);
@@ -41,28 +42,25 @@ class PurchaseRateController extends Controller
 
         // order assignment
         if ($request->has('order')) {
-            $orderUuid = Utils::getUuid('orders', [
+            $orderUuid = $this->getResourceUuid('orders', [
                 'public_id'    => $request->input('order'),
                 'company_uuid' => session('company'),
             ]);
 
-            $order = Order::where('uuid', $orderUuid)->first();
+            $order = $this->findOrderByUuid($orderUuid);
 
             if ($order instanceof Order) {
-                $input['payload_uuid']   = $order->payload_uuid;
-                $input['customer_uuid']  = $order->customer_uuid;
-                $input['customer_type']  = $order->customer_type;
-                $input['company_uuid']   = $order->company_uuid ?? $input['company_uuid'];
+                $input = array_merge($input, $this->purchaseRateInputFromOrder($order, $input['company_uuid']));
             }
         } elseif ($createOrder) {
             // create order from service quote
-            $serviceQuote = ServiceQuote::where('uuid', $input['service_quote_uuid'])->orWhere('public_id', $request->input('service_quote'))->first();
+            $serviceQuote = $this->findServiceQuoteForPurchaseRate($input['service_quote_uuid'], $request->input('service_quote'));
             $order        = $this->createOrderFromServiceQuote($serviceQuote, $request);
         }
 
         // customer assignment
         if ($request->has('customer')) {
-            $customer = Utils::getUuid(
+            $customer = $this->getResourceUuid(
                 ['contacts', 'vendors'],
                 [
                     'public_id'    => $request->input('customer'),
@@ -71,13 +69,12 @@ class PurchaseRateController extends Controller
             );
 
             if (is_array($customer)) {
-                $input['customer_uuid'] = Utils::get($customer, 'uuid');
-                $input['customer_type'] = Utils::getModelClassName(Utils::get($customer, 'table'));
+                $input = array_merge($input, $this->purchaseRateCustomerInputFromLookup($customer));
             }
         }
 
         // create the purchaseRate
-        $purchaseRate = PurchaseRate::create($input);
+        $purchaseRate = $this->createPurchaseRate($input);
 
         if ($order instanceof Order) {
             $order->attachPurchaseRate($purchaseRate);
@@ -87,6 +84,49 @@ class PurchaseRateController extends Controller
         return new PurchaseRateResource($purchaseRate);
     }
 
+    protected function getResourceUuid($tables, array $where)
+    {
+        return Utils::getUuid($tables, $where);
+    }
+
+    protected function findOrderByUuid(?string $uuid): ?Order
+    {
+        return Order::where('uuid', $uuid)->first();
+    }
+
+    protected function findServiceQuoteForPurchaseRate(?string $uuid, ?string $publicId): ?ServiceQuote
+    {
+        return ServiceQuote::where('uuid', $uuid)->orWhere('public_id', $publicId)->first();
+    }
+
+    protected function createPurchaseRate(array $input): PurchaseRate
+    {
+        return PurchaseRate::create($input);
+    }
+
+    protected function purchaseRateInputFromRequest(Request $request): array
+    {
+        return $request->only(['meta']);
+    }
+
+    protected function purchaseRateInputFromOrder(Order $order, ?string $fallbackCompanyUuid = null): array
+    {
+        return [
+            'payload_uuid'  => $order->payload_uuid,
+            'customer_uuid' => $order->customer_uuid,
+            'customer_type' => $order->customer_type,
+            'company_uuid'  => $order->company_uuid ?? $fallbackCompanyUuid,
+        ];
+    }
+
+    protected function purchaseRateCustomerInputFromLookup(array $customer): array
+    {
+        return [
+            'customer_uuid' => Utils::get($customer, 'uuid'),
+            'customer_type' => Utils::getModelClassName(Utils::get($customer, 'table')),
+        ];
+    }
+
     /**
      * Create an Order from Service Quote.
      *
@@ -95,7 +135,7 @@ class PurchaseRateController extends Controller
      *
      * @return \Fleetbase\Models\Order|null
      */
-    private function createOrderFromServiceQuote(?ServiceQuote $serviceQuote, CreatePurchaseRateRequest $request): ?Order
+    protected function createOrderFromServiceQuote(?ServiceQuote $serviceQuote, CreatePurchaseRateRequest $request): Order|JsonResponse|null
     {
         // if integrated vendor service quote create order with vendor first then create fleetbase order
         $integratedVendorOrder = null;
@@ -125,7 +165,9 @@ class PurchaseRateController extends Controller
             $payload = new Payload();
             $payload->setPickup($pickup);
             $payload->setDropoff($dropoff);
-            $payload->setDropoff($return);
+            if ($return) {
+                $payload->setReturn($return);
+            }
             $payload->setWaypoints($waypoints);
             $payload->setEntities($entities);
             $payload->save();
@@ -146,28 +188,25 @@ class PurchaseRateController extends Controller
             $input['type'] = 'default';
         }
 
-        // create the order
+        // create the order — Eloquent's create() always hands back a model
+        // instance, so there is no not-an-Order path to fall through to
         $order = Order::create($input);
 
-        if ($order instanceof Order) {
-            // notify driver if assigned
-            $order->notifyDriverAssigned();
-
-            // set driving distance and time
-            $order->setPreliminaryDistanceAndTime();
-
-            // if it's integrated vendor order apply to meta
-            if ($integratedVendorOrder) {
-                $order->updateMeta([
-                    'integrated_vendor'       => $serviceQuote->integratedVendor->public_id,
-                    'integrated_vendor_order' => $integratedVendorOrder,
-                ]);
-            }
+        // notify driver if assigned
+        $order->notifyDriverAssigned();
+
+        // set driving distance and time
+        $order->setPreliminaryDistanceAndTime();
 
-            return $order;
+        // if it's integrated vendor order apply to meta
+        if ($integratedVendorOrder) {
+            $order->updateMeta([
+                'integrated_vendor'       => $serviceQuote->integratedVendor->public_id,
+                'integrated_vendor_order' => $integratedVendorOrder,
+            ]);
         }
 
-        return null;
+        return $order;
     }
 
     /**
@@ -177,9 +216,9 @@ class PurchaseRateController extends Controller
      */
     public function query(Request $request)
     {
-        $results = PurchaseRate::queryWithRequest($request);
+        $results = $this->queryPurchaseRates($request);
 
-        return PurchaseRateResource::collection($results);
+        return $this->purchaseRateResourceCollection($results);
     }
 
     /**
@@ -191,9 +230,9 @@ class PurchaseRateController extends Controller
     {
         // find for the purchaseRate
         try {
-            $purchaseRate = PurchaseRate::findRecordOrFail($id);
+            $purchaseRate = $this->findPurchaseRate($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'PurchaseRate resource not found.',
                 ],
@@ -202,6 +241,31 @@ class PurchaseRateController extends Controller
         }
 
         // response the purchaseRate resource
+        return $this->purchaseRateResource($purchaseRate);
+    }
+
+    protected function queryPurchaseRates(Request $request)
+    {
+        return PurchaseRate::queryWithRequest($request);
+    }
+
+    protected function findPurchaseRate(string $id): PurchaseRate
+    {
+        return PurchaseRate::findRecordOrFail($id);
+    }
+
+    protected function purchaseRateResource(PurchaseRate $purchaseRate)
+    {
         return new PurchaseRateResource($purchaseRate);
     }
+
+    protected function purchaseRateResourceCollection($results)
+    {
+        return PurchaseRateResource::collection($results);
+    }
+
+    protected function jsonResponse(array $payload, int $status)
+    {
+        return response()->json($payload, $status);
+    }
 }