mirrors/shlink
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2024-11-24 05:38:06 +03:00
Code Issues Projects Releases Packages Wiki Activity

Applied API role specs to domains list

Browse source
This commit is contained in:
Alejandro Celaya 2021-01-04 15:55:59 +01:00
parent 262a06f624
commit 19834f6715
9 changed files with 40 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
module/Core/src/Domain/DomainService.php
View file

@ -8,6 +8,8 @@ use Doctrine\ORM\EntityManagerInterface;
use Shlinkio\Shlink\Core\Domain\Model\DomainItem;
use Shlinkio\Shlink\Core\Domain\Repository\DomainRepositoryInterface;
use Shlinkio\Shlink\Core\Entity\Domain;
use Shlinkio\Shlink\Rest\ApiKey\Role;
use Shlinkio\Shlink\Rest\Entity\ApiKey;
use function Functional\map;
@ -25,15 +27,20 @@ class DomainService implements DomainServiceInterface
/**
* @return DomainItem[]
*/
public function listDomains(): array
public function listDomains(?ApiKey $apiKey = null): array
{
/** @var DomainRepositoryInterface $repo */
$repo = $this->em->getRepository(Domain::class);
$domains = $repo->findDomainsWithout($this->defaultDomain);
$domains = $repo->findDomainsWithout($this->defaultDomain, $apiKey);
$mappedDomains = map($domains, fn (Domain $domain) => new DomainItem($domain->getAuthority(), false));
if ($apiKey !== null && $apiKey->hasRole(Role::DOMAIN_SPECIFIC)) {
return $mappedDomains;
}
return [
new DomainItem($this->defaultDomain, true),
...map($domains, fn (Domain $domain) => new DomainItem($domain->getAuthority(), false)),
...$mappedDomains,
];
}
}

3
module/Core/src/Domain/DomainServiceInterface.php
View file

@ -5,11 +5,12 @@ declare(strict_types=1);
namespace Shlinkio\Shlink\Core\Domain;
use Shlinkio\Shlink\Core\Domain\Model\DomainItem;
use Shlinkio\Shlink\Rest\Entity\ApiKey;
interface DomainServiceInterface
{
/**
* @return DomainItem[]
*/
public function listDomains(): array;
public function listDomains(?ApiKey $apiKey = null): array;
}

11
module/Core/src/Domain/Repository/DomainRepository.php
View file

@ -4,17 +4,18 @@ declare(strict_types=1);
namespace Shlinkio\Shlink\Core\Domain\Repository;
use Doctrine\ORM\EntityRepository;
use Doctrine\ORM\Query\Expr\Join;
use Happyr\DoctrineSpecification\EntitySpecificationRepository;
use Shlinkio\Shlink\Core\Entity\Domain;
use Shlinkio\Shlink\Core\Entity\ShortUrl;
use Shlinkio\Shlink\Rest\Entity\ApiKey;
class DomainRepository extends EntityRepository implements DomainRepositoryInterface
class DomainRepository extends EntitySpecificationRepository implements DomainRepositoryInterface
{
/**
* @return Domain[]
*/
public function findDomainsWithout(?string $excludedAuthority = null): array
public function findDomainsWithout(?string $excludedAuthority, ?ApiKey $apiKey = null): array
{
$qb = $this->createQueryBuilder('d');
$qb->join(ShortUrl::class, 's', Join::WITH, 's.domain = d')
@ -25,6 +26,10 @@ class DomainRepository extends EntityRepository implements DomainRepositoryInter
->setParameter('excludedAuthority', $excludedAuthority);
}
if ($apiKey !== null) {
$this->applySpecification($qb, $apiKey->spec(), 's');
}
return $qb->getQuery()->getResult();
}
}

6
module/Core/src/Domain/Repository/DomainRepositoryInterface.php
View file

@ -5,12 +5,14 @@ declare(strict_types=1);
namespace Shlinkio\Shlink\Core\Domain\Repository;
use Doctrine\Persistence\ObjectRepository;
use Happyr\DoctrineSpecification\EntitySpecificationRepositoryInterface;
use Shlinkio\Shlink\Core\Entity\Domain;
use Shlinkio\Shlink\Rest\Entity\ApiKey;
interface DomainRepositoryInterface extends ObjectRepository
interface DomainRepositoryInterface extends ObjectRepository, EntitySpecificationRepositoryInterface
{
/**
* @return Domain[]
*/
public function findDomainsWithout(?string $excludedAuthority = null): array;
public function findDomainsWithout(?string $excludedAuthority, ?ApiKey $apiKey = null): array;
}

