Feat add react admin (#358)

* started to implement integration with rest-on-admin

* added support json and boolean fields

* fixed flake8

* feat: added logout handler

* feat: added pre-commit to build new bundle in production mode for each commit

* feat: added pre-commit to build new bundle in production mode for each commit

* feat: added new bundle

Author: Arfey

.babelrc

@@ -0,0 +1,5 @@
+{
+  "presets":[
+    "react", "es2015", "stage-0"
+  ]
+}

.eslintrc

@@ -1,25 +1,38 @@
 {
-    "env": {
-        "browser": true,
-        "es6": true
-    },
-    "extends": "eslint:recommended",
-    "rules": {
-        "indent": [
-            "error",
-            4
-        ],
-        "linebreak-style": [
-            "error",
-            "unix"
-        ],
-        "quotes": [
-            "error",
-            "single"
-        ],
-        "semi": [
-            "error",
-            "always"
-        ]
+  "env": {
+    "browser": true,
+    "es6": true
+  },
+  "parserOptions": {
+    "sourceType": "module",
+    "ecmaFeatures": {
+      "jsx": true,
+      "modules": true
     }
-}
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:react/recommended"
+  ],
+  "plugins": [
+    "react"
+  ],
+  "rules": {
+    "indent": [
+      "error",
+      2
+    ],
+    "linebreak-style": [
+      "error",
+      "unix"
+    ],
+    "quotes": [
+      "error",
+      "single"
+    ],
+    "semi": [
+      "error",
+      "always"
+    ]
+  }
+}

.gitignore

@@ -11,7 +11,6 @@ env/
 pyvenv/
 build/
 develop-eggs/
-dist/
 downloads/
 eggs/
 lib/

aiohttp_admin/__init__.py

@@ -2,15 +2,19 @@
 import jinja2
 from aiohttp import web
 
-
-from .admin import AdminHandler, setup_admin_handlers
-from .consts import PROJ_ROOT, TEMPLATE_APP_KEY, APP_KEY
+from .admin import (
+    AdminHandler,
+    setup_admin_handlers,
+    setup_admin_on_rest_handlers,
+    AdminOnRestHandler,
+)
+from .consts import PROJ_ROOT, TEMPLATE_APP_KEY, APP_KEY, TEMPLATES_ROOT
 from .security import Permissions, require, authorize
 from .utils import gather_template_folders
 
 
 __all__ = ['AdminHandler', 'setup', 'get_admin', 'Permissions', 'require',
-           'authorize']
+           'authorize', '_setup', ]
 __version__ = '0.0.2'
 
 
