Merge pull request #298 from getyoti/bug/SDK-2183

'uploadFaceCaptureImage' function results in Server Error 401 - MESSAGE_SIGNING was FIXED

Author: LuborRod

src/DocScan/Service.php

@@ -233,6 +233,7 @@ public function createFaceCaptureResource(
     ): CreateFaceCaptureResourceResponse {
         $response = (new RequestBuilder($this->config))
             ->withBaseUrl($this->apiUrl)
+            ->withQueryParam('sdkId', $this->sdkId)
             ->withEndpoint("sessions/$sessionId/resources/face-capture")
             ->withPemFile($this->pemFile)
             ->withPayload(Payload::fromJsonData($createFaceCaptureResourcePayload))

src/DocScan/Session/Create/FaceCapture/CreateFaceCaptureResourcePayload.php

@@ -2,12 +2,16 @@
 
 namespace Yoti\DocScan\Session\Create\FaceCapture;
 
-class CreateFaceCaptureResourcePayload
+use JsonSerializable;
+use stdClass;
+use Yoti\Util\Json;
+
+class CreateFaceCaptureResourcePayload implements JsonSerializable
 {
     /**
      * @var string
      */
-    private $requirementId;
+    public $requirementId;
 
     /**
      * @param string $requirementId
@@ -24,4 +28,11 @@ public function getRequirementId(): string
     {
         return $this->requirementId;
     }
+
+    public function jsonSerialize(): stdClass
+    {
+        return (object)Json::withoutNullValues([
+            'requirement_id' => $this->getRequirementId(),
+        ]);
+    }
 }

src/DocScan/Session/Create/FaceCapture/UploadFaceCaptureImagePayload.php

@@ -10,15 +10,15 @@ class UploadFaceCaptureImagePayload
     private $imageContentType;
 
     /**
-     * @var array<int, int>
+     * @var string
      */
     private $imageContents;
 
     /**
      * @param string $imageContentType
-     * @param array<int, int> $imageContents
+     * @param string $imageContents
      */
-    public function __construct(string $imageContentType, array $imageContents)
+    public function __construct(string $imageContentType, string $imageContents)
     {
         $this->imageContentType = $imageContentType;
         $this->imageContents = $imageContents;
@@ -33,9 +33,9 @@ public function getImageContentType(): string
     }
 
     /**
-     * @return array<int, int>
+     * @return string
      */
-    public function getImageContents(): array
+    public function getImageContents(): string
     {
         return $this->imageContents;
     }

src/DocScan/Session/Create/FaceCapture/UploadFaceCaptureImagePayloadBuilder.php

@@ -13,7 +13,7 @@ class UploadFaceCaptureImagePayloadBuilder
     private $imageContentType;
 
     /**
-     * @var array<int, int>
+     * @var string
      */
     private $imageContents;
 
@@ -44,10 +44,10 @@ public function forPngImage(): UploadFaceCaptureImagePayloadBuilder
     /**
      * Sets the contents of the image to be uploaded
      *
-     * @param array<int, int> $imageContents
+     * @param string $imageContents
      * @return $this
      */
-    public function withImageContents(array $imageContents): UploadFaceCaptureImagePayloadBuilder
+    public function withImageContents(string $imageContents): UploadFaceCaptureImagePayloadBuilder
     {
         $this->imageContents = $imageContents;
 

src/Http/MultipartEntity.php

@@ -42,19 +42,19 @@ public function setBoundary(string $multipartBoundary): void
 
     /**
      * @param string $name
-     * @param array<int,int> $payload
+     * @param string $payload
      * @param string $contentType
      * @param string $fileName
      *
      * @return void
      */
-    public function addBinaryBody(string $name, array $payload, string $contentType, string $fileName): void
+    public function addBinaryBody(string $name, string $payload, string $contentType, string $fileName): void
     {
         $this->multipartData[] = [
             'name' => $name,
-            'contents' => json_encode($payload),
+            'contents' => $payload,
             'filename' => $fileName,
-            'headers' => ['Content-type' => $contentType]
+            'headers' => ['Content-Type' => $contentType]
         ];
     }
 

src/Http/RequestBuilder.php

@@ -247,14 +247,14 @@ public function withMultipartBoundary(string $multipartBoundary): RequestBuilder
      * in order to make use of the Multipart request
      *
      * @param string $name
-     * @param array<int, int> $payload
+     * @param string $payload
      * @param string $contentType
      * @param string $fileName
      * @return $this
      */
     public function withMultipartBinaryBody(
         string $name,
-        array $payload,
+        string $payload,
         string $contentType,
         string $fileName
     ): RequestBuilder {
@@ -284,10 +284,6 @@ private function getHeaders(): array
             $defaultHeaders['Content-Type'] = 'application/json';
         }
 
-        if (isset($this->multipartEntity)) {
-            $defaultHeaders['Content-Type'] = 'multipart/form-data';
-        }
-
         return array_merge($defaultHeaders, $this->headers);
     }
 
@@ -367,11 +363,14 @@ public function build(): Request
 
         $endpointWithParams = $this->endpoint . '?' . http_build_query($this->queryParams);
 
+        $payload = isset($this->multipartEntity) ? Payload::fromStream($this->multipartEntity->createStream()) :
+            $this->payload;
+
         $this->withHeader(self::YOTI_DIGEST_HEADER_KEY, RequestSigner::sign(
             $this->pemFile,
             $endpointWithParams,
             $this->method,
-            $this->payload
+            $payload
         ));
 
         $url = $this->baseUrl . $endpointWithParams;

src/Util/Config.php

@@ -29,7 +29,7 @@ class Config
     /** Logger key */
     public const LOGGER = 'logger';
 
-    public const YOTI_MULTIPART_BOUNDARY = 'yoti-doc-scan-boundary';
+    public const YOTI_MULTIPART_BOUNDARY = 'X-Yoti-Multipart-Request-Boundary';
 
     /** Type error message */
     private const TYPE_ERROR_MESSAGE = '%s configuration value must be of type %s';

tests/DocScan/Session/Create/FaceCapture/UploadFaceCaptureImagePayloadBuilderTest.php

@@ -13,7 +13,7 @@
  */
 class UploadFaceCaptureImagePayloadBuilderTest extends TestCase
 {
-    private const SOME_IMAGE_CONTENTS = [1, 2, 3, 4];
+    private const SOME_IMAGE_CONTENTS = "SOME_CONTENTS";
 
     /**
      * @test

tests/DocScan/Session/Create/FaceCapture/UploadFaceCaptureImagePayloadTest.php

@@ -11,7 +11,7 @@
  */
 class UploadFaceCaptureImagePayloadTest extends TestCase
 {
-    private const SOME_IMAGE_CONTENTS = [1, 2, 3, 4];
+    private const SOME_IMAGE_CONTENTS = "SOME_CONTENTS";
     private const SOME_IMAGE_CONTENT_TYPE = 'img/some';
 
     /**

tests/Http/MultipartEntityTest.php

@@ -33,7 +33,7 @@ public function shouldCorrectlyCreateObjectTest()
     public function shouldCorrectCreateStream()
     {
         $name = 'SOME_NAME';
-        $payload = ['SOME_PAYLOAD'];
+        $payload = 'SOME_PAYLOAD';
         $contentType = 'SOME_TYPE';
         $fileName = 'SOME_FILENAME';
 
@@ -42,9 +42,9 @@ public function shouldCorrectCreateStream()
         $multipartData = [
             [
                 'name' => $name,
-                'contents' => json_encode($payload),
+                'contents' => $payload,
                 'filename' => $fileName,
-                'headers' => ['Content-type' => $contentType]
+                'headers' => ['Content-Type' => $contentType]
             ]
         ];