Feature/make swagger json links browsable [OSF-6163]

api/addons/urls.py

@@ -1,3 +1,4 @@
+from __future__ import unicode_literals
 from django.conf.urls import url
 
 from api.addons import views

api/addons/views.py

@@ -1,5 +1,6 @@
-import importlib
 
+from __future__ import unicode_literals
+import importlib
 from rest_framework.exceptions import NotFound
 from rest_framework import generics, permissions as drf_permissions
 

api/applications/urls.py

@@ -1,3 +1,4 @@
+from __future__ import unicode_literals
 from django.conf.urls import url
 
 from api.applications import views

api/applications/views.py

@@ -1,3 +1,5 @@
+
+from __future__ import unicode_literals
 """
 Views related to OAuth2 platform applications. Intended for OSF internal use only
 """

api/base/serializers.py

@@ -614,7 +614,6 @@ def to_representation(self, value):
 
         if url is None:
             raise SkipField
-
         related_url = url['related']
         related_meta = self.get_meta_information(self.related_meta, value)
         self_url = url['self']

api/base/settings/defaults.py

@@ -180,11 +180,12 @@
 STATICFILES_DIRS = (
     ('rest_framework_swagger/css', os.path.join(BASE_DIR, 'static/css')),
     ('rest_framework_swagger/images', os.path.join(BASE_DIR, 'static/images')),
+    ('rest_framework_swagger/js', os.path.join(BASE_DIR, 'static/js')),
 )
 
 # TODO: Revisit methods for excluding private routes from swagger docs
 SWAGGER_SETTINGS = {
-    'api_path': '/',
+    'api_path': 'v2/',
     'info': {
         'description':
         """

api/base/urls.py

@@ -1,3 +1,4 @@
+from __future__ import unicode_literals
 from django.conf import settings
 from django.conf.urls import include, url
 from django.conf.urls.static import static
@@ -19,8 +20,16 @@
                 url(r'^applications/', include('api.applications.urls', namespace='applications')),
                 url(r'^collections/', include('api.collections.urls', namespace='collections')),
                 url(r'^comments/', include('api.comments.urls', namespace='comments')),
-                url(r'^docs/', include('rest_framework_swagger.urls')),
+                url(r'^nodes/', include('api.nodes.urls', namespace='nodes')),
+                url(r'^registrations/', include('api.registrations.urls', namespace='registrations')),
+                url(r'^metaschemas/', include('api.metaschemas.urls', namespace='metaschemas')),
+                url(r'^users/', include('api.users.urls', namespace='users')),
+                url(r'^tokens/', include('api.tokens.urls', namespace='tokens')),
+                url(r'^logs/', include('api.logs.urls', namespace='logs')),
                 url(r'^files/', include('api.files.urls', namespace='files')),
+                url(r'^docs/', views.schema_view),
+                url(r'^institutions/', include('api.institutions.urls', namespace='institutions')),
+                url(r'^collections/', include('api.collections.urls', namespace='collections')),
                 url(r'^guids/', include('api.guids.urls', namespace='guids')),
                 url(r'^identifiers/', include('api.identifiers.urls', namespace='identifiers')),
                 url(r'^institutions/', include('api.institutions.urls', namespace='institutions')),

api/base/views.py

@@ -1,11 +1,18 @@
+from __future__ import unicode_literals
+import inspect
 import weakref
 from django.conf import settings as django_settings
 from django.http import JsonResponse
-from rest_framework.decorators import api_view
+from rest_framework.decorators import api_view, renderer_classes
 from rest_framework.response import Response
+from rest_framework.compat import coreapi, uritemplate, urlparse
 from rest_framework import generics
+from rest_framework import exceptions
 from rest_framework import status
 from rest_framework import permissions as drf_permissions
+from rest_framework import schemas
+from rest_framework_swagger.renderers import OpenAPIRenderer, SwaggerUIRenderer
+from rest_framework.request import clone_request
 from rest_framework.exceptions import ValidationError, NotFound
 
 from framework.auth.oauth_scopes import CoreScopes
@@ -25,9 +32,127 @@
 from api.nodes.permissions import ContributorOrPublicForRelationshipPointers
 from api.base.utils import is_bulk_request, get_user_auth
 
-
 CACHE = weakref.WeakKeyDictionary()
 
+class SchemaGenerator(schemas.SchemaGenerator):
+
+    #def __init__(self, title=None, url=None, patterns=None, urlconf=None):
+    #    import ipdb; ipdb.set_trace()
+    #    super(SchemaGenerator, self).__init__(**kwargs)
+
+    def get_schema(self, request=None):
+        if self.endpoints is None:
+            self.endpoints = self.get_api_endpoints(self.patterns)
+
+        links = []
+        for path, method, category, action, callback in self.endpoints:
+            view = callback.cls()
+            for attr, val in getattr(callback, 'initkwargs', {}).items():
+                setattr(view, attr, val)
+            view.args = ()
+            view.kwargs = {
+                'user_id': 'me'
+            }
+            view.format_kwarg = None
+            if request is not None:
+                view.request = clone_request(request, method)
+                try:
+                    view.check_permissions(view.request)
+                except exceptions.APIException:
+                    continue
+            else:
+                view.request = None
+            link = self.get_link(path, method, callback, view)
+            links.append((category, action, link))
+        if not links:
+            return None
+        content = {}
+        for category, action, link in links:
+            if category is None:
+                content[action] = link
+            elif category in content:
+                content[category][action] = link
+            else:
+                content[category] = {action: link}
+        doc = coreapi.Document(title=self.title, content=content, url=self.url)
+        return doc
+
+    def get_link(self, path, method, callback, view):
+        """
+        Return a `coreapi.Link` instance for the given endpoint.
+        """
+        fields = self.get_path_fields(path, method, callback, view)
+        fields += self.get_serializer_fields(path, method, callback, view)
+        fields += self.get_pagination_fields(path, method, callback, view)
+        fields += self.get_filter_fields(path, method, callback, view)
+
+        if fields and any([field.location in ('form', 'body') for field in fields]):
+            encoding = self.get_encoding(path, method, callback, view)
+        else:
+            encoding = None
+
+        if self.url and path.startswith('/'):
+            path = path[1:]
+
+        try:
+            description = inspect.getdoc(callback.cls())
+        except:
+            description = 'No Description'
+
+        link = coreapi.Link(
+            url=urlparse.urljoin(self.url, path),
+            action=method.lower(),
+            encoding=encoding,
+            fields=fields,
+            description=description
+        )
+        return link
+
+    def get_path_fields(self, path, method, callback, view):
+        """
+        Return a list of `coreapi.Field` instances corresponding to any
+        templated path variables.
+        """
+        fields = []
+        for variable in uritemplate.URITemplate(path).variable_names:
+            field = coreapi.Field(name=variable, location='path', required=True)
+            fields.append(field)
+        return fields
+
+    def get_category(self, path, method, callback, action):
+        """
+        Return a descriptive category string for the endpoint, eg. 'users'.
+        """
+
+        try:
+            vn = callback.cls().view_name
+            return vn
+        except:
+            pass
+
+        path_components = path.strip('/').split('/')
+        path_components = [
+            component for component in path_components
+            if '{' not in component
+        ]
+
+        if action in self.known_actions:
+            idx = -1
+        else:
+            idx = -2
+
+        try:
+            return path_components[idx]
+        except IndexError:
+            return None
+
+@api_view()
+@renderer_classes([OpenAPIRenderer, SwaggerUIRenderer])
+def schema_view(request):
+    generator = SchemaGenerator(title='OSF API')
+    res = Response(generator.get_schema(request=request))
+    return res
+
 
 class JSONAPIBaseView(generics.GenericAPIView):
 

api/base/wsgi.py

@@ -1,3 +1,5 @@
+
+from __future__ import unicode_literals
 """
 WSGI config for api project.
 
@@ -26,8 +28,58 @@
 #### WARNING: Here be monkeys ###############
 import six
 import sys
+import re
+from django.contrib.admindocs import views
 from rest_framework.fields import Field
 from rest_framework.request import Request
+import urlparse
+from coreapi.compat import force_bytes
+from openapi_codec import OpenAPICodec, encode
+import simplejson as json
+
+def generate_swagger_object(document):
+    """
+    Generates root of the Swagger spec.
+    """
+    parsed_url = urlparse.urlparse(document.url)
+
+    return {
+        'swagger': '2.0',
+        'info': encode._get_info_object(document),
+        'tags': _get_tags_object(document),
+        'paths': encode._get_paths_object(document),
+        'host': parsed_url.netloc,
+    }
+
+def _get_tags_object(document):
+    return [{'name': tag, 'description': 'No Description'} for tag in sorted({tag for tag, _object in document.data.items()})]
+
+def dump(self, document, **kwargs):
+    data = generate_swagger_object(document)
+    return force_bytes(json.dumps(data))
+
+OpenAPICodec.dump = dump
+
+named_group_matcher = re.compile(r'\(\?P(<\w+>)[^\)]+\)')
+non_named_group_matcher = re.compile(r'\(.*?\)')
+
+def simplify_regex(pattern):
+    """
+    Clean up urlpattern regexes into something somewhat readable by Mere Humans:
+    turns something like "^(?P<sport_slug>\w+)/athletes/(?P<athlete_slug>\w+)/$"
+    into "<sport_slug>/athletes/<athlete_slug>/"
+    """
+    # handle named groups first
+    pattern = named_group_matcher.sub(lambda m: m.group(1), pattern)
+
+    # handle non-named groups
+    pattern = non_named_group_matcher.sub('<var>', pattern)
+
+    # clean up any outstanding regex-y characters.
+    pattern = pattern.replace('^', '').replace('$', '').replace('?', '').replace('//', '/').replace('\\', '')
+    if not pattern.startswith('/'):
+        pattern = '/' + pattern
+    return pattern
 
 # Cached properties break internal caching
 # 792005806b50f8aad086a76ff5a742c66a98428e
@@ -44,6 +96,7 @@ def __getattr__(self, attr):
         info = sys.exc_info()
         six.reraise(info[0], info[1], info[2].tb_next)
 
+views.simplify_regex = simplify_regex
 Field.context = context
 Request.__getattr__ = __getattr__
 Request.__getattribute__ = object.__getattribute__

api/caching/tasks.py

@@ -1,3 +1,4 @@
+from __future__ import unicode_literals
 import urlparse
 
 import requests

api/collections/urls.py

@@ -1,3 +1,4 @@
+from __future__ import unicode_literals
 from django.conf.urls import url
 
 from api.collections import views

api/collections/views.py

@@ -1,3 +1,5 @@
+
+from __future__ import unicode_literals
 from modularodm import Q
 from rest_framework import generics, permissions as drf_permissions
 from rest_framework.exceptions import ValidationError, NotFound, PermissionDenied

api/comments/urls.py

@@ -1,3 +1,4 @@
+from __future__ import unicode_literals
 from django.conf.urls import url
 from api.comments import views
 

api/comments/views.py

@@ -1,3 +1,5 @@
+
+from __future__ import unicode_literals
 from rest_framework import generics, permissions as drf_permissions
 from rest_framework.exceptions import NotFound, ValidationError, PermissionDenied
 

api/files/views.py

@@ -1,4 +1,7 @@
+
+from __future__ import unicode_literals
 from rest_framework import generics
+
 from rest_framework import permissions as drf_permissions
 from rest_framework.exceptions import NotFound
 

api/guids/urls.py

@@ -1,3 +1,4 @@
+from __future__ import unicode_literals
 from django.conf.urls import url
 
 from api.guids import views

api/guids/views.py

@@ -1,3 +1,5 @@
+
+from __future__ import unicode_literals
 import furl
 from django import http
 from rest_framework.exceptions import NotFound

api/identifiers/urls.py

@@ -1,3 +1,4 @@
+from __future__ import unicode_literals
 from django.conf.urls import url
 
 from api.identifiers import views

api/identifiers/views.py

@@ -1,3 +1,5 @@
+
+from __future__ import unicode_literals
 from modularodm import Q
 from rest_framework import generics, permissions as drf_permissions
 

api/institutions/urls.py

@@ -1,3 +1,4 @@
+from __future__ import unicode_literals
 from django.conf.urls import url
 
 from api.institutions import views

api/institutions/views.py

@@ -1,3 +1,5 @@
+
+from __future__ import unicode_literals
 from rest_framework import generics
 from rest_framework import permissions as drf_permissions
 from rest_framework import exceptions

api/licenses/urls.py

@@ -1,3 +1,4 @@
+from __future__ import unicode_literals
 from django.conf.urls import url
 
 from api.licenses import views

api/licenses/views.py

@@ -1,3 +1,5 @@
+
+from __future__ import unicode_literals
 from rest_framework import generics, permissions as drf_permissions
 from framework.auth.oauth_scopes import CoreScopes
 

api/logs/urls.py

@@ -1,3 +1,4 @@
+from __future__ import unicode_literals
 from django.conf.urls import url
 
 from api.logs import views

api/logs/views.py

@@ -1,3 +1,5 @@
+
+from __future__ import unicode_literals
 from rest_framework import generics, permissions as drf_permissions
 from rest_framework.exceptions import NotFound
 

api/metaschemas/urls.py

@@ -1,3 +1,4 @@
+from __future__ import unicode_literals
 from django.conf.urls import url
 
 from api.metaschemas import views

api/metaschemas/views.py

@@ -1,3 +1,5 @@
+
+from __future__ import unicode_literals
 from modularodm import Q
 from rest_framework import generics, permissions as drf_permissions
 from rest_framework.exceptions import NotFound