Team Permissions Model

Author: zanbaldwin

README.md

@@ -113,7 +113,7 @@
          * [Validate incoming webhook payloads](#validate-incoming-webhook-payloads)
       * [License](#license)
 
-<!-- Added by: zanbaldwin, at: Thu 15 Sep 11:30:29 CEST 2022 -->
+<!-- Added by: zanbaldwin, at: Fri 16 Sep 09:48:23 CEST 2022 -->
 
 <!--te-->
 
@@ -161,6 +161,33 @@ Returns an array of created jobs. One for every synchronization.
 
 ### Team
 
+The permissions available for a team are:
+- `canEditTeamPackages`: members of the team can edit and remove packages, assign package permissions (only applies to packages assigned to team).
+- `canAddPackages`: members of the team can add packages to organization; add, edit and remove credentials and mirrored third-party repositories.
+- `canCreateSubrepositories`: members of the team can create subrepositories.
+- `canViewVendorCustomers`: members of the team can view customers, their Composer information, their packages, and their install statistics.
+- `canManageVendorCustomers`: members of the team can create and delete customers, add and remove packages, update their settings, view Composer information and install statistics.
+
+```php
+use PrivatePackagist\ApiClient\TeamPermissions;
+
+$permissions = new TeamPermissions;
+// Grant all permissions.
+$permissions->canEditTeamPackages = true;
+$permissions->canAddPackages = true;
+$permissions->canCreateSubrepositories = true;
+$permissions->canManageVendorCustomers = true;
+$permissions->canManageVendorCustomers = true;
+```
+
+The permissions model can also be constructed via flags:
+
+```php
+use PrivatePackagist\ApiClient\TeamPermissions;
+
+$permissions = TeamPermissions::fromFlags(TeamPermissions::PERMISSION_CAN_CREATE_SUBREPOSITORIES | TeamPermissions::PERMISSION_CAN_ADD_PACKAGES);
+```
+
 #### List an organization's teams
 ```php
 $teams = $client->teams()->all();
@@ -169,21 +196,19 @@ Returns an array of teams.
 
 #### Create a New Team
 ```php
-$team = $client->teams()->create('New Team Name', true, false, false, true, false);
-```
-Creates a team and sets permissions applied to team members. Those permissions are (in order):
-
-- `canEditTeamPackages`: members of the team can edit and remove packages, assign package permissions (only applies to packages assigned to team).
-- `canAddPackages`: members of the team can add packages to organization; add, edit and remove credentials and mirrored third-party repositories.
-- `canCreateSubrepositories`: members of the team can create subrepositories.
-- `canViewVendorCustomers`: members of the team can view customers, their Composer information, their packages, and their install statistics.
-- `canManageVendorCustomers`: members of the team can create and delete customers, add and remove packages, update their settings, view Composer information and install statistics.
+use PrivatePackagist\ApiClient\TeamPermissions;
 
-Returns the newly-created team.
+$permissions = new TeamPermissions;
+$team = $client->teams()->create('New Team Name', $permissions);
+```
+Creates a team and sets permissions applied to team members. Returns the newly-created team.
 
 #### Edit a Team
 ```php
-$team = $client->teams()->edit($teamId, 'Altered Team Name', true, false, false, true, false);
+use PrivatePackagist\ApiClient\TeamPermissions;
+
+$permissions = new TeamPermissions;
+$team = $client->teams()->edit($teamId, 'Altered Team Name', $permissions);
 ```
 Edits a team's name and permissions to be applied to team members. Returns the updated team.
 

src/Api/Teams.php

@@ -9,39 +9,41 @@
 
 namespace PrivatePackagist\ApiClient\Api;
 
+use PrivatePackagist\ApiClient\TeamPermissions;
+
 class Teams extends AbstractApi
 {
     public function all()
     {
         return $this->get('/teams/');
     }
 
-    public function create($name, $canEditTeamPackages = false, $canAddPackages = false, $canCreateSubrepositories = false, $canViewVendorCustomers = false, $canManageVendorCustomers = false)
+    public function create($name, TeamPermissions $permissions)
     {
         $parameters = [
             'name' => $name,
             'permissions' => [
-                'canEditTeamPackages' => $canEditTeamPackages,
-                'canAddPackages' => $canAddPackages,
-                'canCreateSubrepositories' => $canCreateSubrepositories,
-                'canViewVendorCustomers' => $canViewVendorCustomers,
-                'canManageVendorCustomers' => $canManageVendorCustomers,
+                'canEditTeamPackages' => (bool) $permissions->canEditTeamPackages,
+                'canAddPackages' => (bool) $permissions->canAddPackages,
+                'canCreateSubrepositories' => (bool) $permissions->canCreateSubrepositories,
+                'canViewVendorCustomers' => (bool) $permissions->canViewVendorCustomers,
+                'canManageVendorCustomers' => (bool) $permissions->canManageVendorCustomers,
             ],
         ];
 
         return $this->post('/teams/', $parameters);
     }
 
-    public function edit($teamId, $name, $canEditTeamPackages, $canAddPackages, $canCreateSubrepositories, $canViewVendorCustomers, $canManageVendorCustomers)
+    public function edit($teamId, $name, TeamPermissions $permissions)
     {
         $parameters = [
             'name' => $name,
             'permissions' => [
-                'canEditTeamPackages' => $canEditTeamPackages,
-                'canAddPackages' => $canAddPackages,
-                'canCreateSubrepositories' => $canCreateSubrepositories,
-                'canViewVendorCustomers' => $canViewVendorCustomers,
-                'canManageVendorCustomers' => $canManageVendorCustomers,
+                'canEditTeamPackages' => (bool) $permissions->canEditTeamPackages,
+                'canAddPackages' => (bool) $permissions->canAddPackages,
+                'canCreateSubrepositories' => (bool) $permissions->canCreateSubrepositories,
+                'canViewVendorCustomers' => (bool) $permissions->canViewVendorCustomers,
+                'canManageVendorCustomers' => (bool) $permissions->canManageVendorCustomers,
             ],
         ];
 

src/TeamPermissions.php

@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * (c) Packagist Conductors GmbH <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace PrivatePackagist\ApiClient;
+
+class TeamPermissions
+{
+    public const PERMISSION_CAN_EDIT_TEAM_PACKAGES = 1 << 0;
+    public const PERMISSION_CAN_ADD_PACKAGES = 1 << 1;
+    public const PERMISSION_CAN_CREATE_SUBREPOSITORIES = 1 << 2;
+    public const PERMISSION_CAN_VIEW_VENDOR_CUSTOMERS = 1 << 3;
+    public const PERMISSION_CAN_MANAGE_VENDOR_CUSTOMERS = 1 << 4;
+
+    /** @var bool */
+    public $canEditTeamPackages = false;
+    /** @var bool */
+    public $canAddPackages = false;
+    /** @var bool */
+    public $canCreateSubrepositories = false;
+    /** @var bool */
+    public $canViewVendorCustomers = false;
+    /** @var bool */
+    public $canManageVendorCustomers = false;
+
+    public static function fromFlags(int $flags): self
+    {
+        $permissions = new self;
+        $permissions->canEditTeamPackages = ($flags & self::PERMISSION_CAN_EDIT_TEAM_PACKAGES) > 0;
+        $permissions->canAddPackages = ($flags & self::PERMISSION_CAN_ADD_PACKAGES) > 0;
+        $permissions->canCreateSubrepositories = ($flags & self::PERMISSION_CAN_CREATE_SUBREPOSITORIES) > 0;
+        $permissions->canViewVendorCustomers = ($flags & self::PERMISSION_CAN_VIEW_VENDOR_CUSTOMERS) > 0;
+        $permissions->canManageVendorCustomers = ($flags & self::PERMISSION_CAN_MANAGE_VENDOR_CUSTOMERS) > 0;
+        return $permissions;
+    }
+}

tests/Api/TeamsTest.php

@@ -10,6 +10,7 @@
 namespace PrivatePackagist\ApiClient\Api;
 
 use PHPUnit\Framework\MockObject\MockObject;
+use PrivatePackagist\ApiClient\TeamPermissions;
 
 class TeamsTest extends ApiTestCase
 {
@@ -125,7 +126,10 @@ public function testCreateTeam()
             ]))
             ->willReturn($expected);
 
-        $this->assertSame($expected, $api->create('New Team', true, false, false, true, false));
+        $permissions = new TeamPermissions;
+        $permissions->canEditTeamPackages = true;
+        $permissions->canViewVendorCustomers = true;
+        $this->assertSame($expected, $api->create('New Team', $permissions));
     }
 
     public function testEditTeam()
@@ -160,7 +164,10 @@ public function testEditTeam()
             ]))
             ->willReturn($expected);
 
-        $this->assertSame($expected, $api->edit(123, 'New Team', true, false, false, true, false));
+        $permissions = new TeamPermissions;
+        $permissions->canEditTeamPackages = true;
+        $permissions->canViewVendorCustomers = true;
+        $this->assertSame($expected, $api->edit(123, 'New Team', $permissions));
     }
 
     public function testDeleteTeam()