SDK-2010 Add support for Relying Business to trigger IBV email notification (#256)

Co-authored-by: Rodion Liuborets <[email protected]>

Author: LuborRod

src/DocScan/DocScanClient.php

@@ -231,4 +231,17 @@ public function fetchInstructionsContactProfile(string $sessionId): ContactProfi
     {
         return $this->docScanService->fetchInstructionsContactProfile($sessionId);
     }
+
+    /**
+     * Triggers an email notification for the IBV instructions at-home flow.
+     * This will be one of:
+     *  - an email sent directly to the end user, using the email provided in the ContactProfile
+     *  - if requested, a backend notification using the configured notification endpoint
+     *
+     * @throws Exception\DocScanException
+     */
+    public function triggerIbvEmailNotification(string $sessionId): void
+    {
+        $this->docScanService->triggerIbvEmailNotification($sessionId);
+    }
 }

src/DocScan/Service.php

@@ -378,6 +378,23 @@ public function fetchInstructionsContactProfile(string $sessionId): ContactProfi
         return new ContactProfileResponse($result);
     }
 
+    /**
+     * @param string $sessionId
+     * @throws DocScanException
+     */
+    public function triggerIbvEmailNotification(string $sessionId): void
+    {
+        $response = (new RequestBuilder($this->config))
+            ->withBaseUrl($this->apiUrl)
+            ->withPemFile($this->pemFile)
+            ->withEndpoint(sprintf('/sessions/%s/instructions/email', $sessionId))
+            ->withPost()
+            ->build()
+            ->execute();
+
+        self::assertResponseIsSuccess($response);
+    }
+
     /**
      * @param ResponseInterface $response
      *

tests/DocScan/DocScanClientTest.php

@@ -452,4 +452,28 @@ public function testFetchInstructionsContactProfile()
             TestData::DOC_SCAN_SESSION_ID
         );
     }
+
+    /**
+     * @test
+     * @covers ::triggerIbvEmailNotification
+     */
+    public function testTriggerIbvEmailNotification()
+    {
+        $response = $this->createMock(ResponseInterface::class);
+        $response->method('getBody')->willReturn(json_encode((object)[]));
+        $response->method('getStatusCode')->willReturn(200);
+
+        $httpClient = $this->createMock(ClientInterface::class);
+        $httpClient->expects($this->exactly(1))
+            ->method('sendRequest')
+            ->willReturn($response);
+
+        $docScanClient = new DocScanClient(TestData::SDK_ID, TestData::PEM_FILE, [
+            Config::HTTP_CLIENT => $httpClient,
+        ]);
+
+        $docScanClient->triggerIbvEmailNotification(
+            TestData::DOC_SCAN_SESSION_ID
+        );
+    }
 }

tests/DocScan/ServiceTest.php

@@ -1304,4 +1304,93 @@ function (RequestInterface $requestMessage) {
 
         $docScanService->fetchInstructionsContactProfile(TestData::DOC_SCAN_SESSION_ID);
     }
+
+    /**
+     * @test
+     * @covers ::__construct
+     * @covers ::triggerIbvEmailNotification
+     * @covers ::assertResponseIsSuccess
+     */
+    public function triggerIbvEmailNotificationShouldNotThrowExceptionOnSuccessfulCall()
+    {
+        $httpClient = $this->createMock(ClientInterface::class);
+        $httpClient->expects($this->exactly(1))
+            ->method('sendRequest')
+            ->with(
+                $this->callback(
+                    function (RequestInterface $requestMessage) {
+                        $expectedPathPattern = sprintf(
+                            '~^%s/sessions/%s/instructions/email.*?~',
+                            TestData::DOC_SCAN_BASE_URL,
+                            TestData::DOC_SCAN_SESSION_ID
+                        );
+
+                        $this->assertEquals('POST', $requestMessage->getMethod());
+                        $this->assertMatchesRegularExpression($expectedPathPattern, (string)$requestMessage->getUri());
+                        return true;
+                    }
+                )
+            )
+            ->willReturn($this->createResponse(200));
+
+        $docScanService = new Service(
+            TestData::SDK_ID,
+            PemFile::fromFilePath(TestData::PEM_FILE),
+            new Config(
+                [
+                    Config::HTTP_CLIENT => $httpClient,
+                ]
+            )
+        );
+
+        $docScanService->triggerIbvEmailNotification(
+            TestData::DOC_SCAN_SESSION_ID
+        );
+    }
+
+    /**
+     * @test
+     * @covers ::__construct
+     * @covers ::triggerIbvEmailNotification
+     * @covers ::assertResponseIsSuccess
+     */
+    public function triggerIbvEmailNotificationShouldThrowExceptionOnFailedCall()
+    {
+        $httpClient = $this->createMock(ClientInterface::class);
+        $httpClient->expects($this->exactly(1))
+            ->method('sendRequest')
+            ->with(
+                $this->callback(
+                    function (RequestInterface $requestMessage) {
+                        $expectedPathPattern = sprintf(
+                            '~^%s/sessions/%s/instructions/email.*?~',
+                            TestData::DOC_SCAN_BASE_URL,
+                            TestData::DOC_SCAN_SESSION_ID
+                        );
+
+                        $this->assertEquals('POST', $requestMessage->getMethod());
+                        $this->assertMatchesRegularExpression($expectedPathPattern, (string)$requestMessage->getUri());
+                        return true;
+                    }
+                )
+            )
+            ->willReturn($this->createResponse(404));
+
+        $docScanService = new Service(
+            TestData::SDK_ID,
+            PemFile::fromFilePath(TestData::PEM_FILE),
+            new Config(
+                [
+                    Config::HTTP_CLIENT => $httpClient,
+                ]
+            )
+        );
+
+        $this->expectException(DocScanException::class);
+        $this->expectExceptionMessage("Server responded with 404");
+
+        $docScanService->triggerIbvEmailNotification(
+            TestData::DOC_SCAN_SESSION_ID
+        );
+    }
 }