ISSUE-345: admin privileges

tatevikg1 · tatevikg1 · commit fef9cfc5abd7 · 2025-06-13T20:31:35.000+04:00
diff --git a/src/Identity/OpenApi/SwaggerSchemasRequest.php b/src/Identity/OpenApi/SwaggerSchemasRequest.php
@@ -36,6 +36,18 @@
             type: 'boolean',
             example: false
         ),
+        new OA\Property(
+            property: 'privileges',
+            description: 'Array of privileges where keys are privilege names and values are booleans',
+            properties: [
+                new OA\Property(property: 'subscribers', type: 'boolean', example: true),
+                new OA\Property(property: 'campaigns', type: 'boolean', example: false),
+                new OA\Property(property: 'statistics', type: 'boolean', example: true),
+                new OA\Property(property: 'settings', type: 'boolean', example: false),
+            ],
+            type: 'object',
+            example: ['subscribers' => true, 'campaigns' => false, 'statistics' => true, 'settings' => false]
+        ),
     ],
     type: 'object'
 )]
@@ -68,6 +80,18 @@
             type: 'boolean',
             example: false
         ),
+        new OA\Property(
+            property: 'privileges',
+            description: 'Array of privileges where keys are privilege names and values are booleans',
+            properties: [
+                new OA\Property(property: 'subscribers', type: 'boolean', example: true),
+                new OA\Property(property: 'campaigns', type: 'boolean', example: false),
+                new OA\Property(property: 'statistics', type: 'boolean', example: true),
+                new OA\Property(property: 'settings', type: 'boolean', example: false),
+            ],
+            type: 'object',
+            example: ['subscribers' => true, 'campaigns' => false, 'statistics' => true, 'settings' => false]
+        ),
     ],
     type: 'object'
 )]
diff --git a/src/Identity/Request/CreateAdministratorRequest.php b/src/Identity/Request/CreateAdministratorRequest.php
@@ -6,6 +6,7 @@
 
 use PhpList\Core\Domain\Identity\Model\Administrator;
 use PhpList\Core\Domain\Identity\Model\Dto\CreateAdministratorDto;
+use PhpList\Core\Domain\Identity\Model\PrivilegeFlag;
 use PhpList\RestBundle\Common\Request\RequestInterface;
 use PhpList\RestBundle\Identity\Validator\Constraint\UniqueEmail;
 use PhpList\RestBundle\Identity\Validator\Constraint\UniqueLoginName;
@@ -31,13 +32,26 @@ class CreateAdministratorRequest implements RequestInterface
     #[Assert\Type('bool')]
     public bool $superUser = false;
 
+    /**
+     * Array of privileges where keys are privilege names (from PrivilegeFlag enum) and values are booleans.
+     * Example: ['subscribers' => true, 'campaigns' => false, 'statistics' => true, 'settings' => false]
+     */
+    #[Assert\Type('array')]
+    #[Assert\All([
+        'constraints' => [
+            new Assert\Type(['type' => 'bool']),
+        ],
+    ])]
+    public array $privileges = [];
+
     public function getDto(): CreateAdministratorDto
     {
         return new CreateAdministratorDto(
-            $this->loginName,
-            $this->password,
-            $this->email,
-            $this->superUser
+            loginName: $this->loginName,
+            password: $this->password,
+            email: $this->email,
+            isSuperUser: $this->superUser,
+            privileges: $this->privileges
         );
     }
 }
diff --git a/src/Identity/Request/UpdateAdministratorRequest.php b/src/Identity/Request/UpdateAdministratorRequest.php
@@ -6,6 +6,7 @@
 
 use PhpList\Core\Domain\Identity\Model\Administrator;
 use PhpList\Core\Domain\Identity\Model\Dto\UpdateAdministratorDto;
+use PhpList\Core\Domain\Identity\Model\PrivilegeFlag;
 use PhpList\RestBundle\Common\Request\RequestInterface;
 use PhpList\RestBundle\Identity\Validator\Constraint\UniqueEmail;
 use PhpList\RestBundle\Identity\Validator\Constraint\UniqueLoginName;
@@ -29,6 +30,18 @@ class UpdateAdministratorRequest implements RequestInterface
     #[Assert\Type('bool')]
     public ?bool $superAdmin = null;
 
