Merge branch 'release/0.7.2'

jsonapi/__init__.py

@@ -1,5 +1,5 @@
 """ JSON:API realization."""
-__version = (0, 7, 1)
+__version = (0, 7, 2)
 
 __version__ = version = '.'.join(map(str, __version))
 __project__ = PROJECT = __name__

jsonapi/api.py

@@ -23,6 +23,7 @@ class Meta:
 
 """
 from django.http import HttpResponse, HttpResponseNotAllowed
+from django.shortcuts import render
 import logging
 import json
 from .exceptions import JSONAPIError
@@ -116,7 +117,8 @@ def urls(self):
         """
         from django.conf.urls import url
         urls = [
-            url(r'^$', self.map_view),
+            url(r'^$', self.documentation),
+            url(r'^/map$', self.map_view),
         ]
 
         for resource_name in self.resource_map:
@@ -183,6 +185,21 @@ def map_view(self, request):
         response = json.dumps(resource_info)
         return HttpResponse(response, content_type="application/vnd.api+json")
 
+    def documentation(self, request):
+        """ Resource documentation.
+
+        .. versionadded:: 0.7.2
+            Content-Type check
+
+        :return django.http.HttpResponse
+
+        """
+        self.update_urls(request)
+        context = {
+            "resources": sorted(self.resource_map.items())
+        }
+        return render(request, "index.html", context)
+
     def handler_view_get(self, resource, **kwargs):
         items = json.dumps(
             resource.get(**kwargs),

jsonapi/model_inspector.py

@@ -42,11 +42,12 @@ class Field(object):
         ('to_many', 'TO_MANY'),
     )
 
-    def __init__(self, name, category, related_model=None):
+    def __init__(self, name, category, related_model=None, django_field=None):
         self.name = name
         self.related_model = related_model
         self.category = category
         self.is_bidirectional = None
+        self.django_field = django_field
 
     @property
     def query_name(self):
@@ -143,6 +144,7 @@ def _get_fields_own(cls, model):
             Field(
                 name=field.name,
                 related_model=None,
+                django_field=field,
                 category=Field.CATEGORIES.OWN
             ) for field in model._meta.fields
             if field.rel is None and (field.serialize or field.name == 'id')
@@ -155,6 +157,7 @@ def _get_fields_self_foreign_key(cls, model):
             Field(
                 name=field.name,
                 related_model=field.rel.to,
+                django_field=field,
                 category=Field.CATEGORIES.TO_ONE
             ) for field in model._meta.fields
             if field.rel and field.rel.multiple
@@ -174,6 +177,7 @@ def _get_fields_others_foreign_key(cls, model):
                 name=field.rel.related_name or "{}_set".format(
                     get_model_name(related_model)),
                 related_model=related_model,
+                django_field=field,
                 category=Field.CATEGORIES.TO_MANY
             ) for related_model in models.get_models()
             if not related_model._meta.proxy
@@ -190,6 +194,7 @@ def _get_fields_self_many_to_many(cls, model):
             Field(
                 name=field.name,
                 related_model=field.rel.to,
+                django_field=field,
                 category=Field.CATEGORIES.TO_MANY
             ) for field in model._meta.many_to_many
         ]
@@ -202,6 +207,7 @@ def _get_fields_others_many_to_many(cls, model):
                 name=field.rel.related_name or "{}_set".format(
                     get_model_name(related_model)),
                 related_model=related_model,
+                django_field=field,
                 category=Field.CATEGORIES.TO_MANY
             ) for related_model in models.get_models()
             if related_model is not model

jsonapi/resource.py

@@ -144,7 +144,9 @@ def __new__(mcs, name, bases, attrs):
                     "Abstract model {} could not be resource".format(model))
 
             cls.Meta.model_info = model_inspector.models[cls.Meta.model]
+            cls.Meta.default_form = cls.Meta.form or cls.get_form()
 
+        cls.Meta.description = cls.__doc__ or ""
         return cls
 
 

jsonapi/static/main.css

@@ -0,0 +1,13 @@
+aside {
+    float: left;
+    width: 220px;
+    margin-right: 20px;
+    display: block;
+    min-height: 1px;
+}
+
+#content {
+    float: left;
+    display: block;
+    width: 624px;
+}

jsonapi/templates/index.html

