Create Statement of Work after approving sponsorship + Send PDF document (python#1702)

* Model statement of work's information

* Auto increment revision no

* Automatically populate sponsor info and contact fields

* Refactor SponsorBenefit creation

* List benefits info

* Format legal clauses list

* Prevents from rejecting or accepting reviewd applications

* Display detailed sponsor's address information

* Fix f-string and change postal code order

* Implement use case to approve sponsorship

* Refactor use cases

* Model admin for statements of work

* Add link from approved sponsorship to draft SOW

* Replace sponsorships preview by SoW preview

* Black =]

* Add button to preview SoW from change form

* Move sponsor contact to sponsor info and display primary contact's email

* Approve method requires start/end date

* Accept use case now updates the sponsorship with more data

* Display form when reviewing sponsorship application

* Prevent sponsorship from being changed after approval/rejection

* Black =S

* Join markdowns so footnotes can work

* Remove unecessary trailing spaces

* Fix issue after rebase

* Respect db ordering to avoid tests inconsistencies

* Move admin views to a specific file

* Install django easy pdf

* Display SoW preview as PDF

* Move django-easy-pdf code to a specific module

* Refactor model's contants

* Create auxiliar function to render PDF document as bytes

* Add status control to Statement of Work model

* Rename exception

* Create function to save the final document version

* Add vscode dir to gitignore

* UC to send SoW

* Update notifications to use SoW instead of sponsorship obj

* Impleent view to send statement of work to users

* Refactor to use EmailMessage instead of send_mail shortcut

* Attach SoW PDF to emails

* Add button to send SoW

* Display an iframe with the PDF file before sending the document

* Shouldn't edit document fields if not a draft version

* Add administrative flag to sponsor's contact

* Enable rollback sponsorship to edit

* Admin view to rollback to edit

* Add button in sponsorship's change form

* Move rollback view to views_admin to respect internals structure

* Manage SoW before rolling back an application

* Minor lint warnings

* Add document summary content

* Style page to closer to the reference

* Add contract bullet items

* List benefits and legal clauses

* Do not display legal clauses section if nothing to list

* Create merge migration

* Remove element that was useful only for development

* Fix pdf tests

* Return 0 if sponsorship_fee is none None to avoid TypeError from num2words

* Replace description text

* Fix typo and add link

* Rename StatementOfWork model

* Update admin links

* Rename sow variables to contract

* Rename statement_of_work references

* Rename last statement references

* Move num2words requirement to base-requirements

* Create commmand to work as initial data migration

* Remove migration that doesn't work

* add missing configurations from python#1735

* Add logger to approve sponsorship use case

The logger is responsible to add a new entry in Django's LogEntry
to document the approval.

* Remove expired todos

* Add missing migration to replace SoW by Contract

* Legal clauses can be empty

* Also log actitivy when final contract is sent

* fix bad merge

* Store original program name on SponsorBenefit objects

* Benefits must always have a program

* Prevent from sending contract file to sponsor

* Implement logic to finalize contract and, thus, enable sponsorship benefits

* Implement operation to nullify a contract

Co-authored-by: Ernest W. Durbin III <[email protected]>
Co-authored-by: Ee Durbin <[email protected]>

Author: berinhard

.gitignore

@@ -17,3 +17,4 @@ static/stylesheets/no-mq.css
 static/stylesheets/style.css
 __pycache__
 *.db
+.vscode

base-requirements.txt

@@ -29,6 +29,7 @@ requests[security]>=2.20.0
 
 django-honeypot==0.6.0
 django-markupfield==1.4.3
+django-markupfield-helpers==0.1.1
 
 django-allauth==0.41.0
 
@@ -39,3 +40,6 @@ django-filter==1.1.0
 django-ordered-model==3.4.1
 django-widget-tweaks==1.4.8
 django-countries==6.1.3
+xhtml2pdf==0.2.5
+django-easy-pdf==0.1.1
+num2words==0.5.10

pydotorg/settings/base.py

@@ -156,6 +156,7 @@
     'ordered_model',
     'widget_tweaks',
     'django_countries',
+    'easy_pdf',
 
     'users',
     'boxes',

sponsors/admin.py

@@ -1,11 +1,9 @@
 from ordered_model.admin import OrderedModelAdmin
 
-from django.contrib import messages
-from django.urls import path, reverse
 from django.contrib import admin
 from django.contrib.humanize.templatetags.humanize import intcomma
+from django.urls import path
 from django.utils.html import mark_safe
-from django.shortcuts import get_object_or_404, render, redirect
 
 from .models import (
     SponsorshipPackage,
@@ -16,10 +14,10 @@
     SponsorContact,
     SponsorBenefit,
     LegalClause,
+    Contract,
 )
-from sponsors import use_cases
+from sponsors import views_admin
 from sponsors.forms import SponsorshipReviewAdminForm, SponsorBenefitAdminInlineForm
-from sponsors.exceptions import SponsorshipInvalidStatusException
 from cms.admin import ContentManageableModelAdmin
 
 
