Handle credits from the Société générale

apps/treasury/admin.py

@@ -3,7 +3,7 @@
 
 from django.contrib import admin
 
-from .models import RemittanceType, Remittance
+from .models import RemittanceType, Remittance, SogeCredit
 
 
 @admin.register(RemittanceType)
@@ -25,3 +25,6 @@ class RemittanceAdmin(admin.ModelAdmin):
         if not obj:
             return True
         return not obj.closed and super().has_change_permission(request, obj)
+
+
+admin.site.register(SogeCredit)

apps/treasury/api/serializers.py

@@ -4,7 +4,7 @@
 from rest_framework import serializers
 from note.api.serializers import SpecialTransactionSerializer
 
-from ..models import Invoice, Product, RemittanceType, Remittance
+from ..models import Invoice, Product, RemittanceType, Remittance, SogeCredit
 
 
 class ProductSerializer(serializers.ModelSerializer):
@@ -60,3 +60,14 @@ class RemittanceSerializer(serializers.ModelSerializer):
 
     def get_transactions(self, obj):
         return serializers.ListSerializer(child=SpecialTransactionSerializer()).to_representation(obj.transactions)
+
+
+class SogeCreditSerializer(serializers.ModelSerializer):
+    """
+    REST API Serializer for SogeCredit types.
+    The djangorestframework plugin will analyse the model `SogeCredit` and parse all fields in the API.
+    """
+
+    class Meta:
+        model = SogeCredit
+        fields = '__all__'

apps/treasury/api/urls.py

@@ -1,7 +1,7 @@
 # Copyright (C) 2018-2020 by BDE ENS Paris-Saclay
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-from .views import InvoiceViewSet, ProductViewSet, RemittanceViewSet, RemittanceTypeViewSet
+from .views import InvoiceViewSet, ProductViewSet, RemittanceViewSet, RemittanceTypeViewSet, SogeCreditViewSet
 
 
 def register_treasury_urls(router, path):
@@ -12,3 +12,4 @@ def register_treasury_urls(router, path):
     router.register(path + '/product', ProductViewSet)
     router.register(path + '/remittance_type', RemittanceTypeViewSet)
     router.register(path + '/remittance', RemittanceViewSet)
+    router.register(path + '/soge_credit', SogeCreditViewSet)

apps/treasury/api/views.py

@@ -5,8 +5,9 @@ from django_filters.rest_framework import DjangoFilterBackend
 from rest_framework.filters import SearchFilter
 from api.viewsets import ReadProtectedModelViewSet
 
-from .serializers import InvoiceSerializer, ProductSerializer, RemittanceTypeSerializer, RemittanceSerializer
-from ..models import Invoice, Product, RemittanceType, Remittance
+from .serializers import InvoiceSerializer, ProductSerializer, RemittanceTypeSerializer, RemittanceSerializer,\
+    SogeCreditSerializer
+from ..models import Invoice, Product, RemittanceType, Remittance, SogeCredit
 
 
 class InvoiceViewSet(ReadProtectedModelViewSet):
@@ -39,7 +40,7 @@ class RemittanceTypeViewSet(ReadProtectedModelViewSet):
     The djangorestframework plugin will get all `RemittanceType` objects, serialize it to JSON with the given serializer
     then render it on /api/treasury/remittance_type/
     """
-    queryset = RemittanceType.objects.all()
+    queryset = RemittanceType.objects
     serializer_class = RemittanceTypeSerializer
 
 
@@ -49,5 +50,15 @@ class RemittanceViewSet(ReadProtectedModelViewSet):
     The djangorestframework plugin will get all `Remittance` objects, serialize it to JSON with the given serializer,
     then render it on /api/treasury/remittance/
     """
-    queryset = Remittance.objects.all()
+    queryset = Remittance.objects
     serializer_class = RemittanceSerializer
+
+
+class SogeCreditViewSet(ReadProtectedModelViewSet):
+    """
+    REST API View set.
+    The djangorestframework plugin will get all `SogeCredit` objects, serialize it to JSON with the given serializer,
+    then render it on /api/treasury/soge_credit/
+    """
+    queryset = SogeCredit.objects
+    serializer_class = SogeCreditSerializer

apps/treasury/models.py

@@ -1,11 +1,13 @@
 # Copyright (C) 2018-2020 by BDE ENS Paris-Saclay
 # SPDX-License-Identifier: GPL-3.0-or-later
+from datetime import datetime
 
