Changed database field name from key to api_key

TomHAnderson · TomHAnderson · commit a6476acd0d0f · 2021-12-16T22:01:11.000-07:00
diff --git a/LaravelDoctrineApiKey.skipper b/LaravelDoctrineApiKey.skipper
@@ -4,7 +4,7 @@
     <entity name="\ApiSkeletons\Laravel\Doctrine\ApiKey\Entity\ApiKey" local-name="ApiKey" namespace="\ApiSkeletons\Laravel\Doctrine\ApiKey\Entity" uuid="5d41775f-e84c-4890-a202-19c4f93e3b58">
       <field name="id" type="bigint" required="true" unique="true" primary="true" auto-increment="true" uuid="1425ce9b-57d6-4c28-bd8b-89fffce92468"/>
       <field name="name" type="string" required="true" unique="true" uuid="a0ea0895-aab4-4c93-b119-47c9539e95a2"/>
-      <field name="key" type="string" required="true" unique="true" uuid="e5a11137-9889-470a-8d5d-7ce1273d13df"/>
+      <field name="api_key" type="string" required="true" unique="true" uuid="e5a11137-9889-470a-8d5d-7ce1273d13df"/>
       <field name="is_active" type="boolean" required="true" uuid="ba95511b-7e28-47b1-8cd1-eaa9a488dc96"/>
       <field name="created_at" type="datetime" required="true" uuid="d09a3c83-1bd8-45fe-8b2c-9c46b4319c30"/>
       <field name="status_at" type="datetime" required="true" uuid="49072f5c-bbbd-4e04-85df-656eaffd9025"/>
diff --git a/config/orm/ApiSkeletons.Laravel.Doctrine.ApiKey.Entity.ApiKey.dcm.xml b/config/orm/ApiSkeletons.Laravel.Doctrine.ApiKey.Entity.ApiKey.dcm.xml
@@ -5,7 +5,7 @@
       <generator strategy="AUTO"/>
     </id>
     <field name="name" type="string" unique="true" nullable="false"/>
-    <field name="key" type="string" unique="true" nullable="false"/>
+    <field name="api_key" type="string" unique="true" nullable="false"/>
     <field name="is_active" type="boolean" nullable="false"/>
     <field name="created_at" type="datetime" nullable="false"/>
     <field name="status_at" type="datetime" nullable="false"/>
