SDK-1840:Add auth type to notification config

Author: Rodion Liuborets

src/DocScan/Constants.php

@@ -25,4 +25,7 @@ class Constants
     public const ALWAYS = 'ALWAYS';
     public const FALLBACK = 'FALLBACK';
     public const NEVER = 'NEVER';
+
+    public const BASIC = 'BASIC';
+    public const BEARER = 'BEARER';
 }

src/DocScan/Session/Create/NotificationConfig.php

@@ -14,6 +14,11 @@ class NotificationConfig implements \JsonSerializable
      */
     private $authToken;
 
+    /**
+     * @var string|null
+     */
+    private $authType;
+
     /**
      * @var string|null
      */
@@ -27,12 +32,14 @@ class NotificationConfig implements \JsonSerializable
     /**
      * NotificationConfig constructor.
      * @param string|null $authToken
+     * @param string|null $authType
      * @param string|null $endpoint
      * @param array<string> $topics
      */
-    public function __construct(?string $authToken, ?string $endpoint, array $topics = [])
+    public function __construct(?string $authToken, ?string $authType, ?string $endpoint, array $topics = [])
     {
         $this->authToken = $authToken;
+        $this->authType = $authType;
         $this->endpoint = $endpoint;
         $this->topics = array_unique($topics);
     }
@@ -44,6 +51,7 @@ public function jsonSerialize(): \stdClass
     {
         return (object) Json::withoutNullValues([
             'auth_token' => $this->getAuthToken(),
+            'auth_type' => $this->getAuthType(),
             'endpoint' => $this->getEndpoint(),
             'topics' => $this->getTopics(),
         ]);
@@ -57,6 +65,14 @@ public function getAuthToken(): ?string
         return $this->authToken;
     }
 
+    /**
+     * @return string|null
+     */
+    public function getAuthType(): ?string
+    {
+        return $this->authType;
+    }
+
     /**
      * @return string|null
      */

src/DocScan/Session/Create/NotificationConfigBuilder.php

@@ -4,6 +4,8 @@
 
 namespace Yoti\DocScan\Session\Create;
 
