Refactor UserData to extend AbstractResponseData

Author: Greg Bowler

src/Authenticator.php

@@ -4,6 +4,7 @@
 use Authwave\ProviderUri\AbstractProviderUri;
 use Authwave\ProviderUri\AdminUri;
 use Authwave\ProviderUri\LoginUri;
+use Authwave\ProviderUri\LogoutUri;
 use Authwave\ProviderUri\ProfileUri;
 use Gt\Http\Uri;
 use Gt\Session\SessionContainer;
@@ -55,7 +56,7 @@ public function isLoggedIn():bool {
 		$userData = null;
 
 		try {
-			$userData = $this->sessionData->getUserData();
+			$userData = $this->sessionData->getData();
 		}
 		catch(NotLoggedInException $exception) {
 			return false;
@@ -91,17 +92,17 @@ public function logout(Token $token = null):void {
 	}
 
 	public function getUuid():string {
-		$userData = $this->sessionData->getUserData();
+		$userData = $this->sessionData->getData();
 		return $userData->getUuid();
 	}
 
 	public function getEmail():string {
-		$userData = $this->sessionData->getUserData();
+		$userData = $this->sessionData->getData();
 		return $userData->getEmail();
 	}
 
 	public function getField(string $name):?string {
-		$userData = $this->sessionData->getUserData();
+		$userData = $this->sessionData->getData();
 		return $userData->getField($name);
 	}
 
@@ -152,8 +153,6 @@ private function completeAuth():void {
 			new SessionData($token, $userData)
 		);
 
-		setcookie("authwave-trackshift", "test", 0, "/", "localhost");
-
 		$this->redirectHandler->redirect(
 			(new Uri($this->currentUriPath))
 			->withoutQueryValue(self::RESPONSE_QUERY_PARAMETER)

src/ProviderUri/LogoutUri.php

@@ -0,0 +1,18 @@
+<?php
+namespace Authwave\ProviderUri;
+
+use Authwave\Token;
+
+class LogoutUri extends AbstractProviderUri {
+	public function __construct(
+		Token $token,
+		string $currentPath = "/",
+		string $baseRemoteUri = self::DEFAULT_BASE_REMOTE_URI
+	) {
+		$baseRemoteUri = $this->normaliseBaseUri($baseRemoteUri);
+		$baseRemoteUri = $baseRemoteUri->withPath("/logout");
+
+		parent::__construct($baseRemoteUri);
+		$this->query = $this->buildQuery($token, $currentPath);
+	}
+}

src/ResponseData/AbstractResponseData.php

@@ -0,0 +1,14 @@
+<?php
+namespace Authwave\ResponseData;
+
+abstract class AbstractResponseData {
+	protected ?string $message;
+
+	public function __construct(string $message = null) {
+		$this->message = $message;
+	}
+
+	public function getMessage():?string {
+		return $this->message;
+	}
+}

src/UserData.php src/ResponseData/UserData.phpsrc/UserData.php renamed to src/ResponseData/UserData.php

@@ -1,19 +1,22 @@
 <?php
-namespace Authwave;
+namespace Authwave\ResponseData;
 
-class UserData {
+class UserData extends AbstractResponseData {
 	private string $uuid;
 	private string $email;
 	private object $fields;
 
 	public function __construct(
 		string $uuid,
 		string $email,
-		object $fields
+		object $fields,
+		string $message = null
 	) {
 		$this->uuid = $uuid;
 		$this->email = $email;
 		$this->fields = $fields;
+
+		parent::__construct($message);
 	}
 
 	public function getUuid():string {

src/SessionData.php

@@ -1,16 +1,19 @@
 <?php
 namespace Authwave;
 
+use Authwave\ResponseData\AbstractResponseData;
+use Authwave\ResponseData\UserData;
+
 class SessionData {
 	private ?Token $token;
-	private ?UserData $userData;
+	private ?AbstractResponseData $data;
 
 	public function __construct(
 		Token $token = null,
-		UserData $userData = null
+		AbstractResponseData $data = null
 	) {
 		$this->token = $token;
-		$this->userData = $userData;
+		$this->data = $data;
 	}
 
 	public function getToken():Token {
@@ -21,11 +24,11 @@ public function getToken():Token {
 		return $this->token;
 	}
 
-	public function getUserData():UserData {
-		if(!isset($this->userData)) {
+	public function getData():AbstractResponseData {
+		if(!isset($this->data)) {
 			throw new NotLoggedInException();
 		}
 
-		return $this->userData;
+		return $this->data;
 	}
 }

src/Token.php

@@ -1,7 +1,9 @@
 <?php
 namespace Authwave;
 
-use stdClass;
+use Authwave\ResponseData\AbstractResponseData;
+use Authwave\ResponseData\UserData;
+use StdClass;
 
 class Token {
 	const ENCRYPTION_METHOD = "aes128";
@@ -53,7 +55,7 @@ public function generateRequestCipher(string $message = null):string {
 // application after a successful authentication and includes a serialised
 // UserData object, encrypted using the secret IV, which was created when
 // encrypting the original request cipher.
-	public function decryptResponseCipher(string $cipher):UserData {
+	public function decryptResponseCipher(string $cipher):AbstractResponseData {
 		$decrypted = openssl_decrypt(
 			base64_decode($cipher),
 			self::ENCRYPTION_METHOD,

test/phpunit/AuthenticatorTest.php

@@ -8,10 +8,11 @@
 use Authwave\ProviderUri\LoginUri;
 use Authwave\ProviderUri\LogoutUri;
 use Authwave\RedirectHandler;
+use Authwave\ResponseData\AbstractResponseData;
 use Authwave\SessionData;
 use Authwave\SessionNotStartedException;
 use Authwave\Token;
-use Authwave\UserData;
+use Authwave\ResponseData\UserData;
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\UriInterface;
 
@@ -49,7 +50,7 @@ public function testIsLoggedInTrueWhenSessionDataSet() {
 		$userData = self::createMock(UserData::class);
 		$sessionData = self::createMock(SessionData::class);
 		$sessionData->expects(self::once())
-			->method("getUserData")
+			->method("getData")
 			->willReturn($userData);
 
 		$_SESSION = [
@@ -63,7 +64,10 @@ public function testIsLoggedInTrueWhenSessionDataSet() {
 		self::assertTrue($sut->isLoggedIn());
 	}
 
-	public function testLogoutClearsSession() {
+	// TODO: Session shouldn't be cleared on call to logout - instead it should
+	// redirect to the provider, and a new test should asset the response data
+	// contains a logout confirmation.
+	public function TODO_UPDATE_testLogoutClearsSession() {
 		$sessionData = self::createMock(SessionData::class);
 		$_SESSION = [
 			Authenticator::SESSION_KEY => $sessionData
@@ -146,7 +150,7 @@ public function testLoginRedirectsWithCorrectQueryString() {
 		$expectedQueryParts = [
 			LoginUri::QUERY_STRING_CIPHER => $cipher,
 			LoginUri::QUERY_STRING_INIT_VECTOR => $ivString,
-			LoginUri::QUERY_STRING_CURRENT_PATH => $currentPath,
+			LoginUri::QUERY_STRING_CURRENT_PATH => bin2hex($currentPath),
 		];
 		$expectedQuery = http_build_query($expectedQueryParts);
 
@@ -205,7 +209,7 @@ public function testGetUuid() {
 		$userData->method("getUuid")
 			->willReturn($expectedUuid);
 		$sessionData = self::createMock(SessionData::class);
-		$sessionData->method("getUserData")
+		$sessionData->method("getData")
 			->willReturn($userData);
 
 		$_SESSION = [
@@ -235,7 +239,7 @@ public function testGetEmail() {
 		$userData->method("getEmail")
 			->willReturn($expectedEmail);
 		$sessionData = self::createMock(SessionData::class);
-		$sessionData->method("getUserData")
+		$sessionData->method("getData")
 			->willReturn($userData);
 
 		$_SESSION = [
@@ -303,8 +307,8 @@ public function testCompleteAuth() {
 			$newSessionData
 		);
 		self::assertInstanceOf(
-			UserData::class,
-			$newSessionData->getUserData()
+			AbstractResponseData::class,
+			$newSessionData->getData()
 		);
 	}
 

test/phpunit/ProviderUri/LoginUriTest.php

@@ -41,7 +41,7 @@ public function testQueryString() {
 		);
 
 		self::assertEquals(
-			$returnPath,
+			bin2hex($returnPath),
 			$queryParts[LoginUri::QUERY_STRING_CURRENT_PATH]
 		);
 	}

test/phpunit/SessionDataTest.php

@@ -4,7 +4,7 @@
 use Authwave\NotLoggedInException;
 use Authwave\SessionData;
 use Authwave\Token;
-use Authwave\UserData;
+use Authwave\ResponseData\UserData;
 use PHPUnit\Framework\TestCase;
 
 class SessionDataTest extends TestCase {
@@ -23,13 +23,13 @@ public function testGetToken() {
 	public function testGetUserDataNull() {
 		$sut = new SessionData();
 		self::expectException(NotLoggedInException::class);
-		$sut->getUserData();
+		$sut->getData();
 	}
 
 	public function testGetUserData() {
 		$token = self::createMock(Token::class);
 		$userData = self::createMock(UserData::class);
 		$sut = new SessionData($token, $userData);
-		self::assertSame($userData, $sut->getUserData());
+		self::assertSame($userData, $sut->getData());
 	}
 }

test/phpunit/TokenTest.php

@@ -5,7 +5,7 @@
 use Authwave\InvalidUserDataSerializationException;
 use Authwave\ResponseCipherDecryptionException;
 use Authwave\Token;
-use Authwave\UserData;
+use Authwave\ResponseData\UserData;
 use PHPUnit\Framework\TestCase;
 
 class TokenTest extends TestCase {