@@ -148,7 +146,6 @@ class SponsorshipAdmin(admin.ModelAdmin):
         "approved_on",
         "start_date",
         "end_date",
-        "display_sponsorship_link",
     ]
     list_filter = ["status", LevelNameFilter]
     readonly_fields = [
@@ -215,16 +212,36 @@ class SponsorshipAdmin(admin.ModelAdmin):
         ),
     ]
 
+    def get_readonly_fields(self, request, obj):
+        readonly_fields = [
+            "for_modified_package",
+            "sponsor",
+            "status",
+            "applied_on",
+            "rejected_on",
+            "approved_on",
+            "finalized_on",
+            "get_estimated_cost",
+            "get_sponsor_name",
+            "get_sponsor_description",
+            "get_sponsor_landing_page_url",
+            "get_sponsor_web_logo",
+            "get_sponsor_print_logo",
+            "get_sponsor_primary_phone",
+            "get_sponsor_mailing_address",
+            "get_sponsor_contacts",
+        ]
+
+        if obj and obj.status != Sponsorship.APPLIED:
+            extra = ["start_date", "end_date", "level_name", "sponsorship_fee"]
+            readonly_fields.extend(extra)
+
+        return readonly_fields
+
     def get_queryset(self, *args, **kwargs):
         qs = super().get_queryset(*args, **kwargs)
         return qs.select_related("sponsor")
 
-    def display_sponsorship_link(self, obj):
-        url = reverse("admin:sponsors_sponsorship_preview", args=[obj.pk])
-        return mark_safe(f'<a href="{url}" target="_blank">Click to preview</a>')
-
-    display_sponsorship_link.short_description = "Preview sponsorship"
-
     def get_estimated_cost(self, obj):
         cost = None
         html = "This sponsorship has not customizations so there's no estimated cost"
@@ -236,19 +253,9 @@ def get_estimated_cost(self, obj):
 
     get_estimated_cost.short_description = "Estimated cost"
 
