feat: admin view listing a travel's mailing recipients from bpn-connect

config/services.yaml

@@ -435,6 +435,9 @@ services:
     App\BpnConnect\ContingentsClient:
         parent: App\BpnConnect\AbstractApiClient
 
+    App\BpnConnect\TravelsClient:
+        parent: App\BpnConnect\AbstractApiClient
+
     App\ClickUp\ApiClient:
         arguments:
             $apiToken: '%env(default::CLICKUP_API_TOKEN)%'

src/BpnConnect/Model/TravelMailingRecipient.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\BpnConnect\Model;
+
+readonly class TravelMailingRecipient
+{
+    public function __construct(
+        public string $email,
+        public string $firstName,
+        public string $lastName,
+    ) {
+    }
+}

src/BpnConnect/Model/TravelMailingResponse.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\BpnConnect\Model;
+
+readonly class TravelMailingResponse
+{
+    /**
+     * @param TravelMailingRecipient[] $data
+     */
+    public function __construct(
+        public string $travelCode,
+        public array $data,
+    ) {
+    }
+}

src/BpnConnect/TravelsClient.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\BpnConnect;
+
+use App\BpnConnect\Model\TravelMailingRecipient;
+use App\BpnConnect\Model\TravelMailingResponse;
+
+class TravelsClient extends AbstractApiClient
+{
+    private const string MAILING_PATH = '/api/v1/travels/mailing';
+
+    /**
+     * An unknown travel code yields an empty list, not an error: bpn-connect cannot tell it
+     * apart from a travel without confirmed participants.
+     */
+    public function getMailingRecipients(string $travelCode): TravelMailingResponse
+    {
+        $payload = $this->request(self::MAILING_PATH, [
+            'travelCode' => $travelCode,
+        ]);
+
+        $recipients = array_map(
+            static fn (array $item) => new TravelMailingRecipient(
+                email: $item['email'],
+                firstName: $item['first_name'] ?? '',
+                lastName: $item['last_name'] ?? '',
+            ),
+            $payload['data'] ?? [],
+        );
+
+        return new TravelMailingResponse($payload['meta']['travel_code'] ?? $travelCode, $recipients);
+    }
+}

src/Controller/Admin/TravelMailing/IndexController.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller\Admin\TravelMailing;
+
+use App\BpnConnect\Exception\BpnConnectException;
+use App\BpnConnect\TravelsClient;
+use App\Form\Admin\TravelMailingLookupType;
+use App\Form\Model\TravelMailingLookupDto;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
+use Symfony\Component\Security\Http\Attribute\IsGranted;
+
+#[IsGranted('ROLE_CUSTOMER_EXPERT')]
+class IndexController extends AbstractController
+{
+    public function __construct(
+        private readonly TravelsClient $travelsClient,
+    ) {
+    }
+
+    #[Route('/admin/travel-mailing', name: 'app_admin_travelmailing')]
+    public function index(Request $request): Response
+    {
+        $lookup = new TravelMailingLookupDto();
+        $form = $this->createForm(TravelMailingLookupType::class, $lookup, [
+            'action' => $this->generateUrl('app_admin_travelmailing'),
+        ]);
+        $form->handleRequest($request);
+
+        $result = null;
+        $failed = false;
+        if ($form->isSubmitted() && $form->isValid()) {
+            try {
+                $result = $this->travelsClient->getMailingRecipients((string) $lookup->travelCode);
+            } catch (BpnConnectException) {
+                // The client has already logged the cause; the page only needs to say it failed.
+                $failed = true;
+            }
+        }
+
+        return $this->render('admin/travel_mailing/index.html.twig', [
+            'form' => $form,
+            'result' => $result,
+            'failed' => $failed,
+        ]);
+    }
+}

src/Form/Admin/TravelMailingLookupType.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Form\Admin;
+
+use App\Form\Model\TravelMailingLookupDto;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * Submits as GET with an empty block prefix, so a lookup is the plain URL `?travelCode=…`
+ * and can be bookmarked or shared.
+ *
+ * @extends AbstractType<TravelMailingLookupDto>
+ */
+class TravelMailingLookupType extends AbstractType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        $builder->add('travelCode', TextType::class, [
+            'label' => 'Reisecode',
+            'attr' => [
+                'placeholder' => 'z. B. LPJMP281126',
+            ],
+        ]);
+    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setDefaults([
+            'data_class' => TravelMailingLookupDto::class,
+            'method' => 'GET',
+            'csrf_protection' => false,
+        ]);
+    }
+
+    public function getBlockPrefix(): string
+    {
+        return '';
+    }
+}

src/Form/Model/TravelMailingLookupDto.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Form\Model;
+
+use Symfony\Component\Validator\Constraints as Assert;
+
+class TravelMailingLookupDto
+{
+    #[Assert\NotBlank(message: 'Bitte einen Reisecode angeben.')]
+    public ?string $travelCode = null;
+}

src/Menu/AdminMenuBuilder.php

@@ -80,6 +80,15 @@ class AdminMenuBuilder extends AbstractMenuBuilder
                     'routes' => [['pattern' => '/^app_admin_log/']],
                 ],
             ]);
+            $menu->addChild('Reise-Mailingliste', [
+                'route' => 'app_admin_travelmailing',
+                'linkAttributes' => [
+                    'title' => 'Reise-Mailingliste',
+                ],
+                'extras' => [
+                    'icon' => 'mail',
+                ],
+            ]);
         }
 
         $this->addLogoutItem($menu);

templates/admin/travel_mailing/index.html.twig

