Adding google sheets deferrals library (#1604)

app.json

@@ -203,6 +203,34 @@
       "description": "The name of the timezone that should be assumed for date/time values in spreadsheets. Choose from a value in the TZ database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
       "required": false
     },
+    "MITOL_GOOGLE_SHEETS_DEFERRALS_COMPLETED_DATE_COL": {
+      "description": "The zero-based index of the enrollment change sheet column that contains the row completion date",
+      "required": false
+    },
+    "MITOL_GOOGLE_SHEETS_DEFERRALS_ERROR_COL": {
+      "description": "The zero-based index of the enrollment change sheet column that contains row processing error messages",
+      "required": false
+    },
+    "MITOL_GOOGLE_SHEETS_DEFERRALS_FIRST_ROW": {
+      "description": "The first row (as it appears in the spreadsheet) of data that our scripts should consider processing in the deferral request spreadsheet",
+      "required": false
+    },
+    "MITOL_GOOGLE_SHEETS_DEFERRALS_PLUGINS": {
+      "description": "The path to your deferral plugin, example: app.plugins.DeferralPlugin",
+      "required": false
+    },
+    "MITOL_GOOGLE_SHEETS_DEFERRALS_PROCESSOR_COL": {
+      "description": "The zero-based index of the enrollment change sheet column that contains the user that processed the row",
+      "required": false
+    },
+    "MITOL_GOOGLE_SHEETS_DEFERRALS_REQUEST_WORKSHEET_ID": {
+      "description": "ID of the worksheet within the enrollment change request spreadsheet that contains enrollment deferral requests",
+      "required": false
+    },
+    "MITOL_GOOGLE_SHEETS_DEFERRALS_SKIP_ROW_COL": {
+      "description": "The zero-based index of the enrollment change sheet column that indicates whether the row should be skipped",
+      "required": false
+    },
     "MITOL_GOOGLE_SHEETS_DRIVE_API_PROJECT_ID": {
       "description": "ID for the Google API project where the credentials were created",
       "required": false
@@ -551,4 +579,4 @@
   },
   "success_url": "/",
   "website": "https://github.com/mitodl/mitx-online"
-}
+}

main/settings.py

@@ -22,6 +22,7 @@
 )
 from mitol.google_sheets.settings.google_sheets import *
 from mitol.google_sheets_refunds.settings.google_sheets_refunds import *
+from mitol.google_sheets_deferrals.settings.google_sheets_deferrals import *
 from redbeat import RedBeatScheduler
 
 from main.celery_utils import OffsettingSchedule
@@ -207,6 +208,7 @@
     "mitol.common.apps.CommonApp",
     "mitol.google_sheets.apps.GoogleSheetsApp",
     "mitol.google_sheets_refunds.apps.GoogleSheetsRefundsApp",
+    "mitol.google_sheets_deferrals.apps.GoogleSheetsDeferralsApp",
     # "mitol.digitalcredentials.apps.DigitalCredentialsApp",
     "mitol.hubspot_api",
     "mitol.mail.apps.MailApp",
@@ -843,8 +845,8 @@
             month_of_year="*",
         ),
     },
