"""Application. The API application is a `flask` application. It provides simple features such as registering a url for a specific handlers. """ from abacus_common_logic.connectors.database import db from abacus_common_logic.marshalling.custom_fields import ma from abacus_common_logic.marshalling.helpers import patch_default_validation_status from abacus_common_logic.utils.users import set_flask_user_details_from_headers import analytics from flask import Flask from owslogger import flask_logger from owsrequest import flask_request from owsresponse import response from owsresponse.adaptors.flask import flaskify from werkzeug.exceptions import HTTPException, InternalServerError from payee.connectors.sentry import setup_sentry from payee.logic.exceptions import LogicError from payee.utils.exception import FormattedException def create_app(config): """Create an app.""" app = Flask(config.SERVICE_NAME) app.config.from_object(config) app.url_map.strict_slashes = False setup_application_log(app, config) setup_owsrequest(app, config) setup_db(app, config) setup_segment(config) setup_sentry(config) setup_marshmallow(app) register_blueprints(app) register_request_handler(app) register_error_handlers(app) patch_default_validation_status() return app def setup_owsrequest(app, config): """Set up request framework.""" try: import uwsgi # noqa uwsgiRunning = True except ImportError: uwsgiRunning = False flask_request.setup( app, config.ENVIRONMENT, add_request_context=True, label_profile=True, verify_access=True, rules_file='payee/access_rules.yml', access_log_only=config.ONLY_LOG_ACCESS_ERRORS, exclude_paths=[config.HEALTH_CHECK], uwsgi_cache_enabled=uwsgiRunning, ) def setup_application_log(app, config): """Set up the application log.""" flask_logger.setup( app, config.ENVIRONMENT, config.LOGGER_NAME, config.LOGGER_LEVEL, config.SERVICE_NAME, config.SERVICE_VERSION, exclude_paths=[config.HEALTH_CHECK], ) def setup_db(app, config): """Set up the database.""" app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql+pymysql://{}:{}@{}:{}/{}'.format( config.MYSQL_DB_USER, config.MYSQL_DB_PASS, config.MYSQL_DB_HOST, config.MYSQL_DB_PORT, config.MYSQL_DB_NAME, ) db.init_app(app) def setup_marshmallow(app): """Set up marshmallow.""" ma.init_app(app) def register_blueprints(app): """Register blueprints.""" from payee.blueprints.bank_details import bank_details_api from payee.blueprints.base import base_api from payee.blueprints.payee import payee_api from payee.blueprints.payee_kyc_notification import ( account_payee_kyc_notification_api, payee_kyc_notification_api, ) from payee.blueprints.payoneer import payoneer_api from payee.blueprints.tax_details import tax_details_api from payee.blueprints.tax_form import tax_form_api from payee.blueprints.tax_reset import tax_reset_api from payee.blueprints.tax_withholding_override import tax_withholding_override_api app.register_blueprint(base_api) app.register_blueprint(tax_details_api) app.register_blueprint(payoneer_api) app.register_blueprint(tax_form_api) app.register_blueprint(bank_details_api) app.register_blueprint(payee_kyc_notification_api) app.register_blueprint(account_payee_kyc_notification_api) app.register_blueprint(payee_api) app.register_blueprint(tax_withholding_override_api) app.register_blueprint(tax_reset_api) def register_error_handlers(app): """Register error handlers.""" def http_error_handler(error): """Handle http errors.""" return flaskify( response.create_error_response( message=error.description, status=error.code, code='error' ) ) app.register_error_handler(HTTPException, http_error_handler) def exception_handler(_): """Handle exceptions.""" message = ( 'The server encountered an internal error ' 'and was unable to complete your request.' ) return flaskify(response.create_fatal_response(message)) app.register_error_handler(InternalServerError, exception_handler) def formatted_exception_handler(error): return flaskify( response.create_error_response( message=error.to_dict(), status=error.status_code, code='error' ) ) app.register_error_handler(FormattedException, formatted_exception_handler) def logic_error_handler(error): """Handle logic errors.""" return flaskify( response.create_error_response(message=str(error), status=400, code='error') ) app.register_error_handler(LogicError, logic_error_handler) def register_request_handler(app): """Register function to preprocess request data.""" @app.before_request def before_request_start(): """Parse the user details in the header into flask.g.""" set_flask_user_details_from_headers() def setup_segment(config): """Set up segment client.""" analytics.write_key = config.SEGMENT_WRITE_KEY