Merge pull request #11 from Staffbase/NFS-234-update-claims

NFS-234: adds branchId and branchSlug to token

Author: Ninerian

src/SSOData.php

@@ -27,6 +27,8 @@ abstract class SSOData
     const CLAIM_ISSUER                 = 'iss';
     const CLAIM_INSTANCE_ID            = 'instance_id';
     const CLAIM_INSTANCE_NAME          = 'instance_name';
+    const CLAIM_BRANCH_ID              = 'branch_id';
+    const CLAIM_BRANCH_SLUG            = 'branch_slug';
     const CLAIM_USER_ID                = 'sub';
     const CLAIM_USER_EXTERNAL_ID       = 'external_id';
     const CLAIM_USER_FULL_NAME         = 'name';
@@ -135,6 +137,28 @@ public function getIssuer() {
         return $this->getClaimSafe(self::CLAIM_ISSUER);
     }
 
+    /**
+     * Get the branch id of the app that issued the token.
+     *
+     * The id will always be present.
+     *
+     * @return string
+     */
+    public function getBranchId() {
+
+        return $this->getClaimSafe(self::CLAIM_BRANCH_ID);
+    }
+
+    /**
+     * Get the slug of the branch of the app that issued the token.
+     *
+     * @return null|string
+     */
+    public function getBranchSlug() {
+
+        return $this->getClaimSafe(self::CLAIM_BRANCH_SLUG);
+    }
+
     /**
      * Get the (plugin) instance id for which the token was issued.
      *
@@ -313,5 +337,5 @@ public function isDeleteInstanceCall() {
     public function getData() {
 
         return $this->getAllClaims();
-    }   
+    }
 }

test/SSODataTest.php

@@ -48,6 +48,8 @@ public static function getTokenData() {
 		$tokenData[SSOData::CLAIM_THEME_BACKGROUND_COLOR] = '#FFAABB';
 		$tokenData[SSOData::CLAIM_USER_LOCALE]            = 'en_US';
 		$tokenData[SSOData::CLAIM_USER_TAGS]              = ['profile:field1:val', 'profile:field2:val'];
+		$tokenData[SSOData::CLAIM_BRANCH_ID]              = "dev-id";
+		$tokenData[SSOData::CLAIM_BRANCH_SLUG]            = "dev-slug";
 
 		return $tokenData;
 	}
@@ -79,6 +81,8 @@ public static function getTokenAccesors() {
 		$accessors[SSOData::CLAIM_THEME_BACKGROUND_COLOR] = 'getThemeBackgroundColor';
 		$accessors[SSOData::CLAIM_USER_LOCALE]            = 'getLocale';
 		$accessors[SSOData::CLAIM_USER_TAGS]              = 'getTags';
+		$accessors[SSOData::CLAIM_BRANCH_ID]              = "getBranchId";
+		$accessors[SSOData::CLAIM_BRANCH_SLUG]            = "getBranchSlug";
 
 		return $accessors;
 	}
@@ -106,6 +110,8 @@ public static function getTokenAccesors() {
 	 * @covers \Staffbase\plugins\sdk\SSOData::getThemeBackgroundColor()
 	 * @covers \Staffbase\plugins\sdk\SSOData::getLocale()
 	 * @covers \Staffbase\plugins\sdk\SSOData::getTags()
+	 * @covers \Staffbase\plugins\sdk\SSOData::getBranchId()
+	 * @covers \Staffbase\plugins\sdk\SSOData::getTags()
 	 */
 	public function testAccessorsGiveCorrectValues() {
 

test/SSOTokenTest.php

@@ -76,6 +76,8 @@ public static function createSignedTokenFromData($privateKey, $tokenData) {
 			->set(SSOToken::CLAIM_THEME_BACKGROUND_COLOR, $tokenData[SSOToken::CLAIM_THEME_BACKGROUND_COLOR])
 			->set(SSOToken::CLAIM_USER_LOCALE, $tokenData[SSOToken::CLAIM_USER_LOCALE])
 			->set(SSOToken::CLAIM_USER_TAGS, $tokenData[SSOToken::CLAIM_USER_TAGS])
+			->set(SSOToken::CLAIM_BRANCH_ID, $tokenData[SSOToken::CLAIM_BRANCH_ID])
+			->set(SSOToken::CLAIM_BRANCH_SLUG, $tokenData[SSOToken::CLAIM_BRANCH_SLUG])
 			->sign($signer, $keychain->getPrivateKey($privateKey))
 			->getToken();
 
@@ -110,6 +112,8 @@ private static function createUnsignedTokenFromData($tokenData) {
 			->set(SSOToken::CLAIM_THEME_BACKGROUND_COLOR, $tokenData[SSOToken::CLAIM_THEME_BACKGROUND_COLOR])
 			->set(SSOToken::CLAIM_USER_LOCALE, $tokenData[SSOToken::CLAIM_USER_LOCALE])
 			->set(SSOToken::CLAIM_USER_TAGS, $tokenData[SSOToken::CLAIM_USER_TAGS])
+			->set(SSOToken::CLAIM_BRANCH_ID, $tokenData[SSOToken::CLAIM_BRANCH_ID])
+			->set(SSOToken::CLAIM_BRANCH_SLUG, $tokenData[SSOToken::CLAIM_BRANCH_SLUG])
 			->getToken();
 
 		return $token;
@@ -336,6 +340,8 @@ public function testConstructorToFailOnUnsignedToken() {
 	 * @covers \Staffbase\plugins\sdk\SSOToken::getTags()
 	 * @covers \Staffbase\plugins\sdk\SSOToken::hasClaim()
 	 * @covers \Staffbase\plugins\sdk\SSOToken::getClaim()
+	 * @covers \Staffbase\plugins\sdk\SSOToken::getBranchId()
+	 * @covers \Staffbase\plugins\sdk\SSOToken::getBranchSlug()
 	 */
 	public function testAccessorsGiveCorrectValues() {