# Analysis, API and Payment views

* refactors payment creation, editing and removing into class based views
* refactors analysis report methods into class based views
* drops unused method view on api app (token generating has been de facto moved into users app long time ago)

compensation/urls/payment.py

@@ -10,7 +10,7 @@ from compensation.views.payment import *
 
 app_name = "pay"
 urlpatterns = [
-    path('<id>/new', new_payment_view, name='new'),
-    path('<id>/remove/<payment_id>', payment_remove_view, name='remove'),
-    path('<id>/edit/<payment_id>', payment_edit_view, name='edit'),
+    path('<id>/new', NewPaymentView.as_view(), name='new'),
+    path('<id>/remove/<payment_id>', RemovePaymentView.as_view(), name='remove'),
+    path('<id>/edit/<payment_id>', EditPaymentView.as_view(), name='edit'),
 ]

compensation/views/payment.py

@@ -5,10 +5,12 @@ Contact: michel.peltriaux@sgdnord.rlp.de
 Created on: 09.08.21
 
 """
+from django.contrib.auth.mixins import LoginRequiredMixin
 from django.urls import reverse
-from django.contrib.auth.decorators import login_required
 from django.http import HttpRequest
 from django.shortcuts import get_object_or_404
+from django.utils.decorators import method_decorator
+from django.views import View
 
 from compensation.forms.modals.payment import NewPaymentForm, RemovePaymentModalForm, EditPaymentModalForm
 from compensation.models import Payment
@@ -17,72 +19,97 @@ from konova.decorators import default_group_required, shared_access_required
 from konova.utils.message_templates import PAYMENT_ADDED, PAYMENT_REMOVED, PAYMENT_EDITED
 
 
-@login_required
-@default_group_required
-@shared_access_required(Intervention, "id")
-def new_payment_view(request: HttpRequest, id: str):
-    """ Renders a modal view for adding new payments
+class NewPaymentView(LoginRequiredMixin, View):
 
-    Args:
-        request (HttpRequest): The incoming request
-        id (str): The intervention's id for which a new payment shall be added
+    def __process_request(self, request: HttpRequest, id: str):
+        """ Renders a modal view for adding new payments
 
-    Returns:
+        Args:
+            request (HttpRequest): The incoming request
+            id (str): The intervention's id for which a new payment shall be added
 
-    """
-    intervention = get_object_or_404(Intervention, id=id)
-    form = NewPaymentForm(request.POST or None, instance=intervention, request=request)
-    return form.process_request(
-        request,
-        msg_success=PAYMENT_ADDED,
-        redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data"
-    )
+        Returns:
+
+        """
+        intervention = get_object_or_404(Intervention, id=id)
+        form = NewPaymentForm(request.POST or None, instance=intervention, request=request)
+        return form.process_request(
+            request,
+            msg_success=PAYMENT_ADDED,
+            redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data"
+        )
+
+    @method_decorator(default_group_required)
+    @method_decorator(shared_access_required(Intervention, "id"))
+    def get(self, request: HttpRequest, id: str):
+        return self.__process_request(request, id=id)
+
+    @method_decorator(default_group_required)
+    @method_decorator(shared_access_required(Intervention, "id"))
+    def post(self, request: HttpRequest, id: str):
+        return self.__process_request(request, id=id)
 
 
-@login_required
-@default_group_required
-@shared_access_required(Intervention, "id")
-def payment_remove_view(request: HttpRequest, id: str, payment_id: str):
-    """ Renders a modal view for removing payments
+class RemovePaymentView(LoginRequiredMixin, View):
 
-    Args:
-        request (HttpRequest): The incoming request
-        id (str): The intervention's id
-        payment_id (str): The payment's id
+    def __process_request(self, request: HttpRequest, id: str, payment_id: str):
+        """ Renders a modal view for removing payments
 
-    Returns:
+        Args:
+            request (HttpRequest): The incoming request
+            id (str): The intervention's id
+            payment_id (str): The payment's id
 
-    """
-    intervention = get_object_or_404(Intervention, id=id)
-    payment = get_object_or_404(Payment, id=payment_id)
-    form = RemovePaymentModalForm(request.POST or None, instance=intervention, payment=payment, request=request)
-    return form.process_request(
-        request=request,
-        msg_success=PAYMENT_REMOVED,
-        redirect_url=reverse("intervention:detail", args=(payment.intervention_id,)) + "#related_data"
-    )
+        Returns:
+
+        """
+        intervention = get_object_or_404(Intervention, id=id)
+        payment = get_object_or_404(Payment, id=payment_id)
+        form = RemovePaymentModalForm(request.POST or None, instance=intervention, payment=payment, request=request)
+        return form.process_request(
+            request=request,
+            msg_success=PAYMENT_REMOVED,
+            redirect_url=reverse("intervention:detail", args=(payment.intervention_id,)) + "#related_data"
+        )
+
+    @method_decorator(default_group_required)
+    @method_decorator(shared_access_required(Intervention, "id"))
+    def get(self, request: HttpRequest, id: str, payment_id: str):
+        return self.__process_request(request, id=id, payment_id=payment_id)
+
+    @method_decorator(default_group_required)
+    @method_decorator(shared_access_required(Intervention, "id"))
+    def post(self, request: HttpRequest, id: str, payment_id: str):
+        return self.__process_request(request, id=id, payment_id=payment_id)
 
 
-@login_required
-@default_group_required
-@shared_access_required(Intervention, "id")
-def payment_edit_view(request: HttpRequest, id: str, payment_id: str):
-    """ Renders a modal view for editing payments
+class EditPaymentView(LoginRequiredMixin, View):
+    def __process_request(self, request: HttpRequest, id: str, payment_id: str):
+        """ Renders a modal view for editing payments
 
-    Args:
-        request (HttpRequest): The incoming request
-        id (str): The intervention's id
-        payment_id (str): The payment's id
+        Args:
+            request (HttpRequest): The incoming request
+            id (str): The intervention's id
+            payment_id (str): The payment's id
 
-    Returns:
+        Returns:
 
-    """
-    intervention = get_object_or_404(Intervention, id=id)
-    payment = get_object_or_404(Payment, id=payment_id)
-    form = EditPaymentModalForm(request.POST or None, instance=intervention, payment=payment, request=request)
-    return form.process_request(
-        request=request,
-        msg_success=PAYMENT_EDITED,
-        redirect_url=reverse("intervention:detail", args=(payment.intervention_id,)) + "#related_data"
-    )
+        """
+        intervention = get_object_or_404(Intervention, id=id)
+        payment = get_object_or_404(Payment, id=payment_id)
+        form = EditPaymentModalForm(request.POST or None, instance=intervention, payment=payment, request=request)
+        return form.process_request(
+            request=request,
+            msg_success=PAYMENT_EDITED,
+            redirect_url=reverse("intervention:detail", args=(payment.intervention_id,)) + "#related_data"
+        )
 
+    @method_decorator(default_group_required)
+    @method_decorator(shared_access_required(Intervention, "id"))
+    def get(self, request: HttpRequest, id: str, payment_id: str):
+        return self.__process_request(request, id=id, payment_id=payment_id)
+
+    @method_decorator(default_group_required)
+    @method_decorator(shared_access_required(Intervention, "id"))
+    def post(self, request: HttpRequest, id: str, payment_id: str):
+        return self.__process_request(request, id=id, payment_id=payment_id)