Merge pull request #109 from waleko/master

[django] Generalize uuid/key/receive_url logic (openwisp/openwisp-utils#40)

Author: nemesifier

django_netjsongraph/base/admin.py

@@ -6,6 +6,7 @@
 from django.templatetags.static import static
 from django.urls import reverse
 from django.utils.translation import ugettext_lazy as _
+from openwisp_utils.admin import ReceiveUrlAdmin
 
 from ..contextmanagers import log_failure
 
@@ -30,13 +31,12 @@ class Media:
         js = [static('netjsongraph/js/lib/d3.min.js'),
               static('netjsongraph/js/lib/jquery-ui.min.js'),
               static('netjsongraph/js/src/netjsongraph.js'),
-              static('netjsongraph/js/receive-url.js'),
               static('netjsongraph/js/strategy-switcher.js'),
               static('netjsongraph/js/topology-history.js'),
               static('netjsongraph/js/visualize.js')]
 
 
-class AbstractTopologyAdmin(BaseAdmin):
+class AbstractTopologyAdmin(BaseAdmin, ReceiveUrlAdmin):
     list_display = ['label', 'parser', 'strategy', 'published', 'created', 'modified']
     readonly_fields = ['protocol', 'version', 'revision', 'metric', 'receive_url']
     list_filter = ['parser', 'strategy']
@@ -45,12 +45,7 @@ class AbstractTopologyAdmin(BaseAdmin):
     fields = ['label', 'parser', 'strategy', 'url', 'key',
               'expiration_time', 'receive_url', 'published', 'protocol',
               'version', 'revision', 'metric', 'created']
-
-    def receive_url(self, obj):
-        url = reverse('receive_topology', kwargs={'pk': obj.pk})
-        return '{0}?key={1}'.format(url, obj.key)
-
-    receive_url.short_description = _('receive url')
+    receive_url_name = 'receive_topology'
 
     def get_actions(self, request):
         """

django_netjsongraph/base/base.py

@@ -10,11 +10,11 @@
 from jsonfield import JSONField
 from model_utils import Choices
 from model_utils.fields import StatusField
+from openwisp_utils.base import TimeStampedEditableModel
 from rest_framework.utils.encoders import JSONEncoder
 
 from .. import settings
 from ..utils import link_status_changed, print_info
-from .base import TimeStampedEditableModel
 
 
 class AbstractLink(TimeStampedEditableModel):

django_netjsongraph/base/link.py

@@ -6,11 +6,11 @@
 from django.utils.functional import cached_property
 from django.utils.timezone import now
 from jsonfield import JSONField
+from openwisp_utils.base import TimeStampedEditableModel
 from rest_framework.utils.encoders import JSONEncoder
 
 from .. import settings
 from ..utils import print_info
-from .base import TimeStampedEditableModel
 
 
 class AbstractNode(TimeStampedEditableModel):

django_netjsongraph/base/node.py

@@ -1,7 +1,6 @@
 from django.db import models
 from django.utils.translation import ugettext_lazy as _
-
-from .base import TimeStampedEditableModel
+from openwisp_utils.base import TimeStampedEditableModel
 
 
 class AbstractSnapshot(TimeStampedEditableModel):

django_netjsongraph/base/snapshot.py

@@ -10,12 +10,12 @@
 from django.utils.timezone import now
 from django.utils.translation import ugettext_lazy as _
 from netdiff import NetJsonParser, diff
+from openwisp_utils.base import KeyField, TimeStampedEditableModel
 from rest_framework.utils.encoders import JSONEncoder
 
 from ..contextmanagers import log_failure
 from ..settings import PARSERS, TIMEOUT
-from ..utils import get_random_key, print_info
-from .base import TimeStampedEditableModel
+from ..utils import print_info
 
 STRATEGIES = (
     ('fetch', _('FETCH')),
@@ -42,13 +42,11 @@ class AbstractTopology(TimeStampedEditableModel):
                     ' (FETCH strategy)')
     )
     # receive strategy
-    key = models.CharField(
-        _('key'),
-        blank=True,
-        max_length=64,
-        default=get_random_key,
-        help_text=_('key needed to update topology from nodes ')
-    )
+    key = KeyField(unique=False,
+                   db_index=False,
+                   help_text=_('key needed to update topology from nodes '),
+                   verbose_name=_('key'),
+                   blank=True)
     # receive strategy
     expiration_time = models.PositiveIntegerField(
         _('expiration time'),
@@ -275,7 +273,7 @@ def link_status_changed(self, link, status):
             return False
         # if using fetch strategy or
         # using receive strategy and link is coming back up or
-        # receive strategy and ``expiration_time is 0``
+        # receive strategy and ``expiration_time == 0``
         elif self.strategy == 'fetch' or status == 'up' or self.expiration_time == 0:
             return True
         # if using receive strategy and expiration_time of link has expired

django_netjsongraph/base/topology.py

@@ -1,6 +1,12 @@
 # -*- coding: utf-8 -*-
 # Generated by Django 1.9 on 2016-01-24 14:35
-import django_netjsongraph.models
+from __future__ import unicode_literals
+
+import re
+
+import django.core.validators
+import openwisp_utils.base
+import openwisp_utils.utils
 from django.db import migrations, models
 
 
@@ -24,6 +30,6 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name='topology',
             name='key',
-            field=models.CharField(blank=True, default=django_netjsongraph.utils.get_random_key, help_text='key needed to update topology from nodes ', max_length=64, verbose_name='key'),
-        )
+            field=openwisp_utils.base.KeyField(blank=True, default=openwisp_utils.utils.get_random_key, help_text='key needed to update topology from nodes ', max_length=64, validators=[django.core.validators.RegexValidator(re.compile('^[^\\s/\\.]+$'), code='invalid', message='This value must not contain spaces, dots or slashes.')], verbose_name='key'),
+        ),
     ]

django_netjsongraph/migrations/0003_topology_receive_strategy.py

@@ -5,7 +5,6 @@
 from django.dispatch import Signal
 from django.http import Http404
 from django.shortcuts import get_object_or_404 as get_obj_or_404
-from django.utils.crypto import get_random_string
 
 link_status_changed = Signal(providing_args=["link"])
 
@@ -32,10 +31,6 @@ def get_object_or_404(model, pk, **kwargs):
         raise Http404()
 
 
-def get_random_key():
-    return get_random_string(length=32)
-
-
 def get_api_urls(views_module):
     """
     used by third party apps to reduce boilerplate

django_netjsongraph/static/netjsongraph/js/receive-url.js

@@ -1,4 +1,4 @@
 coveralls
 responses
 freezegun
-openwisp-utils[qa]>=0.3.0
+openwisp-utils[qa]>=0.4.1

django_netjsongraph/utils.py

@@ -1,6 +1,7 @@
 django>=2.2,<3.1
 djangorestframework>=3.3,<3.12
 django-model-utils
+
 netdiff>=0.7.0,<0.8.0
-openwisp-utils>=0.4.0,<0.5.0
+openwisp-utils>=0.4.1,<0.5.0
 jsonfield2

requirements-test.txt

@@ -29,6 +29,12 @@
     'rest_framework'
 ]
 
+STATICFILES_FINDERS = [
+    'django.contrib.staticfiles.finders.FileSystemFinder',
+    'django.contrib.staticfiles.finders.AppDirectoriesFinder',
+    'openwisp_utils.staticfiles.DependencyFinder',
+]
+
 MIDDLEWARE = [
     'django.middleware.security.SecurityMiddleware',
     'django.contrib.sessions.middleware.SessionMiddleware',