diff --git a/src/Console/Command/ActivateApiKey.php b/src/Console/Command/ActivateApiKey.php
@@ -67,7 +67,7 @@ public function handle(): mixed
         $rows    = [
             [
                 $apiKey->getName(),
-                $apiKey->getKey(),
+                $apiKey->getApiKey(),
                 $apiKey->getIsActive() ? 'active' : 'deactivated',
                 implode(',', $scopeNames),
             ],
diff --git a/src/Console/Command/AddScope.php b/src/Console/Command/AddScope.php
@@ -84,7 +84,7 @@ public function handle(): mixed
         $rows    = [
             [
                 $apiKey->getName(),
-                $apiKey->getKey(),
+                $apiKey->getApiKey(),
                 $apiKey->getIsActive() ? 'active' : 'deactivated',
                 implode(',', $scopeNames),
             ],
diff --git a/src/Console/Command/DeactivateApiKey.php b/src/Console/Command/DeactivateApiKey.php
@@ -67,7 +67,7 @@ public function handle(): mixed
         $rows    = [
             [
                 $apiKey->getName(),
-                $apiKey->getKey(),
+                $apiKey->getApiKey(),
                 $apiKey->getIsActive() ? 'active' : 'deactivated',
                 implode(',', $scopeNames),
             ],
diff --git a/src/Console/Command/GenerateApiKey.php b/src/Console/Command/GenerateApiKey.php
@@ -72,7 +72,7 @@ public function handle(): mixed
         $rows    = [
             [
                 $apiKey->getName(),
-                $apiKey->getKey(),
+                $apiKey->getApiKey(),
                 $apiKey->getIsActive() ? 'active' : 'deactivated',
                 implode(',', $scopeNames),
             ],
diff --git a/src/Console/Command/PrintApiKey.php b/src/Console/Command/PrintApiKey.php
@@ -64,7 +64,7 @@ public function handle(): mixed
         $rows    = [
             [
                 $apiKey->getName(),
-                $apiKey->getKey(),
+                $apiKey->getApiKey(),
                 $apiKey->getIsActive() ? 'active' : 'deactivated',
                 implode(',', $scopeNames),
             ],
diff --git a/src/Console/Command/RemoveScope.php b/src/Console/Command/RemoveScope.php
@@ -84,7 +84,7 @@ public function handle(): mixed
         $rows    = [
             [
                 $apiKey->getName(),
-                $apiKey->getKey(),
+                $apiKey->getApiKey(),
                 $apiKey->getIsActive() ? 'active' : 'deactivated',
                 implode(',', $scopeNames),
             ],
diff --git a/src/Entity/ApiKey.php b/src/Entity/ApiKey.php
@@ -15,7 +15,7 @@ class ApiKey
     /**
      * @var string
      */
-    private $key;
+    private $api_key;
 
     /**
      * @var bool
@@ -87,27 +87,27 @@ public function getName()
     }
 
     /**
-     * Set key.
+     * Set apiKey.
      *
-     * @param string $key
+     * @param string $apiKey
      *
      * @return ApiKey
      */
-    public function setKey($key)
+    public function setApiKey($apiKey)
     {
-        $this->key = $key;
+        $this->api_key = $apiKey;
 
         return $this;
     }
 
     /**
-     * Get key.
+     * Get apiKey.
      *
      * @return string
      */
-    public function getKey()
+    public function getApiKey()
     {
-        return $this->key;
+        return $this->api_key;
     }
 
     /**
diff --git a/src/Repository/ApiKeyRepository.php b/src/Repository/ApiKeyRepository.php
@@ -33,12 +33,12 @@ public function generate(string $name): ApiKey
 
         do {
             $key = Str::random(64);
-        } while ($this->findBy(['key' => $key]));
+        } while ($this->findBy(['api_key' => $key]));
 
         $apiKey = new ApiKey();
         $apiKey
             ->setName($name)
-            ->setKey($key)
+            ->setApiKey($key)
             ->setCreatedAt(new DateTime())
             ->setIsActive(true)
             ->setStatusAt(new DateTime());
diff --git a/src/Service/ApiKeyService.php b/src/Service/ApiKeyService.php
@@ -42,7 +42,7 @@ public function init(EntityManager $entityManager): self|bool
     public function isActive(string $key): ApiKey|bool
     {
         $apiKey = $this->entityManager->getRepository(ApiKey::class)
-            ->findOneBy(['key' => $key]);
+            ->findOneBy(['api_key' => $key]);
 
         if (! $apiKey || ! $apiKey->getIsActive()) {
             return false;
@@ -54,7 +54,7 @@ public function isActive(string $key): ApiKey|bool
     public function hasScope(string $key, string $scopeName): bool
     {
         $apiKey = $this->entityManager->getRepository(ApiKey::class)
-            ->findOneBy(['key' => $key]);
+            ->findOneBy(['api_key' => $key]);
 
         $scope = $this->entityManager->getRepository(Scope::class)
             ->findOneBy(['name' => $scopeName]);
diff --git a/src/ServiceProvider.php b/src/ServiceProvider.php
@@ -4,7 +4,6 @@
 
 namespace ApiSkeletons\Laravel\Doctrine\ApiKey;
 
-use ApiSkeletons\Laravel\Doctrine\ApiKey\Http\Middleware\AuthorizeApiKey;
 use ApiSkeletons\Laravel\Doctrine\ApiKey\Service\ApiKeyService;
 use Illuminate\Support\ServiceProvider as LaravelServiceProvider;
 
diff --git a/test/Feature/Http/Middleware/AuthorizeApiKeyTest.php b/test/Feature/Http/Middleware/AuthorizeApiKeyTest.php
@@ -20,7 +20,7 @@ public function testApiKeyAuthorizesRequest(): void
         $entityManager->flush();
 
         $request = Request::create('/apiresource', 'GET');
-        $request->headers->set('Authorization', 'Bearer ' . $apiKey->getKey());
+        $request->headers->set('Authorization', 'Bearer ' . $apiKey->getApiKey());
 
         $middleware = new AuthorizeApiKey(app(ApiKeyService::class));
 
@@ -54,7 +54,7 @@ public function testApiKeyAuthorizesRequestWithScope(): void
         $entityManager->flush();
 
         $request = Request::create('/apiresource', 'GET');
-        $request->headers->set('Authorization', 'Bearer ' . $apiKey->getKey());
+        $request->headers->set('Authorization', 'Bearer ' . $apiKey->getApiKey());
 
         $middleware = new AuthorizeApiKey(app(ApiKeyService::class));
 
@@ -73,7 +73,7 @@ public function testApiKeyDoesNotAuthorizeRequestWithInvalidScope(): void
         $entityManager->flush();
 
         $request = Request::create('/apiresource', 'GET');
-        $request->headers->set('Authorization', 'Bearer ' . $apiKey->getKey());
+        $request->headers->set('Authorization', 'Bearer ' . $apiKey->getApiKey());
 
         $middleware = new AuthorizeApiKey(app(ApiKeyService::class));
 
diff --git a/test/Feature/Repository/ApiKeyRepositoryTest.php b/test/Feature/Repository/ApiKeyRepositoryTest.php
@@ -23,7 +23,7 @@ public function testGenerate(): void
 
         $this->assertGreaterThan(0, $apiKey->getId());
         $this->assertEquals('testing', $apiKey->getName());
-        $this->assertEquals(64, strlen($apiKey->getKey()));
+        $this->assertEquals(64, strlen($apiKey->getApiKey()));
         $this->assertEquals(true, $apiKey->getIsActive());
     }
 
diff --git a/test/Feature/Service/ApiKeyServiceTest.php b/test/Feature/Service/ApiKeyServiceTest.php
@@ -38,7 +38,7 @@ public function testIsActive(): void
         $apiKey = $apiKeyRepository->generate('testing');
         $entityManager->flush();
 
-        $apiKey = $apiKeyService->isActive($apiKey->getKey());
+        $apiKey = $apiKeyService->isActive($apiKey->getApiKey());
         $this->assertInstanceOf(ApiKey::class, $apiKey);
     }
 
@@ -68,7 +68,7 @@ public function testIsActiveReturnsFalseForInactiveKey(): void
         $apiKey = $apiKeyRepository->updateActive($apiKey, false);
         $entityManager->flush();
 
-        $this->assertFalse($apiKeyService->isActive($apiKey->getKey()));
+        $this->assertFalse($apiKeyService->isActive($apiKey->getApiKey()));
     }
 
     public function testHasScope(): void
@@ -87,7 +87,7 @@ public function testHasScope(): void
         $apiKeyRepository->addScope($apiKey, $scope);
         $entityManager->flush();
 
-        $this->assertTrue($apiKeyService->hasScope($apiKey->getKey(), 'scope1'));
+        $this->assertTrue($apiKeyService->hasScope($apiKey->getApiKey(), 'scope1'));
     }
 
     public function testHasScopeReturnsFalseForInvalidApiKey(): void
@@ -125,6 +125,6 @@ public function testHasScopeReturnsFalseForInvalidScope(): void
         $apiKeyRepository->addScope($apiKey, $scope);
         $entityManager->flush();
 
-        $this->assertFalse($apiKeyService->hasScope($apiKey->getKey(), 'scope2'));
+        $this->assertFalse($apiKeyService->hasScope($apiKey->getApiKey(), 'scope2'));
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ public function handle(): mixed`
`67`	`67`	`$rows = [`
`68`	`68`	`[`
`69`	`69`	`$apiKey->getName(),`
`70`		`- $apiKey->getKey(),`
	`70`	`+ $apiKey->getApiKey(),`
`71`	`71`	`$apiKey->getIsActive() ? 'active' : 'deactivated',`
`72`	`72`	`implode(',', $scopeNames),`
`73`	`73`	`],`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ public function handle(): mixed`
`84`	`84`	`$rows = [`
`85`	`85`	`[`
`86`	`86`	`$apiKey->getName(),`
`87`		`- $apiKey->getKey(),`
	`87`	`+ $apiKey->getApiKey(),`
`88`	`88`	`$apiKey->getIsActive() ? 'active' : 'deactivated',`
`89`	`89`	`implode(',', $scopeNames),`
`90`	`90`	`],`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ public function handle(): mixed`
`72`	`72`	`$rows = [`
`73`	`73`	`[`
`74`	`74`	`$apiKey->getName(),`
`75`		`- $apiKey->getKey(),`
	`75`	`+ $apiKey->getApiKey(),`
`76`	`76`	`$apiKey->getIsActive() ? 'active' : 'deactivated',`
`77`	`77`	`implode(',', $scopeNames),`
`78`	`78`	`],`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ public function handle(): mixed`
`64`	`64`	`$rows = [`
`65`	`65`	`[`
`66`	`66`	`$apiKey->getName(),`
`67`		`- $apiKey->getKey(),`
	`67`	`+ $apiKey->getApiKey(),`
`68`	`68`	`$apiKey->getIsActive() ? 'active' : 'deactivated',`
`69`	`69`	`implode(',', $scopeNames),`
`70`	`70`	`],`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ class ApiKey`
`15`	`15`	`/**`
`16`	`16`	`* @var string`
`17`	`17`	`*/`
`18`		`- private $key;`
	`18`	`+ private $api_key;`
`19`	`19`
`20`	`20`	`/**`
`21`	`21`	`* @var bool`
`@@ -87,27 +87,27 @@ public function getName()`
`87`	`87`	`}`
`88`	`88`
`89`	`89`	`/**`
`90`		`- * Set key.`
	`90`	`+ * Set apiKey.`
`91`	`91`	`*`
`92`		`- * @param string $key`
	`92`	`+ * @param string $apiKey`
`93`	`93`	`*`
`94`	`94`	`* @return ApiKey`
`95`	`95`	`*/`
`96`		`- public function setKey($key)`
	`96`	`+ public function setApiKey($apiKey)`
`97`	`97`	`{`
`98`		`- $this->key = $key;`
	`98`	`+ $this->api_key = $apiKey;`
`99`	`99`
`100`	`100`	`return $this;`
`101`	`101`	`}`
`102`	`102`
`103`	`103`	`/**`
`104`		`- * Get key.`
	`104`	`+ * Get apiKey.`
`105`	`105`	`*`
`106`	`106`	`* @return string`
`107`	`107`	`*/`
`108`		`- public function getKey()`
	`108`	`+ public function getApiKey()`
`109`	`109`	`{`
`110`		`- return $this->key;`
	`110`	`+ return $this->api_key;`
`111`	`111`	`}`
`112`	`112`
`113`	`113`	`/**`