SDK-2075-2085 Add subject and identity profile requirements (#275)

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

Author: LuborRod

src/ShareUrl/DynamicScenario.php

@@ -31,6 +31,11 @@ class DynamicScenario implements \JsonSerializable
      */
     private $extensions;
 
+    /**
+     * @var object|null
+     */
+    private $subject;
+
     /**
      * @param string $callbackEndpoint
      *   The device's callback endpoint. Must be a URL relative to the Application
@@ -39,14 +44,21 @@ class DynamicScenario implements \JsonSerializable
      *   The customisable DynamicPolicy to use in the share.
      * @param \Yoti\ShareUrl\Extension\Extension[] $extensions
      *   List of Extension to be activated for the application.
+     * @param object $subject
+     *   Set of data required to represent an identity profile
      */
-    public function __construct(string $callbackEndpoint, DynamicPolicy $dynamicPolicy, array $extensions)
-    {
+    public function __construct(
+        string $callbackEndpoint,
+        DynamicPolicy $dynamicPolicy,
+        array $extensions,
+        $subject = null
+    ) {
         $this->callbackEndpoint = $callbackEndpoint;
         $this->dynamicPolicy = $dynamicPolicy;
 
         Validation::isArrayOfType($extensions, [Extension::class], 'extensions');
         $this->extensions = $extensions;
+        $this->subject = $subject;
     }
 
     /**
@@ -60,6 +72,7 @@ public function jsonSerialize(): stdClass
             'callback_endpoint' => $this->callbackEndpoint,
             'policy' => $this->dynamicPolicy,
             'extensions' => $this->extensions,
+            'subject' => $this->subject,
         ];
     }
 
@@ -70,4 +83,12 @@ public function __toString(): string
     {
         return Json::encode($this);
     }
+
+    /**
+     * @return object|null
+     */
+    public function getSubject()
+    {
+        return $this->subject;
+    }
 }

src/ShareUrl/DynamicScenarioBuilder.php

@@ -27,6 +27,11 @@ class DynamicScenarioBuilder
      */
     private $extensions = [];
 
+    /**
+     * @var object|null
+     */
+    private $subject = null;
+
     /**
      * @param string $callbackEndpoint
      *
@@ -60,11 +65,22 @@ public function withExtension(Extension $extension): self
         return $this;
     }
 
+    /**
+     * @param object $subject
+     *
+     * @return $this
+     */
+    public function withSubject($subject): self
+    {
+        $this->subject = $subject;
+        return $this;
+    }
+
     /**
      * @return \Yoti\ShareUrl\DynamicScenario
      */
     public function build(): DynamicScenario
     {
-        return new DynamicScenario($this->callbackEndpoint, $this->dynamicPolicy, $this->extensions);
+        return new DynamicScenario($this->callbackEndpoint, $this->dynamicPolicy, $this->extensions, $this->subject);
     }
 }

src/ShareUrl/Policy/DynamicPolicy.php

@@ -28,17 +28,24 @@ class DynamicPolicy implements \JsonSerializable
      */
     private $wantedRememberMe;
 
+    /**
+     * @var object|null
+     */
+    private $identityProfileRequirements;
+
     /**
      * @param \Yoti\ShareUrl\Policy\WantedAttribute[] $wantedAttributes
      *   Array of attributes to be requested.
      * @param int[] $wantedAuthTypes
      *   Auth types represents the authentication type to be used.
      * @param bool $wantedRememberMe
+     * @param object $identityProfileRequirements
      */
     public function __construct(
         array $wantedAttributes,
         array $wantedAuthTypes,
-        bool $wantedRememberMe = false
+        bool $wantedRememberMe = false,
+        $identityProfileRequirements = null
     ) {
         Validation::isArrayOfType($wantedAttributes, [WantedAttribute::class], 'wantedAttributes');
         $this->wantedAttributes = $wantedAttributes;
@@ -47,6 +54,7 @@ public function __construct(
         $this->wantedAuthTypes = $wantedAuthTypes;
 
         $this->wantedRememberMe = $wantedRememberMe;
+        $this->identityProfileRequirements = $identityProfileRequirements;
     }
 
     /**
@@ -61,6 +69,7 @@ public function jsonSerialize(): stdClass
             'wanted_auth_types' => $this->wantedAuthTypes,
             'wanted_remember_me' => $this->wantedRememberMe,
             'wanted_remember_me_optional' => false,
+            'identity_profile_requirements' => $this->identityProfileRequirements,
         ];
     }
 
@@ -71,4 +80,14 @@ public function __toString(): string
     {
         return Json::encode($this);
     }
+
+    /**
+     * IdentityProfileRequirements requested in the policy
+     *
+     * @return object|null
+     */
+    public function getIdentityProfileRequirements()
+    {
+        return $this->identityProfileRequirements;
+    }
 }