@@ -0,0 +1,114 @@
+{% load staticfiles %}
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>API Documentation</title>
+  <link rel="stylesheet" href="{% static 'bootstrap.min.css' %}">
+  <link rel="stylesheet" href="{% static 'highlight.min.css' %}">
+  <link rel="stylesheet" href="{% static 'main.css' %}">
+
+  <script src="{% static 'highlight.min.js' %}"></script>
+</head>
+<body>
+  <div class="container">
+    <header>
+      <h1>API Documentation</h1>
+    </header>
+    <div>
+      <aside>
+        <nav class="nav-main">
+          <ul>
+            <li class="nav-header">Authentication</li>
+            <li class="nav-header">Resources</li>
+            {% for resource_name, resource in  resources %}
+            <li>
+              <a href="#{{ resource_name }}">
+                {{ resource_name|capfirst }}
+              </a>
+            </li>
+            {% endfor %}
+          </ul>
+        </nav>
+      </aside>
+      <div id="content">
+        <h1>Getting Started</h1>
+        Generated date: {% now 'c' %}
+
+        <h1>Resources</h1>
+        {% for resource_name, resource in resources %}
+        <section id="{{ resource_name }}">
+          <h2 class="bg-primary">{{ resource_name|capfirst }}</h2>
+          {% if resource.Meta.description %}
+          <pre>{{ resource.Meta.description }}</pre>
+          {% endif %}
+          <table class="table table-bordered">
+            <tr>
+              <td>Location</td>
+              <td>{{ resource.Meta.api.api_url }}/{{ resource_name }}</td>
+            </tr>
+            <tr>
+              <td>Document Location</td>
+              <td>{{ resource.Meta.api.api_url }}/{{ resource_name }}/{id}</td>
+            </tr>
+            <tr>
+              <td>Allowed methods</td>
+              <td>{{ resource.Meta.allowed_methods }}</td>
+            </tr>
+            <tr>
+              <td>Authenticators</td>
+              <td>{{ resource.Meta.authenticators }}</td>
+            </tr>
+          </table>
+
+          <h3>Fields</h3>
+          <table class="table table-bordered">
+            <tr>
+              <th>Name</th>
+              <th>Type</th>
+              <th>Default</th>
+              <th>Description</th>
+            </tr>
+            {% for field in resource.Meta.model_info.fields_own %}
+            <tr>
+              <td>{{ field.name }}</td>
+              <td>{{ field.django_field.description }}</td>
+              {% if field.django_field.has_default %}
+              <td>{{ field.django_field.default }}</td>
+              {% else %}
+              <td></td>
+              {% endif %}
+              <td>{{ field.django_field.help_text }}</td>
+            </tr>
+            {% endfor %}
+          </table>
+
+          <h3>Form Fields</h3>
+          <table class="table table-bordered">
+            <tr>
+              <th>Name</th>
+              <th>Required</th>
+              <th>Description</th>
+            </tr>
+            {% for field_name, field in resource.Meta.default_form.base_fields.items %}
+            <tr>
+              <td>{{ field_name }}</td>
+              <td>{{ field.required }}</td>
+              <td>{{ field.help_text }}</td>
+            </tr>
+            {% endfor %}
+          </table>
+          <!-- <h3>Usage Examples</h3> -->
+          <!-- <h4>GET</h4> -->
+          <!-- <h5>Request</h5> -->
+          <!-- <h5>Response</h5> -->
+        </section>
+        {% endfor %}
+      </div>
+    </div>
+  </div>
+
+
+  <script>hljs.initHighlightingOnLoad();</script>
+</body>
+</html>

tests/testapp/resources.py

@@ -7,6 +7,9 @@
 
 @api.register
 class UserResource(Resource):
+
+    """ User Resource."""
+
     class Meta:
         model = settings.AUTH_USER_MODEL
         authenticators = [Resource.AUTHENTICATORS.SESSION]
@@ -16,6 +19,13 @@ class Meta:
 
 @api.register
 class AuthorResource(Resource):
+
+    """ Author Resource.
+
+    Description for Author Resource.
+
+    """
+
     class Meta:
         model = 'testapp.Author'
         allowed_methods = 'GET', 'POST', 'PUT', 'DELETE'

tests/testapp/settings/base.py

@@ -1,5 +1,4 @@
 import os.path
-import django
 
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
 STATIC_URL = '/static/'
@@ -18,6 +17,7 @@
     'django.contrib.admin',
     'django.contrib.messages',
     'django.contrib.sessions',
+    'jsonapi',
     'tests.testapp',
 )
 MIDDLEWARE_CLASSES = (

tests/testapp/settings/dev.py

@@ -1,3 +1,4 @@
+import django
 from .base import *
 
 INSTALLED_APPS += (

tests/testapp/settings/test.py

@@ -1,3 +1,4 @@
+import django
 from .base import *
 
 if django.VERSION[:2] < (1, 6):