Merge pull request #786 from aaxelb/eng-2650--nonbroken-web-ui

[ENG-2650] give the frontend enough to display something useful for each suid

api/banners/urls.py

@@ -3,5 +3,5 @@
 
 
 router = SimpleRouter()
-router.register(r'site_banners', views.SiteBannerViewSet, base_name='site_banners')
+router.register(r'^site_?banners', views.SiteBannerViewSet, base_name='site_banners')
 urlpatterns = router.urls

api/formattedmetadatarecords/serializers.py

@@ -0,0 +1,19 @@
+from share import models
+
+from api.base import ShareSerializer
+from api.fields import ShareIdentityField
+
+
+class FormattedMetadataRecordSerializer(ShareSerializer):
+    # link to self
+    url = ShareIdentityField(view_name='api:formattedmetadatarecord-detail')
+
+    class Meta:
+        model = models.FormattedMetadataRecord
+        fields = (
+            'suid',
+            'record_format',
+            'date_modified',
+            'formatted_metadata',
+            'url',
+        )

api/formattedmetadatarecords/urls.py

@@ -0,0 +1,7 @@
+from rest_framework.routers import SimpleRouter
+from api.formattedmetadatarecords import views
+
+
+router = SimpleRouter()
+router.register(r'formattedmetadatarecords', views.FormattedMetadataRecordViewSet, base_name='formattedmetadatarecord')
+urlpatterns = router.urls

api/formattedmetadatarecords/views.py

@@ -0,0 +1,15 @@
+from rest_framework import viewsets
+
+from api.formattedmetadatarecords.serializers import FormattedMetadataRecordSerializer
+from api.base import ShareViewSet
+
+from share.models import FormattedMetadataRecord
+
+
+class FormattedMetadataRecordViewSet(ShareViewSet, viewsets.ReadOnlyModelViewSet):
+    serializer_class = FormattedMetadataRecordSerializer
+
+    ordering = ('id', )
+
+    def get_queryset(self):
+        return FormattedMetadataRecord.objects.all()

api/normalizeddata/views.py

@@ -1,3 +1,4 @@
+import logging
 from django.db import transaction
 from django.urls import reverse
 
@@ -20,6 +21,9 @@
 from api.permissions import ReadOnlyOrTokenHasScopeOrIsAuthenticated
 
 
