Selc 1576 (#165)

* fix: Adding new Token Verify API

* fix: Token Verify API

Author: andrea-putzu

src/main/resources/interface-specification.yml

@@ -862,6 +862,48 @@ paths:
             application/problem+json:
               schema:
                 $ref: '#/components/schemas/Problem'
+  /tokens/{tokenId}/verify:
+    post:
+      security: [{}]
+      tags:
+        - public
+      summary: Verify if the token is already consumed
+      description: Return ok
+      operationId: verifyToken
+      parameters:
+        - name: tokenId
+          in: path
+          description: The token id to verify
+          required: true
+          schema:
+            description: to be defined
+            type: string
+            format: uuid
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/TokenId'
+        '400':
+          description: Invalid ID supplied
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/Problem'
+        '404':
+          description: Token not found
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/Problem'
+        '409':
+          description: Token already consumed
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/Problem'
   /status:
     get:
       security:
@@ -1392,6 +1434,16 @@ components:
         - zipCode
         - billing
       additionalProperties: false
+    TokenId:
+      type: object
+      properties:
+        id:
+          type: string
+          format: uuid
+          example: 97c0f418-bcb3-48d4-825a-fe8b29ae68e5
+      additionalProperties: false
+      required:
+        - id
   securitySchemes:
     bearerAuth:
       type: http

src/main/scala/it/pagopa/interop/partyprocess/api/impl/PublicApiMarshallerImpl.scala

@@ -10,4 +10,5 @@ object PublicApiMarshallerImpl extends PublicApiMarshaller with SprayJsonSupport
 
   override implicit def toEntityMarshallerProblem: ToEntityMarshaller[Problem] = sprayJsonMarshaller[Problem]
 
+  override implicit def toEntityMarshallerTokenId: ToEntityMarshaller[TokenId] = sprayJsonMarshaller[TokenId]
 }

src/main/scala/it/pagopa/interop/partyprocess/api/impl/PublicApiServiceImpl.scala

@@ -10,7 +10,7 @@ import it.pagopa.interop.commons.files.service.FileManager
 import it.pagopa.interop.commons.logging.{CanLogContextFields, ContextFieldsToLog}
 import it.pagopa.interop.commons.mail.model.PersistedTemplate
 import it.pagopa.interop.commons.utils.TypeConversions._
-import it.pagopa.interop.commons.utils.errors.GenericComponentErrors.ResourceConflictError
+import it.pagopa.interop.commons.utils.errors.GenericComponentErrors.{ResourceConflictError, ResourceNotFoundError}
 import it.pagopa.interop.partymanagement.client.model.{PartyRole => PartyMgmtRole, Problem => _}
 import it.pagopa.interop.partyprocess.api.PublicApiService
 import it.pagopa.interop.partyprocess.common.system.ApplicationConfiguration
@@ -82,16 +82,16 @@ class PublicApiServiceImpl(
 
       validator <- signatureService.createDocumentValidator(Files.readAllBytes(contract._2.toPath))
       _         <- SignatureValidationService.validateSignature(signatureValidationService.isDocumentSigned(validator))
-      _    <- SignatureValidationService.validateSignature(signatureValidationService.verifyOriginalDocument(validator))
+      _ <- SignatureValidationService.validateSignature(signatureValidationService.verifyOriginalDocument(validator))
       reports                  <- signatureValidationService.validateDocument(validator)
       _                        <- SignatureValidationService.validateSignature(
         signatureValidationService.verifySignatureForm(validator),
         signatureValidationService.verifySignature(reports),
         signatureValidationService.verifyDigest(validator, token.checksum),
         signatureValidationService.verifyManagerTaxCode(reports, legalUsers)
       )
-      logo      <- getLogoFile(ApplicationConfiguration.emailLogoPath)
-      product   <- productManagementService.getProductById(institutionId.head.product)
+      logo                     <- getLogoFile(ApplicationConfiguration.emailLogoPath)
+      product                  <- productManagementService.getProductById(institutionId.head.product)
       onboardingMailParameters <- getOnboardingMailParameters(product.name)
       emails = legalEmails ++ institutionEmail.toSeq
       _ <- sendOnboardingCompleteEmail(emails, onboardingMailParameters, logo)
@@ -153,7 +153,36 @@ class PublicApiServiceImpl(
         logger.error("Error while invalidating onboarding for token identified with {}", tokenId, ex)
         val errorResponse: Problem = problemOf(StatusCodes.BadRequest, InvalidateOnboardingError)
         invalidateOnboarding400(errorResponse)
+    }
+  }
+
+  /**
+    * Code: 200, Message: successful operation, DataType: TokenId
+    * Code: 400, Message: Invalid ID supplied, DataType: Problem
+    * Code: 404, Message: Token not found, DataType: Problem
+    * Code: 409, Message: Token already consumed, DataType: Problem
+    */
+  override def verifyToken(tokenId: String)(implicit
+    toEntityMarshallerTokenId: ToEntityMarshaller[TokenId],
+    toEntityMarshallerProblem: ToEntityMarshaller[Problem],
+    contexts: Seq[(String, String)]
+  ): Route = {
+    val result: Future[TokenId] = for {
+      tokenIdUUID <- tokenId.toFutureUUID
+      token       <- partyManagementService.verifyToken(tokenIdUUID)
+    } yield TokenId(id = token.id)
 
+    onComplete(result) {
+      case Success(tokenId)                   => verifyToken200(tokenId)
+      case Failure(ex: ResourceNotFoundError) =>
+        logger.error(s"Token not found", ex)
+        verifyToken404(problemOf(StatusCodes.NotFound, ex))
+      case Failure(ex: ResourceConflictError) =>
+        logger.error(s"Token already consumed", ex)
+        verifyToken409(problemOf(StatusCodes.Conflict, ex))
+      case Failure(ex)                        =>
+        logger.error(s"Verifying token failed", ex)
+        verifyToken400(problemOf(StatusCodes.InternalServerError, TokenVerificationFatalError(tokenId, ex.getMessage)))
     }
   }
 

src/main/scala/it/pagopa/interop/partyprocess/api/impl/package.scala

@@ -37,6 +37,8 @@ package object impl extends DefaultJsonProtocol {
   implicit val productsFormat: RootJsonFormat[Products]                 = jsonFormat1(Products)
   implicit val billingDataFormat: RootJsonFormat[BillingData]           = jsonFormat12(BillingData)
 
+  implicit val tokenIdFormat: RootJsonFormat[TokenId] = jsonFormat1(TokenId)
+
   final val serviceErrorCodePrefix: String = "002"
   final val defaultProblemType: String     = "about:blank"
   final val uidClaim: String               = "uid"

src/main/scala/it/pagopa/interop/partyprocess/error/PartyProcessErrors.scala

@@ -131,4 +131,7 @@ object PartyProcessErrors {
 
   final case class OnboardingInvalidUpdates(externalId: String)
       extends ComponentError("0046", s"Cannot perform data overrides on institution having external id $externalId")
+
+  final case class TokenVerificationFatalError(tokenId: String, error: String)
+      extends ComponentError("0048", s"Error on retrieve $tokenId: $error")
 }