+from django.contrib.auth.models import User
 from django.core.exceptions import ValidationError
 from django.db import models
 from django.db.models import Q
 from django.utils.translation import gettext_lazy as _
-from note.models import NoteSpecial, SpecialTransaction
+from note.models import NoteSpecial, SpecialTransaction, MembershipTransaction
 
 
 class Invoice(models.Model):
@@ -207,3 +209,90 @@ class SpecialTransactionProxy(models.Model):
     class Meta:
         verbose_name = _("special transaction proxy")
         verbose_name_plural = _("special transaction proxies")
+
+
+class SogeCredit(models.Model):
+    """
+    Manage the credits from the Société générale.
+    """
+    user = models.OneToOneField(
+        User,
+        on_delete=models.PROTECT,
+        verbose_name=_("user"),
+    )
+
+    transactions = models.ManyToManyField(
+        MembershipTransaction,
+        related_name="+",
+        verbose_name=_("membership transactions"),
+    )
+
+    credit_transaction = models.OneToOneField(
+        SpecialTransaction,
+        on_delete=models.SET_NULL,
+        verbose_name=_("credit transaction"),
+        null=True,
+    )
+
+    @property
+    def valid(self):
+        return self.credit_transaction is not None
+
+    @property
+    def amount(self):
+        return sum(transaction.quantity * transaction.amount for transaction in self.transactions.all())
+
+    def invalidate(self):
+        """
+        Invalidating a Société générale delete the transaction of the bank if it was already created.
+        Treasurers must know what they do, With Great Power Comes Great Responsibility...
+        """
+        if self.valid:
+            self.credit_transaction.valid = False
+            self.credit_transaction.save()
+            self.credit_transaction.delete()
+        self.credit_transaction = None
+        for transaction in self.transactions.all():
+            transaction.valid = False
+            transaction.save()
+
+    def validate(self, force=False):
+        if self.valid and not force:
+            # The credit is already done
+            return
+
+        # First invalidate all transaction and delete the credit if already did (and force mode)
+        self.invalidate()
+        self.credit_transaction = SpecialTransaction.objects.create(
+            source=NoteSpecial.objects.get(special_type="Virement bancaire"),
+            destination=self.user.note,
+            quantity=1,
+            amount=self.amount,
+            reason="Crédit société générale",
+            last_name=self.user.last_name,
+            first_name=self.user.first_name,
+            bank="Société générale",
+        )
+        self.save()
+
+        for transaction in self.transactions.all():
+            transaction.valid = True
+            transaction.created_at = datetime.now()
+            transaction.save()
+
+    def delete(self, **kwargs):
+        """
+        Deleting a SogeCredit is equivalent to say that the Société générale didn't pay.
+        Treasurers must know what they do, this is difficult to undo this operation.
+        With Great Power Comes Great Responsibility...
+        """
+        self.invalidate()
+        for transaction in self.transactions.all():
+            transaction.valid = True
+            transaction.created_at = datetime.now()
+            transaction.save()
+        super().delete(**kwargs)
+
+    class Meta:
+        verbose_name = _("Credit from the Société générale")
+        verbose_name_plural = _("Credits from the Société générale")

apps/treasury/tables.py

@@ -7,7 +7,7 @@ from django_tables2 import A
 from note.models import SpecialTransaction
 from note.templatetags.pretty_money import pretty_money
 
-from .models import Invoice, Remittance
+from .models import Invoice, Remittance, SogeCredit
 
 
 class InvoiceTable(tables.Table):
@@ -101,3 +101,28 @@ class SpecialTransactionTable(tables.Table):
         model = SpecialTransaction
         template_name = 'django_tables2/bootstrap4.html'
         fields = ('id', 'source', 'destination', 'last_name', 'first_name', 'bank', 'amount', 'reason',)
+
+
+class SogeCreditTable(tables.Table):
+    user = tables.LinkColumn(
+        'treasury:manage_soge_credit',
+        args=[A('pk')],
+    )
+
+    amount = tables.Column(
+        verbose_name=_("Amount"),
+    )
+
+    valid = tables.Column(
+        verbose_name=_("Valid"),
+    )
+
+    def render_amount(self, value):
+        return pretty_money(value)
+
+    def render_valid(self, value):
+        return _("Yes") if value else _("No")
+
+    class Meta:
+        model = SogeCredit
+        fields = ('user', 'amount', 'valid', )

apps/treasury/urls.py

@@ -4,7 +4,8 @@
 from django.urls import path
 
 from .views import InvoiceCreateView, InvoiceListView, InvoiceUpdateView, InvoiceRenderView, RemittanceListView,\