+logger = logging.getLogger(__name__)
+
+
 class NormalizedDataViewSet(ShareViewSet, generics.ListCreateAPIView, generics.RetrieveAPIView):
     """View showing all normalized data in the SHARE Dataset.
 

api/source_configs/serializers.py → api/sourceconfigs/serializers.py

@@ -3,8 +3,11 @@
 from api.base import ShareSerializer
 
 
-# TODO make an endpoint for SourceConfigs
 class SourceConfigSerializer(ShareSerializer):
     class Meta:
         model = models.SourceConfig
-        fields = ('label',)
+        fields = (
+            'label',
+            'source',
+            'disabled',
+        )

api/sourceconfigs/urls.py

@@ -0,0 +1,7 @@
+from rest_framework.routers import SimpleRouter
+from api.sourceconfigs import views
+
+
+router = SimpleRouter()
+router.register(r'sourceconfigs', views.SourceConfigViewSet, base_name='sourceconfig')
+urlpatterns = router.urls

api/sourceconfigs/views.py

@@ -0,0 +1,15 @@
+from rest_framework import viewsets
+
+from api.sourceconfigs.serializers import SourceConfigSerializer
+from api.base import ShareViewSet
+
+from share.models import SourceConfig
+
+
+class SourceConfigViewSet(ShareViewSet, viewsets.ReadOnlyModelViewSet):
+    serializer_class = SourceConfigSerializer
+
+    ordering = ('id', )
+
+    def get_queryset(self):
+        return SourceConfig.objects.all()

api/sources/serializers.py

@@ -25,7 +25,14 @@ class ReadonlySourceSerializer(ShareSerializer):
 
     class Meta:
         model = models.Source
-        fields = ('name', 'home_page', 'long_title', 'icon', 'url')
+        fields = (
+            'name',
+            'home_page',
+            'long_title',
+            'icon',
+            'url',
+            'source_configs',
+        )
         read_only_fields = fields
 
 

api/suids/serializers.py

@@ -0,0 +1,25 @@
+from share import models
+
+from api.base import ShareSerializer
+from api.fields import ShareIdentityField
+from api.sourceconfigs.serializers import SourceConfigSerializer
+from api.formattedmetadatarecords.serializers import FormattedMetadataRecordSerializer
+
+
+class SuidSerializer(ShareSerializer):
+    included_serializers = {
+        'source_config': SourceConfigSerializer,
+        'formattedmetadatarecord_set': FormattedMetadataRecordSerializer,
+    }
+
+    # link to self
+    url = ShareIdentityField(view_name='api:suid-detail')
+
+    class Meta:
+        model = models.SourceUniqueIdentifier
+        fields = (
+            'identifier',
+            'source_config',
+            'url',
+            'formattedmetadatarecord_set',
+        )

api/suids/urls.py

@@ -0,0 +1,7 @@
+from rest_framework.routers import SimpleRouter
+from api.suids import views
+
+
+router = SimpleRouter()
+router.register(r'suids', views.SuidViewSet, base_name='suid')
+urlpatterns = router.urls

api/suids/views.py

@@ -0,0 +1,15 @@
+from rest_framework import viewsets
+
+from api.suids.serializers import SuidSerializer
+from api.base import ShareViewSet
+
+from share.models import SourceUniqueIdentifier
+
+
+class SuidViewSet(ShareViewSet, viewsets.ReadOnlyModelViewSet):
+    serializer_class = SuidSerializer
+
+    ordering = ('id', )
+
+    def get_queryset(self):
+        return SourceUniqueIdentifier.objects.all()

api/urls.py

@@ -12,12 +12,15 @@
 urlpatterns = [
     url('^$', RootView.as_view()),
     url('^', include('api.banners.urls')),
+    url('^', include('api.formattedmetadatarecords.urls')),
     url('^', include('api.ingestjobs.urls')),
     url('^', include('api.normalizeddata.urls')),
     url('^', include('api.rawdata.urls')),
     url('^', include('api.shareobjects.urls')),
     url('^', include('api.sourceregistrations.urls')),
+    url('^', include('api.sourceconfigs.urls')),
     url('^', include('api.sources.urls')),
+    url('^', include('api.suids.urls')),
     url('^', include('api.users.urls')),
 
     url('^schemas?/', include('api.schemas.urls'), name='schema'),

share/models/core.py

@@ -255,6 +255,9 @@ class FormattedMetadataRecord(models.Model):
     date_modified = models.DateTimeField(auto_now=True)
     formatted_metadata = models.TextField()  # could be JSON, XML, or whatever
 
+    class JSONAPIMeta(BaseJSONAPIMeta):
+        pass
+
     class Meta:
         unique_together = ('suid', 'record_format')
 

share/models/ingest.py

@@ -261,6 +261,9 @@ class SourceUniqueIdentifier(models.Model):
     identifier = models.TextField()
     source_config = models.ForeignKey('SourceConfig', on_delete=models.CASCADE)
 
+    class JSONAPIMeta(BaseJSONAPIMeta):
+        pass
+
     class Meta:
         unique_together = ('identifier', 'source_config')
 

share/models/validators.py

@@ -153,11 +153,9 @@ def validator_for(self, share_schema_type):
 
 
 def is_valid_iri(iri):
-    try:
-        IRILink().execute(iri)
-    except InvalidIRI:
-        return False
+    # raises InvalidIRI if invalid
+    IRILink().execute(iri)
     return True
 
 
-draft4_format_checker.checks('uri', raises=ValueError)(is_valid_iri)
+draft4_format_checker.checks('uri', raises=InvalidIRI)(is_valid_iri)

share/transform/chain/links.py

@@ -802,12 +802,15 @@ class URLLink(AbstractIRILink):
     IMPLICIT_PORTS = {80, 443}
     IP_RE = re.compile(r'\b({schemes})://(\d{{1,3}}.){{4}}(?:\d{{2,5}})\b([-a-z0-9@:%_\+.~#?&//=]*)'.format(schemes='|'.join(SCHEMES)), flags=re.I)
     URL_RE = re.compile(r'\b({schemes})://[-a-z0-9@:%._\+~#=]{{2,256}}\.[a-z]{{2,6}}\b([-a-z0-9@:%_\+.~#?&//=]*)'.format(schemes='|'.join(SCHEMES)), flags=re.I)
+    LOCAL_URL_RE = re.compile(r'\b({schemes})://localhost:[0-9]{{2,5}}\b([-a-z0-9@:%_\+.~#?&//=]*)'.format(schemes='|'.join(SCHEMES)), flags=re.I)
 
     @classmethod
     def hint(cls, obj):
         # BePress double escapes in OAI feeds
         obj = obj.replace('&', '&')
 
+        if settings.DEBUG and cls.LOCAL_URL_RE.search(obj) is not None:
+            return 0.25
         if cls.URL_RE.search(obj) is not None:
             return 0.25
         if cls.IP_RE.search(obj) is not None:
@@ -819,10 +822,16 @@ def hint(cls, obj):
     def _parse(self, obj):
         # BePress double escapes in OAI feeds
         obj = obj.replace('&', '&')
+        match = None
+        if settings.DEBUG:
+            match = self.LOCAL_URL_RE.search(obj)
+
+        if not match:
+            match = self.URL_RE.search(obj) or self.IP_RE.search(obj)
 
-        match = self.URL_RE.search(obj) or self.IP_RE.search(obj)
         if not match and obj.lower().startswith(self.SCHEMELESS_STARTS):
             match = self.URL_RE.search('http://{}'.format(obj))
+
         return super(URLLink, self)._parse(match.group(0))
 
     def _process_scheme(self, scheme):