app.py

#!/usr/bin/python3

"""
USER MANAGEMENT MODULE & LIFECYCLE MANAGER - REST API
This is being developed for the MF2C Project: http://www.mf2c-project.eu/

Copyright: Roi Sucasas Font, Atos Research and Innovation, 2017.

This code is licensed under an Apache 2.0 license. Please, refer to the LICENSE.TXT file for more information

Created on 18 oct. 2018

@author: Roi Sucasas - ATOS
"""

import config as cfg
# um
from usermgnt import init_config as um_init_config
from usermgnt.modules import um_profiling as um_profiling
from usermgnt.modules import um_sharing_model as um_sharing_model
from usermgnt.modules import um_assessment as um_assesment
from usermgnt.modules import um_user as um_user
from usermgnt.modules import current as current
from usermgnt.modules import policies as policies
# common
from usermgnt.common.logs import LOG
# ext
from flask_cors import CORS
from flask import Flask, request, Response, json
from flask_restful import Resource, Api
from flask_restful_swagger import swagger


'''
REST API
    Routes:
        Root:
            /api/v2
                        GET:    get rest api service status
            User Management:
                /um/user/<string:user_id>
                        GET     get my personal data (user cimi resource)
                /um/user
                        DELETE  remove user (user cimi resource)
                        
                /um/current/<string:val>
                        GET     val=user => get current user
                        GET     val=device => get current device
                        
                /um/user-profile/
                        GET:    get "current" profile
                /um/user-profile/<string:user_profile_id>
                        GET:    get profile by profile ID
                        PUT:    updates profile
                        DELETE: deletes profile
                        
                /um/sharing-model
                        GET:    get current sharing model
                        PUT:    updates User Management global properties (num apps running)
                /um/sharing-model/<string:sharing_model_id>
                        GET:    get a sharing model
                        PUT:    updates a sharing model
                        DELETE: deletes a sharing model
                        
                /um/assesment
                        GET:    gets the status of the current assessment in the device
                        PUT:    start / stop assessment
                        
                /um/check
                        GET:    checks if device can run more apps
'''


try:
    # initialization
    um_init_config.init()
    um_init_config.create_user_profile()
    um_init_config.create_sharing_model()

    # APP
    app = Flask(__name__)
    CORS(app)

    # API DOC
    api = swagger.docs(Api(app),
                       apiVersion=cfg.dic['VERSION'],
                       api_spec_url=cfg.dic['API_DOC_URL'],
                       produces=["application/json", "text/html"],
                       swaggerVersion="1.2",
                       description='mF2C - User Management REST API - version ' + cfg.dic['VERSION'],
                       basePath='http://localhost:' + str(cfg.dic['SERVER_PORT']),
                       resourcePath='/')
except ValueError:
    LOG.error('[app] Exception: Error while initializing app / api')


########################################################################################################################
### USER MANAGEMENT
########################################################################################################################

#
# API 'home' Route
#
#     '/api/v2/'
#         GET:    get rest api service status
#
@app.route('/api/v2', methods=['GET'])
@app.route('/api/v2/', methods=['GET'])
def default_route():
    data = {
        'app': "User Management module REST API",
        'status': "Running",
        'api_doc_json': "http://" + cfg.dic['HOST_IP'] + ":" + str(cfg.dic['SERVER_PORT']) + cfg.dic['API_DOC_URL'],
        'api_doc_html': "http://" + cfg.dic['HOST_IP'] + ":" + str(cfg.dic['SERVER_PORT']) + cfg.dic['API_DOC_URL'] + ".html#!/spec"
    }
    resp = Response(json.dumps(data), status=200, mimetype='application/json')
    return resp


########################################################################################################################
### USER
########################################################################################################################
#
# UserModule route:
#
#   /um/user/<string:user_id>
#            GET     get my personal data (user cimi resource)
#
class UserModule(Resource):
    # GET
    @swagger.operation(
        summary="gets 'my personal data' (from user cimi resource)",
        notes="gets 'my personal data' (from user cimi resource)",
        produces=["application/json"],
        authorizations=[],
        parameters=[{
                "name": "user_id",
                "description": "username",
                "required": True,
                "paramType": "path",
                "type": "string"
            }],
        responseMessages=[{
            "code": 500,
            "message": "Exception processing request"
        }])
    def get(self, user_id):
        return um_user.get_user(user_id)


