From 94e678c4b193a01c4f663baacba10d535e1c76c7 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Mon, 10 Apr 2023 21:40:30 -0700 Subject: [PATCH] authx - Rename "JWT" API to "AuthxCredential" --- .../{JWT => AuthxCredential}/Create.php | 2 +- .../{JWT => AuthxCredential}/Validate.php | 2 +- .../Api4/{JWT.php => AuthxCredential.php} | 12 ++++---- ...JwtApiTest.php => AuthxCredentialTest.php} | 28 +++++++++---------- 4 files changed, 22 insertions(+), 22 deletions(-) rename ext/authx/Civi/Api4/Action/{JWT => AuthxCredential}/Create.php (97%) rename ext/authx/Civi/Api4/Action/{JWT => AuthxCredential}/Validate.php (97%) rename ext/authx/Civi/Api4/{JWT.php => AuthxCredential.php} (81%) rename ext/authx/tests/phpunit/api/v4/{JwtApiTest.php => AuthxCredentialTest.php} (66%) diff --git a/ext/authx/Civi/Api4/Action/JWT/Create.php b/ext/authx/Civi/Api4/Action/AuthxCredential/Create.php similarity index 97% rename from ext/authx/Civi/Api4/Action/JWT/Create.php rename to ext/authx/Civi/Api4/Action/AuthxCredential/Create.php index 323dc8c894..1d6c312f2e 100644 --- a/ext/authx/Civi/Api4/Action/JWT/Create.php +++ b/ext/authx/Civi/Api4/Action/AuthxCredential/Create.php @@ -10,7 +10,7 @@ +--------------------------------------------------------------------+ */ -namespace Civi\Api4\Action\JWT; +namespace Civi\Api4\Action\AuthxCredential; use Civi\Api4\Generic\Result; diff --git a/ext/authx/Civi/Api4/Action/JWT/Validate.php b/ext/authx/Civi/Api4/Action/AuthxCredential/Validate.php similarity index 97% rename from ext/authx/Civi/Api4/Action/JWT/Validate.php rename to ext/authx/Civi/Api4/Action/AuthxCredential/Validate.php index 4e08af7983..528baca69f 100644 --- a/ext/authx/Civi/Api4/Action/JWT/Validate.php +++ b/ext/authx/Civi/Api4/Action/AuthxCredential/Validate.php @@ -10,7 +10,7 @@ +--------------------------------------------------------------------+ */ -namespace Civi\Api4\Action\JWT; +namespace Civi\Api4\Action\AuthxCredential; use Civi\Api4\Generic\Result; use Civi\Authx\AuthxException; diff --git a/ext/authx/Civi/Api4/JWT.php b/ext/authx/Civi/Api4/AuthxCredential.php similarity index 81% rename from ext/authx/Civi/Api4/JWT.php rename to ext/authx/Civi/Api4/AuthxCredential.php index c666be2b0c..b700a3fc9e 100644 --- a/ext/authx/Civi/Api4/JWT.php +++ b/ext/authx/Civi/Api4/AuthxCredential.php @@ -12,29 +12,29 @@ namespace Civi\Api4; /** - * Methods of handling JWTs + * Methods of handling (JWT) authx credentialss * * @searchable none * @since 5.62 * @package Authx */ -class JWT extends Generic\AbstractEntity { +class AuthxCredential extends Generic\AbstractEntity { /** * @param bool $checkPermissions - * @return Action\JWT\create + * @return Action\AuthxCredential\create */ public static function create($checkPermissions = TRUE) { - return (new Action\JWT\Create(__CLASS__, __FUNCTION__)) + return (new Action\AuthxCredential\Create(__CLASS__, __FUNCTION__)) ->setCheckPermissions($checkPermissions); } /** * @param bool $checkPermissions - * @return Action\JWT\validate + * @return Action\AuthxCredential\validate */ public static function validate($checkPermissions = TRUE) { - return (new Action\JWT\Validate(__CLASS__, __FUNCTION__)) + return (new Action\AuthxCredential\Validate(__CLASS__, __FUNCTION__)) ->setCheckPermissions($checkPermissions); } diff --git a/ext/authx/tests/phpunit/api/v4/JwtApiTest.php b/ext/authx/tests/phpunit/api/v4/AuthxCredentialTest.php similarity index 66% rename from ext/authx/tests/phpunit/api/v4/JwtApiTest.php rename to ext/authx/tests/phpunit/api/v4/AuthxCredentialTest.php index a818e354ae..87dc8e15e7 100644 --- a/ext/authx/tests/phpunit/api/v4/JwtApiTest.php +++ b/ext/authx/tests/phpunit/api/v4/AuthxCredentialTest.php @@ -2,16 +2,16 @@ namespace api\v4\Authx; -use Civi\Api4\JWT; +use Civi\Api4\AuthxCredential; use Civi\Test\HeadlessInterface; use Civi\Test\TransactionalInterface; use PHPUnit\Framework\TestCase; /** - * Test JWT API methods + * Test AuthxCredential API methods * @group headless */ -class JwtApiTest extends TestCase implements HeadlessInterface, TransactionalInterface { +class AuthxCredentialTest extends TestCase implements HeadlessInterface, TransactionalInterface { use \Civi\Test\Api4TestTrait; use \Civi\Test\Api3TestTrait; @@ -23,7 +23,7 @@ class JwtApiTest extends TestCase implements HeadlessInterface, TransactionalInt ->apply(); } - public function testJWTGenrateToken(): void { + public function testGenerateToken(): void { $this->_apiversion = 4; $contactRecord = $this->createTestRecord('Contact', ['contact_type' => 'Individual']); $this->createLoggedInUser(); @@ -31,8 +31,8 @@ class JwtApiTest extends TestCase implements HeadlessInterface, TransactionalInt 'access CiviCRM', ]); try { - JWT::create()->setContactId($contactRecord['id'])->execute(); - $this->fail('JWT Should not be created as permission is not granted'); + AuthxCredential::create()->setContactId($contactRecord['id'])->execute(); + $this->fail('AuthxCredential Should not be created as permission is not granted'); } catch (\Exception $e) { } @@ -40,11 +40,11 @@ class JwtApiTest extends TestCase implements HeadlessInterface, TransactionalInt 'access CiviCRM', 'generate JWT', ]); - $jwt = JWT::create()->setContactId($contactRecord['id'])->execute(); + $jwt = AuthxCredential::create()->setContactId($contactRecord['id'])->execute(); $this->assertNotEmpty($jwt[0]['token']); } - public function testJWTValidation(): void { + public function testValidation(): void { $this->_apiversion = 4; $contactRecord = $this->createTestRecord('Contact', ['contact_type' => 'Individual']); $this->createLoggedInUser(); @@ -52,17 +52,17 @@ class JwtApiTest extends TestCase implements HeadlessInterface, TransactionalInt 'access CiviCRM', 'generate JWT', ]); - $jwt = JWT::create()->setContactId($contactRecord['id'])->execute(); - $validate = JWT::validate()->setToken($jwt[0]['token'])->execute(); + $jwt = AuthxCredential::create()->setContactId($contactRecord['id'])->execute(); + $validate = AuthxCredential::validate()->setToken($jwt[0]['token'])->execute(); $this->assertEquals('jwt', $validate[0]['credType']); $this->assertEquals($contactRecord['id'], $validate[0]['contactId']); $this->assertEquals('cid:' . $contactRecord['id'], $validate[0]['jwt']['sub']); } /** - * Test that the JWT does not validate if expired + * Test that the AuthxCredential does not validate if expired */ - public function testExpiredJWTValidation(): void { + public function testExpiredValidation(): void { $this->expectException(\Civi\Authx\AuthxException::class); $this->expectExceptionMessage('Expired token'); $this->_apiversion = 4; @@ -72,9 +72,9 @@ class JwtApiTest extends TestCase implements HeadlessInterface, TransactionalInt 'access CiviCRM', 'generate JWT', ]); - $jwt = JWT::create()->setContactId($contactRecord['id'])->setTtl(5)->execute(); + $jwt = AuthxCredential::create()->setContactId($contactRecord['id'])->setTtl(5)->execute(); sleep(10); - $validate = JWT::validate()->setToken($jwt[0]['token'])->execute(); + $validate = AuthxCredential::validate()->setToken($jwt[0]['token'])->execute(); } /** -- 2.25.1