<filename>aiokts/web/view.py<gh_stars>1-10
import asyncio
import json

from aiohttp import web
from aiohttp.web_exceptions import HTTPNotFound, HTTPException, \
    HTTPMethodNotAllowed
from aiokts.web.context import Context
from aiokts.web.error import ServerError

from aiokts.util.arguments import ArgumentException
from aiokts.web.response import ApiErrorResponse, ApiOkResponse


class BaseView(web.View):
    CONTEXT_CLS = Context

    def __init__(self, request):
        super().__init__(request)
        self.app = self.request.app
        self.ctx = self.request.ctx
        self.request_data = None

    @property
    def logger(self):
        return self.ctx.logger if self.ctx is not None else None

    @property
    def store(self):
        return self.app.store

    @property
    def loop(self):
        return self.app.loop

    @property
    def debug(self):
        return self.app.debug

    async def _iter(self):
        try:
            await self._parse_request()
            await self.pre_handle()
            res = await super(BaseView, self)._iter()
            await self.post_handle(self.request, res)
            return res
        except Exception as e:
            res = self.handle_exception(e)
            return res

    async def _parse_request(self):
        if self.request.method == 'GET':
            source = self.request.url.query
        else:
            if self.request.content_type.startswith('application/json'):
                try:
                    source = await self.request.json()
                except json.JSONDecodeError:
                    raise ServerError(ServerError.BAD_REQUEST(
                        message='Body must be a valid json'))
            elif self.request.content_type.startswith(
                    'application/x-www-form-urlencoded'):
                source = await self.request.post()
            else:
                source = None
        self.request_data = source

    async def pre_handle(self):
        pass

    async def post_handle(self, request, response):
        pass

    def response_api_ok(self, data=None, http_status=200, *,
                        headers=None, charset=None, json_dump_func=None,
                        **kwargs):
        return ApiOkResponse(ctx=self.ctx,
                             data=data, http_status=http_status,
                             headers=headers, charset=charset,
                             json_dump_func=json_dump_func, **kwargs)

    def response_api_error(self, message=None, data=None, http_status=500, *,
                           headers=None, charset=None, json_dump_func=None,
                           **kwargs):
        return ApiErrorResponse(ctx=self.ctx,
                                message=message, data=data,
                                http_status=http_status, headers=headers,
                                charset=charset, json_dump_func=json_dump_func,
                                **kwargs)

    def handle_exception(self, e):
        if isinstance(e, ServerError):
            error = e.error
            if error.http_code is None:
                status = 500
            else:
                status = error.http_code
            self.logger.error(
                '[{}] Error: {}'.format(repr(error.code), error.message))

            return self.response_api_error(message=error.message,
                                           data=error.payload,
                                           http_status=status,
                                           code=error.code)
        elif isinstance(e, ArgumentException):
            self.logger.warning('ArgumentException: {}'.format(e.message))

            if e.field is not None:
                message = 'Field {} is invalid'.format(e.field)
            else:
                message = ''

            return self.response_api_error(message=message,
                                           system_message=e.message,
                                           http_status=400,
                                           code='bad_request',
                                           data=dict(field=e.field))
        elif isinstance(e, HTTPException):
            if e.status_code >= 500:
                self.logger.exception('HTTPException: {}'.format(str(e)),
                                      exc_info=e)

            # e.headers.pop('Content-Type')
            return self.response_api_error(message=e.reason,
                                           http_status=e.status_code,
                                           headers=e.headers)
        elif isinstance(e, Exception):
            self.logger.exception('Exception: {}'.format(str(e)), exc_info=e)
            return self.response_api_error(message='Internal Server Error')
        else:
            self.logger.error('{} is not an exception'.format(repr(e)))


class ActionBaseView(BaseView):
    CONTEXT_CLS = Context

    def __init__(self, request):
        super().__init__(request)

    @property
    def store(self):
        return self.app.store

    @property
    def default_methods(self):
        """
            Dict with keys for HTTP Methods (GET, POST, ...)
            and values are dict with mapping action => func
            i.e.
            {
                "GET": self.default_get,
                "POST": self.default_post
            }
        """
        return {}

    @property
    def methods(self):
        """
            Dict with keys for HTTP Methods (GET, POST, ...)
            and values are dict with mapping action => func
            i.e.
            {
                "GET": {
                    "home": self.home
                },
                "POST": {
                    "post": self.post
                }
            }
        """
        return {}

    async def before_action(self):
        pass

    async def after_action(self):
        pass

    async def _iter(self):
        try:
            await self._parse_request()
            await self.pre_handle()

            action_title = self.request.match_info['method']

            if action_title is None:
                raise HTTPNotFound()

            method = self.request.method.upper()
            methods = self.methods
            if methods is None:
                methods = {}

            actions = methods.get(method, {})

            def_method = self.default_methods.get(method)
            if action_title in actions:
                executing_method = actions.get(action_title)
            elif def_method is not None:
                executing_method = def_method
            else:
                executing_method = None

            if executing_method is not None:
                await self.before_action()
                result = await executing_method()
                await self.after_action()
                await self.post_handle(self.request, result)
                return result
            else:
                allowed_methods = []
                for k, k_actions in methods.items():
                    if action_title in k_actions:
                        allowed_methods.append(k)

                if allowed_methods:
                    raise HTTPMethodNotAllowed(method,
                                               allowed_methods=allowed_methods)

                raise HTTPNotFound()
        except Exception as e:
            res = self.handle_exception(e)
            return res

<filename>aiokts/web/view.py<gh_stars>1-10
import asyncio
import json

from aiohttp import web
from aiohttp.web_exceptions import HTTPNotFound, HTTPException, \
    HTTPMethodNotAllowed