api.add_resource(UserModule, '/api/v2/um/user/<string:user_id>')


#
# UserModule route:
#
#   /um/user
#            DELETE  remove user (user cimi resource)
#
class UserRemoveModule(Resource):
    # DELETE Deletes a user
    @swagger.operation(
        summary="Deletes a user",
        notes="Deletes a user",
        produces=["application/json"],
        authorizations=[],
        parameters=[{
                "name": "body",
                "description": "Parameters in JSON format.<br/>Example: <br/>{\"user_id\":\"user/testuser\"}",
                "required": True,
                "paramType": "body",
                "type": "string"
            }],
        responseMessages=[{
                "code": 405, "message": "User ID parameter not found"
            }, {
                "code": 500, "message": "Exception processing request"
            }])
    def delete(self):
        return um_user.delete_user(request.get_json())


api.add_resource(UserRemoveModule, '/api/v2/um/user')



########################################################################################################################
### CURRENT USER
### CURRENT DEVICE
########################################################################################################################
#
# CurrentModule route:
#
#   /um/current/<string:val>
#            GET     get current user
#            GET     get current device
#
class CurrentModule(Resource):
    # GET
    @swagger.operation(
        summary="gets current user / device",
        notes="gets current user / device",
        produces=["application/json"],
        authorizations=[],
        parameters=[{
                "name": "val",
                "description": "user / device",
                "required": True,
                "paramType": "path",
                "type": "string"
            }],
        responseMessages=[{
            "code": 500,
            "message": "Exception processing request"
        }])
    def get(self, val):
        return current.getCurrent(val)


api.add_resource(CurrentModule, '/api/v2/um/current/<string:val>')


########################################################################################################################
### USER-PROFILE
########################################################################################################################
#
#  ProfileInstanceById route:
#
#     '/api/v2/um/user-profile/<string:user_profile_id>'
#
#         GET:    get profile by ID
#         PUT:    updates profile
#         DELETE: deletes profile
#
class ProfileInstanceById(Resource):
    # GET Get Profile by ID
    @swagger.operation(
        summary="Returns a profile by ID",
        notes="Returns a profile by ID",
        produces=["application/json"],
        authorizations=[],
        parameters=[{
                "name": "user_profile_id",
                "description": "User ID. Example: '50b12ccc-76fb-45a6-af7f-634312bc7ca5'",
                "required": True,
                "paramType": "path",
                "type": "string"
            }],
        responseMessages=[{
                "code": 500,
                "message": "Exception processing request"
            }])
    def get(self, user_profile_id):
        return um_profiling.get_user_profile_by_id(user_profile_id)


    # PUT Updates the users profile
    @swagger.operation(
        summary="Updates a profile.",
        notes="Updates a profile.",
        produces=["application/json"],
        authorizations=[],
        parameters=[{
                "name": "user_profile_id",
                "description": "User ID. Example: '50b12ccc-76fb-45a6-af7f-634312bc7ca5'",
                "required": True,
                "paramType": "path",
                "type": "string"
            }, {
                "name": "body",
                "description": "Parameters in JSON format.<br/>Example: <br/>{ "
                               "\"device_id\":\"device/50b12ccc-76fb-45a6-af7f-634312bc7ca5\", "
                               "\"resource_contributor\":false, \"service_consumer\":false}",
                "required": True,
                "paramType": "body",
                "type": "string"
            }],
        responseMessages=[{
                "code": 405,
                "message": "User ID / Device ID parameters not found"
            },{
                "code": 500,
                "message": "Exception processing request"
            }])
    def put(self, user_profile_id):
        return um_profiling.update_user_profile_by_id(user_profile_id, request.get_json())


    # DELETE Deletes the users profile
    @swagger.operation(
        summary="Deletes a profile",
        notes="Deletes a profile.",
        produces=["application/json"],
        authorizations=[],
        parameters=[{
                "name": "user_profile_id",
                "description": "User ID. Example: '50b12ccc-76fb-45a6-af7f-634312bc7ca5'",
                "required": True,
                "paramType": "path",
                "type": "string"
            }],
        responseMessages=[{
                "code": 406,
                "message": "User ID / Device ID parameters not found"
            },{
                "code": 500,
                "message": "Exception processing request"
            }])
    def delete(self, user_profile_id):
        return um_profiling.delete_user_profile_by_id(user_profile_id)


