Merge pull request #58 from eduNEXT/mgs/audit_model-logging

Add eox-audit-model and drop support for Ironwood

.circleci/config.yml

@@ -14,11 +14,8 @@ workflows:
               only: /v?[0-9]+(\.[0-9]+)*/
           matrix:
             parameters:
-              python_version: ["2.7", "3.5"]
-              django_version: ["django111", "django22"]
-            exclude:
-              - python_version: "2.7"
-                django_version: "django22"
+              python_version: ["3.5"]
+              django_version: ["django22"]
       - pypi:
           requires:
             - test

eox_tagging/admin.py

@@ -41,7 +41,7 @@ def get_search_results(self, request, queryset, search_term):
         """
         Custom search to support searching on the tagged objects
         """
-        queryset, use_distinct = super(TagAdmin, self).get_search_results(
+        queryset, use_distinct = super().get_search_results(
             request,
             queryset,
             search_term
@@ -71,7 +71,7 @@ def tagged_object(self, tag):
         except Exception as error:
             return str(error)
 
-    def add_view(self, request, *args, **kwargs):  # pylint: disable=arguments-differ
+    def add_view(self, request, form_url='', extra_context=None):
         """
         Custom method to handle the specific case of tagging course_keys
 
@@ -106,7 +106,7 @@ def add_view(self, request, *args, **kwargs):  # pylint: disable=arguments-diffe
             request.POST['target_type'] = ContentType.objects.get(model='OpaqueKeyProxyModel').id
             request.POST['target_object_id'] = opaque_key_proxy.id
 
-        return super(TagAdmin, self).add_view(request, *args, **kwargs)
+        return super().add_view(request, form_url='', extra_context=None)
 
 
 admin.site.register(Tag, TagAdmin)

eox_tagging/api/v1/filters.py

@@ -18,7 +18,7 @@ class TagFilter(filters.FilterSet):
     expiration_date = filters.DateTimeFromToRangeFilter()
     access = filters.CharFilter(method="filter_access_type")
 
-    class Meta:  # pylint: disable=old-style-class, useless-suppression
+    class Meta:
         """Meta class."""
         model = Tag
         fields = ["key", "status", "tag_type", "tag_value"]

eox_tagging/api/v1/serializers.py

@@ -29,7 +29,7 @@ class TagSerializer(serializers.ModelSerializer):
     access = fields.EnumField(enum=AccessLevel, required=False)
     status = fields.EnumField(enum=Status, required=False)
 
-    class Meta:  # pylint: disable=old-style-class, useless-suppression
+    class Meta:
         """Meta class."""
         model = Tag
         fields = ('meta', 'key', 'tag_value', 'tag_type', 'access', 'activation_date', 'expiration_date',

eox_tagging/api/v1/viewset.py

@@ -2,6 +2,7 @@
 Viewset for Tags.
 """
 from django_filters import rest_framework as filters
+from eox_audit_model.decorators import audit_method
 from rest_framework import viewsets
 from rest_framework.authentication import SessionAuthentication
 
@@ -36,6 +37,32 @@ def get_queryset(self):
 
         return queryset
 
+    def create(self, request, *args, **kwargs):
+        """"Hijack the create method and use a wrapper function to perform the
+        audit process. The original parameters of create are not very useful in
+        raw form, this way we pass more useful information to our wrapper
+        function to be audited
+        """
+
+        @audit_method(action="eox_tagging-api-v1-viewset:tagviewset-create")
+        def audited_create(headers, body):  # pylint: disable=unused-argument
+            return super(TagViewSet, self).create(request, *args, **kwargs)
+
+        return audited_create(headers=request.headers, body=request.data)
+
+    def destroy(self, request, *args, **kwargs):
+        """"Hijack the destroy method and use a wrapper function to perform the
+        audit process. The original parameters of destroy are not very useful in
+        raw form, this way we pass more useful information to our wrapper
+        function to be audited
+        """
+
+        @audit_method(action="eox_tagging-api-v1-viewset:tagviewset-destroy")
+        def audited_destroy(headers, path):  # pylint: disable=unused-argument
+            return super(TagViewSet, self).destroy(request, *args, **kwargs)
+
+        return audited_destroy(headers=request.headers, path=request.path)
+
     def __get_objects_by_status(self, queryset):
         """Method that returns queryset filtered by tag status."""
         include_inactive = self.request.query_params.get("include_inactive")

eox_tagging/edxapp_wrappers/backends/bearer_authentication_i_v1_test.py

@@ -9,7 +9,7 @@ def get_bearer_authentication():
         BearerAuthentication function.
     """
     try:
-        from openedx.core.lib.api.authentication import BearerAuthentication
+        from openedx.core.lib.api.authentication import BearerAuthentication  # pylint: disable=import-outside-toplevel
     except ImportError:
         BearerAuthentication = object
     return BearerAuthentication

eox_tagging/edxapp_wrappers/backends/course_overview_i_v1.py

@@ -7,7 +7,7 @@
 def get_course_overview():
     """Backend to get course overview."""
     try:
-        from openedx.core.djangoapps.content.course_overviews.models import CourseOverview
+        from openedx.core.djangoapps.content.course_overviews.models import CourseOverview  # pylint: disable=import-outside-toplevel
     except ImportError:
         CourseOverview = object
     return CourseOverview

eox_tagging/edxapp_wrappers/backends/enrollment_i_v1.py

@@ -7,7 +7,7 @@
 def get_enrollment_object():
     """Backend to get enrollment object."""
     try:
-        from student.models import CourseEnrollment
+        from student.models import CourseEnrollment  # pylint: disable=import-outside-toplevel
     except ImportError:
         CourseEnrollment = object
     return CourseEnrollment

eox_tagging/models.py

@@ -201,14 +201,14 @@ class Tag(models.Model):
 
     objects = TagQuerySet().as_manager()
 
-    class Meta:  # pylint: disable=old-style-class, useless-suppression
+    class Meta:
         """Meta class. """
         verbose_name = "tag"
         verbose_name_plural = "tags"
         app_label = "eox_tagging"
 
     def __str__(self):
-        return self.tag_value
+        return str(self.tag_value)
 
     @property
     def target_object_type(self):
@@ -308,15 +308,15 @@ def full_clean(self, exclude=None, validate_unique=False):
         self.clean()
         self.clean_fields()
 
-    def save(self, *args, **kwargs):  # pylint: disable=arguments-differ
+    def save(self, *args, **kwargs):  # pylint: disable=signature-differs
         self.full_clean()
-        super(Tag, self).save(*args, **kwargs)
+        super().save(*args, **kwargs)
 
     def delete(self):  # pylint: disable=arguments-differ
         self.inactivated_at = timezone.now()
         self.status = Status.INACTIVE
-        super(Tag, self).save()
+        super().save()
 
     def hard_delete(self):
         """Deletes object from database."""
-        super(Tag, self).delete()
+        super().delete()

eox_tagging/settings/common.py

@@ -22,6 +22,7 @@
     'django.contrib.auth',
     'django.contrib.contenttypes',
     'rest_framework',
+    'eox_audit_model.apps.EoxAuditModelConfig',
     'eox_tagging',
 ]
 

eox_tagging/settings/production.py

@@ -9,4 +9,3 @@ def plugin_settings(settings):  # pylint: disable=unused-argument
     Set of plugin settings used by the Open Edx platform.
     More info: https://github.com/edx/edx-platform/blob/master/openedx/core/djangoapps/plugins/README.rst
     """
-    pass

eox_tagging/settings/test.py

@@ -6,11 +6,9 @@
 from .common import *  # pylint: disable=wildcard-import
 
 
-class SettingsClass(object):
+class SettingsClass:
     """ dummy settings class """
 
-    pass
-
 
 SETTINGS = SettingsClass()
 # This is executing the plugin_settings method imported from common module

eox_tagging/validators.py

@@ -29,7 +29,7 @@
 DATETIME_FORMAT_VALIDATION = "%Y-%m-%d %H:%M:%S"
 
 
-class TagValidators(object):
+class TagValidators:
     """ Defines all validator methods.
     """
 
@@ -352,7 +352,7 @@ def validate_equals(self, field, value):
         if not field_value:
             raise ValidationError("EOX_TAGGING | The field '{}' is required and must be equal to '{}'."
                                   .format(field, value))
-        elif field_value.lower() != value.lower():
+        if field_value.lower() != value.lower():
             raise ValidationError("EOX_TAGGING | The field '{}' must be equal to '{}'.".format(field, value))
 
     def validate_between(self, field, value):

requirements/base.in

@@ -1,4 +1,5 @@
 # Main requirements of your plugin application.
 -c constraints.txt
 
+eox-audit-model
 eox-core