Merge pull request #5370 from mitodl/shanbady/api-endpoint-for-program-page-config

api endpoint for program page config

Author: shanbady

cms/api.py

@@ -0,0 +1,15 @@
+"""
+Integrate Wagtail's builtin api endpointss
+"""
+from wagtail.api.v2.views import PagesAPIViewSet
+from wagtail.api.v2.router import WagtailAPIRouter
+from wagtail.images.api.v2.views import ImagesAPIViewSet
+from wagtail.documents.api.v2.views import DocumentsAPIViewSet
+
+# Create the router. "wagtailapi" is the URL namespace
+api_router = WagtailAPIRouter('wagtailapi')
+
+# Register wagtail built-in api routes
+api_router.register_endpoint('pages', PagesAPIViewSet)
+api_router.register_endpoint('images', ImagesAPIViewSet)
+api_router.register_endpoint('documents', DocumentsAPIViewSet)

cms/models.py

@@ -20,6 +20,7 @@
 from wagtail.contrib.table_block.blocks import TableBlock
 from wagtail.images.models import Image
 from wagtail.images.edit_handlers import ImageChooserPanel
+from wagtail.api import APIField
 
 from courses.models import Program
 from micromasters.serializers import serialize_maybe_user
@@ -28,6 +29,7 @@
 from cms.util import get_coupon_code
 from cms.blocks import CourseTeamBlock, ImageWithLinkBlock, ResourceBlock
 
+
 common_table_options = {
     'startRows': 3,
     'startCols': 2,
@@ -450,6 +452,18 @@ def get_context(self, request, *args, **kwargs):
 
         return context
 
+    api_fields = [
+        APIField('title'),
+        APIField('description'),
+        APIField('program_id'),
+        APIField('program_letter_footer'),
+        APIField('program_letter_footer_text'),
+        APIField('program_letter_header_text'),
+        APIField('program_letter_logo'),
+        APIField('program_letter_text'),
+        APIField('program_letter_signatories'),
+    ]
+
 
 def get_program_page_context(programpage, request):
     """ Get context for the program page"""
@@ -718,3 +732,10 @@ class ProgramLetterSignatory(Orderable):
             ]
         )
     ]
+
+    api_fields = [
+        APIField('name'),
+        APIField('title_line_1'),
+        APIField('title_line_2'),
+        APIField('signature_image'),
+    ]

cms/urls.py

@@ -0,0 +1,8 @@
+"""URLs for courses and programs"""
+
+from django.conf.urls import url
+from cms.api import api_router
+
+urlpatterns = [
+    url('api/v0/wagtail/', api_router.urls),
+]

cms/wagtail_api_test.py

@@ -0,0 +1,73 @@
+"""
+Tests for wagtail built-in endpoints
+"""
+from django.urls import reverse
+from cms.factories import ProgramPageFactory, ProgramLetterSignatoryFactory
+from search.base import MockedESTestCase
+
+
+class WagtailAPITestCase(MockedESTestCase):
+    """
+    Tests for Wagtail api
+    """
+    def test_program_page_api_detail(self):
+        """
+        Basic test to ensure the page detail endpoint returns data
+        """
+        page = ProgramPageFactory(title="test program page title")
+        response = self.client.get(
+            reverse("wagtailapi:pages:detail", args=[page.id]))
+        json = response.json()
+        self.assertTrue(json["title"] == page.title)
+
+    def test_program_page_api_serializes_signatories(self):
+        """
+        Test that program letter signatories
+        are included along with image data
+        """
+        page = ProgramPageFactory(
+            description="test program page description", title="test program page title"
+        )
+        ProgramLetterSignatoryFactory.create_batch(3, program_page=page)
+        response = self.client.get(
+            reverse("wagtailapi:pages:detail", args=[page.id]))
+        json = response.json()
+        signatories = json["program_letter_signatories"]
+        self.assertTrue(len(signatories) == 3)
+        self.assertTrue("signature_image" in signatories[0].keys())
+        self.assertTrue(
+            "download_url" in signatories[0]["signature_image"]["meta"].keys()
+        )
+
+    def test_program_page_api_list_view_details(self):
+        """
+        Tests that we can get all the program letter
+        related detail from the list view directly
+        """
+        page = ProgramPageFactory(
+            description="test program page description", title="test program page title"
+        )
+        ProgramLetterSignatoryFactory.create_batch(3, program_page=page)
+        response = self.client.get(
+            reverse("wagtailapi:pages:listing"),
+            {"id": page.id, "type": "cms.ProgramPage", "fields": "*"},
+        )
+        json = response.json()
+        response_keys = list(json["items"][0].keys())
+        self.assertTrue(
+            all(
+                [
+                    key in response_keys
+                    for key in [
+                        "title",
+                        "program_id",
+                        "program_letter_footer",
+                        "program_letter_footer_text",
+                        "program_letter_header_text",
+                        "program_letter_logo",
+                        "program_letter_text",
+                        "program_letter_signatories",
+                    ]
+                ]
+            )
+        )

micromasters/settings.py

@@ -88,10 +88,12 @@
     'django.contrib.sites',
     'rest_framework',
     'rest_framework.authtoken',
+    'django_filters',
     'server_status',
     'social_django',
 
     # WAGTAIL
+    'wagtail.api.v2',
     'wagtail.contrib.forms',
     'wagtail.contrib.redirects',
     'wagtail.contrib.table_block',

micromasters/urls.py

@@ -25,6 +25,7 @@
     url(r'', include('backends.urls')),
     url(r'^admin/', admin.site.urls),
     url('', include('courses.urls')),
+    url("", include("cms.urls")),
     url('', include('dashboard.urls')),
     url('', include('ecommerce.urls')),
     url('', include('financialaid.urls')),