api.add_resource(ProfileInstanceById, '/api/v2/um/user-profile/<string:user_profile_id>')


#
#  Profile route:
#
#     '/api/v2/um/user-profile'
#         GET:    get "current" profile
#         POST:   create new profile
#
class Profile(Resource):
    # GET Get the user profile of current device
    @swagger.operation(
        summary="Returns the current user-profile information",
        notes="Returns the current user-profile information",
        produces=["application/json"],
        authorizations=[],
        parameters=[], responseMessages=[{
        "code": 500, "message": "Exception processing request"
    }])
    def get(self):
        return um_profiling.get_current_user_profile()


api.add_resource(Profile, '/api/v2/um/user-profile')


########################################################################################################################
### SHARING MODEL
########################################################################################################################
#
#  SharingModelInstance route:
#
#     /um/sharing-model/<string:sharing_model_id>
#
#         GET:
#         PUT:
#         DELETE:
#
class SharingModelInstanceById(Resource):
    # GET Get the user sharing model
    @swagger.operation(
        summary="Returns a sharing model information",
        notes="Returns a sharing model information",
        produces=["application/json"],
        authorizations=[],
        parameters=[{
                "name": "sharing_model_id",
                "description": "User ID. Example: '50b12ccc-76fb-45a6-af7f-634312bc7ca5'",
                "required": True,
                "paramType": "path",
                "type": "string"
            }],
        responseMessages=[{
                "code": 500,
                "message": "Exception processing request"
            }])
    def get(self, sharing_model_id):
        return um_sharing_model.get_sharing_model_by_id(sharing_model_id)


    # PUT Updates sharing model
    @swagger.operation(
        summary="Updates a sharing model",
        notes="Updates a sharing model",
        produces=["application/json"],
        authorizations=[],
        parameters=[{
                "name": "sharing_model_id",
                "description": "User ID. Example: '50b12ccc-76fb-45a6-af7f-634312bc7ca5'",
                "required": True,
                "paramType": "path",
                "type": "string"
            }, {
            "name": "body",
            "description": "Parameters in JSON format.<br/>Example: <br/>"
                           "{\"user_id\":\"user/testuser\", "
                           "\"device_id\":\"device/50b12ccc-76fb-45a6-af7f-634312bc7ca5\", "
                           "\"gps_allowed\": false, "
                           "\"max_cpu_usage\": 3, "
                           "\"max_memory_usage\": 3, "
                           "\"max_storage_usage\": 3, "
                           "\"max_bandwidth_usage\": 3, "
                           "\"max_apps\":2 , "
                           "\"battery_limit\": 3 }",
            "required": True,
            "paramType": "body",
            "type": "string"
        }],
        responseMessages=[{
            "code": 406,
            "message": "User ID / Device ID parameters not found not found"
        }, {
            "code": 500,
            "message": "Exception processing request"
        }])
    def put(self, sharing_model_id):
        return um_sharing_model.update_sharing_model_by_id(sharing_model_id, request.get_json())


    # DELETE Deletes a sharing model
    @swagger.operation(
        summary="Deletes a sharing model",
        notes="Deletes a sharing model",
        produces=["application/json"],
        authorizations=[],
        parameters=[{
                "name": "sharing_model_id",
                "description": "User ID. Example: '50b12ccc-76fb-45a6-af7f-634312bc7ca5'",
                "required": True,
                "paramType": "path",
                "type": "string"
            }],
        responseMessages=[{
            "code": 406,
            "message": "User ID / Device ID parameters not found not found"
        }, {
            "code": 500,
            "message": "Exception processing request"
        }])
    def delete(self, sharing_model_id):
        return um_sharing_model.delete_sharing_model_by_id(sharing_model_id)


api.add_resource(SharingModelInstanceById, '/api/v2/um/sharing-model/<string:sharing_model_id>')


