@fleetbase/fleetops-engine 0.2.5 → 0.2.7

package/server/src/Support/Metrics.php

@@ -0,0 +1,305 @@
+<?php
+
+namespace Fleetbase\FleetOps\Support;
+
+use Fleetbase\FleetOps\Models\Contact;
+use Fleetbase\FleetOps\Models\Driver;
+use Fleetbase\FleetOps\Models\FuelReport;
+use Fleetbase\FleetOps\Models\Issue;
+use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\Models\Company;
+use Fleetbase\Models\Transaction;
+use Illuminate\Support\Carbon;
+use Illuminate\Support\Str;
+
+/**
+ * Metrics service to pull analyitcs and metrics from FleetOps.
+ *
+ * Ex:
+ * $metrics = Metrics::new($company)->withEarnings()->withFuelCosts()->get();
+ */
+class Metrics
+{
+    protected \DateTime $start;
+    protected \DateTime $end;
+    protected Company $company;
+    protected array $metrics = [];
+
+    public static function new(Company $company, \DateTime $start = null, \DateTime $end = null): Metrics
+    {
+        $start = $start === null ? Carbon::create(1900)->toDateTime() : $start;
+        $end   = $end === null ? Carbon::tomorrow()->toDateTime() : $end;
+
+        return (new static())->setCompany($company)->between($start, $end);
+    }
+
+    public static function forCompany(Company $company, \DateTime $start = null, \DateTime $end = null): Metrics
+    {
+        return static::new($company, $start, $end);
+    }
+
+    public function start(\DateTime $start): Metrics
+    {
+        $this->start = $start;
+
+        return $this;
+    }
+
+    public function end(\DateTime $end): Metrics
+    {
+        $this->end = $end;
+
+        return $this;
+    }
+
+    public function between(\DateTime $start, \DateTime $end): Metrics
+    {
+        return $this->start($start)->end($end);
+    }
+
+    private function setCompany(Company $company): Metrics
+    {
+        $this->company = $company;
+
+        return $this;
+    }
+
+    private function set($key, $value = null): Metrics
+    {
+        if (is_array($key)) {
+            foreach ($key as $k => $v) {
+                $this->set($k, $v);
+            }
+
+            return $this;
+        }
+
+        $this->metrics = data_set($this->metrics, $key, $value);
+
+        return $this;
+    }
+
+    public function get()
+    {
+        return $this->metrics;
+    }
+
+    public function with(?array $metrics = [])
+    {
+        if (empty($metrics)) {
+            $metrics = array_slice(get_class_methods($this), 9);
+        }
+
+        $metrics = array_map(
+            function ($metric) {
+                return Str::camel($metric);
+            },
+            $metrics
+        );
+
+        foreach ($metrics as $metric) {
+            if (method_exists($this, $metric)) {
+                $this->{$metric}();
+            }
+        }
+
+        return $this;
+    }
+
+    public function earnings(callable $callback = null): Metrics
+    {
+        $query = Transaction::where('company_uuid', $this->company->uuid)->whereBetween('created_at', [$this->start, $this->end]);
+
+        if (is_callable($callback)) {
+            $callback($query);
+        }
+
+        $data = $query->sum('amount');
+
+        return $this->set('earnings', (int) $data);
+    }
+
+    public function fuelCosts(callable $callback = null): Metrics
+    {
+        $query = FuelReport::where('company_uuid', $this->company->uuid)->whereBetween('created_at', [$this->start, $this->end]);
+
+        if (is_callable($callback)) {
+            $callback($query);
+        }
+
+        $data = $query->sum('amount');
+
+        return $this->set('fuel_costs', (int) $data);
+    }
+
+    public function totalDistanceTraveled(callable $callback = null): Metrics
+    {
+        $query = Order::where(
+            [
+                'company_uuid' => $this->company->uuid,
+                'status'       => 'completed',
+            ]
+        )
+            ->whereBetween('created_at', [$this->start, $this->end]);
+
+        if (is_callable($callback)) {
+            $callback($query);
+        }
+
+        $data = $query->sum('distance');
+
+        return $this->set('total_distance_traveled', (int) $data);
+    }
+
+    public function totalTimeTraveled(callable $callback = null): Metrics
+    {
+        $query = Order::where(
+            [
+                'company_uuid' => $this->company->uuid,
+                'status'       => 'completed',
+            ]
+        )
+            ->whereBetween('created_at', [$this->start, $this->end]);
+
+        if (is_callable($callback)) {
+            $callback($query);
+        }
+
+        $data = $query->sum('distance');
+
+        return $this->set('total_distance_traveled', (int) $data);
+    }
+
+    public function ordersCanceled(callable $callback = null): Metrics
+    {
+        $query = Order::where('company_uuid', $this->company->uuid)
+            ->whereBetween('created_at', [$this->start, $this->end])
+            ->where('status', 'canceled');
+
+        if (is_callable($callback)) {
+            $callback($query);
+        }
+
+        $data = $query->count();
+
+        return $this->set('orders_canceled', $data);
+    }
+
+    public function ordersCompleted(callable $callback = null): Metrics
+    {
+        $query = Order::where('company_uuid', $this->company->uuid)
+            ->whereBetween('created_at', [$this->start, $this->end])
+            ->where('status', 'completed');
+
+        if (is_callable($callback)) {
+            $callback($query);
+        }
+
+        $data = $query->count();
+
+        return $this->set('orders_completed', $data);
+    }
+
+    public function ordersInProgress(callable $callback = null): Metrics
+    {
+        $query = Order::where('company_uuid', $this->company->uuid)
+            ->whereBetween('created_at', [$this->start, $this->end])
+            ->whereNotIn('status', ['completed', 'created', 'pending', 'canceled']);
+
+        if (is_callable($callback)) {
+            $callback($query);
+        }
+
+        $data = $query->count();
+
+        return $this->set('orders_in_progress', $data);
+    }
+
+    public function ordersScheduled(callable $callback = null): Metrics
+    {
+        $query = Order::where('company_uuid', $this->company->uuid)
+            ->whereBetween('created_at', [$this->start, $this->end])
+            ->where('status', 'created')
+            ->whereDate('scheduled_at', '>', Carbon::now());
+
+        if (is_callable($callback)) {
+            $callback($query);
+        }
+
+        $data = $query->count();
+
+        return $this->set('orders_scheduled', $data);
+    }
+
+    public function driversOnline(callable $callback = null): Metrics
+    {
+        $query = Driver::where('company_uuid', $this->company->uuid)
+            ->where('online', true)
+            ->whereNotNull('current_job_uuid');
+
+        if (is_callable($callback)) {
+            $callback($query);
+        }
+
+        $data = $query->count();
+
+        return $this->set('drivers_online', $data);
+    }
+
+    public function totalDrivers(callable $callback = null): Metrics
+    {
+        $query = Driver::where('company_uuid', $this->company->uuid);
+
+        if (is_callable($callback)) {
+            $callback($query);
+        }
+
+        $data = $query->count();
+
+        return $this->set('total_drivers', $data);
+    }
+
+    public function totalCustomers(callable $callback = null): Metrics
+    {
+        $query = Contact::where('company_uuid', $this->company->uuid)
+            ->where('type', 'customer');
+
+        if (is_callable($callback)) {
+            $callback($query);
+        }
+
+        $data = $query->count();
+
+        return $this->set('total_customers', $data);
+    }
+
+    public function openIssues(callable $callback = null): Metrics
+    {
+        $query = Issue::where('company_uuid', session('company'))
+            ->whereBetween('created_at', [$this->start, $this->end])
+            ->where('status', 'pending');
+
+        if (is_callable($callback)) {
+            $callback($query);
+        }
+
+        $data = $query->count();
+
+        return $this->set('open_issues', $data);
+    }
+
+    public function resolvedIssues(callable $callback = null): Metrics
+    {
+        $query = Issue::where('company_uuid', session('company'))
+            ->whereBetween('created_at', [$this->start, $this->end])
+            ->whereNotNull('resolved_at');
+
+        if (is_callable($callback)) {
+            $callback($query);
+        }
+
+        $data = $query->count();
+
+        return $this->set('resolved_issues', $data);
+    }
+}

