Merge pull request #10 from flavienbwk/develop

Fixed docker volumes problems and added HTTP response codes

Author: flavienbwk

.gitignore

@@ -1,7 +1,7 @@
 .vscode/
 
 web/app/node_modules/
-ldap-data/
+ldap/
 logs/
 migrations/
 

api/app/app.py

@@ -3,15 +3,23 @@
 from flask import Flask
 
 from utils.Database import Database
+from utils.ApiResponse import ApiResponse
 
 from config import config_by_name
 
 FLASK_LEVEL = os.environ.get("FLASK_LEVEL", "dev")
 
 database = Database()
 
+def page_not_found(e):
+    apiResponse = ApiResponse()
+    apiResponse.setMessage("Page not found")
+    apiResponse.setHTTPCode(404)
+    return apiResponse.getResponse()
+
 def create_app():
     app = Flask(__name__)
+    app.register_error_handler(404, page_not_found)
     app.config.from_object(config_by_name[FLASK_LEVEL])
     database.initDatabase(app)
     return app

api/app/manager.py

@@ -33,7 +33,8 @@ def after_request(response):
     response.headers.add('Access-Control-Allow-Origin', '*')
     response.headers.add('Access-Control-Allow-Headers', 'Content-Type,X-Api-Auth-Token')
     response.headers.add('Access-Control-Allow-Methods', 'GET,POST,PUT,OPTIONS')
-    return ApiResponse.formatFlaskResponse(response)
+    response, http_code = ApiResponse.formatFlaskResponse(response)
+    return app.make_response((response, http_code))
 
 if __name__ == '__main__':
     manager.run()

api/app/utils/ApiResponse.py

@@ -5,22 +5,28 @@ class ApiResponse():
     """
     A class that formats correctly the expected
     response from the web applicaiton.
+
+    @author : github.com/flavienbwk | berwic_f
     """
 
     def __init__(self) -> None:
         self.error = True
         self.message = ""
         self.details = {}
+        self.http_code = 400
 
-    def setAll(self, error: bool, message: str, details: dict) -> None:
+    def setAll(self, error: bool, message: str, details: dict, http_code: int = 400) -> None:
         self.error = error
         self.message = message
         self.details = details
+        self.http_code = http_code
 
     def setSuccess(self) -> None:
+        self.http_code = 200
         self.error = False
 
     def setError(self) -> None:
+        self.http_code = 400
         self.error = True
 
     def setMessage(self, message: str) -> None:
@@ -29,11 +35,16 @@ def setMessage(self, message: str) -> None:
     def setDetails(self, details: dict) -> None:
         self.details = details
 
-    def getResponse(self) -> {"error": bool, "message": str, "details": {}}:
+    def setHTTPCode(self, http_code: int) -> None:
+        self.http_code = http_code
+
+    def getResponse(self) -> {"http_code": int, "error": bool, "message": str, "data": {}}:
         return {
+            "flask_api": True,
+            "http_code": self.http_code,
             "error": self.error,
             "message": self.message,
-            "details": self.details
+            "data": self.details
         }
 
     @staticmethod
@@ -45,24 +56,37 @@ def formatFlaskResponse(response):
         Switching from the Flask "errors" key to
         response format with "error" & "message".
         
-        Adding an empty "details" object if no details
+        Adding an empty "data" object if no details
         are returned, to remain consistent.
         """
         try:
+            # Checking if response is from our Flask API.
+            # Maybe it is from Swagger UI
             response_data = json.loads(response.get_data())
-            response.headers.add('Content-Type', 'application/json')
-            if "errors" in response_data:
-                response_data["message"] = ApiResponse.stringifyFlaskErrors(response_data["errors"])
-                response_data["error"] = True
-                del(response_data["errors"])
-            if "details" not in response_data:
-                response_data["details"] = {}
-            response.set_data(json.dumps(response_data))
+            if "flask_api" not in response_data:
+                return response, response._status_code
+            else:
+                del response_data["flask_api"]
         except ValueError:
-            # Response is not JSON, probably HTML
-            # Swagger UI returns HTML for example
-            pass
-        return response
+            return response, response._status_code
+
+        http_code = 200
+        response.headers.add('Content-Type', 'application/json')
+        if "errors" in response_data:
+            response_data["message"] = ApiResponse.stringifyFlaskErrors(response_data["errors"])
+            response_data["error"] = True
+            del(response_data["errors"])
+        if "data" not in response_data:
+            response_data["data"] = {}
+        if "error" not in response_data:
+            response_data["error"] = True
+        if "http_code" in response_data:
+            http_code = response_data["http_code"] if response_data["error"] is True else 200
+            del response_data["http_code"]
+        else:
+            http_code = 400 if response_data["error"] is True else 200
+        response.set_data(json.dumps(response_data))
+        return response, http_code
 
     @staticmethod
     def stringifyFlaskErrors(obj: object) -> str:
@@ -75,8 +99,9 @@ def stringifyFlaskErrors(obj: object) -> str:
         return final_message
 
     def __repr__(self) -> str:
-        return "<ApiResponse(error='{}', message='{}', details={})>".format(
+        return "<ApiResponse(error='{}', message='{}', details={}, http_code={})>".format(
             self.error,
             self.message,
-            len(self.details)
+            len(self.details),
+            self.http_code
         )

docker-compose.yml

@@ -15,7 +15,8 @@ services:
         LDAP_DOMAIN: "mycompany.com"
         LDAP_ADMIN_PASSWORD: "adminpwd"
     volumes:
-        - './ldap-data:/var/lib/ldap'
+        - './ldap/data:/var/lib/ldap'
+        - './ldap/slapd:/etc/ldap/slapd.d'
 
   phpldapadmin:
     image: osixia/phpldapadmin:0.9.0