-    RemittanceCreateView, RemittanceUpdateView, LinkTransactionToRemittanceView, UnlinkTransactionToRemittanceView
+    RemittanceCreateView, RemittanceUpdateView, LinkTransactionToRemittanceView, UnlinkTransactionToRemittanceView,\
+    SogeCreditListView, SogeCreditManageView
 
 app_name = 'treasury'
 urlpatterns = [
@@ -21,4 +22,7 @@ urlpatterns = [
     path('remittance/link_transaction/<int:pk>/', LinkTransactionToRemittanceView.as_view(), name='link_transaction'),
     path('remittance/unlink_transaction/<int:pk>/', UnlinkTransactionToRemittanceView.as_view(),
          name='unlink_transaction'),
+
+    path('soge-credits/list/', SogeCreditListView.as_view(), name='soge_credits'),
+    path('soge-credits/manage/<int:pk>/', SogeCreditManageView.as_view(), name='manage_soge_credit'),
 ]

apps/treasury/views.py

@@ -10,21 +10,23 @@ from crispy_forms.helper import FormHelper
 from django.contrib.auth.mixins import LoginRequiredMixin
 from django.core.exceptions import ValidationError
 from django.db.models import Q
+from django.forms import Form
 from django.http import HttpResponse
 from django.shortcuts import redirect
 from django.template.loader import render_to_string
 from django.urls import reverse_lazy
-from django.views.generic import CreateView, UpdateView
+from django.views.generic import CreateView, UpdateView, DetailView
 from django.views.generic.base import View, TemplateView
+from django.views.generic.edit import BaseFormView
 from django_tables2 import SingleTableView
-from note.models import SpecialTransaction, NoteSpecial
+from note.models import SpecialTransaction, NoteSpecial, Alias
 from note_kfet.settings.base import BASE_DIR
 from permission.backends import PermissionBackend
 from permission.views import ProtectQuerysetMixin
 
 from .forms import InvoiceForm, ProductFormSet, ProductFormSetHelper, RemittanceForm, LinkTransactionToRemittanceForm
-from .models import Invoice, Product, Remittance, SpecialTransactionProxy
-from .tables import InvoiceTable, RemittanceTable, SpecialTransactionTable
+from .models import Invoice, Product, Remittance, SpecialTransactionProxy, SogeCredit
+from .tables import InvoiceTable, RemittanceTable, SpecialTransactionTable, SogeCreditTable
 
 
 class InvoiceCreateView(ProtectQuerysetMixin, LoginRequiredMixin, CreateView):
@@ -307,3 +309,61 @@ class UnlinkTransactionToRemittanceView(LoginRequiredMixin, View):
         transaction.save()
 
         return redirect('treasury:remittance_list')
+
+
+class SogeCreditListView(LoginRequiredMixin, ProtectQuerysetMixin, SingleTableView):
+    """
+    List all Société Générale credits
+    """
+    model = SogeCredit
+    table_class = SogeCreditTable
+
+    def get_queryset(self, **kwargs):
+        """
+        Filter the table with the given parameter.
+        :param kwargs:
+        :return:
+        """
+        qs = super().get_queryset()
+        if "search" in self.request.GET:
+            pattern = self.request.GET["search"]
+
+            if not pattern:
+                return qs.none()
+
+            qs = qs.filter(
+                Q(user__first_name__iregex=pattern)
+                | Q(user__last_name__iregex=pattern)
+                | Q(user__note__alias__name__iregex="^" + pattern)
+                | Q(user__note__alias__normalized_name__iregex="^" + Alias.normalize(pattern))
+            )
+        else:
+            qs = qs.none()
+
+        if "valid" in self.request.GET:
+            q = Q(credit_transaction=None)
+            if not self.request.GET["valid"]:
+                q = ~q
+            qs = qs.filter(q)
+
+        return qs[:20]
+
+
+class SogeCreditManageView(LoginRequiredMixin, ProtectQuerysetMixin, BaseFormView, DetailView):
+    """
+    Manage credits from the Société générale.
+    """
+    model = SogeCredit
+    form_class = Form
+
+    def form_valid(self, form):
+        if "validate" in form.data:
+            self.get_object().validate(True)
+        elif "delete" in form.data:
+            self.get_object().delete()
+        return super().form_valid(form)
+
+    def get_success_url(self):
+        if "validate" in self.request.POST:
+            return reverse_lazy('treasury:manage_soge_credit', args=(self.get_object().pk,))
+        return reverse_lazy('treasury:soge_credits')