feat: add user to group endpoint

Signed-off-by: romanetar <roman_ag@hotmail.com>

Author: romanetar

app/Http/Controllers/Api/OAuth2/OAuth2GroupApiController.php

@@ -13,8 +13,12 @@
  **/
 
 use App\Http\Controllers\GetAllTrait;
+use App\Http\Controllers\Traits\RequestProcessor;
 use App\libs\Auth\Repositories\IGroupRepository;
 use App\ModelSerializers\SerializerRegistry;
+use App\Services\Auth\IGroupService;
+use Auth\Group;
+use Illuminate\Http\JsonResponse;
 use OAuth2\IResourceServerContext;
 use Utils\Services\ILogService;
 
@@ -26,21 +30,28 @@ final class OAuth2GroupApiController extends OAuth2ProtectedController
 {
     use GetAllTrait;
 
+    use RequestProcessor;
+
+    private IGroupService $service;
+
     /**
      * OAuth2UserApiController constructor.
      * @param IGroupRepository $repository
+     * @param IGroupService $service
      * @param IResourceServerContext $resource_server_context
      * @param ILogService $log_service
      */
     public function __construct
     (
         IGroupRepository $repository,
+        IGroupService $service,
         IResourceServerContext $resource_server_context,
         ILogService $log_service,
     )
     {
         parent::__construct($resource_server_context, $log_service);
         $this->repository = $repository;
+        $this->service = $service;
     }
 
     protected function getAllSerializerType(): string
@@ -76,4 +87,20 @@ public function getOrderRules(): array
             'slug'
         ];
     }
+
+    /**
+     * @param $group_id
+     * @param $user_id
+     * @return JsonResponse|mixed
+     */
+    public function addUserToGroup($group_id, $user_id): mixed
+    {
+        return $this->processRequest(function() use($group_id, $user_id) {
+            $group = $this->repository->getById(intval($group_id));
+            if (!$group instanceof Group)
+                return $this->error404();
+            $this->service->addUser2Group($group, intval($user_id));
+            return $this->updated();
+        });
+    }
 }

composer.json

@@ -89,6 +89,7 @@
       "Database\\Seeders\\": "database/seeders/"
     },
     "files": [
+      "app/Utils/helpers.php",
       "app/libs/Utils/Html/HtmlHelpers.php"
     ]
   },

database/migrations/Version20250805084926.php

@@ -0,0 +1,49 @@
+<?php namespace Database\Migrations;
+/**
+ * Copyright 2025 OpenStack Foundation
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ **/
+
+use Database\Seeders\SeedUtils;
+use Doctrine\Migrations\AbstractMigration;
+use Doctrine\DBAL\Schema\Schema as Schema;
+/**
+ * Class Version20250805084926
+ * @package Database\Migrations
+ */
+class Version20250805084926 extends AbstractMigration
+{
+    /**
+     * @param Schema $schema
+     */
+    public function up(Schema $schema):void
+    {
+        SeedUtils::seedApiEndpoints('groups', [
+            [
+                'name' => 'add-user-to-groups',
+                'active' => true,
+                'route' => '/api/v1/groups/{id}/users/{user_id}',
+                'http_method' => 'PUT',
+                'scopes' => [
+                    \App\libs\OAuth2\IGroupScopes::Write
+                ],
+            ],
+        ]);
+    }
+
+    /**
+     * @param Schema $schema
+     */
+    public function down(Schema $schema):void
+    {
+
+    }
+}

database/seeds/ApiEndpointSeeder.php

@@ -198,6 +198,15 @@ private function seedGroupEndpoints(){
                     \App\libs\OAuth2\IGroupScopes::ReadAll
                 ],
             ],
+            [
+                'name' => 'add-user-to-groups',
+                'active' => true,
+                'route' => '/api/v1/groups/{id}/users/{user_id}',
+                'http_method' => 'PUT',
+                'scopes' => [
+                    \App\libs\OAuth2\IGroupScopes::Write
+                ],
+            ],
         ]);
     }
 

routes/api.php

@@ -55,6 +55,13 @@
 
 Route::group(['prefix' => 'groups'], function () {
     Route::get('', 'OAuth2GroupApiController@getAll');
+    Route::group(array('prefix' => '{id}'), function () {
+        Route::group(['prefix' => 'users'], function () {
+            Route::group(['prefix' => '{user_id}'], function () {
+                Route::put('', 'OAuth2GroupApiController@addUserToGroup');
+            });
+        });
+    });
 });
 
 // 3rd Party SSO integrations

tests/OAuth2GroupApiTest.php

@@ -14,6 +14,9 @@
  **/
 
 use App\libs\OAuth2\IGroupScopes;
+use Auth\Group;
+use Auth\User;
+use LaravelDoctrine\ORM\Facades\EntityManager;
 use Tests\OAuth2ProtectedApiTestCase;
 
 /**
@@ -42,6 +45,36 @@ public function testGetAll(){
         $this->assertTrue($page->total > 0);
     }
 
+    public function testAddUserToGroup(){
+        $repo = EntityManager::getRepository(Group::class);
+        $group = $repo->getOneBySlug('sponsors-services');
+
+        $repo = EntityManager::getRepository(User::class);
+        $user = $repo->getAll()[0];
+
+        $params = [
+            'id' => $group->getId(),
+            'user_id' => $user->getId()
+        ];
+
+        $former_groups_count = count($user->getGroups());
+
+        $this->action(
+            "PUT",
+            "Api\\OAuth2\\OAuth2GroupApiController@addUserToGroup",
+            $params,
+            [],
+            [],
+            [],
+            array("HTTP_Authorization" => " Bearer " .$this->access_token));
+
+        $this->assertResponseStatus(201);
+
+        $user = $repo->getById($user->getId());
+        $this->assertNotNull($user);
+        $this->assertCount($former_groups_count + 1, $user->getGroups());
+    }
+
     protected function getScopes()
     {
         return [