feat: CourseEnrollmentAllowed API

[MaferMazu]

Description

This PR adds the methods GET and POST to CourseEnrollmentAllowed to have and usable API only for Staff or Owners.

Supporting information

We want to add this for the WooCommerce Plugin we are building to integrate third-party e-commerce with Open edX.

Testing instructions

GET /api/enrollment/v1/enrollment_allowed?email=user@example.com

Parameters

• email (optional, string, query_params)

POST /api/enrollment/v1/enrollment_allowed

Example request data:

{
        "email": "user@example.com",
        "course_id": "course-v1:edX+DemoX+Demo_Course",
        "auto_enroll": true
}

Deadline

We would like to have this merged by 08/31/2023

Other information

ADR when we discuss these additions: eduNEXT/platform-plugin-ecommerce-api#1 (comment)

How to have a JWT Token

POST /oauth2/access_token
Body in Form:

client_id="CLIENT_ID"
client_secret="CLIENT_SECRET"
grant_type="client_credentials"
token_type="jwt"

[openedx-webhooks]

Thanks for the pull request, @MaferMazu! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

• supporting documentation
• Open edX discussion forum threads
• timeline information ("this must be merged by XX date", and why that is)
• partner information ("this is a course on edx.org")
• any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

[feanil]

Mostly looks good, just a couple of small change requests!

[MaferMazu]

Thank @feanil; tomorrow, I will improve the PR and request again for your feedback.

[MaferMazu]

@feanil I applied your feedback; thanks again.

I still have a test failed, and the output is:

django.urls.exceptions.NoReverseMatch: Reverse for 'courseenrollmentallowed' not found. 'courseenrollmentallowed' is not a valid view function or pattern name.

I have that name in my URLs, but I wonder if I'm missing something. Do you know how to fix this error?

cc @felipemontoya

[MaferMazu]

Tests fixed!
cc @mphilbrick211 @feanil @felipemontoya

[pshiu]

Great add of a serializer for the existing CourseEnrollmentAllowed model! Apologies, but still one security question:

[MaferMazu]

Thanks for the patience, @pshiu and @felipemontoya. By the middle of this week, I can retake this effort.

[pshiu]

(@MaferMazu No problem, thank you!)

[MaferMazu]

Changes in my latest commit:

• Add the delete method
• Add the delete tests
• Apply the feedback: enrollment_allowed and isAdminUser
• Refactor of the required args checks
• Improve the test documentation

What do you think, @felipemontoya and @pshiu?

[MaferMazu]

@felipemontoya @pshiu, do you have more feedback about this API?

[pshiu]

Thank you for incorporating the feedback, @MaferMazu. Great work.

[pshiu]

@MaferMazu, when you've finished collecting feedback from @felipemontoya & @feanil, give me a ping anytime and happy to be the merger & monitor deployment.

[feanil]

One small nit, but otherwise looks good to me as well!

[felipemontoya]

Thanks for all the work @MaferMazu. With the latest round of changes addressing all the feedback I think this is good to go.

[MaferMazu]

@pshiu, please give it a last look, and you can merge it when the tests are finished 🙌

[openedx-webhooks]

@MaferMazu 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX production environment.

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX production environment.