from aiokts.web.context import Context
from aiokts.web.error import ServerError

from aiokts.util.arguments import ArgumentException
from aiokts.web.response import ApiErrorResponse, ApiOkResponse


class BaseView(web.View):
    CONTEXT_CLS = Context

    def __init__(self, request):
        super().__init__(request)
        self.app = self.request.app
        self.ctx = self.request.ctx
        self.request_data = None

    @property
    def logger(self):
        return self.ctx.logger if self.ctx is not None else None

    @property
    def store(self):
        return self.app.store

    @property
    def loop(self):
        return self.app.loop

    @property
    def debug(self):
        return self.app.debug

    async def _iter(self):
        try:
            await self._parse_request()
            await self.pre_handle()
            res = await super(BaseView, self)._iter()
            await self.post_handle(self.request, res)
            return res
        except Exception as e:
            res = self.handle_exception(e)
            return res

    async def _parse_request(self):
        if self.request.method == 'GET':
            source = self.request.url.query
        else:
            if self.request.content_type.startswith('application/json'):
                try:
                    source = await self.request.json()
                except json.JSONDecodeError:
                    raise ServerError(ServerError.BAD_REQUEST(
                        message='Body must be a valid json'))
            elif self.request.content_type.startswith(
                    'application/x-www-form-urlencoded'):
                source = await self.request.post()
            else:
                source = None
        self.request_data = source

    async def pre_handle(self):
        pass

    async def post_handle(self, request, response):
        pass

    def response_api_ok(self, data=None, http_status=200, *,
                        headers=None, charset=None, json_dump_func=None,
                        **kwargs):
        return ApiOkResponse(ctx=self.ctx,
                             data=data, http_status=http_status,
                             headers=headers, charset=charset,
                             json_dump_func=json_dump_func, **kwargs)

    def response_api_error(self, message=None, data=None, http_status=500, *,
                           headers=None, charset=None, json_dump_func=None,
                           **kwargs):
        return ApiErrorResponse(ctx=self.ctx,
                                message=message, data=data,
                                http_status=http_status, headers=headers,
                                charset=charset, json_dump_func=json_dump_func,
                                **kwargs)

    def handle_exception(self, e):
        if isinstance(e, ServerError):
            error = e.error
            if error.http_code is None:
                status = 500
            else:
                status = error.http_code
            self.logger.error(
                '[{}] Error: {}'.format(repr(error.code), error.message))

            return self.response_api_error(message=error.message,
                                           data=error.payload,
                                           http_status=status,
                                           code=error.code)
        elif isinstance(e, ArgumentException):
            self.logger.warning('ArgumentException: {}'.format(e.message))

            if e.field is not None:
                message = 'Field {} is invalid'.format(e.field)
            else:
                message = ''

            return self.response_api_error(message=message,
                                           system_message=e.message,
                                           http_status=400,
                                           code='bad_request',
                                           data=dict(field=e.field))
        elif isinstance(e, HTTPException):
            if e.status_code >= 500:
                self.logger.exception('HTTPException: {}'.format(str(e)),
                                      exc_info=e)

            # e.headers.pop('Content-Type')
            return self.response_api_error(message=e.reason,
                                           http_status=e.status_code,
                                           headers=e.headers)
        elif isinstance(e, Exception):
            self.logger.exception('Exception: {}'.format(str(e)), exc_info=e)
            return self.response_api_error(message='Internal Server Error')
        else:
            self.logger.error('{} is not an exception'.format(repr(e)))


class ActionBaseView(BaseView):
    CONTEXT_CLS = Context

    def __init__(self, request):
        super().__init__(request)

    @property
    def store(self):
        return self.app.store

    @property
    def default_methods(self):
        """
            Dict with keys for HTTP Methods (GET, POST, ...)
            and values are dict with mapping action => func
            i.e.
            {
                "GET": self.default_get,
                "POST": self.default_post
            }
        """
        return {}

    @property
    def methods(self):
        """
            Dict with keys for HTTP Methods (GET, POST, ...)
            and values are dict with mapping action => func
            i.e.
            {
                "GET": {
                    "home": self.home
                },
                "POST": {
                    "post": self.post
                }
            }
        """
        return {}

    async def before_action(self):
        pass

    async def after_action(self):
        pass

    async def _iter(self):
        try:
            await self._parse_request()
            await self.pre_handle()

            action_title = self.request.match_info['method']

            if action_title is None:
                raise HTTPNotFound()

            method = self.request.method.upper()
            methods = self.methods
            if methods is None:
                methods = {}

            actions = methods.get(method, {})

            def_method = self.default_methods.get(method)
            if action_title in actions:
                executing_method = actions.get(action_title)
            elif def_method is not None:
                executing_method = def_method
            else:
                executing_method = None

            if executing_method is not None:
                await self.before_action()
                result = await executing_method()
                await self.after_action()
                await self.post_handle(self.request, result)
                return result
            else:
                allowed_methods = []
                for k, k_actions in methods.items():
                    if action_title in k_actions:
                        allowed_methods.append(k)

                if allowed_methods:
                    raise HTTPMethodNotAllowed(method,
                                               allowed_methods=allowed_methods)

                raise HTTPNotFound()
        except Exception as e:
            res = self.handle_exception(e)
            return res

# e.headers.pop('Content-Type') Dict with keys for HTTP Methods (GET, POST, ...)             and values are dict with mapping action => func             i.e.             {                 "GET": self.default_get,                 "POST": self.default_post             } Dict with keys for HTTP Methods (GET, POST, ...)             and values are dict with mapping action => func             i.e.             {                 "GET": {                     "home": self.home                 },                 "POST": {                     "post": self.post                 }             }