code challenge 6 solution

Author: jschaedl

CODING-CHALLENGE-7.md

@@ -0,0 +1,14 @@
+# RESTful Webservices in Symfony
+
+## Coding Challenge 7 - Validation
+
+### Tasks
+
+- introduce Symfony's Validator to validate the request content used to create and update workshops and attendees
+
+### Solution
+
+- require the Symfony Validator component: `composer require validator`
+- add validation constraints to your model properties (e.g. NotBlank, Email)
+- inject the `Validator` Service in your `ValueResolver`s
+- for now throw an `UnprocessableEntityHttpException` on validation errors

src/ArgumentValueResolver/CreateAttendeeModelResolver.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\ArgumentValueResolver;
+
+use App\Domain\Model\CreateAttendeeModel;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Controller\ArgumentValueResolverInterface;
+use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
+use Symfony\Component\Serializer\SerializerInterface;
+
+final class CreateAttendeeModelResolver implements ArgumentValueResolverInterface
+{
+    public function __construct(
+        private SerializerInterface $serializer,
+    ) {
+    }
+
+    public function supports(Request $request, ArgumentMetadata $argument): bool
+    {
+        return CreateAttendeeModel::class === $argument->getType() && 'POST' === $request->getMethod();
+    }
+
+    /**
+     * @return iterable<CreateAttendeeModel>
+     */
+    public function resolve(Request $request, ArgumentMetadata $argument)
+    {
+        yield $this->serializer->deserialize(
+            $request->getContent(),
+            CreateAttendeeModel::class,
+            $request->getRequestFormat(),
+        );
+    }
+}

src/ArgumentValueResolver/UpdateAttendeeModelResolver.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\ArgumentValueResolver;
+
+use App\Domain\Model\UpdateAttendeeModel;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Controller\ArgumentValueResolverInterface;
+use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
+use Symfony\Component\Serializer\SerializerInterface;
+
+final class UpdateAttendeeModelResolver implements ArgumentValueResolverInterface
+{
+    public function __construct(
+        private SerializerInterface $serializer,
+    ) {
+    }
+
+    public function supports(Request $request, ArgumentMetadata $argument): bool
+    {
+        return UpdateAttendeeModel::class === $argument->getType() && 'PUT' === $request->getMethod();
+    }
+
+    /**
+     * @return iterable<UpdateAttendeeModel>
+     */
+    public function resolve(Request $request, ArgumentMetadata $argument)
+    {
+        yield $this->serializer->deserialize(
+            $request->getContent(),
+            UpdateAttendeeModel::class,
+            $request->getRequestFormat(),
+        );
+    }
+}

src/Domain/.gitignore renamed to src/Controller/Attendee/.gitignore

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller\Attendee;
+
+use App\Domain\AttendeeCreator;
+use App\Domain\Model\CreateAttendeeModel;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+use Symfony\Component\Serializer\SerializerInterface;
+
+#[Route('/attendees', name: 'create_attendee', methods: ['POST'])]
+final class CreateController
+{
+    public function __construct(
+        private AttendeeCreator $attendeeCreator,
+        private SerializerInterface $serializer,
+        private UrlGeneratorInterface $urlGenerator,
+    ) {
+    }
+
+    public function __invoke(Request $request, CreateAttendeeModel $createAttendeeModel)
+    {
+        $createdAttendee = $this->attendeeCreator->create($createAttendeeModel);
+
+        $serializedCreatedAttendee = $this->serializer->serialize($createdAttendee, $request->getRequestFormat());
+
+        return new Response($serializedCreatedAttendee, Response::HTTP_CREATED, [
+            'Location' => $this->urlGenerator->generate('read_attendee', [
+                'identifier' => $createdAttendee->getIdentifier(),
+            ], UrlGeneratorInterface::ABSOLUTE_URL),
+        ]);
+    }
+}

src/Controller/Attendee/CreateController.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller\Attendee;
+
+use App\Domain\AttendeeUpdater;
+use App\Domain\Model\UpdateAttendeeModel;
+use App\Entity\Attendee;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
+
+#[Route('/attendees/{identifier}', name: 'update_attendee', methods: ['PUT'])]
+final class UpdateController
+{
+    public function __construct(
+        private AttendeeUpdater $attendeeUpdater,
+    ) {
+    }
+
+    public function __invoke(Request $request, Attendee $attendee, UpdateAttendeeModel $updateAttendeeModel)
+    {
+        $this->attendeeUpdater->update($attendee, $updateAttendeeModel);
+
+        return new Response(null, Response::HTTP_NO_CONTENT);
+    }
+}

src/Controller/Attendee/UpdateController.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Domain;
+
+use App\Domain\Model\CreateAttendeeModel;
+use App\Entity\Attendee;
+use Doctrine\ORM\EntityManagerInterface;
+use Ramsey\Uuid\Uuid;
+
+final class AttendeeCreator
+{
+    public function __construct(
+        private EntityManagerInterface $entityManager,
+    ) {
+    }
+
+    public function create(CreateAttendeeModel $createAttendeeModel): Attendee
+    {
+        $newAttendee = new Attendee(
+            Uuid::uuid4()->toString(),
+            $createAttendeeModel->firstname,
+            $createAttendeeModel->lastname,
+            $createAttendeeModel->email,
+        );
+
+        $this->entityManager->persist($newAttendee);
+        $this->entityManager->flush();
+
+        return $newAttendee;
+    }
+}

src/Domain/AttendeeCreator.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Domain;
+
+use App\Domain\Model\UpdateAttendeeModel;
+use App\Entity\Attendee;
+use Doctrine\ORM\EntityManagerInterface;
+
+final class AttendeeUpdater
+{
+    public function __construct(
+        private EntityManagerInterface $entityManager,
+    ) {
+    }
+
+    public function update(Attendee $attendee, UpdateAttendeeModel $createAttendeeModel): Attendee
+    {
+        if ($firstname = $createAttendeeModel->firstname) {
+            $attendee->updateFirstname($firstname);
+        }
+
+        if ($lastname = $createAttendeeModel->lastname) {
+            $attendee->updateLastname($lastname);
+        }
+
+        if ($email = $createAttendeeModel->email) {
+            $attendee->updateEmail($email);
+        }
+
+        $this->entityManager->flush();
+
+        return $attendee;
+    }
+}

src/Domain/AttendeeUpdater.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Domain\Model;
+
+final class CreateAttendeeModel
+{
+    public string $firstname;
+    public string $lastname;
+    public string $email;
+}

src/Domain/Model/CreateAttendeeModel.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Domain\Model;
+
+final class UpdateAttendeeModel
+{
+    public ?string $firstname = null;
+    public ?string $lastname = null;
+    public ?string $email = null;
+}