feat: add import taxonomy endpoint

openedx/core/djangoapps/content_tagging/rest_api/v1/views.py

@@ -2,8 +2,14 @@
 Tagging Org API Views
 """
 
+from django.http import HttpResponse, HttpResponseBadRequest
+from openedx_tagging.core.tagging import rules as oel_tagging_rules
 from openedx_tagging.core.tagging.rest_api.v1.views import ObjectTagView, TaxonomyView
-
+from openedx_tagging.core.tagging.rest_api.v1.serializers import TaxonomyImportBodySerializer, TaxonomyImportNewBodySerializer
+from openedx_tagging.core.tagging.import_export.api import get_last_import_log, import_tags
+from rest_framework.decorators import action
+from rest_framework.exceptions import PermissionDenied
+from rest_framework.request import Request
 
 from ...api import (
     create_taxonomy,
@@ -61,6 +67,79 @@ def perform_create(self, serializer):
         user_admin_orgs = get_admin_orgs(self.request.user)
         serializer.instance = create_taxonomy(**serializer.validated_data, orgs=user_admin_orgs)
 
+    @action(detail=False, url_path="import", methods=["post"])
+    def create_import(self, request: Request, **_kwargs) -> HttpResponse:
+        """
+        Creates a new taxonomy and imports the tags from the uploaded file.
+        """
+        perm = "oel_tagging.import_taxonomy"
+        if not request.user.has_perm(perm):
+            raise PermissionDenied("You do not have permission to import taxonomies")
+
+        body = TaxonomyImportNewBodySerializer(data=request.data)
+        body.is_valid(raise_exception=True)
+
+        taxonomy_name = body.validated_data["taxonomy_name"]
+        taxonomy_description = body.validated_data["taxonomy_description"]
+        file = body.validated_data["file"].file
+        parser_format = body.validated_data["parser_format"]
+
+        # ToDo: This code is temporary
+        # In the future, the orgs parameter will be defined in the request body from the frontend
+        # See: https://github.com/openedx/modular-learning/issues/116
+        if oel_tagging_rules.is_taxonomy_admin(request.user):
+            orgs = None
+        else:
+            orgs = get_admin_orgs(request.user)
+
+        taxonomy = create_taxonomy(taxonomy_name, taxonomy_description, orgs=orgs)
+        try:
+            import_success = import_tags(taxonomy, file, parser_format)
+
+            if import_success:
+                return HttpResponse(status=200)
+            else:
+                import_error = get_last_import_log(taxonomy)
+                taxonomy.delete()
+                return HttpResponseBadRequest(import_error)
+        except ValueError as e:
+            return HttpResponseBadRequest(e)
+
+    @action(detail=True, url_path="tags/import", methods=["put"])
+    def update_import(self, request: Request, **_kwargs) -> HttpResponse:
+        """
+        Creates a new taxonomy and imports the tags from the uploaded file.
+        """
+        perm = "oel_tagging.import_taxonomy"
+        if not request.user.has_perm(perm):
+            raise PermissionDenied("You do not have permission to import taxonomies")
+
+        body = TaxonomyImportBodySerializer(data=request.data)
+        body.is_valid(raise_exception=True)
+
+        file = body.validated_data["file"].file
+        parser_format = body.validated_data["parser_format"]
+
+        # ToDo: This code is temporary
+        # In the future, the orgs parameter will be defined in the request body from the frontend
+        # See: https://github.com/openedx/modular-learning/issues/116
+        if oel_tagging_rules.is_taxonomy_admin(request.user):
+            orgs = None
+        else:
+            orgs = get_admin_orgs(request.user)
+
+        taxonomy = self.get_object()
+        try:
+            import_success = import_tags(taxonomy, file, parser_format)
+
+            if import_success:
+                return HttpResponse(status=200)
+            else:
+                import_error = get_last_import_log(taxonomy)
+                return HttpResponseBadRequest(import_error)
+        except ValueError as e:
+            return HttpResponseBadRequest(e)
+
 
 class ObjectTagOrgView(ObjectTagView):
     """

openedx/core/djangoapps/content_tagging/rules.py

@@ -282,6 +282,7 @@ def can_change_taxonomy_tag(user: UserType, tag: oel_tagging.Tag | None = None)
 rules.set_perm("oel_tagging.delete_taxonomy", can_change_taxonomy)
 rules.set_perm("oel_tagging.view_taxonomy", can_view_taxonomy)
 rules.set_perm("oel_tagging.export_taxonomy", can_view_taxonomy)
+rules.set_perm("oel_tagging.import_taxonomy", can_create_taxonomy)
 
 # Tag
 rules.set_perm("oel_tagging.add_tag", can_change_taxonomy_tag)

requirements/constraints.txt

@@ -121,7 +121,7 @@ libsass==0.10.0
 click==8.1.6
 
 # pinning this version to avoid updates while the library is being developed
-openedx-learning==0.3.0
+openedx-learning==0.3.1
 
 # lti-consumer-xblock 9.6.2 contains a breaking change that makes
 # existing custom parameter configurations unusable.

requirements/edx/base.txt

@@ -785,7 +785,7 @@ openedx-filters==1.6.0
     # via
     #   -r requirements/edx/kernel.in
     #   lti-consumer-xblock
-openedx-learning==0.3.0
+openedx-learning @ git+https://github.com/open-craft/openedx-learning@rpenido/fal-3532-import-taxonomy-bare-bones
     # via
     #   -c requirements/edx/../constraints.txt
     #   -r requirements/edx/kernel.in

requirements/edx/development.txt

@@ -1315,7 +1315,7 @@ openedx-filters==1.6.0
     #   -r requirements/edx/doc.txt
     #   -r requirements/edx/testing.txt
     #   lti-consumer-xblock
-openedx-learning==0.3.0
+openedx-learning @ git+https://github.com/open-craft/openedx-learning@rpenido/fal-3532-import-taxonomy-bare-bones
     # via
     #   -c requirements/edx/../constraints.txt
     #   -r requirements/edx/doc.txt

requirements/edx/doc.txt

@@ -925,7 +925,7 @@ openedx-filters==1.6.0
     # via
     #   -r requirements/edx/base.txt
     #   lti-consumer-xblock
-openedx-learning==0.3.0
+openedx-learning @ git+https://github.com/open-craft/openedx-learning@rpenido/fal-3532-import-taxonomy-bare-bones
     # via
     #   -c requirements/edx/../constraints.txt
     #   -r requirements/edx/base.txt

requirements/edx/kernel.in

@@ -117,7 +117,8 @@ openedx-calc                        # Library supporting mathematical calculatio
 openedx-django-require
 openedx-events                      # Open edX Events from Hooks Extension Framework (OEP-50)
 openedx-filters                     # Open edX Filters from Hooks Extension Framework (OEP-50)
-openedx-learning                    # Open edX Learning core (experimental)
+# openedx-learning                    # Open edX Learning core (experimental)
+openedx-learning @ git+https://github.com/open-craft/openedx-learning@rpenido/fal-3532-import-taxonomy-bare-bones
 openedx-mongodbproxy
 openedx-django-wiki
 openedx-blockstore

requirements/edx/testing.txt

@@ -989,7 +989,7 @@ openedx-filters==1.6.0
     # via
     #   -r requirements/edx/base.txt
     #   lti-consumer-xblock
-openedx-learning==0.3.0
+openedx-learning @ git+https://github.com/open-craft/openedx-learning@rpenido/fal-3532-import-taxonomy-bare-bones
     # via
     #   -c requirements/edx/../constraints.txt
     #   -r requirements/edx/base.txt