[feature] Added REST API endpoints for Radius Groups #553

Closes #553

---------

Co-authored-by: Gagan Deep <pandafy.dev@gmail.com>
Co-authored-by: Federico Capoano <f.capoano@openwisp.io>

Author: 3 people

docs/user/rest-api.rst

@@ -871,3 +871,93 @@ users for a specific batch user creation operation. Example:
     curl -X GET \
         'http://127.0.0.1:8000/api/v1/radius/organization/default/batch/f4943c8a-462e-40ba-89b6-91a2541c9cf4/csv/' \
         -H 'Authorization: Bearer your-token-here'
+
+RADIUS Groups
++++++++++++++
+
+.. code-block:: text
+
+    /api/v1/radius/group/
+
+GET
+^^^
+
+This allows listing of RADIUS groups. It supports sorting by organization
+id and group name.
+
+.. code-block:: text
+
+    /api/v1/radius/group?search=<group_name>
+    /api/v1/radius/group?organization=<org_id>
+
+Filters
+"""""""
+
+================= ============================
+Filter Parameter  Description
+================= ============================
+search            Search groups by name
+organization      Filter organizations by id
+organization_slug Filter organizations by slug
+================= ============================
+
+Pagination
+""""""""""
+
+Pagination is provided using page number pagination, the default page size
+is 20, which can be overridden using the ``page_size`` parameter (maximum
+100).
+
+.. code-block:: text
+
+    {
+        "count": 42,
+        "next": "http://example.com/api/v1/radius/group/?page=2",
+        "previous": null,
+        "results": [...]
+    }
+
+POST
+^^^^
+
+Creates RADIUS Group.
+
+============ ====================
+Param        Description
+============ ====================
+name         Name of group
+organization Organization UUID
+description  Description of group
+============ ====================
+
+.. note::
+
+    The group name is automatically prefixed with the organization slug
+    when stored (for example: ``org-slug-Staff``).
+
+GET (detail)
+^^^^^^^^^^^^
+
+Returns a single RADIUS Group by its UUID.
+
+.. code-block:: text
+
+    /api/v1/radius/group/<uuid>
+
+PATCH
+^^^^^
+
+Partially updates a RADIUS group identified by its UUID.
+
+============ ====================
+Param        Description
+============ ====================
+name         Name of group
+organization Organization UUID
+description  Description of group
+============ ====================
+
+DELETE
+^^^^^^
+
+Deletes a RADIUS group identified by its UUID.

openwisp_radius/api/serializers.py

@@ -29,7 +29,9 @@
 from rest_framework.fields import empty
 
 from openwisp_radius.api.exceptions import CrossOrgRegistrationException
+from openwisp_users.api.mixins import FilterSerializerByOrgManaged
 from openwisp_users.backends import UsersAuthenticationBackend
+from openwisp_utils.api.serializers import ValidatedModelSerializer
 
 from .. import settings as app_settings
 from ..base.forms import PasswordResetForm
@@ -48,6 +50,7 @@
 RadiusPostAuth = load_model("RadiusPostAuth")
 RadiusAccounting = load_model("RadiusAccounting")
 RadiusBatch = load_model("RadiusBatch")
+RadiusGroup = load_model("RadiusGroup")
 RadiusToken = load_model("RadiusToken")
 RadiusGroupCheck = load_model("RadiusGroupCheck")
 RadiusUserGroup = load_model("RadiusUserGroup")
@@ -340,6 +343,28 @@ def to_representation(self, obj):
         return {"checks": checks_data}
 
 
+class RadiusGroupSerializer(FilterSerializerByOrgManaged, ValidatedModelSerializer):
+    class Meta:
+        model = RadiusGroup
+        fields = "__all__"
+        read_only_fields = ("created", "modified")
+
+    def validate(self, data):
+        """Validate and capture prefixed name from clean()."""
+        data = super().validate(data)
+        # For updates, ensure organization is in the data
+        if self.instance and "organization" not in data:
+            data["organization"] = self.instance.organization
+        # Only apply name prefixing if name is being changed or created
+        if "name" in data:
+            # Create a temporary instance to get the prefixed name
+            temp_instance = self.Meta.model(**data)
+            temp_instance.clean()
+            # Update data with the prefixed name
+            data["name"] = temp_instance.name
+        return data
+
+
 class GroupSerializer(serializers.ModelSerializer):
     class Meta:
         model = Group

openwisp_radius/api/urls.py

@@ -88,6 +88,16 @@ def get_api_urls(api_views=None):
                 api_views.radius_accounting,
                 name="radius_accounting_list",
             ),
+            path(
+                "radius/group/",
+                api_views.radius_group_list,
+                name="radius_group_list",
+            ),
+            path(
+                "radius/group/<uuid:pk>/",
+                api_views.radius_group_detail,
+                name="radius_group_detail",
+            ),
         ]
     else:
         return []

openwisp_radius/api/views.py

@@ -19,19 +19,24 @@
 from django.utils.translation import gettext_lazy as _
 from django.utils.translation.trans_real import get_language_from_request
 from django.views.decorators.csrf import csrf_exempt
+from django_filters import rest_framework as filters
 from django_filters.rest_framework import CharFilter, DjangoFilterBackend
 from drf_yasg.utils import no_body, swagger_auto_schema
 from rest_framework import serializers, status
 from rest_framework.authentication import SessionAuthentication
 from rest_framework.authtoken.models import Token as UserToken
 from rest_framework.authtoken.views import ObtainAuthToken as BaseObtainAuthToken
 from rest_framework.exceptions import NotFound, ParseError, PermissionDenied
+from rest_framework.filters import SearchFilter
 from rest_framework.generics import (
     CreateAPIView,
     GenericAPIView,
     ListAPIView,
+    ListCreateAPIView,
     RetrieveAPIView,
+    RetrieveUpdateDestroyAPIView,
 )
+from rest_framework.pagination import PageNumberPagination
 from rest_framework.permissions import (
     DjangoModelPermissions,
     IsAdminUser,
@@ -42,6 +47,7 @@
 
 from openwisp_radius.api.serializers import RadiusUserSerializer
 from openwisp_users.api.authentication import BearerAuthentication, SesameAuthentication
+from openwisp_users.api.filters import OrganizationManagedFilter
 from openwisp_users.api.mixins import FilterByOrganizationManaged, ProtectedAPIMixin
 from openwisp_users.api.permissions import IsOrganizationManager
 from openwisp_users.api.views import ChangePasswordView as BasePasswordChangeView
@@ -62,6 +68,7 @@
     ChangePhoneNumberSerializer,
     RadiusAccountingSerializer,
     RadiusBatchSerializer,
+    RadiusGroupSerializer,
     UserRadiusUsageSerializer,
     ValidatePhoneTokenSerializer,
 )
@@ -84,6 +91,7 @@
 RadiusToken = load_model("RadiusToken")
 RadiusBatch = load_model("RadiusBatch")
 RadiusUserGroup = load_model("RadiusUserGroup")
+RadiusGroup = load_model("RadiusGroup")
 RadiusGroupCheck = load_model("RadiusGroupCheck")
 auth_backend = UsersAuthenticationBackend()
 
@@ -847,3 +855,90 @@ class RadiusAccountingView(ProtectedAPIMixin, FilterByOrganizationManaged, ListA
 
 
 radius_accounting = RadiusAccountingView.as_view()
+
+
+class RadiusGroupFilter(OrganizationManagedFilter, filters.FilterSet):
+    """
+    Filter RADIUS groups by organizations managed by the user.
+    """
+
+    class Meta(OrganizationManagedFilter.Meta):
+        model = RadiusGroup
+
+
+class RadiusGroupPaginator(PageNumberPagination):
+    page_size = 20
+    page_size_query_param = "page_size"
+    max_page_size = 100
+
+
+@method_decorator(
+    name="get",
+    decorator=swagger_auto_schema(
+        operation_description="""
+        Returns a list of RADIUS groups for the organizations managed by the user.
+        """,
+    ),
+)
+@method_decorator(
+    name="post",
+    decorator=swagger_auto_schema(
+        operation_description="""
+        Creates a new RADIUS group for an organization managed by the user.
+        """,
+    ),
+)
+class RadiusGroupListView(
+    ProtectedAPIMixin, FilterByOrganizationManaged, ListCreateAPIView
+):
+    serializer_class = RadiusGroupSerializer
+    queryset = RadiusGroup.objects.order_by("name")
+    filterset_class = RadiusGroupFilter
+    filter_backends = [DjangoFilterBackend, SearchFilter]
+    search_fields = ["name"]
+    pagination_class = RadiusGroupPaginator
+
+
+radius_group_list = RadiusGroupListView.as_view()
+
+
+@method_decorator(
+    name="get",
+    decorator=swagger_auto_schema(
+        operation_description="""
+        Returns a single RADIUS group by its UUID.
+        """,
+    ),
+)
+@method_decorator(
+    name="put",
+    decorator=swagger_auto_schema(
+        operation_description="""
+        Updates a RADIUS group identified by its UUID.
+        """,
+    ),
+)
+@method_decorator(
+    name="patch",
+    decorator=swagger_auto_schema(
+        operation_description="""
+        Partially updates a RADIUS group identified by its UUID.
+        """,
+    ),
+)
+@method_decorator(
+    name="delete",
+    decorator=swagger_auto_schema(
+        operation_description="""
+        Deletes a RADIUS group identified by its UUID.
+        """,
+    ),
+)
+class RadiusGroupDetailView(
+    ProtectedAPIMixin, FilterByOrganizationManaged, RetrieveUpdateDestroyAPIView
+):
+    serializer_class = RadiusGroupSerializer
+    queryset = RadiusGroup.objects.order_by("name")
+
+
+radius_group_detail = RadiusGroupDetailView.as_view()