BLUEBUTTON-522 application list (#707)

* Separate openid related view

* Add paged ApplicationListView

* Add django setting for APP_LIST_EXCLUDE for list

Author: dtisza1

apps/wellknown/serializers.py

@@ -0,0 +1,25 @@
+from rest_framework.serializers import (ModelSerializer, SerializerMethodField)
+from ..dot_ext.models import Application, ApplicationLabel
+
+
+class ApplicationLabelSerializer(ModelSerializer):
+    class Meta:
+        model = ApplicationLabel
+        fields = (
+            'name',
+            'slug',
+            'description',
+        )
+
+
+class ApplicationListSerializer(ModelSerializer):
+    labels = SerializerMethodField()
+
+    class Meta:
+        model = Application
+        fields = ('name', 'website_uri', 'logo_uri', 'tos_uri', 'policy_uri',
+                  'support_email', 'support_phone_number', 'description', 'labels')
+
+    def get_labels(self, obj):
+        labels = ApplicationLabel.objects.filter(applications=obj.id).values('name', 'slug', 'description')
+        return(labels)

apps/wellknown/urls.py

@@ -1,10 +1,10 @@
 from django.conf.urls import url
-from .views import openid_configuration
+from .views import openid_configuration, ApplicationListView
 
 
 urlpatterns = [
-    # openid-configuration -----------------------------------
     url(r'^openid-configuration$',
         openid_configuration,
         name='openid-configuration'),
+    url(r'^applications$', ApplicationListView.as_view(), name='applications-list'),
 ]

apps/wellknown/views/__init__.py

@@ -0,0 +1,2 @@
+from .openid import openid_configuration, base_issuer, build_endpoint_info  # NOQA
+from .application import ApplicationListView  # NOQA

apps/wellknown/views/application.py

@@ -0,0 +1,31 @@
+from ...dot_ext.models import Application
+from ..serializers import ApplicationListSerializer
+from django.conf import settings
+from rest_framework.generics import ListAPIView
+from rest_framework.pagination import PageNumberPagination
+from rest_framework.permissions import AllowAny
+from rest_framework.renderers import JSONRenderer
+
+
+class ApplicationListPagination(PageNumberPagination):
+    page_size = 10
+    page_size_query_param = 'page_size'
+    max_page_size = 10000
+
+
+class ApplicationListView(ListAPIView):
+    """
+    View to provide an applications list.
+
+    An application that has active=False or with a label slug in the APP_LIST_EXCLUDE
+    list will be excluded from this view.
+    """
+    permission_classes = (AllowAny,)
+    renderer_classes = (JSONRenderer,)
+    serializer_class = ApplicationListSerializer
+    pagination_class = ApplicationListPagination
+
+    def get_queryset(self):
+        queryset = Application.objects.exclude(active=False).exclude(
+            applicationlabel__slug__in=settings.APP_LIST_EXCLUDE).order_by('name')
+        return queryset

apps/wellknown/views.py renamed to apps/wellknown/views/openid.py

@@ -348,6 +348,10 @@
 APP_LOGO_WIDTH_MAX = env('DJANGO_APP_LOGO_WIDTH_MAX', '128')
 APP_LOGO_HEIGHT_MAX = env('DJANGO_APP_LOGO_HEIGHT_MAX', '128')
 
+# Application label slugs to exclude from externally
+# published lists, like those used for internal use testing.
+APP_LIST_EXCLUDE = env('DJANGO_APP_LIST_EXCLUDE', ['internal-use'])
+
 # LINKS TO DOCS
 DEVELOPER_DOCS_URI = "https://bluebutton.cms.gov/developers"
 DEVELOPER_DOCS_TITLE = "Documentation"
@@ -383,7 +387,6 @@
     'STATIC_ROOT',
     'MEDIA_URL',
     'MEDIA_ROOT',
-    'IS_MEDIA_URL_LOCAL',
     'MFA',
     'DEVELOPER_DOCS_URI',
     'DEVELOPER_DOCS_TITLE',