#
#  SharingModel route:
#
#     '/api/v2/um/sharingmodel'
#         GET:    get "current" sharing model
#         PUT:    updates User Management global properties (num apps running)
#         POST:   create new sharing model
#
class SharingModel(Resource):
    # GET Get the user sharing model
    @swagger.operation(
        summary="Returns the current device/user's sharing model information",
        notes="Returns the current device/user's sharing model information",
        produces=["application/json"],
        authorizations=[],
        parameters=[], responseMessages=[{
        "code": 500, "message": "Exception processing request"
    }])
    def get(self):
        return um_sharing_model.get_current_sharing_model()

    # PUT updates User Management global properties
    @swagger.operation(
        summary="updates User Management global properties",
        notes="updates User Management global properties",
        produces=["application/json"],
        authorizations=[],
        parameters=[{
            "name": "body",
            "description": "Parameters in JSON format.<br/>Example: <br/>{"
                           "\"apps_running\":1}",
            "required": True,
            "paramType": "body",
            "type": "string"
    }], responseMessages=[{
        "code": 500, "message": "Exception processing request"
    }])
    def put(self):
        return um_sharing_model.updateUM(request.get_json())


api.add_resource(SharingModel, '/api/v2/um/sharing-model')


########################################################################################################################

'''
 Assessment route:

    '/api/v2/um/assesment'

        GET:    gets the status of the current assessment in the device
        PUT:    start / stop assessment
'''
class Assessment(Resource):
    # Get process status
    # GET /api/v2/um/assesment
    @swagger.operation(
        summary="Returns the assessment process status",
        notes="Returns a json object with the information about the assessment process status",
        produces=["application/json"],
        authorizations=[],
        responseMessages=[{
                "code": 500,
                "message": "Exception processing request"
            }])
    def get(self):
        return um_assesment.status()

    # Process operation: start / stop
    #   data: {'operation':'stop/start'}
    # PUT /api/v2/um/assesment
    @swagger.operation(
        summary="Starts / stops the assessment process",
        notes="Starts / stops the assessment process. 'operation' value (start, stop) is readed from body.",
        produces=["application/json"],
        authorizations=[],
        parameters=[{
                "name": "body",
                "description": "Parameters in JSON format. Options: start, stop<br/>Example: <br/>"
                               "{\"operation\":\"stop\"}",
                "required": True,
                "paramType": "body",
                "type": "string"
            }],
        responseMessages=[{
                "code": 406,
                "message": "'Operation' parameter not found"
            },{
                "code": 501,
                "message": "Operation not defined / implemented"
            },{
                "code": 500,
                "message": "Exception processing request"
            }])
    def put(self):
        return um_assesment.operation( request.get_json() )

api.add_resource(Assessment, '/api/v2/um/assesment')


########################################################################################################################

'''
 Policies route:

        '/um/check'
                GET:    checks if device can run more apps - UP & SM policies
'''
class Policies(Resource):
    # GET /api/v2/um/check
    @swagger.operation(
        summary="checks if device can run more apps - UP & SM policies",
        notes="Returns a json object with the response",
        produces=["application/json"],
        authorizations=[],
        responseMessages=[{
                "code": 500,
                "message": "Exception processing request"
            }])
    def get(self):
        return policies.check_policies()

api.add_resource(Policies, '/api/v2/um/check')


########################################################################################################################
# MAIN
def main():
    LOG.info("[app] Starting User Management application [version=" + str(cfg.dic['VERSION']) + "] ...")
    LOG.info("[app] Swagger running on http://" + cfg.dic['HOST_IP'] + ":" + str(cfg.dic['SERVER_PORT']) + cfg.dic['API_DOC_URL'] + ".html")
    LOG.info("[app] REST API running on http://" + cfg.dic['HOST_IP'] + ":" + str(cfg.dic['SERVER_PORT']) + cfg.dic['API_DOC_URL'])

    # START (SSL) SERVER
    # context = ('PATH_TO_CERT_CRT'], 'PATH_TO_CERT_KEY'])
    # app.run(host='0.0.0.0', port=config.dic['SERVER_PORT'], ssl_context=context, threaded=True, debug=False)

    # START SERVER
    app.run(host='0.0.0.0', port=cfg.dic['SERVER_PORT'], threaded=True, debug=False)


if __name__ == "__main__":
    main()