Create a new ready session use case

composer.json

@@ -6,6 +6,7 @@
         "php": "^7.2.5",
         "ext-ctype": "*",
         "ext-iconv": "*",
+        "ramsey/uuid": "^4.0",
         "sensio/framework-extra-bundle": "^5.1",
         "surfnet/stepup-saml-bundle": "^4.1",
         "symfony/asset": "4.4.*",
@@ -16,6 +17,7 @@
         "symfony/framework-bundle": "4.4.*",
         "symfony/http-client": "4.4.*",
         "symfony/intl": "4.4.*",
+        "symfony/messenger": "4.4.*",
         "symfony/monolog-bundle": "^3.1",
         "symfony/security-bundle": "4.4.*",
         "symfony/serializer-pack": "*",
@@ -24,6 +26,7 @@
         "symfony/yaml": "4.4.*"
     },
     "require-dev": {
+        "ext-json": "*",
         "ibuildings/qa-pack": "^1.8",
         "symfony/debug-pack": "*",
         "symfony/maker-bundle": "^1.0",

config/packages/messenger.yaml

@@ -0,0 +1,7 @@
+framework:
+    messenger:
+        # The bus that is going to be injected when injecting MessageBusInterface
+        default_bus: command.bus
+        buses:
+            command.bus: ~
+            query.bus: ~

config/packages/parameters.yaml.dist

@@ -0,0 +1,4 @@
+parameters:
+    app.authorization_token:
+    app.opaque_id:
+    app.readid_server_fqdn:

config/packages/test/parameters.yaml

@@ -0,0 +1,4 @@
+parameters:
+    app.authorization_token: 'authorization_token'
+    app.opaque_id: 'opaque_id'
+    app.readid_server_fqdn: 'readid.server.com'

config/services.yaml

@@ -25,3 +25,23 @@ services:
 
     # add more service definitions when explicit configuration is needed
     # please note that last definitions always *replace* previous ones
+
+    command_handlers:
+        namespace: StepupReadId\Application\
+        resource: '%kernel.project_dir%/src/Application/**/*CommandHandler.php'
+        autoconfigure: false
+        tags:
+            - { name: messenger.message_handler, bus: command.bus }
+
+    query_handlers:
+        namespace: StepupReadId\Application\
+        resource: '%kernel.project_dir%/src/Application/**/*QueryHandler.php'
+        autoconfigure: false
+        tags:
+            - { name: messenger.message_handler, bus: query.bus }
+
+    StepupReadId\Infrastructure\Services\HttpReadIDConfiguration:
+        arguments:
+            - '%app.authorization_token%'
+            - '%app.opaque_id%'
+            - '%app.readid_server_fqdn%'

config/services_test.yaml

@@ -7,3 +7,6 @@ services:
     # aliases are prefixed with test. For example:
     #
     # test.App\Service\MyService: '@App\Service\MyService'
+
+    test.StepupReadId\Application\ReadySession\GetReadySessionQueryHandler: '@StepupReadId\Application\ReadySession\GetReadySessionQueryHandler'
+    test.Symfony\Contracts\HttpClient\HttpClientInterface: '@Symfony\Contracts\HttpClient\HttpClientInterface'

src/Application/ReadySession/GetReadySessionQuery.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace StepupReadId\Application\ReadySession;
+
+final class GetReadySessionQuery
+{
+    /** @var int */
+    private $ttl;
+
+    public function __construct(int $ttl)
+    {
+        $this->ttl = $ttl;
+    }
+
+    public function ttl(): int
+    {
+        return $this->ttl;
+    }
+}

src/Application/ReadySession/GetReadySessionQueryHandler.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace StepupReadId\Application\ReadySession;
+
+use StepupReadId\Domain\ReadySession\Model\ReadySession;
+use StepupReadId\Domain\ReadySession\Model\ReadySessionTTL;
+use StepupReadId\Domain\ReadySession\Services\RequestReadySessionInterface;
+
+final class GetReadySessionQueryHandler
+{
+    /** @var RequestReadySessionInterface */
+    private $requestReadySession;
+
+    public function __construct(RequestReadySessionInterface $requestReadySession)
+    {
+        $this->requestReadySession = $requestReadySession;
+    }
+
+    public function __invoke(GetReadySessionQuery $query): ReadySession
+    {
+        $ttl = ReadySessionTTL::fromInteger($query->ttl());
+
+        return $this->requestReadySession->with($ttl);
+    }
+}

src/Domain/ReadySession/Exception/InvalidReadySessionBase64ImageException.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace StepupReadId\Domain\ReadySession\Exception;
+
+use InvalidArgumentException;
+
+final class InvalidReadySessionBase64ImageException extends InvalidArgumentException
+{
+    public static function becauseNoValidHeader(): self
+    {
+        return new self('Invalid base64 image header');
+    }
+}

src/Domain/ReadySession/Exception/InvalidReadySessionTTLException.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace StepupReadId\Domain\ReadySession\Exception;
+
+use InvalidArgumentException;
+use StepupReadId\Domain\ReadySession\Model\ReadySessionTTL;
+use function sprintf;
+
+final class InvalidReadySessionTTLException extends InvalidArgumentException
+{
+    public static function becauseOutOfRange(int $ttl): self
+    {
+        return new self(
+            sprintf(
+                'Invalid TTL (%d), must be between %d and %d',
+                $ttl,
+                ReadySessionTTL::MINIMUM_TTL,
+                ReadySessionTTL::MINIMUM_TTL
+            )
+        );
+    }
+}

src/Domain/ReadySession/Exception/InvalidReadySessionTimestampException.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace StepupReadId\Domain\ReadySession\Exception;
+
+use InvalidArgumentException;
+
+final class InvalidReadySessionTimestampException extends InvalidArgumentException
+{
+    public static function becauseShouldBeGreaterThanZero(): self
+    {
+        return new self('Timestamp must be greater than zero.');
+    }
+}

src/Domain/ReadySession/Exception/RequestReadySessionAuthorizationException.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace StepupReadId\Domain\ReadySession\Exception;
+
+use RuntimeException;
+
+final class RequestReadySessionAuthorizationException extends RuntimeException
+{
+}

src/Domain/ReadySession/Exception/RequestReadySessionBadRequestException.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace StepupReadId\Domain\ReadySession\Exception;
+
+use RuntimeException;
+
+final class RequestReadySessionBadRequestException extends RuntimeException
+{
+}

src/Domain/ReadySession/Exception/RequestReadySessionConnectionException.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace StepupReadId\Domain\ReadySession\Exception;
+
+use RuntimeException;
+use function sprintf;
+
+final class RequestReadySessionConnectionException extends RuntimeException
+{
+    public static function becauseTransportError(string $cause): self
+    {
+        return new self(sprintf('Transport error: %s', $cause));
+    }
+
+    public static function becauseResponseIsInvalid(): self
+    {
+        return new self('Invalid response');
+    }
+}

src/Domain/ReadySession/Model/ReadySession.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace StepupReadId\Domain\ReadySession\Model;
+
+final class ReadySession
+{
+    /** @var ReadySessionId  */
+    private $id;
+    /** @var ReadySessionBase64Image  */
+    private $qrCode;
+    /** @var ReadySessionJwtToken  */
+    private $jwtToken;
+    /** @var ReadySessionTimestamp  */
+    private $timestamp;
+
+    private function __construct(
+        ReadySessionId $id,
+        ReadySessionBase64Image $qrCode,
+        ReadySessionJwtToken $jwtToken,
+        ReadySessionTimestamp $timestamp
+    ) {
+        $this->id        = $id;
+        $this->qrCode    = $qrCode;
+        $this->jwtToken  = $jwtToken;
+        $this->timestamp = $timestamp;
+    }
+
+    public static function create(
+        ReadySessionId $id,
+        ReadySessionBase64Image $qrCode,
+        ReadySessionJwtToken $jwtToken,
+        ReadySessionTimestamp $timestamp
+    ): ReadySession {
+        return new self($id, $qrCode, $jwtToken, $timestamp);
+    }
+
+    public function id(): ReadySessionId
+    {
+        return $this->id;
+    }
+
+    public function qrCode(): ReadySessionBase64Image
+    {
+        return $this->qrCode;
+    }
+
+    public function jwtToken(): ReadySessionJwtToken
+    {
+        return $this->jwtToken;
+    }
+
+    public function timestamp(): ReadySessionTimestamp
+    {
+        return $this->timestamp;
+    }
+}

src/Domain/ReadySession/Model/ReadySessionBase64Image.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace StepupReadId\Domain\ReadySession\Model;
+
+use StepupReadId\Domain\ReadySession\Exception\InvalidReadySessionBase64ImageException;
+use function preg_match;
+
+final class ReadySessionBase64Image
+{
+    /** @var string  */
+    private $value;
+
+    public function __construct(string $base64Image)
+    {
+        $this->checkValidBase64Image($base64Image);
+
+        $this->value = $base64Image;
+    }
+
+    public static function fromString(string $base64Image): ReadySessionBase64Image
+    {
+        return new self($base64Image);
+    }
+
+    public function value(): string
+    {
+        return $this->value;
+    }
+
+    public function equals(ReadySessionBase64Image $other): bool
+    {
+        return $this->value === $other->value;
+    }
+
+    private function checkValidBase64Image(string $base64Image): void
+    {
+        if (!preg_match('/^data:image\/[^;]+;base64,/', $base64Image)) {
+            throw InvalidReadySessionBase64ImageException::becauseNoValidHeader();
+        }
+    }
+}

src/Domain/ReadySession/Model/ReadySessionId.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace StepupReadId\Domain\ReadySession\Model;
+
+use Ramsey\Uuid\Uuid;
+use Ramsey\Uuid\UuidInterface;
+
+final class ReadySessionId
+{
+    /** @var UuidInterface */
+    private $value;
+
+    private function __construct(UuidInterface $readySessionId)
+    {
+        $this->value = $readySessionId;
+    }
+
+    public static function fromString(string $readySessionId): ReadySessionId
+    {
+        return new self(Uuid::fromString($readySessionId));
+    }
+
+    public function value(): string
+    {
+        return $this->value->toString();
+    }
+
+    public function equals(ReadySessionId $other): bool
+    {
+        return $this->value->equals($other);
+    }
+}

src/Domain/ReadySession/Model/ReadySessionJwtToken.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace StepupReadId\Domain\ReadySession\Model;
+
+final class ReadySessionJwtToken
+{
+    /** @var string */
+    private $value;
+
+    private function __construct(string $jwtToken)
+    {
+        $this->value = $jwtToken;
+    }
+
+    public static function fromString(string $jwtToken): self
+    {
+        return new self($jwtToken);
+    }
+
+    public function value(): string
+    {
+        return $this->value;
+    }
+
+    public function equals(ReadySessionJwtToken $other): bool
+    {
+        return $this->value === $other->value;
+    }
+}