src/ShareUrl/Policy/DynamicPolicyBuilder.php

@@ -36,6 +36,11 @@ class DynamicPolicyBuilder
      */
     private $wantedRememberMe = false;
 
+    /**
+     * @var object|null
+     */
+    private $identityProfileRequirements = null;
+
     /**
      * @param \Yoti\ShareUrl\Policy\WantedAttribute $wantedAttribute
      *
@@ -378,14 +383,27 @@ public function withWantedRememberMe(bool $wantedRememberMe): self
     }
 
     /**
-     * @return \Yoti\ShareUrl\Policy\DynamicPolicy
+     * Use an Identity Profile Requirement object for the share
+     *
+     * @param object $identityProfileRequirements
+     * @return $this
+     */
+    public function withIdentityProfileRequirements($identityProfileRequirements): self
+    {
+        $this->identityProfileRequirements = $identityProfileRequirements;
+        return $this;
+    }
+
+    /**
+     * @return DynamicPolicy
      */
     public function build(): DynamicPolicy
     {
         return new DynamicPolicy(
             array_values($this->wantedAttributes),
             array_values($this->wantedAuthTypes),
-            $this->wantedRememberMe
+            $this->wantedRememberMe,
+            $this->identityProfileRequirements
         );
     }
 }

tests/ShareUrl/DynamicScenarioBuilderTest.php

@@ -23,12 +23,18 @@ class DynamicScenarioBuilderTest extends TestCase
      * @covers ::withCallbackEndpoint
      * @covers ::withPolicy
      * @covers ::withExtension
+     * @covers ::withSubject
      * @covers \Yoti\ShareUrl\DynamicScenario::__construct
      * @covers \Yoti\ShareUrl\DynamicScenario::__toString
      * @covers \Yoti\ShareUrl\DynamicScenario::jsonSerialize
+     * @covers \Yoti\ShareUrl\DynamicScenario::getSubject
      */
     public function testBuild()
     {
+        $subjectSample = (object)[
+          'subject_id' => 'SOME_STRING'
+        ];
+
         $somePolicy = (new DynamicPolicyBuilder())
             ->withFullName()
             ->withGivenNames()
@@ -49,6 +55,7 @@ public function testBuild()
             ->withPolicy($somePolicy)
             ->withExtension($someExtension1)
             ->withExtension($someExtension2)
+            ->withSubject($subjectSample)
             ->build();
 
         $expectedJsonData = [
@@ -67,6 +74,7 @@ public function testBuild()
                 'wanted_auth_types' => [],
                 'wanted_remember_me' => false,
                 'wanted_remember_me_optional' => false,
+                'identity_profile_requirements' => null
             ],
             'extensions' => [
                 [
@@ -82,10 +90,12 @@ public function testBuild()
                     ],
                 ],
             ],
+            'subject' => $subjectSample
         ];
 
         $this->assertEquals(json_encode($expectedJsonData), json_encode($dynamicScenario));
         $this->assertEquals(json_encode($expectedJsonData), $dynamicScenario);
+        $this->assertEquals($subjectSample, $dynamicScenario->getSubject());
     }
 
     /**