@@ -37,5 +41,34 @@ def setup(app, admin_conf_path, *, resources, static_folder=None,
     return admin
 
 
+def _setup(app, *, schema,  title=None, app_key=APP_KEY, db=None):
+    """Initialize the admin-on-rest admin"""
+
+    admin = web.Application(loop=app.loop)
+    app[app_key] = admin
+    loader = jinja2.FileSystemLoader([TEMPLATES_ROOT, ])
+    aiohttp_jinja2.setup(admin, loader=loader, app_key=TEMPLATE_APP_KEY)
+
+    if title:
+        schema.title = title
+
+    resources = [
+        init(db, info['table'], url=info['url'])
+        for init, info in schema.resources
+    ]
+
+    admin_handler = AdminOnRestHandler(
+        admin,
+        resources=resources,
+        loop=app.loop,
+        schema=schema,
+    )
+
+    admin['admin_handler'] = admin_handler
+    setup_admin_on_rest_handlers(admin, admin_handler)
+
+    return admin
+
+
 def get_admin(app, *, app_key=APP_KEY):
     return app.get(app_key)

aiohttp_admin/admin.py

@@ -2,13 +2,16 @@
 from aiohttp_security import remember, forget
 from yarl import URL
 
-from .consts import TEMPLATE_APP_KEY
+from .consts import TEMPLATE_APP_KEY, PROJ_ROOT
 from .exceptions import JsonValidaitonError
 from .security import authorize
 from .utils import json_response, validate_payload, LoginForm
 
 
-__all__ = ['AdminHandler', 'setup_admin_handlers']
+__all__ = [
+    'AdminHandler', 'setup_admin_handlers', 'setup_admin_on_rest_handlers',
+    'AdminOnRestHandler',
+]
 
 
 class AdminHandler:
@@ -80,3 +83,78 @@ def setup_admin_handlers(admin, admin_handler, static_folder, admin_conf_path):
     add_route('DELETE', '/logout', a.logout, name='admin.logout')
     add_static('/static', path=static_folder, name='admin.static')
     add_static('/config', path=admin_conf_path, name='admin.config')
+
+
+class AdminOnRestHandler:
+
+    template = 'admin_on_rest.jinja2'
+
+    def __init__(self, admin, *, resources, loop, schema):
+        self._admin = admin
+        self._loop = loop
+        self.schema = schema
+
+        for r in resources:
+            r.setup(self._admin, URL('/'))
+        self._resources = tuple(resources)
+
+    @property
+    def resources(self):
+        return self._resources
+
+    async def index_page(self, request):
+        """
+        Return index page with initial state for admin
+        """
+        context = {"initial_state": self.schema.to_json()}
+
+        return render_template(
+            self.template,
+            request,
+            context,
+            app_key=TEMPLATE_APP_KEY,
+        )
+
+    async def token(self, request):
+        """
+        Validation of user data and generate auth token
+        """
+        raw_payload = await request.read()
+        data = validate_payload(raw_payload, LoginForm)
+        await authorize(request, data['username'], data['password'])
+
+        router = request.app.router
+        location = router["admin.index"].url_for().human_repr()
+        payload = {"location": location}
+        response = json_response(payload)
+        await remember(request, response, data['username'])
+
+        return response
+
+    async def logout(self, request):
+        """
+        Simple handler for logout
+        """
+        if "Authorization" not in request.headers:
+            msg = "Auth header is not present, can not destroy token"
+            raise JsonValidaitonError(msg)
+
+        response = json_response()
+        await forget(request, response)
+
+        return response
+
+
+def setup_admin_on_rest_handlers(admin, admin_handler):
+    """
+    Initialize routes.
+    """
+    add_route = admin.router.add_route
+    add_static = admin.router.add_static
+    static_folder = str(PROJ_ROOT / 'static')
+    a = admin_handler
+
+    add_route('GET', '', a.index_page, name='admin.index')
+    add_route('POST', '/token', a.token, name='admin.token')
+    add_static('/static', path=static_folder, name='admin.static')
+    add_route('DELETE', '/logout', a.logout, name='admin.logout')

aiohttp_admin/backends/sa.py

@@ -1,4 +1,5 @@
 import sqlalchemy as sa
+from sqlalchemy.dialects import postgresql
 
 from ..resource import AbstractResource
 from ..exceptions import ObjectNotFound
@@ -11,6 +12,16 @@
 __all__ = ['PGResource', 'MySQLResource']
 
 
+DATA_TYPES = {
+    sa.Integer: 'integer',
+    sa.Text: 'string',
+    sa.Float: 'number',
+    sa.Date: 'date',
+    sa.Boolean: 'bool',
+    postgresql.JSON: 'json',
+}
+
+
 class PGResource(AbstractResource):
 
     def __init__(self, db, table, primary_key='id', url=None):
@@ -33,6 +44,27 @@ def pool(self):
     def table(self):
         return self._table
 
+    @staticmethod
+    def get_type_of_fields(fields, table):
+        """
+        Return data types of `fields` that are in `table`.
+
+        :param fields: list - list of fields that need to be returned
+        :param table: sa.Table - the current table
+        :return: list - list of the tuples `(field_name, fields_type)`
+        """
+
+        actual_fields = [
+            field for field in table.c.items() if field[0] in fields
+        ]
+
+        data_type_fields = {
+            name: DATA_TYPES.get(type(field_type.type), 'string')
+            for name, field_type in actual_fields
+        }
+
+        return data_type_fields
+
     async def list(self, request):
         await require(request, Permissions.view)
         columns_names = list(self._table.c.keys())

aiohttp_admin/contrib/__init__.py

@@ -0,0 +1 @@
+from .admin import Schema  # noqa

aiohttp_admin/contrib/admin.py

@@ -0,0 +1,68 @@
+import json
+
+
+__all__ = ['Schema', ]
+
+
+class Schema:
+    """
+    The main abstraction for registering tables and presenting data in
+    admin-on-rest format.
+    """
+
+    def __init__(self, title='Admin'):
+        self.title = title
+        self.endpoints = []
+
+    def register(self, Endpoint):
+        """
+        Register a wrapped `ModelAdmin` class as the endpoint for admin page.
+
+        @schema.register
+        class User(admin.ModelAdmin):
+            pass
+
+        """
+        self.endpoints.append(Endpoint())
+
+        return Endpoint
+
+    def to_json(self):
+        """
+        Prepare data for the initial state of the admin-on-rest
+        """
+        endpoints = []
+        for endpoint in self.endpoints:
+            list_fields = endpoint.fields
+            resource_type = endpoint.Meta.resource_type
+            table = endpoint.Meta.table
+
+            data = endpoint.to_dict()
+            data['fields'] = resource_type.get_type_of_fields(
+                list_fields,
+                table,
+            )
+            endpoints.append(data)
+
+        data = {
+            'title': self.title,
+            'endpoints': sorted(endpoints, key=lambda x: x['name']),
+        }
+
+        return json.dumps(data)
+
+    @property
+    def resources(self):
+        """
+        Return list of all registered resources.
+        """
+        resources = []
+
+        for endpoint in self.endpoints:
+            resource_type = endpoint.Meta.resource_type
+            table = endpoint.Meta.table
+            url = endpoint.name
+
+            resources.append((resource_type, {'table': table, 'url': url}))
+
+        return resources

aiohttp_admin/contrib/models.py

@@ -0,0 +1,27 @@
+class ModelAdmin:
+    """
+    The class provides the possibility of declarative describe of information
+    about the table and describe all things related to viewing this table on
+    the administrator's page.
+
+
+    class Users(models.ModelAdmin):
+        fields = ('id', 'username', )
+
+        class Meta:
+            resource_type = PGResource
+            table = users
+
+    """
+
+    def __init__(self):
+        self.name = self.__class__.__name__.lower()
+
+    def to_dict(self):
+        """
+        Return dict with the all base information about the instance.
+        """
+
+        data = {"name": self.name}
+
+        return data