tracim.views.example_api.example_api_controller

Complexity

Total Complexity

6

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	ExampleApiController.get_user()	0	15	1
A	ExampleApiController.get_users()	0	20	1
A	ExampleApiController.del_user()	0	9	1
A	ExampleApiController.bind()	0	15	1
A	ExampleApiController.add_user()	0	17	1
A	ExampleApiController.about()	0	9	1

# -*- coding: utf-8 -*-
from datetime import datetime

from pyramid.config import Configurator

from hapic.data import HapicData

from tracim.extensions import hapic
from tracim.views.controllers import Controller
from tracim.views.example_api.schema import *


class ExampleApiController(Controller):

    @hapic.with_api_doc()
    @hapic.output_body(AboutResponseSchema())

The variable AboutResponseSchema does not seem to be defined.

    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.with_api_doc()
    @hapic.output_body(ListsUserSchema())

The variable ListsUserSchema does not seem to be defined.

    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())

The variable UserPathSchema does not seem to be defined.

    @hapic.output_body(UserSchema())

The variable UserSchema does not seem to be defined.

    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',)))

The variable UserSchema does not seem to be defined.

    @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(),

The variable NoContentSchema does not seem to be defined.

                       default_http_code=204)
    @hapic.input_path(UserPathSchema())

The variable UserPathSchema does not seem to be defined.

    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