teracyhq-incubator/flask-boilerplate

Boilerplate to speed up Flask development with best practices.

flask-boilerplate's Issues

add support for @extract_args to avoid boilerplate

from:

    @route('', methods=['GET'])
    @token_auth_required()
    @permissions_required(admin_role_permission)
    @marshal_with(_user_list_schema)
    @paginated
    @use_args(search_args)  # TODO(hoate): add support for @extract_args to avoid boilerplate
    def index(self, args):
        filters, args = extract_filters(args)
        args['filters'] = filters
        return auth_datastore.find_users(**args), args

to:

    @route('', methods=['GET'])
    @token_auth_required()
    @permissions_required(admin_role_permission)
    @marshal_with(_user_list_schema)
    @paginated
    @extract_args(search_args) 
    def index(self, args):
        return auth_datastore.find_users(**args), args

all error messages should follow error message specified on the REST API Design GuideLine

and the messages should be clear.

should fully support mediaType

as specified here: https://github.com/teracyhq/flask-boilerplate/blob/develop/docs/dev-guide/rest_api_design_guideline.rst#L33

use better semantic special method names for Resource

CRUD and list => CRUDL

create -> POST
read -> GET
update -> PUT
delete -> DELETE
list -> GET

update this on https://github.com/teracyhq/flask-boilerplate/blob/develop/app/api/base.py#L166-L177

to:

    special_methods = {
        'get': ['GET'],
        'put': ['PUT'],
        'patch': ['PATCH'],
        'post': ['POST'],
        'delete': ['DELETE'],
        'index': ['GET'],
        'create': ['POST'],
        'read': ['GET'],
        'update': ['PUT'],
        'list': ['GET']
    }

note: remember to update existing resources (UserResource, RoleResource)

run full tests on travis-ci

need to run full tests instead of just current unit tests

upgrade to semantic pip versions to fix broken changes

many places are broken due to latest incompatible changes from pip packages