@@ -0,0 +1,71 @@
+{% extends 'layout_admin.html.twig' %}
+
+{% form_theme form 'forms_admin.html.twig' %}
+
+{% block content %}
+    <twig:page:heading>Reise-Mailingliste</twig:page:heading>
+    {{ form_start(form) }}
+    <div class="flex flex-wrap items-end gap-4 pb-8">
+        <div class="w-64">
+            {{ form_row(form.travelCode) }}
+        </div>
+        <button type="submit"
+                class="button button--primary button--small">
+            abrufen
+        </button>
+    </div>
+    {{ form_rest(form) }}
+    {{ form_end(form) }}
+
+    {% if failed %}
+        {% include '_partials/_alert.html.twig' with {
+            level: 'warning',
+            messages: ['Die Teilnehmerliste konnte nicht von BusPro abgerufen werden. Bitte später erneut versuchen.'],
+        } %}
+    {% elseif result is not null %}
+        {% if result.data is empty %}
+            {% include '_partials/_alert.html.twig' with {
+                level: 'warning',
+                messages: ['Keine Empfänger für <code>%s</code> gefunden: Reisecode unbekannt oder keine bestätigten Teilnehmer.'|format(result.travelCode|e)],
+            } %}
+        {% else %}
+            <p class="pb-4 text-sm text-gray-700">
+                {{ result.data|length }} Empfänger für <code>{{ result.travelCode }}</code>
+            </p>
+            <div class="data-table-wrapper">
+                <div class="data-table-wrapper__inner text-sm">
+                    <table class="data-table">
+                        <thead>
+                        <tr>
+                            <th>
+                                Vorname
+                            </th>
+                            <th>
+                                Nachname
+                            </th>
+                            <th>
+                                E-Mail
+                            </th>
+                        </tr>
+                        </thead>
+                        <tbody>
+                        {% for recipient in result.data %}
+                            <tr>
+                                <td>
+                                    {{ recipient.firstName }}
+                                </td>
+                                <td>
+                                    {{ recipient.lastName }}
+                                </td>
+                                <td>
+                                    <a href="mailto:{{ recipient.email }}">{{ recipient.email }}</a>
+                                </td>
+                            </tr>
+                        {% endfor %}
+                        </tbody>
+                    </table>
+                </div>
+            </div>
+        {% endif %}
+    {% endif %}
+{% endblock %}

tests/BpnConnect/TravelsClientTest.php

@@ -0,0 +1,89 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Tests\BpnConnect;
+
+use App\BpnConnect\Exception\BpnConnectException;
+use App\BpnConnect\Model\TravelMailingRecipient;
+use App\BpnConnect\TravelsClient;
+use PHPUnit\Framework\TestCase;
+use Psr\Log\NullLogger;
+use Symfony\Component\HttpClient\MockHttpClient;
+use Symfony\Component\HttpClient\Response\MockResponse;
+
+class TravelsClientTest extends TestCase
+{
+    public function testGetMailingRecipientsQueriesTheTravelCodeAndMapsTheRecipients(): void
+    {
+        $requests = [];
+        $http = new MockHttpClient(function (string $method, string $url, array $options) use (&$requests): MockResponse {
+            $requests[] = [$method, $url, $options];
+
+            return $this->jsonResponse([
+                'meta' => ['travel_code' => 'LPJMP281126', 'row_count' => 2, 'execution_time_ms' => 12],
+                'data' => [
+                    ['email' => '[email protected]', 'first_name' => 'Erika', 'last_name' => 'Muster'],
+                    ['email' => '[email protected]', 'first_name' => 'Max', 'last_name' => 'Muster'],
+                ],
+            ]);
+        });
+
+        $response = $this->client($http)->getMailingRecipients('LPJMP281126');
+
+        self::assertSame('GET', $requests[0][0]);
+        self::assertSame('https://bpn-connect.test/api/v1/travels/mailing?travelCode=LPJMP281126', $requests[0][1]);
+        self::assertContains('X-API-KEY: secret', $requests[0][2]['headers']);
+        self::assertSame('LPJMP281126', $response->travelCode);
+        self::assertEquals([
+            new TravelMailingRecipient('[email protected]', 'Erika', 'Muster'),
+            new TravelMailingRecipient('[email protected]', 'Max', 'Muster'),
+        ], $response->data);
+    }
+
+    public function testAnUnknownTravelCodeYieldsAnEmptyList(): void
+    {
+        $http = new MockHttpClient($this->jsonResponse([
+            'meta' => ['travel_code' => 'NOPE', 'row_count' => 0, 'execution_time_ms' => 3],
+            'data' => [],
+        ]));
+
+        $response = $this->client($http)->getMailingRecipients('NOPE');
+
+        self::assertSame('NOPE', $response->travelCode);
+        self::assertSame([], $response->data);
+    }
+
+    public function testAnHttpErrorIsWrappedInADomainException(): void
+    {
+        $http = new MockHttpClient(new MockResponse('{"error":"internal error"}', ['http_code' => 500]));
+
+        $this->expectException(BpnConnectException::class);
+
+        $this->client($http)->getMailingRecipients('LPJMP281126');
+    }
+
+    public function testAnUnconfiguredClientFailsBeforeRequesting(): void
+    {
+        $client = new TravelsClient(new MockHttpClient(), new NullLogger());
+
+        $this->expectException(BpnConnectException::class);
+
+        $client->getMailingRecipients('LPJMP281126');
+    }
+
+    /**
+     * @param array<string, mixed> $payload
+     */
+    private function jsonResponse(array $payload): MockResponse
+    {
+        return new MockResponse(json_encode($payload, JSON_THROW_ON_ERROR), [
+            'response_headers' => ['content-type' => 'application/json'],
+        ]);
+    }
+
+    private function client(MockHttpClient $http): TravelsClient
+    {
+        return new TravelsClient($http, new NullLogger(), 'https://bpn-connect.test', 'secret');
+    }
+}