+use Yoti\DocScan\Constants;
+
 class NotificationConfigBuilder
 {
 
@@ -17,6 +19,11 @@ class NotificationConfigBuilder
      */
     private $authToken;
 
+    /**
+     * @var string
+     */
+    private $authType;
+
     /**
      * @var string
      */
@@ -27,46 +34,91 @@ class NotificationConfigBuilder
      */
     private $topics = [];
 
+    /**
+     * @param string $authToken
+     * @return $this
+     */
     public function withAuthToken(string $authToken): self
     {
         $this->authToken = $authToken;
         return $this;
     }
 
+    /**
+     * @return $this
+     */
+    public function withAuthTypeBasic(): self
+    {
+        $this->authType = Constants::BASIC;
+        return $this;
+    }
+
+    /**
+     * @return $this
+     */
+    public function withAuthTypeBearer(): self
+    {
+        $this->authType = Constants::BEARER;
+        return $this;
+    }
+
+    /**
+     * @param string $endpoint
+     * @return $this
+     */
     public function withEndpoint(string $endpoint): self
     {
         $this->endpoint = $endpoint;
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function forResourceUpdate(): self
     {
         return $this->withTopic(self::RESOURCE_UPDATE);
     }
 
+    /**
+     * @param string $topic
+     * @return $this
+     */
     public function withTopic(string $topic): self
     {
         $this->topics[] = $topic;
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function forTaskCompletion(): self
     {
         return $this->withTopic(self::TASK_COMPLETION);
     }
 
+    /**
+     * @return $this
+     */
     public function forCheckCompletion(): self
     {
         return $this->withTopic(self::CHECK_COMPLETION);
     }
 
+    /**
+     * @return $this
+     */
     public function forSessionCompletion(): self
     {
         return $this->withTopic(self::SESSION_COMPLETION);
     }
 
+    /**
+     * @return NotificationConfig
+     */
     public function build(): NotificationConfig
     {
-        return new NotificationConfig($this->authToken, $this->endpoint, $this->topics);
+        return new NotificationConfig($this->authToken, $this->authType, $this->endpoint, $this->topics);
     }
 }

tests/DocScan/Session/Create/NotificationConfigBuilderTest.php

@@ -4,6 +4,7 @@
 
 namespace Yoti\Test\DocScan\Session\Create;
 
+use Yoti\DocScan\Constants;
 use Yoti\DocScan\Session\Create\NotificationConfigBuilder;
 use Yoti\Test\TestCase;
 
@@ -28,7 +29,7 @@ class NotificationConfigBuilderTest extends TestCase
      * @covers \Yoti\DocScan\Session\Create\NotificationConfig::getEndpoint
      * @covers \Yoti\DocScan\Session\Create\NotificationConfig::getTopics
      */
-    public function shouldBuildNotificationConfig()
+    public function shouldBuildNotificationConfig(): void
     {
         $result = (new NotificationConfigBuilder())
             ->withAuthToken(self::SOME_AUTH_TOKEN)
@@ -47,7 +48,7 @@ public function shouldBuildNotificationConfig()
      * @test
      * @covers ::forResourceUpdate
      */
-    public function shouldUseCorrectValueForResourceUpdate()
+    public function shouldUseCorrectValueForResourceUpdate(): void
     {
         $result = (new NotificationConfigBuilder())
             ->withAuthToken(self::SOME_AUTH_TOKEN)
@@ -62,7 +63,7 @@ public function shouldUseCorrectValueForResourceUpdate()
      * @test
      * @covers ::forTaskCompletion
      */
-    public function shouldUseCorrectValueForTaskCompletion()
+    public function shouldUseCorrectValueForTaskCompletion(): void
     {
         $result = (new NotificationConfigBuilder())
             ->withAuthToken(self::SOME_AUTH_TOKEN)
@@ -77,7 +78,7 @@ public function shouldUseCorrectValueForTaskCompletion()
      * @test
      * @covers ::forCheckCompletion
      */
-    public function shouldUseCorrectValueForCheckCompletion()
+    public function shouldUseCorrectValueForCheckCompletion(): void
     {
         $result = (new NotificationConfigBuilder())
             ->withAuthToken(self::SOME_AUTH_TOKEN)
@@ -92,7 +93,7 @@ public function shouldUseCorrectValueForCheckCompletion()
      * @test
      * @covers ::forSessionCompletion
      */
-    public function shouldUseCorrectValueForSessionCompletion()
+    public function shouldUseCorrectValueForSessionCompletion(): void
     {
         $result = (new NotificationConfigBuilder())
             ->withAuthToken(self::SOME_AUTH_TOKEN)
@@ -111,7 +112,7 @@ public function shouldUseCorrectValueForSessionCompletion()
      * @covers ::forSessionCompletion
      * @covers ::withTopic
      */
-    public function shouldAllowAllNotificationTypes()
+    public function shouldAllowAllNotificationTypes(): void
     {
         $result = (new NotificationConfigBuilder())
             ->withAuthToken(self::SOME_AUTH_TOKEN)
@@ -133,7 +134,7 @@ public function shouldAllowAllNotificationTypes()
      * @test
      * @covers \Yoti\DocScan\Session\Create\NotificationConfig::jsonSerialize
      */
-    public function shouldSerializeWithCorrectProperties()
+    public function shouldSerializeWithCorrectProperties(): void
     {
         $result = (new NotificationConfigBuilder())
             ->withAuthToken(self::SOME_AUTH_TOKEN)
@@ -156,7 +157,7 @@ public function shouldSerializeWithCorrectProperties()
      * @test
      * @covers \Yoti\DocScan\Session\Create\NotificationConfig::jsonSerialize
      */
-    public function shouldSerializeWithoutNullValues()
+    public function shouldSerializeWithoutNullValues(): void
     {
         $result = (new NotificationConfigBuilder())->build();
 
@@ -166,4 +167,45 @@ public function shouldSerializeWithoutNullValues()
 
         $this->assertJsonStringEqualsJsonString(json_encode($expected), json_encode($result));
     }
+
+    /**
+     * @test
+     * @covers \Yoti\DocScan\Session\Create\NotificationConfig::getAuthType
+     */
+    public function shouldNotImplicitlySetAValueForAuthType(): void
+    {
+        $result = (new NotificationConfigBuilder())
+            ->forResourceUpdate()
+            ->build();
+
+        $this->assertNull($result->getAuthType());
+    }
+
+    /**
+     * @test
+     * @covers \Yoti\DocScan\Session\Create\NotificationConfigBuilder::withAuthTypeBasic
+     */
+    public function shouldSetAuthTypeToBasic()
+    {
+        $result = (new NotificationConfigBuilder())
+            ->forResourceUpdate()
+            ->withAuthTypeBasic()
+            ->build();
+
+        $this->assertEquals($result->getAuthType(), Constants::BASIC);
+    }
+
+    /**
+     * @test
+     * @covers \Yoti\DocScan\Session\Create\NotificationConfigBuilder::withAuthTypeBearer
+     */
+    public function shouldSetAuthTypeToBearer()
+    {
+        $result = (new NotificationConfigBuilder())
+            ->forResourceUpdate()
+            ->withAuthTypeBearer()
+            ->build();
+
+        $this->assertEquals($result->getAuthType(), Constants::BEARER);
+    }
 }