feat(api): Staff Grant Extension - Upstream Rebase

[SteveDala]

Description

This pull request is a complete rebase of the Staff Grant Extension (SGE) API functionality introduced in #77. The initial feature was built on 9.x, and this PR migrates the feature to the new 10.0.x development branch.

All credit for development of the feature API goes to @samindiii and @SahiruWithanage.

Sister branches

Run OnTrack with the latest version of these branches to recreate the environment.

• doubtfire-web: feat/SGE-rebase-upstream
• doubtfire-deploy: 10.0.x

Sister Pull Requests

• doubtfire-lms/doubtfire-web #1074: Front-end that interacts with this feature
• thoth-tech/doubtfire-api #82: Forked version to be closed if this is merged

Repo cleanup

Merging this PR should be followed by closing the following open PRs with a comment that they have been merged into 10.0.x:

• Feature/Add Staff Grant Extension endpoint #463, which is the initial PR of the API endpoint
• Feature/Extension notification system - Backend #464, which adds an in-app notification system and integrates Feature/Add Staff Grant Extension endpoint #463

Merging this PR should also be followed by closing the forked version PR mentioned above with a comment that it has been merged into 10.0.x upstream:

Type of change

• New feature (non-breaking change which adds functionality)
• This change requires a documentation update

How Has This Been Tested?

Test A

While the development container is running, connect and run rails test from the directory /workspace/doubtfire-api. This runs all unit tests. For the last successful GitHub Action run of this branch, see here.

Test B

To strictly test the API, head to localhost's API docs while your Docker server is running.

Open "auth : Operations about auths" and go to "POST /api/auth". Enter the following JSON for the postApiAuth value:

{"username": "aconvenor", "password":"password"}

Then click "Try it out!". From the response, grab the auth_token value.

Open "units : Operations about units" further down the page then go to "POST /api/units/{unit_id}/staff-grant-extension". Enter the following values for each parameter:

• unit_id: 1
• Username: aconvenor
• Auth_token: (The one you received from POST /api/auth)
• postApiUnitsUnitIdStaffGrantExtension:

{
  "student_ids": [
    24
  ],
  "task_definition_id": 1,
  "weeks_requested": 1,
  "comment": "string"
}

You should receive a "successful" result in the Response Body.

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation if appropriate
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• I have created or extended unit tests to address my new additions
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

[SteveDala]

@b0ink please review when you have a moment.

[b0ink]

I'll need to review the notification workflow a little more in-depth, but here's a few changes that can be made for now

[b0ink]

The html template should be more consistent with existing email templates (eg. using the logo and main content border outline), refer to portfolio_ready.html.erb or weekly_student_summary.html.erb - you can preview these by copying the HTML output from one of the students in doubtfire-api/tmp/mails/student_**@doubtfire.com into an HTML previewer online to verify that it looks right