+    /**
+     * Array of privileges where keys are privilege names (from PrivilegeFlag enum) and values are booleans.
+     * Example: ['subscribers' => true, 'campaigns' => false, 'statistics' => true, 'settings' => false]
+     */
+    #[Assert\Type('array')]
+    #[Assert\All([
+        'constraints' => [
+            new Assert\Type(['type' => 'bool']),
+        ],
+    ])]
+    public array $privileges = [];
+
     public function getDto(): UpdateAdministratorDto
     {
         return new UpdateAdministratorDto(
@@ -37,6 +50,7 @@ public function getDto(): UpdateAdministratorDto
             password: $this->password,
             email: $this->email,
             superAdmin: $this->superAdmin,
+            privileges: $this->privileges
         );
     }
 }
diff --git a/src/Identity/Serializer/AdministratorNormalizer.php b/src/Identity/Serializer/AdministratorNormalizer.php
@@ -26,6 +26,7 @@ public function normalize($object, string $format = null, array $context = []):
             'login_name' => $object->getLoginName(),
             'email' => $object->getEmail(),
             'super_admin' => $object->isSuperUser(),
+            'privileges' => $object->getPrivileges()->all(),
             'created_at' => $object->getCreatedAt()?->format(DateTimeInterface::ATOM),
         ];
     }
diff --git a/tests/Integration/Identity/Controller/AdministratorControllerTest.php b/tests/Integration/Identity/Controller/AdministratorControllerTest.php
@@ -60,11 +60,24 @@ public function testCreateAdministratorWithValidDataReturnsCreated(): void
             'loginName' => 'new.admin',
             'password' => 'NewPassword123!',
             'email' => 'new.admin@example.com',
+            'privileges' => [
+                'subscribers' => true,
+                'campaigns' => false,
+                'statistics' => true,
+                'settings' => false,
+            ],
         ]));
 
         $this->assertHttpCreated();
         $data = $this->getDecodedJsonResponseContent();
         self::assertSame('new.admin', $data['login_name']);
+
+        $administrator = $this->administratorRepository->findOneBy(['loginName' => 'new.admin']);
+        $privileges = $administrator->getPrivileges()->all();
+        self::assertTrue($privileges['subscribers']);
+        self::assertFalse($privileges['campaigns']);
+        self::assertTrue($privileges['statistics']);
+        self::assertFalse($privileges['settings']);
     }
 
     public function testUpdateAdministratorReturnsOk(): void
@@ -73,11 +86,24 @@ public function testUpdateAdministratorReturnsOk(): void
 
         $this->authenticatedJsonRequest('put', '/api/v2/administrators/1', [], [], [], json_encode([
             'email' => 'updated@example.com',
+            'privileges' => [
+                'subscribers' => false,
+                'campaigns' => true,
+                'statistics' => false,
+                'settings' => true,
+            ],
         ]));
 
         $this->assertHttpOkay();
         $data = $this->getDecodedJsonResponseContent();
         self::assertSame('updated@example.com', $data['email']);
+
+        $administrator = $this->administratorRepository->find(1);
+        $privileges = $administrator->getPrivileges()->all();
+        self::assertFalse($privileges['subscribers']);
+        self::assertTrue($privileges['campaigns']);
+        self::assertFalse($privileges['statistics']);
+        self::assertTrue($privileges['settings']);
     }
 
     public function testDeleteAdministratorReturnsNoContent(): void
@@ -116,4 +142,32 @@ public function testPutAdministratorWithInvalidIdReturns404(): void
 
         $this->assertHttpNotFound();
     }
+
+    public function testUpdateAdministratorPrivilegesOnly(): void
+    {
+        $this->loadFixtures([AdministratorFixture::class]);
+
+        $originalAdmin = $this->administratorRepository->find(1);
+        $originalEmail = $originalAdmin->getEmail();
+
+        $this->authenticatedJsonRequest('put', '/api/v2/administrators/1', [], [], [], json_encode([
+            'privileges' => [
+                'subscribers' => true,
+                'campaigns' => true,
+                'statistics' => true,
+                'settings' => true,
+            ],
+        ]));
+
+        $this->assertHttpOkay();
+
+        $updatedAdmin = $this->administratorRepository->find(1);
+        self::assertSame($originalEmail, $updatedAdmin->getEmail());
+
+        $privileges = $updatedAdmin->getPrivileges()->all();
+        self::assertTrue($privileges['subscribers']);
+        self::assertTrue($privileges['campaigns']);
+        self::assertTrue($privileges['statistics']);
+        self::assertTrue($privileges['settings']);
+    }
 }
diff --git a/tests/Unit/Identity/Request/CreateAdministratorRequestTest.php b/tests/Unit/Identity/Request/CreateAdministratorRequestTest.php
@@ -16,13 +16,25 @@ public function testGetDtoReturnsCorrectDto(): void
         $request->password = 'password123';
         $request->email = 'test@example.com';
         $request->superUser = true;
