Merge pull request #12 from TomHAnderson/feature/has-scope

Added hasScope() to ApiKey entity

Author: TomHAnderson

src/Entity/ApiKey.php

@@ -62,6 +62,21 @@ public function __construct()
         $this->scopes = new \Doctrine\Common\Collections\ArrayCollection();
     }
 
+    /**
+     * A convenience function to check if a scope is assigned to the apikey
+     * by name
+     */
+    public function hasScope(string $scopeName): bool
+    {
+        foreach ($this->getScopes() as $scope) {
+            if ($scope->getName() === $scopeName) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
     /**
      * Set name.
      *

test/Feature/Entity/ApiKeyTest.php

@@ -3,6 +3,7 @@
 namespace ApiSkeletonsTest\Laravel\Doctrine\ApiKey\Feature\Entity;
 
 use ApiSkeletons\Laravel\Doctrine\ApiKey\Entity\ApiKey;
+use ApiSkeletons\Laravel\Doctrine\ApiKey\Entity\Scope;
 use ApiSkeletons\Laravel\Doctrine\ApiKey\Http\Middleware\AuthorizeApiKey;
 use ApiSkeletons\Laravel\Doctrine\ApiKey\Service\ApiKeyService;
 use ApiSkeletonsTest\Laravel\Doctrine\ApiKey\TestCase;
@@ -60,4 +61,21 @@ public function testAccessEvent(): void
 
         $this->assertEquals(0, count($apiKey->getAccessEvents()));
     }
+
+    public function testHasScope(): void
+    {
+        $entityManager = $this->createDatabase(app('em'));
+        $apiKeyRepository = $entityManager->getRepository(ApiKey::class);
+        $scopeRepository = $entityManager->getRepository(Scope::class);
+
+        $apiKey = $apiKeyRepository->generate('testing');
+        $scope = $scopeRepository->generate('scopetest');
+        $entityManager->flush();
+
+        $apiKeyRepository->addScope($apiKey, $scope);
+        $entityManager->flush();
+
+        $this->assertTrue($apiKey->hasScope('scopetest'));
+        $this->assertFalse($apiKey->hasScope('fail'));
+    }
 }