2
module/Core/test-db/Domain/Repository/DomainRepositoryTest.php
View file

@ -46,7 +46,7 @@ class DomainRepositoryTest extends DatabaseTestCase
$this->getEntityManager()->flush();
self::assertEquals([$barDomain, $bazDomain, $fooDomain], $this->repo->findDomainsWithout());
self::assertEquals([$barDomain, $bazDomain, $fooDomain], $this->repo->findDomainsWithout(null));
self::assertEquals([$barDomain, $bazDomain], $this->repo->findDomainsWithout('foo.com'));
self::assertEquals([$bazDomain, $fooDomain], $this->repo->findDomainsWithout('bar.com'));
self::assertEquals([$barDomain, $fooDomain], $this->repo->findDomainsWithout('baz.com'));

2
module/Core/test/Domain/DomainServiceTest.php
View file

@ -34,7 +34,7 @@ class DomainServiceTest extends TestCase
{
$repo = $this->prophesize(DomainRepositoryInterface::class);
$getRepo = $this->em->getRepository(Domain::class)->willReturn($repo->reveal());
$findDomains = $repo->findDomainsWithout('default.com')->willReturn($domains);
$findDomains = $repo->findDomainsWithout('default.com', null)->willReturn($domains);
$result = $this->domainService->listDomains();

4
module/Rest/src/Action/Domain/ListDomainsAction.php
View file

@ -9,6 +9,7 @@ use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Shlinkio\Shlink\Core\Domain\DomainServiceInterface;
use Shlinkio\Shlink\Rest\Action\AbstractRestAction;
use Shlinkio\Shlink\Rest\Middleware\AuthenticationMiddleware;
class ListDomainsAction extends AbstractRestAction
{
@ -24,7 +25,8 @@ class ListDomainsAction extends AbstractRestAction
public function handle(ServerRequestInterface $request): ResponseInterface
{
$domainItems = $this->domainService->listDomains();
$apiKey = AuthenticationMiddleware::apiKeyFromRequest($request);
$domainItems = $this->domainService->listDomains($apiKey);
return new JsonResponse([
'domains' => [

7
module/Rest/src/Entity/ApiKey.php
View file

@ -76,6 +76,11 @@ class ApiKey extends AbstractEntity
public function isAdmin(): bool
{
return $this->roles->count() === 0;
return $this->roles->isEmpty();
}
public function hasRole(string $roleName): bool
{
return $this->roles->exists(fn ($key, ApiKeyRole $role) => $role->name() === $roleName);
}
}

8
module/Rest/test/Action/Domain/ListDomainsActionTest.php
View file

@ -12,6 +12,7 @@ use Prophecy\Prophecy\ObjectProphecy;
use Shlinkio\Shlink\Core\Domain\DomainServiceInterface;
use Shlinkio\Shlink\Core\Domain\Model\DomainItem;
use Shlinkio\Shlink\Rest\Action\Domain\ListDomainsAction;
use Shlinkio\Shlink\Rest\Entity\ApiKey;
class ListDomainsActionTest extends TestCase
{
@ -23,20 +24,21 @@ class ListDomainsActionTest extends TestCase
public function setUp(): void
{
$this->domainService = $this->prophesize(DomainServiceInterface::class);
$this->action = new ListDomainsAction($this->domainService->reveal(), 'foo.com');
$this->action = new ListDomainsAction($this->domainService->reveal());
}
/** @test */
public function domainsAreProperlyListed(): void
{
$apiKey = new ApiKey();
$domains = [
new DomainItem('bar.com', true),
new DomainItem('baz.com', false),
];
$listDomains = $this->domainService->listDomains()->willReturn($domains);
$listDomains = $this->domainService->listDomains($apiKey)->willReturn($domains);
/** @var JsonResponse $resp */
$resp = $this->action->handle(ServerRequestFactory::fromGlobals());
$resp = $this->action->handle(ServerRequestFactory::fromGlobals()->withAttribute(ApiKey::class, $apiKey));
$payload = $resp->getPayload();
self::assertEquals([