+        $request->privileges = [
+            'subscribers' => true,
+            'campaigns' => false,
+            'statistics' => true,
+            'settings' => false,
+        ];
 
         $dto = $request->getDto();
 
         $this->assertEquals('testuser', $dto->loginName);
         $this->assertEquals('password123', $dto->password);
         $this->assertEquals('test@example.com', $dto->email);
         $this->assertTrue($dto->isSuperUser);
+        $this->assertEquals([
+            'subscribers' => true,
+            'campaigns' => false,
+            'statistics' => true,
+            'settings' => false,
+        ], $dto->privileges);
     }
 
     public function testGetDtoWithDefaultSuperUserValue(): void
@@ -38,5 +50,6 @@ public function testGetDtoWithDefaultSuperUserValue(): void
         $this->assertEquals('password123', $dto->password);
         $this->assertEquals('test@example.com', $dto->email);
         $this->assertFalse($dto->isSuperUser);
+        $this->assertEquals([], $dto->privileges);
     }
 }
diff --git a/tests/Unit/Identity/Request/UpdateAdministratorRequestTest.php b/tests/Unit/Identity/Request/UpdateAdministratorRequestTest.php
@@ -18,6 +18,12 @@ public function testGetDtoReturnsCorrectDto(): void
         $request->password = 'password123';
         $request->email = 'test@example.com';
         $request->superAdmin = true;
+        $request->privileges = [
+            'subscribers' => true,
+            'campaigns' => false,
+            'statistics' => true,
+            'settings' => false,
+        ];
 
         $dto = $request->getDto();
 
@@ -26,6 +32,12 @@ public function testGetDtoReturnsCorrectDto(): void
         $this->assertEquals('password123', $dto->password);
         $this->assertEquals('test@example.com', $dto->email);
         $this->assertTrue($dto->superAdmin);
+        $this->assertEquals([
+            'subscribers' => true,
+            'campaigns' => false,
+            'statistics' => true,
+            'settings' => false,
+        ], $dto->privileges);
     }
 
     public function testGetDtoWithNullValues(): void
@@ -40,5 +52,6 @@ public function testGetDtoWithNullValues(): void
         $this->assertNull($dto->password);
         $this->assertNull($dto->email);
         $this->assertNull($dto->superAdmin);
+        $this->assertEquals([], $dto->privileges);
     }
 }
diff --git a/tests/Unit/Identity/Serializer/AdministratorNormalizerTest.php b/tests/Unit/Identity/Serializer/AdministratorNormalizerTest.php
@@ -7,6 +7,7 @@
 use DateTime;
 use InvalidArgumentException;
 use PhpList\Core\Domain\Identity\Model\Administrator;
+use PhpList\Core\Domain\Identity\Model\Privileges;
 use PhpList\RestBundle\Identity\Serializer\AdministratorNormalizer;
 use PHPUnit\Framework\TestCase;
 
@@ -20,6 +21,12 @@ public function testNormalizeValidAdministrator(): void
         $admin->method('getEmail')->willReturn('admin@example.com');
         $admin->method('isSuperUser')->willReturn(true);
         $admin->method('getCreatedAt')->willReturn(new DateTime('2024-01-01T10:00:00+00:00'));
+        $admin->method('getPrivileges')->willReturn(new Privileges([
+            'subscribers' => true,
+            'campaigns' => false,
+            'statistics' => true,
+            'settings' => false,
+        ]));
 
         $normalizer = new AdministratorNormalizer();
         $data = $normalizer->normalize($admin);
@@ -30,6 +37,12 @@ public function testNormalizeValidAdministrator(): void
             'login_name' => 'admin',
             'email' => 'admin@example.com',
             'super_admin' => true,
+            'privileges' => [
+                'subscribers' => true,
+                'campaigns' => false,
+                'statistics' => true,
+                'settings' => false,
+            ],
             'created_at' => '2024-01-01T10:00:00+00:00',
         ], $data);
     }

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ public function normalize($object, string $format = null, array $context = []):`
`26`	`26`	`'login_name' => $object->getLoginName(),`
`27`	`27`	`'email' => $object->getEmail(),`
`28`	`28`	`'super_admin' => $object->isSuperUser(),`
	`29`	`+ 'privileges' => $object->getPrivileges()->all(),`
`29`	`30`	`'created_at' => $object->getCreatedAt()?->format(DateTimeInterface::ATOM),`
`30`	`31`	`];`
`31`	`32`	`}`