package/server/src/Support/OSRM.php

@@ -0,0 +1,191 @@
+<?php
+
+namespace Fleetbase\FleetOps\Support;
+
+use Fleetbase\FleetOps\Support\Encoding\Polyline;
+use Grimzy\LaravelMysqlSpatial\Types\Point;
+use Illuminate\Support\Facades\Cache;
+use Illuminate\Support\Facades\Http;
+
+/**
+ * Class OSRM
+ * A support class to interact with the Open Source Routing Machine (OSRM) API.
+ */
+class OSRM
+{
+    protected static $baseUrl = 'https://bundle.routing.fleetbase.io';
+
+    /**
+     * Get the route between two points.
+     *
+     * @param Point $start           starting point
+     * @param Point $end             ending point
+     * @param array $queryParameters additional query parameters
+     *
+     * @return array response from the OSRM API
+     */
+    public static function getRoute(Point $start, Point $end, array $queryParameters = [])
+    {
+        // Generate a unique cache key based on the method parameters
+        $cacheKey = 'getRoute:' . md5($start . $end . serialize($queryParameters));
+
+        // Return the cached result if it exists
+        if (Cache::has($cacheKey)) {
+            return Cache::get($cacheKey);
+        }
+
+        $coordinates = "{$start->getLng()},{$start->getLat()};{$end->getLng()},{$end->getLat()}";
+        $url         = self::$baseUrl . "/route/v1/driving/{$coordinates}";
+        $response    = Http::get($url, $queryParameters);
+        $data        = $response->json();
+
+        // Check for the presence of the encoded polyline in each route and decode it if found
+        if (isset($data['routes']) && is_array($data['routes'])) {
+            foreach ($data['routes'] as &$route) {
+                if (isset($route['geometry'])) {
+                    $route['waypoints'] = self::decodePolyline($route['geometry']);
+                }
+            }
+        }
+
+        // Store the result in the cache for 60 minutes
+        Cache::put($cacheKey, $data, 60 * 60);
+
+        return $data;
+    }
+
+    /**
+     * Get the nearest point on a road to a given location.
+     *
+     * @param Point $location        location point
+     * @param array $queryParameters additional query parameters
+     *
+     * @return array response from the OSRM API
+     */
+    public static function getNearest(Point $location, array $queryParameters = [])
+    {
+        $cacheKey = 'getNearest:' . md5($location . serialize($queryParameters));
+
+        if (Cache::has($cacheKey)) {
+            return Cache::get($cacheKey);
+        }
+
+        $coordinates = "{$location->getLng()},{$location->getLat()}";
+        $url         = self::$baseUrl . "/nearest/v1/driving/{$coordinates}";
+        $response    = Http::get($url, $queryParameters);
+        $result      = $response->json();
+
+        Cache::put($cacheKey, $result, 60 * 60);
+
+        return $result;
+    }
+
+    /**
+     * Get a table of travel times or distances between multiple points.
+     *
+     * @param array $points          array of Point objects
+     * @param array $queryParameters additional query parameters
+     *
+     * @return array response from the OSRM API
+     */
+    public static function getTable(array $points, array $queryParameters = [])
+    {
+        $cacheKey = 'getTable:' . md5(serialize($points) . serialize($queryParameters));
+
+        if (Cache::has($cacheKey)) {
+            return Cache::get($cacheKey);
+        }
+
+        $coordinates = implode(';', array_map(function (Point $point) {
+            return "{$point->getLng()},{$point->getLat()}";
+        }, $points));
+
+        $url      = self::$baseUrl . "/table/v1/driving/{$coordinates}";
+        $response = Http::get($url, $queryParameters);
+        $result   = $response->json();
+
+        Cache::put($cacheKey, $result, 60 * 60);
+
+        return $result;
+    }
+
+    /**
+     * Get a trip between multiple points.
+     *
+     * @param array $points          array of Point objects
+     * @param array $queryParameters additional query parameters
+     *
+     * @return array response from the OSRM API
+     */
+    public static function getTrip(array $points, array $queryParameters = [])
+    {
+        $cacheKey = 'getTrip:' . md5(serialize($points) . serialize($queryParameters));
+
+        if (Cache::has($cacheKey)) {
+            return Cache::get($cacheKey);
+        }
+
+        $coordinates = implode(';', array_map(function (Point $point) {
+            return "{$point->getLng()},{$point->getLat()}";
+        }, $points));
+
+        $url      = self::$baseUrl . "/trip/v1/driving/{$coordinates}";
+        $response = Http::get($url, $queryParameters);
+        $data     = $response->json();
+
+        Cache::put($cacheKey, $data, 60 * 60);
+
+        return $data;
+    }
+
+    /**
+     * Get a match between GPS points and roads.
+     *
+     * @param array $points          array of Point objects
+     * @param array $queryParameters additional query parameters
+     *
+     * @return array response from the OSRM API
+     */
+    public static function getMatch(array $points, array $queryParameters = [])
+    {
+        $coordinates = implode(';', array_map(function (Point $point) {
+            return "{$point->getLng()},{$point->getLat()}";
+        }, $points));
+        $url = self::$baseUrl . "/match/v1/driving/{$coordinates}";
+
+        $response = Http::get($url, $queryParameters);
+
+        return $response->json();
+    }
+
+    /**
+     * Get a tile for a specific zoom level and coordinates.
+     *
+     * @param int   $z               zoom level
+     * @param int   $x               x coordinate
+     * @param int   $y               y coordinate
+     * @param array $queryParameters additional query parameters
+     *
+     * @return string response from the OSRM API
+     */
+    public static function getTile(int $z, int $x, int $y, array $queryParameters = [])
+    {
+        $url = self::$baseUrl . "/tile/v1/car/{$z}/{$x}/{$y}.mvt";
+
+        $response = Http::get($url, $queryParameters);
+
+        return $response->body();
+    }
+
+    /**
+     * Decodes an encoded polyline string into an array of coordinates.
+     *
+     * @param string $polyline the encoded polyline string
+     *
+     * @return array an array of Point's
+     */
+    public static function decodePolyline($polyline)
+    {
+        return Polyline::decode($polyline);
+    }
+}

package/server/src/Support/ParsePhone.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Fleetbase\FleetOps\Support;
+
+use Fleetbase\FleetOps\Models\Contact;
+use Fleetbase\FleetOps\Models\Place;
+use Fleetbase\Support\ParsePhone as ParsePhoneUtil;
+use libphonenumber\PhoneNumberFormat;
+
+class ParsePhone extends ParsePhoneUtil
+{
+    public static function fromContact(Contact $contact, $options = [], $format = PhoneNumberFormat::E164)
+    {
+        return static::fromModel($contact, $options, $format);
+    }
+
+    public static function fromPlace(Place $place, $options = [], $format = PhoneNumberFormat::E164)
+    {
+        return static::fromModel($place, $options, $format);
+    }
+}