-    "process-refund-requests": {
-        "task": "sheets.tasks.process_refund_requests",
+    "process-google-sheets-requests": {
+        "task": "sheets.tasks.process_google_sheets_requests",
         "schedule": crontab(minute=CRON_PROCESS_REFUND_REQUESTS_MINUTES),
     },
     "generate-course-certificate": {
@@ -1090,6 +1092,7 @@
 )
 
 MITOL_GOOGLE_SHEETS_REFUNDS_PLUGINS = ["sheets.plugins.RefundPlugin"]
+MITOL_GOOGLE_SHEETS_DEFERRALS_PLUGINS = ["sheets.plugins.DeferralPlugin"]
 
 
 # Fastly configuration

requirements.in

@@ -37,6 +37,7 @@ mitol-django-openedx>=1.3.0
 mitol-django-payment-gateway>=1.9.1
 mitol-django-google-sheets>=2.6.0
 mitol-django-google-sheets-refunds>=0.8.0
+mitol-django-google-sheets-deferrals~=2023.5.25
 newrelic
 pyOpenSSL>=23.1.1
 psycopg2

requirements.txt

@@ -117,6 +117,7 @@ django==3.2.18
     #   mitol-django-authentication
     #   mitol-django-common
     #   mitol-django-google-sheets
+    #   mitol-django-google-sheets-deferrals
     #   mitol-django-google-sheets-refunds
     #   mitol-django-hubspot-api
     #   mitol-django-mail
@@ -284,14 +285,18 @@ mitol-django-common==2.7.0
     #   -r requirements.in
     #   mitol-django-authentication
     #   mitol-django-google-sheets
+    #   mitol-django-google-sheets-deferrals
     #   mitol-django-google-sheets-refunds
     #   mitol-django-hubspot-api
     #   mitol-django-mail
     #   mitol-django-payment-gateway
 mitol-django-google-sheets==2.6.0
     # via
     #   -r requirements.in
+    #   mitol-django-google-sheets-deferrals
     #   mitol-django-google-sheets-refunds
+mitol-django-google-sheets-deferrals==2023.5.25
+    # via -r requirements.in
 mitol-django-google-sheets-refunds==0.8.0
     # via -r requirements.in
 mitol-django-hubspot-api==2023.5.22
@@ -327,6 +332,7 @@ pillow==9.3.0
     # via wagtail
 pluggy==0.13.1
     # via
+    #   mitol-django-google-sheets-deferrals
     #   mitol-django-google-sheets-refunds
     #   pytest
 premailer==3.9.0

sheets/plugins.py

@@ -1,8 +1,12 @@
 from mitol.google_sheets_refunds.hooks import hookimpl, RefundResult
 from mitol.google_sheets_refunds.utils import RefundRequestRow
+from mitol.google_sheets_deferrals.hooks import hookimpl, DeferralResult
+from mitol.google_sheets_deferrals.utils import DeferralRequestRow
 from mitol.google_sheets.utils import ResultType
 
 from ecommerce.api import refund_order
+from courses.api import defer_enrollment
+from users.api import fetch_user
 
 
 class RefundPlugin:
@@ -18,3 +22,23 @@ def refunds_process_request(
             return RefundResult(ResultType.PROCESSED)
 
         return RefundResult(ResultType.FAILED)
+
+
+class DeferralPlugin:
+    @hookimpl
+    def deferrals_process_request(
+        self, deferral_request_row: DeferralRequestRow
+    ) -> DeferralResult:
+        user = fetch_user(deferral_request_row.learner_email)
+        from_courseware_id = deferral_request_row.from_courseware_id
+        to_courseware_id = deferral_request_row.to_courseware_id
+
+        deferral_api_success = defer_enrollment(
+            user,
+            from_courseware_id,
+            to_courseware_id,
+        )
+        if deferral_api_success:
+            return DeferralResult(ResultType.PROCESSED)
+
+        return DeferralResult(ResultType.FAILED)

sheets/tasks.py

@@ -1,18 +1,21 @@
 import logging
 from mitol.google_sheets_refunds.api import RefundRequestHandler
+from mitol.google_sheets_deferrals.api import DeferralRequestHandler
 
 from main.celery import app
 
 log = logging.getLogger(__name__)
 
 
 @app.task
-def process_refund_requests():
+def process_google_sheets_requests():
     """
-    Task to process refund requests from Google sheets
+    Task to process refund and deferral requests from Google sheets
     """
     refund_request_handler = RefundRequestHandler()
-    if not refund_request_handler.is_configured():
-        log.warning("MITOL_GOOGLE_SHEETS_* are not set")
-        return
-    refund_request_handler.process_sheet()
+    deferral_request_handler = DeferralRequestHandler()
+    if refund_request_handler.is_configured():
+        refund_request_handler.process_sheet()
+
+    if deferral_request_handler.is_configured():
+        deferral_request_handler.process_sheet()

sheets/tasks_test.py

@@ -1,34 +1,52 @@
 import pytest
 
 from mitol.google_sheets_refunds.api import RefundRequestHandler
+from mitol.google_sheets_deferrals.api import DeferralRequestHandler
 
-from sheets.tasks import process_refund_requests
+from sheets.tasks import process_google_sheets_requests
 
 
 @pytest.mark.django_db
 @pytest.mark.parametrize(
-    "is_configured",
-    [True, False],
+    "refunds_is_configured, deferrals_is_configured",
+    [(True, True), (False, False)],
 )
-def test_process_refund_requests(mocker, user, is_configured):
+def test_process_google_sheets_requests(
+    mocker, user, refunds_is_configured, deferrals_is_configured
+):
     """
-    Test that process_refund_requests calls process_sheet only if it is properly configured
+    Test that process_google_sheets_requests calls process_sheet only if it is properly configured
     """
     Mock = mocker.Mock
     MagicMock = mocker.MagicMock
     refund_req_handler = MagicMock(
         spec=RefundRequestHandler, process_sheet=Mock(), is_configured=Mock()
     )
+    deferral_req_handler = MagicMock(
+        spec=DeferralRequestHandler, process_sheet=Mock(), is_configured=Mock()
+    )
     refund_req_handler_mock = mocker.patch(
         "sheets.tasks.RefundRequestHandler",
         return_value=refund_req_handler,
     )
-    refund_req_handler.is_configured.return_value = is_configured
+    deferral_req_handler_mock = mocker.patch(
+        "sheets.tasks.DeferralRequestHandler",
+        return_value=deferral_req_handler,
+    )
+    refund_req_handler.is_configured.return_value = refunds_is_configured
+    deferral_req_handler.is_configured.return_value = deferrals_is_configured
 
-    process_refund_requests.delay()
+    process_google_sheets_requests.delay()
     refund_req_handler_mock.assert_called()
     refund_req_handler.is_configured.assert_called()
-    if is_configured:
+    deferral_req_handler_mock.assert_called()
+    deferral_req_handler.is_configured.assert_called()
+    if refunds_is_configured:
         refund_req_handler.process_sheet.assert_called()
     else:
         assert not refund_req_handler.process_sheet.called
+
+    if deferrals_is_configured:
+        deferral_req_handler.process_sheet.assert_called()
+    else:
+        assert not deferral_req_handler.process_sheet.called