v2api.py

from flask_restful import Api
from apispec import APISpec
from apispec.ext.marshmallow import MarshmallowPlugin
from flask_apispec.extension import FlaskApiSpec

from _swagger_api.affiliate import AffiliateView
from _swagger_api.memberships import MembershipsView
from _swagger_api.wallet import WalletView
from _swagger_api.users import UserViewModel, UserListView, AuthViewModel
from _swagger_api.memberships import CouponsView

docs = FlaskApiSpec()


def add_wallet_endpoints(api: Api) -> Api:
    """
    **add_wallet_endpoints**
        will create wallet related endpoints
    :param api:
    :return: api
    """
    # create new wallet
    api.add_resource(WalletView, '/api/v2/wallet', endpoint='create_wallet', methods=['POST'])
    # get an existing wallet
    get_wallet_url: str = '/api/v2/wallet/<string:organization_id>/<string:uid>'
    api.add_resource(WalletView, get_wallet_url, endpoint='get_wallet', methods=['GET'])
    # update wallet
    api.add_resource(WalletView, '/api/v2/wallet', endpoint='update_wallet', methods=['PUT'])
    return api


def add_user_endpoints(api: Api) -> Api:
    """
        **add_user_endpoints**
            will add user related endpoints
    :param api:
    :return: Api
    """
    # Adds new User
    api.add_resource(UserViewModel, '/api/v2/user', endpoint='create_user', methods=['POST'])
    # Update existing user
    api.add_resource(UserViewModel, '/api/v2/user', endpoint='update_user', methods=['PUT'])
    # Get user record
    get_user_url: str = '/api/v2/user/<string:organization_id>/<string:uid>'
    api.add_resource(UserViewModel, get_user_url, endpoint='get_user', methods=['GET'])
    return api


def add_auth_endpoints(api: Api) -> Api:
    """
        **add_auth_endpoints**
            adds authentication related endpoints
    :param api:
    :return: APi
    """
    # login user
    api.add_resource(AuthViewModel, '/api/v2/auth/login', endpoint='user_login', methods=['POST'])
    # logout user
    api.add_resource(AuthViewModel, '/api/v2/auth/logout', endpoint='user_logout', methods=['PUT'])
    return api


def add_membership_endpoints(api: Api) -> Api:
    """
        ** Adding resources for membership **
        :param api:
        :return: API
    """
    api.add_resource(MembershipsView, '/api/v2/membership', endpoint='create_membership', methods=['POST'])
    get_endpoint: str = '/api/v2/membership/<string:organization_id>/<string:uid>'
    api.add_resource(MembershipsView, get_endpoint, endpoint='get_membership', methods=['GET'])
    api.add_resource(MembershipsView, '/api/v2/membership', endpoint='update_membership', methods=['PUT'])

    return api


def add_affiliate_endpoints(api: Api) -> Api:
    """
        ** adding affiliate endpoints **
    :param api:
    :return: Api
    """
    get_affiliate_url: str = '/api/v2/affiliate/<string:organization_id>/<string:affiliate_id>'
    api.add_resource(AffiliateView, '/api/v2/affiliate', endpoint='create_affiliate', methods=['POST'])
    api.add_resource(AffiliateView, get_affiliate_url, endpoint='get_affiliate', methods=['GET'])
    return api


def add_coupons_endpoints(api: Api) -> Api:
    """
        ** adding coupon endpoints **
    :param api:
    :return: Api
    """
    coupon_code_url: str = '/api/v2/coupon/<string:organization_id>/<string:code>'
    api.add_resource(AffiliateView, coupon_code_url, endpoint='get_coupon', methods=['GET'])
    api.add_resource(AffiliateView, '/api/v2/coupon', endpoint='create_coupon', methods=['POST'])
    api.add_resource(AffiliateView, '/api/v2/coupon', endpoint='update_coupon', methods=['PUT'])
    # api.add_resource(AffiliateView, coupon_code_url, endpoint='delete_coupon', methods=['DELETE'])
    return api


def register_v2_api(app):
    """
    **register_v2_api**
        this function only adds version 2 of the public facing API
        register v2 swagger compatible api here
    :param app:
    :return:
    """
    api = Api(app)
    # adding authentication & wallet and user endpoints
    api = add_auth_endpoints(api=add_wallet_endpoints(api=add_user_endpoints(api=api)))
    api = add_membership_endpoints(api=api)
    api = add_affiliate_endpoints(api=api)
    api = add_coupons_endpoints(api=api)

    app.config.update({
        'APISPEC_SPEC': APISpec(

            title='Memberships & Affiliate Management API',
            version='0.1.1',
            plugins=[MarshmallowPlugin()],
            openapi_version='2.0'
        ),
        'APISPEC_SWAGGER_URL': '/api',
        'APISPEC_SWAGGER_UI_URL': '/api-ui'

    })
    # registering documentation
    docs.init_app(app)
    docs.register(target=UserViewModel, endpoint='create_user')
    docs.register(target=UserViewModel, endpoint='update_user')
    docs.register(target=UserViewModel, endpoint='get_user')

    # Authentication Docs
    docs.register(target=AuthViewModel, endpoint='user_login')
    docs.register(target=AuthViewModel, endpoint='user_logout')

    # Wallet Docs
    docs.register(target=WalletView, endpoint='create_wallet')
    docs.register(target=WalletView, endpoint='get_wallet')

    # Memberships Docs
    docs.register(target=MembershipsView, endpoint='create_membership')
    docs.register(target=MembershipsView, endpoint='get_membership')
    docs.register(target=MembershipsView, endpoint='update_membership')

    # Affiliate Docs
    docs.register(target=AffiliateView, endpoint='create_affiliate')
    docs.register(target=AffiliateView, endpoint='get_affiliate')

    # Coupon Code Docs
    docs.register(target=CouponsView, endpoint='create_coupon')
    docs.register(target=CouponsView, endpoint='update_coupon')
    docs.register(target=CouponsView, endpoint='get_coupon')

    return app