G2P-418 and G2P-432

gene2phenotype_project/gene2phenotype_app/serializers/__init__.py

@@ -2,7 +2,7 @@
 
 from .user import UserSerializer, LoginSerializer, CreateUserSerializer, AddUserToPanelSerializer, LogoutSerializer, ChangePasswordSerializer, VerifyEmailSerializer, PasswordResetSerializer
 
-from .panel import PanelDetailSerializer, LGDPanelSerializer
+from .panel import PanelCreateSerializer, PanelDetailSerializer, LGDPanelSerializer
 
 from .publication import PublicationSerializer, LGDPublicationSerializer, LGDPublicationListSerializer
 

gene2phenotype_project/gene2phenotype_app/serializers/panel.py

@@ -5,6 +5,86 @@
 
 from ..utils import get_date_now
 
+
+class PanelCreateSerializer(serializers.ModelSerializer):
+    """
+        Panel Creation Serializer
+
+        Args:
+            serializers (_type_): 
+                name - A required char field
+                description - An optional char field
+
+
+        Raises:
+            serializers.ValidationError: Raises a validation error when the panel exists
+
+        Returns:
+            _type_: A created panel
+    """    
+    name = serializers.CharField(required=True)
+    description = serializers.CharField(required=False)
+
+    def validate(self, attrs):
+        """
+            Validate the request data 
+
+            Args:
+                attrs (_type_): A dictionary like object containing the request data
+
+            Raises:
+                serializers.ValidationError: Raises a validation error when the panel exists
+
+            Returns:
+                _type_: A validated request object
+        """        
+        name = attrs.get('name')
+        if Panel.objects.filter(name=name).exists():
+            raise serializers.ValidationError({'message': 'Can not create an existing panel'})
+
+        return attrs
+
+    def create(self, validated_data):
+        """
+            Creation of the panel if panel does not exists
+            Updating the panel if is_visible = 0
+
+            Args:
+                validated_data (_type_): validated request object
+
+            Returns:
+                _type_: Created panel
+        """        
+        name = validated_data.get('name')
+        description = validated_data.get('description', '')
+
+        if Panel.objects.filter(name=name, is_visible=0).exists():
+            self.update(name)
+
+        panel = Panel.objects.create(name=name, description=description, is_visible=1)
+
+        return panel
+
+    def update(self, name):
+        """
+            Updating the panel if the panel is_visible = 0 
+
+            Args:
+                name (_type_): name of the panel 
+
+            Returns:
+                _type_: Updated panel
+        """        
+        panel = Panel.objects.get(name=name)
+        panel.is_visible = 1
+        panel.save()
+
+        return panel
+
+    class Meta:
+        model = Panel
+        fields = ['name', 'description']
+
 class PanelDetailSerializer(serializers.ModelSerializer):
     """
         Serializer for the Panel model.

gene2phenotype_project/gene2phenotype_app/serializers/user.py

@@ -230,10 +230,40 @@ class Meta:
                         }
 
 class AddUserToPanelSerializer(serializers.ModelSerializer):
+    """
+        Adds User to a Panel serializer 
+        Args:
+            serializers (_type_): 
+                user : Serializers CharField
+                panel : Serializers ListField that only accepts CharField and can not be empty
+
+        Raises:
+            serializers.ValidationError: If UserEmail is not sent in the request
+            serializers.ValidationError: If User does not exists
+            serializers.ValidationError: If Panel does not exists
+            serializers.ValidationError: If UserPanel already exists
+
+        Returns:
+            _type_: Created UserPanel or Updated UserPanel
+    """    
     user = serializers.CharField(write_only=True)
     panel = serializers.ListField(child=serializers.CharField(), allow_empty=False, write_only=True)
 
     def validate(self, attrs):
+        """
+            Validation step for the AddUserPanelSerializer
+
+            Args:
+                attrs (_type_): The request data that will be validated
+
+            Raises:
+                serializers.ValidationError: If UserEmail is not sent in the request
+                serializers.ValidationError: If User does not exists
+                serializers.ValidationError: If Panel does not exists
+
+            Returns:
+                _type_: Validated data
+        """        
         user = attrs.get('user', '')
         if user is None:
             raise serializers.ValidationError({'message': 'user email is required to add user to panel'})
@@ -251,6 +281,19 @@ def validate(self, attrs):
 
 
     def create(self, validated_data):
+        """
+            Creates the User panel, taking the User and a list of panels from validated data 
+            Also calls the update function if UserPanel already exists
+
+            Args:
+                validated_data (_type_): A dictionary object containing a list of panels and user_email
+
+            Raises:
+                serializers.ValidationError: If UserPanel already exists and it is not deleted 
+
+            Returns:
+                _type_: Created UserPanel
+        """        
         user_email = validated_data.get('user')
         panels = validated_data.get('panel')
 
@@ -259,7 +302,7 @@ def create(self, validated_data):
             panel_obj = Panel.objects.get(name=panel)
 
             if UserPanel.objects.filter(user=user_obj, panel=panel_obj, is_deleted=1).exists():
-                raise serializers.ValidationError({'message': f"User {user_email} used to exists in this {panel}, Update instead"})
+                self.update(user_obj, panel_obj)
 
             if not UserPanel.objects.filter(user=user_obj, panel=panel_obj, is_deleted=0).exists():
                 user_panel = UserPanel.objects.create(user=user_obj, panel=panel_obj, is_deleted=0)
@@ -268,6 +311,24 @@ def create(self, validated_data):
 
         return user_panel
 
+    def update(self, user, panel):
+        """
+            Updates the UserPanel, if UserPanel exists
+            Changes from is_deleted = 1 to is_deleted = 0
+
+            Args:
+                user (_type_): user object 
+                panel (_type_): Panel object
+
+        Returns:
+            _type_: The updated user panel
+        """        
+        user_panel = UserPanel.objects.get(user=user, panel=panel, is_deleted=1)
+        user_panel.is_deleted = 0
+        user_panel.save()
+
+        return user_panel
+
 
     class Meta:
         model = UserPanel

gene2phenotype_project/gene2phenotype_app/urls.py

@@ -81,5 +81,8 @@ def perform_create(self, serializer):
     path('logout/', views.LogOutView.as_view(), name='logout'),
     path('token/refresh/', views.CustomTokenRefreshView.as_view(), name='token_refresh'),
 
+    #panels management 
+    path("create/panel/", views.PanelCreateView.as_view(), name="panel_create")
+
 ]
 urlpatterns = format_suffix_patterns(urlpatterns)

gene2phenotype_project/gene2phenotype_app/views/__init__.py

@@ -1,6 +1,6 @@
 from .base import BaseView, BaseAdd, BaseUpdate, ListEndpoints
 
-from .panel import (PanelList, PanelDetail, PanelRecordsSummary, 
+from .panel import (PanelCreateView, PanelList, PanelDetail, PanelRecordsSummary, 
                     PanelDownload, LGDEditPanel)
 
 from .locus import LocusGene, LocusGeneSummary, GeneFunction

gene2phenotype_project/gene2phenotype_app/views/panel.py

@@ -15,10 +15,16 @@
                                        LGDPublication, LGDCrossCuttingModifier,
                                        LGDPanel, LGDComment)
 
-from gene2phenotype_app.serializers import PanelDetailSerializer, LGDPanelSerializer, UserSerializer
+from gene2phenotype_app.serializers import PanelCreateSerializer, PanelDetailSerializer, LGDPanelSerializer, UserSerializer
 
 from .base import BaseView, IsSuperUser, CustomPermissionAPIView
 
+class PanelCreateView(generics.CreateAPIView):
+    """ 
+        Panel Creation View 
+    """    
+    serializer_class = PanelCreateSerializer
+    permission_classes = [permissions.IsAdminUser]
 
 class PanelList(generics.ListAPIView):
     """
@@ -143,7 +149,7 @@ class LGDEditPanel(CustomPermissionAPIView):
     # Define specific permissions
     method_permissions = {
         "post": [permissions.IsAuthenticated],
-        "update": [permissions.IsAuthenticated, IsSuperUser],
+        "update": [IsSuperUser],
     }
 
     @transaction.atomic

gene2phenotype_project/gene2phenotype_app/views/user.py

@@ -104,6 +104,12 @@ class CreateUserView(generics.CreateAPIView):
     permission_classes = [permissions.IsAdminUser]
 
 class AddUserToPanelView(generics.CreateAPIView):
+    """
+        Add User to Panel view
+
+        Args:
+            generics (_type_): Adds User to panel, permissions is AdminUser, so views only available to AdminUser
+    """    
     serializer_class = AddUserToPanelSerializer
     permission_classes = [permissions.IsAdminUser]