Merge pull request #147 from eduNEXT/and/add_eox_audit_requirement

And/add eox audit requirement

Author: andrey-canon

CHANGELOG.rst

@@ -11,7 +11,11 @@ Change Log
 .. There should always be an "Unreleased" section for changes pending release.
 Unreleased
 ----------
-*
+
+Added
+~~~~~
+* Decorate views that change or register some information.
+* Include eox-audit-model wrapper.
 
 [4.9.0] - 2021-05-12
 --------------------

MANIFEST.in

@@ -4,4 +4,5 @@ include README.rst
 include requirements/base.in
 include requirements/sentry.in
 include requirements/tpa.in
+include requirements/eox-audit-model.in
 recursive-include eox_core *.html *.png *.gif *js *.css *jpg *jpeg *svg *py

eox_core/integrations/audit_wrapper.py

@@ -0,0 +1,44 @@
+"""Wrapper file for eox-audit-model"""
+from importlib import import_module, util
+
+try:
+    eox_audit_decorator = import_module('eox_audit_model.decorators')
+    audit_method = eox_audit_decorator.audit_method
+except ImportError:
+    pass
+
+
+def audit_api_wrapper(action='', data_filter=None):
+    """This decorator wraps the functionality of audit_method in order to
+    work with django API view methods,also this allows to filter the data that will be
+    stored in the data base.
+
+    Example
+
+    class YourAPIView(APIView):
+
+        @audit_api_wrapper(action='Get my items', data_filter=['username', 'location'])
+        def get(self, request, *args, **kwargs):
+            ...
+    """
+    def decorator(func):
+        def wrapper(*args, **kwargs):
+            if not util.find_spec('eox_audit_model'):
+                return func(*args, **kwargs)
+
+            request = args[1]
+            audit_data = request.data if request.data else request.query_params
+
+            if data_filter:
+                audit_data = {key: value for key, value in audit_data.items() if key in data_filter}
+
+            @audit_method(action=action)
+            def eox_core_api_method(audit_data):
+                """This method is just a wrapper in order to capture the input data"""
+                return func(*args, **kwargs)
+
+            return eox_core_api_method(audit_data)
+
+        return wrapper
+
+    return decorator

eox_core/settings/common.py

@@ -3,6 +3,8 @@
 """
 from __future__ import absolute_import, unicode_literals
 
+from importlib.util import find_spec
+
 SECRET_KEY = 'a-not-to-be-trusted-secret-key'
 INSTALLED_APPS = (
     'django.contrib.auth',
@@ -12,6 +14,7 @@
     'django_filters',
     'oauth2_provider',
 )
+EOX_AUDIT_MODEL_APP = 'eox_audit_model.apps.EoxAuditModelConfig'
 
 
 def plugin_settings(settings):
@@ -71,3 +74,6 @@ def plugin_settings(settings):
     # has a match with the regex provided in the exc_text unique element. If exc_text contains more than one
     # regex, the exception is ignored if any of the regex matches the traceback text.
     settings.EOX_CORE_SENTRY_IGNORED_ERRORS = []
+
+    if find_spec('eox_audit_model') and EOX_AUDIT_MODEL_APP not in settings.INSTALLED_APPS:
+        settings.INSTALLED_APPS.append(EOX_AUDIT_MODEL_APP)

requirements/eox-audit-model.in

@@ -0,0 +1,3 @@
+# Extra requirements
+
+eox-audit-model

setup.py

@@ -72,7 +72,8 @@ def is_requirement(line):
     install_requires=load_requirements('requirements/base.in'),
     extras_require={
         "sentry": load_requirements('requirements/sentry.in'),
-        "tpa": load_requirements('requirements/tpa.in')
+        "tpa": load_requirements('requirements/tpa.in'),
+        "eox-audit": load_requirements('requirements/eox-audit-model.in')
     },
     scripts=[],
     license="AGPL",