refactor: delete the BusProNet base-data read path

src/BusProNet/ApiClient.php

@@ -2,7 +2,6 @@
 
 namespace App\BusProNet;
 
-use App\BusProNet\Model\BaseDataResponse;
 use App\BusProNet\Model\CrmAttributesResponse;
 use App\BusProNet\Model\NotificationResponse;
 use App\BusProNet\Model\ProfileResponse;
@@ -17,15 +16,24 @@ use Symfony\Component\OptionsResolver\OptionsResolver;
 use Symfony\Component\Serializer\SerializerInterface;
 use Symfony\Component\Uid\Uuid;
 
+/**
+ * The socket protocol against BusProNet: length prefixed German XML over fsockopen.
+ *
+ * This is the **write** path and the user facing reads that go with it - profile lookup and
+ * update, registration, password reset, the CRM selections behind the leads roles and hotel
+ * codes. All of it is per user and authenticated as that user, which is why it stays here.
+ *
+ * It is not legacy. The base data reads that used to sit alongside it - STAMMLAENDER,
+ * STAMMZUSTIEGE, STAMMHOTELS - are gone: hotels, pickups and countries now come from MyE&P's
+ * REST api (App\BusProNet\DataProvider\*, App\MyEp\Api\ApiClient), which is the one place
+ * that understands BusProNet's XML.
+ */
 class ApiClient
 {
     use ApiClientTrait;
 
     public const TYPE_NOTIFICATION = 'HINWEIS';
     public const TYPE_CUSTOMER_DATA = 'KUNDENKONTO';
-    public const TYPE_BASE_DATA_COUNTRIES = 'STAMMLAENDER';
-    public const TYPE_BASE_DATA_PICKUPS = 'STAMMZUSTIEGE';
-    public const TYPE_BASE_DATA_HOTELS = 'STAMMHOTELS';
 
     private array $config;
 
@@ -204,23 +212,6 @@ class ApiClient
         return $this->sendRequest(static::TYPE_CUSTOMER_DATA, $data);
     }
 
-    /**
-     * @throws ApiClientException
-     * @throws ResponseParserException
-     */
-    public function getBaseData(string $type): NotificationResponse|BaseDataResponse
-    {
-        $data = [
-            'anfrage' => [
-                'user' => $this->config['bpn_username'],
-                'key' => $this->createKey($this->config['bpn_username'], $this->config['bpn_password'], $type),
-                'satz' => ['@typ' => $type],
-            ],
-        ];
-
-        return $this->sendRequest($type, $data);
-    }
-
     /**
      * @throws ApiClientException
      * @throws ResponseParserException

src/BusProNet/Model/BaseDataResponse.php

@@ -1,15 +0,0 @@
-<?php
-
-namespace App\BusProNet\Model;
-
-class BaseDataResponse
-{
-    public function __construct(private readonly array $items)
-    {
-    }
-
-    public function getItems(): array
-    {
-        return $this->items;
-    }
-}

src/BusProNet/ResponseParser.php

@@ -3,15 +3,11 @@
 namespace App\BusProNet;
 
 use App\BusProNet\Model\Address;
-use App\BusProNet\Model\BaseDataResponse;
 use App\BusProNet\Model\Communication;
-use App\BusProNet\Model\Country;
 use App\BusProNet\Model\CrmAttribute;
 use App\BusProNet\Model\CrmAttributeGroup;
 use App\BusProNet\Model\CrmAttributesResponse;
-use App\BusProNet\Model\Hotel;
 use App\BusProNet\Model\NotificationResponse;
-use App\BusProNet\Model\Pickup;
 use App\BusProNet\Model\ProfileResponse;
 use App\BusProNet\Model\ProfileUpdateResponse;
 use App\BusProNet\Model\RegistrationResponse;
@@ -64,12 +60,6 @@ class ResponseParser
                         return $this->createRegistrationResponse($xml);
                 }
                 break;
-            case ApiClient::TYPE_BASE_DATA_COUNTRIES:
-                return $this->createCountriesResponse($xml);
-            case ApiClient::TYPE_BASE_DATA_PICKUPS:
-                return $this->createPickupsResponse($xml);
-            case ApiClient::TYPE_BASE_DATA_HOTELS:
-                return $this->createHotelsResponse($xml);
         }
 
         throw new ResponseParserException(sprintf('Unrecognised BusProNet response type "%s"', $responseType));
@@ -268,75 +258,6 @@ class ResponseParser
         return $response;
     }
 
-    public function createCountriesResponse(\SimpleXMLElement $xml): BaseDataResponse
-    {
-        $countries = [];
-
-        foreach ($xml->laender->land as $item) {
-            $itemAttributes = $item->attributes();
-            $token = (string) $itemAttributes['kuerzel'];
-            $country = new Country();
-            $country
-                ->setId((int) $itemAttributes['id'])
-                ->setName((string) $itemAttributes['bezeichnung'])
-                ->setToken((string) $itemAttributes['kuerzel'])
-                ->setNationality((string) $itemAttributes['nationalitaet'])
-            ;
-            $countries[$token] = $country;
-        }
-
-        return new BaseDataResponse($countries);
-    }
-
-    public function createPickupsResponse(\SimpleXMLElement $xml): BaseDataResponse
-    {
-        $pickups = [];
-
-        foreach ($xml->zustieg as $item) {
-            $itemAttributes = $item->attributes();
-            $id = (int) $itemAttributes['id'];
-            $busProId = (int) $itemAttributes['idbuspro'];
-            $pickup = new Pickup();
-            $pickup
-                ->setId($id)
-                ->setBusProId($busProId)
-                ->setCode((string) $itemAttributes['code'])
-                ->setCity((string) $item->ort)
-                ->setStreet((string) $item->strasse)
-            ;
-            $pickups[$busProId] = $pickup;
-        }
-
-        return new BaseDataResponse($pickups);
-    }
-
-    public function createHotelsResponse(\SimpleXMLElement $xml): BaseDataResponse
-    {
-        $hotels = [];
-
-        foreach ($xml->hotel as $item) {
-            $itemAttributes = $item->attributes();
-            $id = (int) $itemAttributes['id'];
-            $busProId = (int) $itemAttributes['idbuspro'];
-            $hotel = new Hotel();
-            $hotel
-                ->setId($id)
-                ->setBusProId($busProId)
-                ->setCode((string) $itemAttributes['code'])
-                ->setName((string) $item->name)
-                ->setCountry(strtolower((string) $item->land))
-                ->setCity((string) $item->ort)
-                ->setStreet((string) $item->strasse)
-                ->setPhone((string) $item->telefon)
-                ->setType((string) $item->art)
-                ->setCostUnit($item->kostenstelle)
-            ;
-            $hotels[$busProId] = $hotel;
-        }
-
-        return new BaseDataResponse($hotels);
-    }
-
     /**
      * The BusProNet endpoint can answer with an empty or truncated body. Keep the libxml
      * reason instead of collapsing every shape of broken response into one message.