feat: Adds the Video XBlock code extracted from the edx-platform

Author: farhan

xblocks_contrib/video/ajax_handler_mixin.py

@@ -1,21 +1,22 @@
-# NOTE: Code has been copied from the following source file
-# https://github.com/openedx/edx-platform/blob/master/xmodule/x_module.py#L739
+from xblock.core import XBlock
+from webob.multidict import MultiDict
+from webob import Response
 
-class XModuleToXBlockMixin:
+class AjaxHandlerMixin:
     """
-    Common code needed by XModule and XBlocks converted from XModules.
+    Mixin that provides AJAX handling for Video XBlock
     """
     @property
     def ajax_url(self):
         """
         Returns the URL for the ajax handler.
         """
-        return self.runtime.handler_url(self, 'xmodule_handler', '', '').rstrip('/?')
+        return self.runtime.handler_url(self, 'ajax_handler', '', '').rstrip('/?')
 
     @XBlock.handler
-    def xmodule_handler(self, request, suffix=None):
+    def ajax_handler(self, request, suffix=None):
         """
-        XBlock handler that wraps `handle_ajax`
+        XBlock handler that wraps `ajax_handler`
         """
         class FileObjForWebobFiles:
             """

xblocks_contrib/video/bumper_utils.py

@@ -1,5 +1,3 @@
-# NOTE: Code has been copied from the following source files
-# https://github.com/openedx/edx-platform/blob/master/xmodule/video_block/bumper_utils.py
 """
 Utils for video bumper
 """

xblocks_contrib/video/cache_utils.py

@@ -1,14 +1,6 @@
-# NOTE: Code has been copied from the following source files
-# https://github.com/openedx/edx-platform/blob/master/openedx/core/lib/cache_utils.py
-"""
-Utilities related to caching.
-"""
-
-
 import itertools
-
 import wrapt
-from django.db.models.signals import post_save, post_delete
+
 from django.utils.encoding import force_str
 
 from edx_django_utils.cache import RequestCache

xblocks_contrib/video/constants.py

@@ -0,0 +1,17 @@
+"""
+Constants used by DjangoXBlockUserService
+"""
+
+# This is the view that will be rendered to display the XBlock in the LMS.
+# It will also be used to render the block in "preview" mode in Studio, unless
+# the XBlock also implements author_view.
+STUDENT_VIEW = 'student_view'
+
+# This is the view that will be rendered to display the XBlock in the LMS for unenrolled learners.
+# Implementations of this view should assume that a user and user data are not available.
+PUBLIC_VIEW = 'public_view'
+
+# The personally identifiable user ID.
+ATTR_KEY_USER_ID = 'edx-platform.user_id'
+# The country code determined from the user's request IP address.
+ATTR_KEY_REQUEST_COUNTRY_CODE = 'edx-platform.request_country_code'

xblocks_contrib/video/content.py

@@ -1,8 +1,12 @@
-# NOTE: Original code has been copied from the following file: 
-# https://github.com/openedx/edx-platform/blob/farhan/extract-video-xblock/xmodule/contentstore/content.py#L28
+from opaque_keys import InvalidKeyError
+from opaque_keys.edx.keys import AssetKey
+from opaque_keys.edx.locator import AssetLocator
 
-
-class StaticContent:  # lint-amnesty, pylint: disable=missing-class-docstring
+""" 
+Methods of this class has been copied from the 
+StaticContent class in edx-platform/xmodule/contentstore/content.py
+"""
+class VideoBlockStaticContent:  # lint-amnesty, pylint: disable=missing-class-docstring
     def __init__(self, loc, name, content_type, data, last_modified_at=None, thumbnail_location=None, import_path=None,
                  length=None, locked=False, content_digest=None):
         self.location = loc
@@ -19,7 +23,8 @@ def __init__(self, loc, name, content_type, data, last_modified_at=None, thumbna
         self.content_digest = content_digest
 
     @staticmethod
-    def compute_location(course_key, path, revision=None, is_thumbnail=False):  # lint-amnesty, pylint: disable=unused-argument
+    def compute_location(course_key, path, revision=None,
+                         is_thumbnail=False):  # lint-amnesty, pylint: disable=unused-argument
         """
         Constructs a location object for static content.
 

xblocks_contrib/video/exceptions.py

@@ -9,64 +9,3 @@ class TranscriptsGenerationException(Exception):
 
 class TranscriptNotFoundError(Exception):
     pass
-
-# # lint-amnesty, pylint: disable=missing-module-docstring
-# class InvalidDefinitionError(Exception):
-#     pass
-
-
-class NotFoundError(Exception):
-    pass
-
-
-# class ProcessingError(Exception):
-#     '''
-#     An error occurred while processing a request to the XModule.
-#     For example: if an exception occurs while checking a capa problem.
-#     '''
-#     pass  # lint-amnesty, pylint: disable=unnecessary-pass
-
-
-# class InvalidVersionError(Exception):
-#     """
-#     Tried to save an item with a location that a store cannot support (e.g., draft version
-#     for a non-leaf node)
-#     """
-#     def __init__(self, location):
-#         super().__init__()
-#         self.location = location
-
-
-# class SerializationError(Exception):
-#     """
-#     Thrown when a module cannot be exported to XML
-#     """
-#     def __init__(self, location, msg):
-#         super().__init__(msg)
-#         self.location = location
-
-
-# class UndefinedContext(Exception):
-#     """
-#     Tried to access an xmodule field which needs a different context (runtime) to have a value.
-#     """
-#     pass  # lint-amnesty, pylint: disable=unnecessary-pass
-
-
-# class HeartbeatFailure(Exception):
-#     """
-#     Raised when heartbeat fails.
-#     """
-
-#     def __init__(self, msg, service):
-#         """
-#         In addition to a msg, provide the name of the service.
-#         """
-#         self.service = service
-#         super().__init__(msg)
-
-
-class ServiceUnavailable(Exception):
-    """
-    This error is raised if the service backing this client is currently unavailable.
-    """

xblocks_contrib/video/mixin.py

@@ -1,7 +1,5 @@
-# NOTE: Code has been copied from the following source files
-# https://github.com/openedx/edx-platform/blob/master/openedx/core/lib/license/mixin.py
 """
-License mixin for XBlocks and XModules
+License mixin for XBlocks
 """
 
 from xblock.core import XBlockMixin