drop example api

tracim/__init__.py

@@ -14,7 +14,6 @@ from tracim.lib.utils.authentification import BASIC_AUTH_WEBUI_REALM
 from tracim.lib.utils.authorization import AcceptAllAuthorizationPolicy
 from tracim.lib.utils.authorization import TRACIM_DEFAULT_PERM
 from tracim.views.core_api.session_controller import SessionController
-#from tracim.views.example_api.example_api_controller import ExampleApiController
 from tracim.views.default.default_controller import DefaultController
 
 
@@ -49,8 +48,6 @@ def main(global_config, **settings):
     # Add controllers
     default_controllers = DefaultController()
     default_controllers.bind(configurator)
-    #example_api_controllers = ExampleApiController()
-    #example_api_controllers.bind(configurator)
     session_api = SessionController()
     session_api.bind(configurator)
     # TODO - G.M - 09-04-2018 - Enable swagger ui doc

tracim/views/example_api/__init__.py

@@ -1 +0,0 @@
-# -*- coding: utf-8 -*-

tracim/views/example_api/example_api_controller.py

@@ -1,121 +0,0 @@
-# -*- coding: utf-8 -*-
-# TODO - G.M - 10-04-2018 - [cleanup][tempExample] - Drop this file
-from datetime import datetime
-try:  # Python 3.5+
-    from http import HTTPStatus
-except ImportError:
-    from http import client as HTTPStatus
-from pyramid.config import Configurator
-
-from hapic.data import HapicData
-
-from tracim.exceptions import InsufficientUserWorkspaceRole, NotAuthentificated
-from tracim.extensions import hapic
-from tracim.lib.utils.authorization import require_workspace_role
-from tracim.models.data import UserRoleInWorkspace
-from tracim.views.controllers import Controller
-from tracim.views.example_api.schema import *
-
-
-class ExampleApiController(Controller):
-
-    @hapic.with_api_doc()
-    @hapic.output_body(AboutResponseSchema())
-    def about(self, context, request):
-        """
-        General information about this API.
-        """
-        return {
-            'version': '1.2.3',
-            'datetime': datetime(2017, 12, 7, 10, 55, 8, 488996),
-        }
-
-    @hapic.handle_exception(
-        NotAuthentificated,
-        http_code=HTTPStatus.BAD_REQUEST
-    )
-    @hapic.with_api_doc()
-    @hapic.output_body(ListsUserSchema())
-    @require_workspace_role(UserRoleInWorkspace.READER)
-    def get_users(self, context, request):
-        """
-        Obtain users list.
-        """
-        return {
-            'item_nb': 1,
-            'items': [
-                {
-                    'id': 4,
-                    'username': 'some_user',
-                    'display_name': 'Damien Accorsi',
-                    'company': 'Algoo',
-                },
-            ],
-            'pagination': {
-                'first_id': 0,
-                'last_id': 5,
-                'current_id': 0,
-            }
-        }
-
-    @hapic.with_api_doc()
-    @hapic.input_path(UserPathSchema())
-    @hapic.output_body(UserSchema())
-    def get_user(self, context, request, hapic_data: HapicData):
-        """
-        Obtain one user
-        """
-        return {
-             'id': 4,
-             'username': 'some_user',
-             'email_address': 'some.user@hapic.com',
-             'first_name': 'Damien',
-             'last_name': 'Accorsi',
-             'display_name': 'Damien Accorsi',
-             'company': 'Algoo',
-        }
-
-    @hapic.with_api_doc()
-    # TODO - G.M - 2017-12-5 - Support input_forms ?
-    # TODO - G.M - 2017-12-5 - Support exclude, only ?
-    @hapic.input_body(UserSchema(exclude=('id',)))
-    @hapic.output_body(UserSchema())
-    def add_user(self, context, request, hapic_data: HapicData):
-        """
-        Add new user
-        """
-        return {
-             'id': 4,
-             'username': 'some_user',
-             'email_address': 'some.user@hapic.com',
-             'first_name': 'Damien',
-             'last_name': 'Accorsi',
-             'display_name': 'Damien Accorsi',
-             'company': 'Algoo',
-        }
-
-    @hapic.with_api_doc()
-    @hapic.output_body(NoContentSchema(),
-                       default_http_code=204)
-    @hapic.input_path(UserPathSchema())
-    def del_user(self, context, request, hapic_data: HapicData):
-        """
-        delete user
-        """
-        return NoContentSchema()
-
-    def bind(self, configurator: Configurator):
-        configurator.add_route('about', '/about', request_method='GET')
-        configurator.add_view(self.about, route_name='about', renderer='json')
-
-        configurator.add_route('get_users', '/users', request_method='GET')  # nopep8
-        configurator.add_view(self.get_users, route_name='get_users', renderer='json')  # nopep8
-
-        configurator.add_route('get_user', '/users/{id}', request_method='GET')  # nopep8
-        configurator.add_view(self.get_user, route_name='get_user', renderer='json')  # nopep8
-
-        configurator.add_route('add_user', '/users/', request_method='POST')  # nopep8
-        configurator.add_view(self.add_user, route_name='add_user', renderer='json')  # nopep8
-
-        configurator.add_route('del_user', '/users/{id}', request_method='DELETE')  # nopep8
-        configurator.add_view(self.del_user, route_name='del_user', renderer='json')  # nopep8

tracim/views/example_api/schema.py

@@ -1,57 +0,0 @@
-# -*- coding: utf-8 -*-
-# TODO - G.M - 10-04-2018 - [cleanup][tempExample] - Drop this file
-import marshmallow
-
-
-class NoContentSchema(marshmallow.Schema):
-    pass
-
-
-class AboutResponseSchema(marshmallow.Schema):
-    version = marshmallow.fields.String(required=True,)
-    datetime = marshmallow.fields.DateTime(required=True)
-
-
-class UserPathSchema(marshmallow.Schema):
-    id = marshmallow.fields.Int(
-        required=True,
-        validate=marshmallow.validate.Range(min=1),
-    )
-
-
-class UserSchema(marshmallow.Schema):
-    id = marshmallow.fields.Int(required=True)
-    username = marshmallow.fields.String(
-        required=True,
-        validate=marshmallow.validate.Regexp(regex='[\w-]+'),
-    )
-    email_address = marshmallow.fields.Email(required=True)
-    first_name = marshmallow.fields.String(required=True)
-    last_name = marshmallow.fields.String(required=True)
-    display_name = marshmallow.fields.String(required=True)
-    company = marshmallow.fields.String(required=True)
-
-
-class PaginationSchema(marshmallow.Schema):
-    first_id = marshmallow.fields.Int(required=True)
-    last_id = marshmallow.fields.Int(required=True)
-    current_id = marshmallow.fields.Int(required=True)
-
-
-class ListsUserSchema(marshmallow.Schema):
-    item_nb = marshmallow.fields.Int(
-        required=True,
-        validate=marshmallow.validate.Range(min=0)
-    )
-    items = marshmallow.fields.Nested(
-        UserSchema,
-        many=True,
-        only=['id', 'username', 'display_name', 'company']
-    )
-    # TODO - G.M - 2017-12-05 - Fix nested schema import into doc !
-    # Can't add doc for nested Schema properly
-    # When schema item isn't added through their own method
-    # Ex : Pagination Schema doesn't work here but UserSchema is ok.
-    pagination = marshmallow.fields.Nested(
-        PaginationSchema
-    )