✨ Preparations for multiple data sources (#3034)

Author: HerrLevin

app/Console/Commands/RefreshCurrentTrips.php

@@ -2,11 +2,13 @@
 
 namespace App\Console\Commands;
 
+use App\DataProviders\DataProviderBuilder;
+use App\DataProviders\DataProviderInterface;
+use App\DataProviders\HafasStopoverService;
 use App\Enum\TripSource;
 use App\Exceptions\HafasException;
-use App\Http\Controllers\HafasController;
-use App\Models\Trip;
 use App\Models\Checkin;
+use App\Models\Trip;
 use Illuminate\Console\Command;
 use PDOException;
 
@@ -15,6 +17,11 @@ class RefreshCurrentTrips extends Command
     protected $signature   = 'trwl:refreshTrips';
     protected $description = 'Refresh delay data from current active trips';
 
+    private function getDataProvider(): DataProviderInterface {
+        // Probably only HafasController is needed here, because this Command is very Hafas specific
+        return (new DataProviderBuilder)->build();
+    }
+
     public function handle(): int {
         $this->info('Getting trips to be refreshed...');
 
@@ -23,22 +30,22 @@ public function handle(): int {
                      ->join('train_stopovers as origin_stopovers', 'origin_stopovers.id', '=', 'train_checkins.origin_stopover_id')
                      ->join('train_stopovers as destination_stopovers', 'destination_stopovers.id', '=', 'train_checkins.destination_stopover_id')
                      ->where(function($query) {
-                              $query->where('destination_stopovers.arrival_planned', '>=', now()->subMinutes(20))
-                                    ->orWhere('destination_stopovers.arrival_real', '>=', now()->subMinutes(20));
-                          })
+                         $query->where('destination_stopovers.arrival_planned', '>=', now()->subMinutes(20))
+                               ->orWhere('destination_stopovers.arrival_real', '>=', now()->subMinutes(20));
+                     })
                      ->where(function($query) {
-                              $query->where('origin_stopovers.departure_planned', '<=', now()->addMinutes(20))
-                                    ->orWhere('origin_stopovers.departure_real', '<=', now()->addMinutes(20));
-                          })
+                         $query->where('origin_stopovers.departure_planned', '<=', now()->addMinutes(20))
+                               ->orWhere('origin_stopovers.departure_real', '<=', now()->addMinutes(20));
+                     })
                      ->where(function($query) {
-                              $query->where('hafas_trips.last_refreshed', '<', now()->subMinutes(5))
-                                    ->orWhereNull('hafas_trips.last_refreshed');
-                          })
-                          ->where('hafas_trips.source', TripSource::HAFAS->value)
-                          ->select('hafas_trips.*')
-                          ->distinct()
-                          ->orderBy('hafas_trips.last_refreshed')
-                          ->get();
+                         $query->where('hafas_trips.last_refreshed', '<', now()->subMinutes(5))
+                               ->orWhereNull('hafas_trips.last_refreshed');
+                     })
+                     ->where('hafas_trips.source', TripSource::HAFAS->value)
+                     ->select('hafas_trips.*')
+                     ->distinct()
+                     ->orderBy('hafas_trips.last_refreshed')
+                     ->get();
 
         if ($trips->isEmpty()) {
             $this->warn('No trips to be refreshed');
@@ -53,8 +60,8 @@ public function handle(): int {
                 $this->info('Refreshing trip ' . $trip->trip_id . ' (' . $trip->linename . ')...');
                 $trip->update(['last_refreshed' => now()]);
 
-                $rawHafas    = HafasController::fetchRawHafasTrip($trip->trip_id, $trip->linename);
-                $updatedCounts = HafasController::refreshStopovers($rawHafas);
+                $rawHafas      = $this->getDataProvider()->fetchRawHafasTrip($trip->trip_id, $trip->linename);
+                $updatedCounts = HafasStopoverService::refreshStopovers($rawHafas);
                 $this->info('Updated ' . $updatedCounts->stopovers . ' stopovers.');
 
                 //set duration for refreshed trips to null, so it will be recalculated

app/DataProviders/DataProviderBuilder.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\DataProviders;
+
+class DataProviderBuilder
+{
+    public function build(): DataProviderInterface {
+        return new Hafas();
+    }
+}

app/DataProviders/DataProviderInterface.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\DataProviders;
+
+use App\Enum\TravelType;
+use App\Models\Station;
+use Carbon\Carbon;
+
+interface DataProviderInterface
+{
+    public function fetchHafasTrip(string $tripID, string $lineName);
+
+    public function fetchRawHafasTrip(string $tripId, string $lineName);
+
+    public function getStations(string $query, int $results);
+
+    public function getDepartures(Station $station, Carbon $when, int $duration = 15, TravelType $type = null, bool $localtime = false);
+
+    public function getNearbyStations(float $latitude, float $longitude, int $results);
+
+    public function getStationByRilIdentifier(string $rilIdentifier);
+
+    public function getStationsByFuzzyRilIdentifier(string $rilIdentifier);
+}

app/DataProviders/FptfHelper.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace App\DataProviders;
+
+use App\Enum\TravelType;
+
+class FptfHelper
+{
+    public static function checkTravelType(?TravelType $type, TravelType $travelType): string {
+        return (is_null($type) || $type === $travelType) ? 'true' : 'false';
+    }
+}