Add REST API functionality for generating menus

.coveragerc

@@ -0,0 +1,33 @@
+# .coveragerc to control coverage.py
+[run]
+branch = True
+
+source = wagtailmenus/*
+
+omit =
+    */migrations/*
+
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+    if self\.debug
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+    return NotImplemented
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:
+
+ignore_errors = True
+
+[html]
+directory = coverage_html_report

setup.py

@@ -21,6 +21,7 @@
     'beautifulsoup4<4.6.1,>=4.5.1',
     'coverage>=4.5',
     'django-webtest>=1.9,<1.10',
+    'django-crispy-forms>=1.7,<1.8',
 ]
 
 development_extras = [

tox.ini

@@ -8,7 +8,7 @@ envlist =
 
 [testenv]
 install_command = pip install -e ".[testing]" -U {opts} {packages}
-commands = coverage run --source=wagtailmenus runtests.py
+commands = coverage run runtests.py
 
 basepython =
     py34: python3.4

wagtailmenus/api/form_fields.py

@@ -0,0 +1,140 @@
+from functools import lru_cache
+
+from django import forms
+from django.core.exceptions import ValidationError
+from django.utils.translation import ugettext_lazy as _
+from wagtail.core.models import Page, Site
+
+from wagtailmenus.conf import constants, settings
+
+
+@lru_cache(maxsize=64)
+def get_label_indent(depth, indent_string):
+    if depth > 1:
+        return ''.join(str(indent_string) for i in range(depth-2))
+    return ''
+
+
+class IndentedPageChoiceIterator(forms.models.ModelChoiceIterator):
+    indent_string = '    - '
+
+    def __init__(self, field):
+        self.field = field
+        # Limit fields to help with performance
+        self.queryset = field.queryset.only('id', 'depth', 'title')
+
+    def label_from_instance(self, obj):
+        # Indent field labels according to depth (if enabled)
+        if self.field.indent_choice_labels:
+            return '{indent}{title}'.format(
+                indent=get_label_indent(obj.depth, self.indent_string),
+                title=obj.title,
+            )
+        return obj.title
+
+    def choice(self, obj):
+        # Use the above label_from_instance() method instead
+        # of the one
+        return (self.field.prepare_value(obj), self.label_from_instance(obj))
+
+
+class JavascriptStyleBooleanSelect(forms.Select):
+
+    def __init__(self, attrs=None):
+        choices = (
+            ('true', _('true')),
+            ('false', _('false')),
+        )
+        super().__init__(attrs, choices)
+
+    def format_value(self, value):
+        try:
+            return {
+                True: 'true',
+                False: 'false',
+                'True': 'true',
+                'False': 'false',
+                'true': 'true',
+                'false': 'false',
+                1: 'true',
+                0: 'false',
+                '1': 'true',
+                '0': 'false',
+            }[value]
+        except KeyError:
+            return ''
+
+    def value_from_datadict(self, data, files, name):
+        value = data.get(name)
+        return {
+            True: True,
+            False: False,
+            'True': True,
+            'False': False,
+            'true': True,
+            'false': False,
+            '1': True,
+            '0': False,
+        }.get(value)
+
+
+class BooleanChoiceField(forms.BooleanField):
+    widget = JavascriptStyleBooleanSelect
+
+    def clean(self, value):
+        if value is None:
+            raise ValidationError("The value must be 'true' or 'false'.", code="invalid")
+        return value
+
+
+class MaxLevelsChoiceField(forms.TypedChoiceField):
+
+    default_error_messages = {
+        'invalid_choice': _('The provided value is not a supported.')
+    }
+
+    def __init__(self, *args, **kwargs):
+        empty_label = kwargs.pop('empty_label', '-----')
+        choices = (('', empty_label),) + constants.MAX_LEVELS_CHOICES
+        defaults = {
+            'choices': choices,
+            'coerce': int,
+            'empty_value': None,
+        }
+        kwargs.update({k: v for k, v in defaults.items() if k not in kwargs})
+        super().__init__(*args, **kwargs)
+
+
+class PageIDChoiceField(forms.ModelChoiceField):
+
+    default_error_messages = {
+        'invalid_choice': _('The provided value is not a valid page ID.')
+    }
+
+    iterator = IndentedPageChoiceIterator
+
+    def __init__(self, *args, **kwargs):
+        if 'queryset' not in kwargs:
+            kwargs['queryset'] = Page.objects.filter(depth__gt=1)
+        self.indent_choice_labels = kwargs.pop('indent_choice_labels', True)
+        super().__init__(*args, **kwargs)
+
+
+class SiteIDChoiceField(forms.ModelChoiceField):
+
+    default_error_messages = {
+        'invalid_choice': _('The provided valie is not a valid site ID.')
+    }
+
+    def __init__(self, *args, **kwargs):
+        if 'queryset' not in 'kwargs':
+            kwargs['queryset'] = Site.objects.all()
+        super().__init__(*args, **kwargs)
+
+
+class FlatMenuHandleField(forms.SlugField):
+
+    def __init__(self, *args, **kwargs):
+        if settings.FLAT_MENUS_HANDLE_CHOICES:
+            kwargs['widget'] = forms.Select(choices=settings.FLAT_MENUS_HANDLE_CHOICES)
+        super().__init__(*args, **kwargs)

wagtailmenus/api/urls.py

@@ -0,0 +1,6 @@
+from django.conf.urls import include, url
+
+app_name = 'wagtailmenus_api'
+urlpatterns = [
+    url(r'^v1/', include('wagtailmenus.api.v1.urls', namespace='v1')),
+]

wagtailmenus/api/utils.py

@@ -0,0 +1,127 @@
+from io import StringIO
+from urllib.parse import urlparse
+
+from django.conf import settings
+from django.core.handlers.base import BaseHandler
+from django.core.handlers.wsgi import WSGIRequest
+from wagtail.core.sites import get_site_for_hostname
+
+from wagtailmenus.utils.misc import derive_page
+
+
+def derive_current_site(request, site_page, url):
+    """
+    Attempts to find a ``Site`` object for the current ``request``.
+    using the supplied ``site_page`` or ``url``.
+
+    This function makes some assumptions about how Wagtail is being
+    used, and might not be appropriate for all implementations.
+    If needed, you can implement an alternative derivation function
+    (accepting the same arguments as this one) and register it using the
+    ``WAGTAILMENUS_API_V1_CURRENT_SITE_DERIVATION_FUNCTION`` setting.
+    """
+    if site_page is not None:
+        return site_page.get_site()
+    parsed_url = urlparse(url)
+    port = parsed_url.port or 443 if parsed_url.scheme == 'https' else 80
+    return get_site_for_hostname(parsed_url.hostname, port)
+
+
+def derive_current_page(request, site, url):
+    """
+    Attempts to find a ``Page`` object matching the supplied ``url`` for the
+    current API ``request``. Returns a tuple with two items, where the first
+    is the matching ``Page`` (or ``None`` if no match was found), and the
+    second a boolean indicating whether the match was an exact match for
+    the URL (or ``False`` if no match was found).
+
+    This function uses Wagtail's built-in page routing mechanism to find
+    a matching page. In order to do this, a 'dummy request' is created from
+    ``api_request`` for the supplied ``url``. This approach might not be
+    appropriate for all implementations. If needed, you can implement an
+    alternative derivation function (accepting the same arguments as this one)
+    and register it using the ``WAGTAILMENUS_API_V1_CURRENT_PAGE_DERIVATION_FUNCTION``
+    setting.
+    """
+
+    # Create a dummy request is created for the supplied URL, but otherwise
+    # matching
+    dummy_request = make_dummy_request(url, request)
+    return derive_page(dummy_request, site)
+
+
+def make_dummy_request(url, original_request, **metadata):
+    """
+    Construct a HttpRequest object that is, as far as possible,
+    representative of the original request - only for the provided ``url``
+    instead of the one that was originally requested.
+    """
+    url_info = urlparse(url)
+    hostname = url_info.hostname
+    path = url_info.path
+    port = url_info.port or (443 if url_info.scheme == 'https' else 80)
+    scheme = url_info.scheme
+
+    dummy_values = {
+        'REQUEST_METHOD': 'GET',
+        'PATH_INFO': path,
+        'SERVER_NAME': hostname,
+        'SERVER_PORT': port,
+        'SERVER_PROTOCOL': 'HTTP/1.1',
+        'HTTP_HOST': hostname,
+        'wsgi.version': (1, 0),
+        'wsgi.input': StringIO(),
+        'wsgi.errors': StringIO(),
+        'wsgi.url_scheme': scheme,
+        'wsgi.multithread': True,
+        'wsgi.multiprocess': True,
+        'wsgi.run_once': False,
+    }
+
+    # Add important values from the original request object
+    headers_to_copy = [
+        'REMOTE_ADDR', 'HTTP_X_FORWARDED_FOR', 'HTTP_COOKIE',
+        'HTTP_USER_AGENT', 'HTTP_AUTHORIZATION', 'wsgi.version',
+        'wsgi.multithread', 'wsgi.multiprocess', 'wsgi.run_once',
+    ]
+    if settings.SECURE_PROXY_SSL_HEADER:
+        headers_to_copy.append(settings.SECURE_PROXY_SSL_HEADER[0])
+    for header in headers_to_copy:
+        if header in original_request.META:
+            dummy_values[header] = original_request.META[header]
+
+    # Add additional custom metadata sent by the caller.
+    dummy_values.update(**metadata)
+
+    request = WSGIRequest(dummy_values)
+
+    # Add a flag to let middleware know that this is a dummy request.
+    request.is_dummy = True
+
+    # Apply middleware to the request
+    handler = BaseHandler()
+    handler.load_middleware()
+    handler._middleware_chain(request)
+
+    return request
+
+
+def make_serializer_class(name, base_class, field_names, model=None, field_serializer_overrides=None, **additional_attributes):
+    _model = model
+
+    if _model is not None:
+        class Meta:
+            model = _model
+            fields = list(field_names)
+    else:
+        class Meta:
+            fields = list(field_names)
+
+    attrs = {'Meta': Meta}
+
+    if field_serializer_overrides:
+        attrs.update(field_serializer_overrides)
+
+    attrs.update(additional_attributes)
+
+    return type(name, (base_class, ), attrs)

wagtailmenus/api/v1/conf/defaults.py

@@ -0,0 +1,52 @@
+# NOTE: All supported app settings must be added here
+
+# --------------------
+# REST Framework views
+# --------------------
+
+# Use the REST framework defaults by default
+AUTHENTICATION_CLASSES = None
+
+# Use the REST framework defaults by default
+PERMISSION_CLASSES = None
+
+# Use custom renderer by default. Override this setting to hide the browsable
+# API in production
+RENDERER_CLASSES = [
+    'rest_framework.renderers.JSONRenderer',
+    'rest_framework.renderers.BrowsableAPIRenderer',
+]
+
+# -------------------------
+# Option serializer classes
+# -------------------------
+
+CHILDREN_MENU_OPTION_SERIALIZER = 'wagtailmenus.api.v1.serializers.ChildrenMenuOptionSerializer'
+
+SECTION_MENU_OPTION_SERIALIZER = 'wagtailmenus.api.v1.serializers.SectionMenuOptionSerializer'
+
+MAIN_MENU_OPTION_SERIALIZER = 'wagtailmenus.api.v1.serializers.MainMenuOptionSerializer'
+
+FLAT_MENU_OPTION_SERIALIZER = 'wagtailmenus.api.v1.serializers.FlatMenuOptionSerializer'
+
+# -----------------------
+# Menu serializer classes
+# -----------------------
+
+CHILDREN_MENU_SERIALIZER = 'wagtailmenus.api.v1.serializers.ChildrenMenuSerializer'
+
+SECTION_MENU_SERIALIZER = 'wagtailmenus.api.v1.serializers.SectionMenuSerializer'
+
+MAIN_MENU_BASE_SERIALIZER = 'wagtailmenus.api.v1.serializers.BaseModelMenuSerializer'
+
+FLAT_MENU_BASE_SERIALIZER = 'wagtailmenus.api.v1.serializers.BaseModelMenuSerializer'
+
+# --------------
+# View behaviour
+# --------------
+
+SINGLE_SITE_MODE = False
+
+CURRENT_SITE_DERIVATION_FUNCTION = 'wagtailmenus.api.utils.derive_current_site'
+
+CURRENT_PAGE_DERIVATION_FUNCTION = 'wagtailmenus.api.utils.derive_current_page'

wagtailmenus/api/v1/conf/settings.py

@@ -0,0 +1,9 @@
+import sys
+from cogwheels import BaseAppSettingsHelper
+
+
+class WagtailmenusAPISettingsHelper(BaseAppSettingsHelper):
+    deprecations = ()
+
+
+sys.modules[__name__] = WagtailmenusAPISettingsHelper()