-    def preview_sponsorship_view(self, request, pk):
-        sponsorship = get_object_or_404(self.get_queryset(request), pk=pk)
-        ctx = {"sponsorship": sponsorship}
-        return render(request, "sponsors/admin/preview-sponsorship.html", context=ctx)
-
     def get_urls(self):
         urls = super().get_urls()
         my_urls = [
-            path(
-                "<int:pk>/preview",
-                self.admin_site.admin_view(self.preview_sponsorship_view),
-                name="sponsors_sponsorship_preview",
-            ),
             path(
                 "<int:pk>/reject",
                 # TODO: maybe it would be better to create a specific
@@ -345,77 +352,157 @@ def get_sponsor_contacts(self, obj):
     get_sponsor_contacts.short_description = "Contacts"
 
     def rollback_to_editing_view(self, request, pk):
-        sponsorship = get_object_or_404(self.get_queryset(request), pk=pk)
-
-        if request.method.upper() == "POST" and request.POST.get("confirm") == "yes":
-            try:
-                sponsorship.rollback_to_editing()
-                sponsorship.save()
-                self.message_user(
-                    request, "Sponsorship is now editable!", messages.SUCCESS
-                )
-            except SponsorshipInvalidStatusException as e:
-                self.message_user(request, str(e), messages.ERROR)
+        return views_admin.rollback_to_editing_view(self, request, pk)
 
-            redirect_url = reverse(
-                "admin:sponsors_sponsorship_change", args=[sponsorship.pk]
-            )
-            return redirect(redirect_url)
+    def reject_sponsorship_view(self, request, pk):
+        return views_admin.reject_sponsorship_view(self, request, pk)
 
-        context = {"sponsorship": sponsorship}
-        return render(
-            request,
-            "sponsors/admin/rollback_sponsorship_to_editing.html",
-            context=context,
-        )
+    def approve_sponsorship_view(self, request, pk):
+        return views_admin.approve_sponsorship_view(self, request, pk)
 
-    def reject_sponsorship_view(self, request, pk):
-        sponsorship = get_object_or_404(self.get_queryset(request), pk=pk)
-
-        if request.method.upper() == "POST" and request.POST.get("confirm") == "yes":
-            try:
-                use_case = use_cases.RejectSponsorshipApplicationUseCase.build()
-                use_case.execute(sponsorship)
-                self.message_user(
-                    request, "Sponsorship was rejected!", messages.SUCCESS
-                )
-            except SponsorshipInvalidStatusException as e:
-                self.message_user(request, str(e), messages.ERROR)
 
-            redirect_url = reverse(
-                "admin:sponsors_sponsorship_change", args=[sponsorship.pk]
-            )
-            return redirect(redirect_url)
+@admin.register(LegalClause)
+class LegalClauseModelAdmin(OrderedModelAdmin):
+    list_display = ["internal_name"]
 
-        context = {"sponsorship": sponsorship}
-        return render(
-            request, "sponsors/admin/reject_application.html", context=context
-        )
 
-    def approve_sponsorship_view(self, request, pk):
-        sponsorship = get_object_or_404(self.get_queryset(request), pk=pk)
-
-        if request.method.upper() == "POST" and request.POST.get("confirm") == "yes":
-            try:
-                sponsorship.approve()
-                sponsorship.save()
-                self.message_user(
-                    request, "Sponsorship was approved!", messages.SUCCESS
+@admin.register(Contract)
+class ContractModelAdmin(admin.ModelAdmin):
+    change_form_template = "sponsors/admin/contract_change_form.html"
+    list_display = [
+        "id",
+        "sponsorship",
+        "created_on",
+        "last_update",
+        "status",
+        "get_revision",
+        "document_link",
+    ]
+
+    def get_queryset(self, *args, **kwargs):
+        qs = super().get_queryset(*args, **kwargs)
+        return qs.select_related("sponsorship__sponsor")
+
+    def get_revision(self, obj):
+        return obj.revision if obj.is_draft else "Final"
+
+    get_revision.short_description = "Revision"
+
+    fieldsets = [
+        (
+            "Info",
+            {
+                "fields": ("sponsorship", "status", "revision"),
+            },
+        ),
+        (
+            "Editable",
+            {
+                "fields": (
+                    "sponsor_info",
+                    "sponsor_contact",
+                    "benefits_list",
+                    "legal_clauses",
+                ),
+            },
+        ),
+        (
+            "Files",
+            {
+                "fields": (
+                    "document",
+                    "signed_document",
                 )
-            except SponsorshipInvalidStatusException as e:
-                self.message_user(request, str(e), messages.ERROR)
+            },
+        ),
+        (
+            "Activities log",
+            {
+                "fields": (
+                    "created_on",
+                    "last_update",
+                    "sent_on",
+                ),
+                "classes": ["collapse"],
+            },
+        ),
+    ]
 
-            redirect_url = reverse(
-                "admin:sponsors_sponsorship_change", args=[sponsorship.pk]
-            )
-            return redirect(redirect_url)
+    def get_readonly_fields(self, request, obj):
+        readonly_fields = [
+            "status",
+            "created_on",
+            "last_update",
+            "sent_on",
+            "sponsorship",
+            "revision",
+            "document",
+        ]
 
-        context = {"sponsorship": sponsorship}
-        return render(
-            request, "sponsors/admin/approve_application.html", context=context
-        )
+        if obj and not obj.is_draft:
+            extra = [
+                "sponsor_info",
+                "sponsor_contact",
+                "benefits_list",
+                "legal_clauses",
+            ]
+            readonly_fields.extend(extra)
+
+        return readonly_fields
+
+    def document_link(self, obj):
+        html, url, msg = "---", "", ""
+
+        if obj.is_draft:
+            url = obj.preview_url
+            msg = "Preview document"
+        elif obj.document:
+            url = obj.document.url
+            msg = "Download Contract"
+        elif obj.signed_document:
+            url = obj.signed_document.url
+            msg = "Download Signed Contract"
+
+        if url and msg:
+            html = f'<a href="{url}" target="_blank">{msg}</a>'
+        return mark_safe(html)
 
+    document_link.short_description = "Contract document"
 
-@admin.register(LegalClause)
-class LegalClauseModelAdmin(OrderedModelAdmin):
-    list_display = ["internal_name"]
+    def get_urls(self):
+        urls = super().get_urls()
+        my_urls = [
+            path(
+                "<int:pk>/preview",
+                self.admin_site.admin_view(self.preview_contract_view),
+                name="sponsors_contract_preview",
+            ),
+            path(
+                "<int:pk>/send",
+                self.admin_site.admin_view(self.send_contract_view),
+                name="sponsors_contract_send",
+            ),
+            path(
+                "<int:pk>/execute",
+                self.admin_site.admin_view(self.execute_contract_view),
+                name="sponsors_contract_execute",
+            ),
+            path(
+                "<int:pk>/nullify",
+                self.admin_site.admin_view(self.nullify_contract_view),
+                name="sponsors_contract_nullify",
+            ),
+        ]
+        return my_urls + urls
+
+    def preview_contract_view(self, request, pk):
+        return views_admin.preview_contract_view(self, request, pk)
+
+    def send_contract_view(self, request, pk):
+        return views_admin.send_contract_view(self, request, pk)
+
+    def execute_contract_view(self, request, pk):
+        return views_admin.execute_contract_view(self, request, pk)
+
+    def nullify_contract_view(self, request, pk):
+        return views_admin.nullify_contract_view(self, request, pk)

sponsors/exceptions.py

@@ -5,8 +5,15 @@ class SponsorWithExistingApplicationException(Exception):
     """
 
 
-class SponsorshipInvalidStatusException(Exception):
+class InvalidStatusException(Exception):
     """
     Raised when user tries to change the Sponsorship's status
     to a new one but from an invalid current status
     """
+
+
+class SponsorshipInvalidDateRangeException(Exception):
+    """
+    Raised when user tries to approve a sponsorship with a start date
+    greater than the end date.
+    """