review changes

Author: pratik-vii

metering/constants.py

@@ -0,0 +1,11 @@
+class StatusCode:
+    BAD_PARAMETERS_CODE = 400
+    SERVER_ERROR_CODE = 500
+    SUCCESS_POST_CODE = 201
+    SUCCESS_GET_CODE = 200
+
+
+class StatusMessage:
+    BAD_PARAMETER = "Request validation failed"
+    SERVER_ERROR_MSG = "failed"
+    SUCCESS_POST_CODE = "successful"

metering/handlers/freecall_handler.py

@@ -1,59 +1,44 @@
 import json
 import logging
 
+from constants import StatusCode, StatusMessage
 from services import UsageService
 from logger import setup_logger
-from utils import validate_freecalls_request
+from utils import validate_request, make_freecalls_response
 
 usage_service = UsageService()
 
 setup_logger()
 logger = logging.getLogger(__name__)
 
+required_keys = ['username', 'organization_id', 'service_id']
+
 
 def main(event, context):
-    if validate_freecalls_request(event['queryStringParameters']):
+    if validate_request(event['queryStringParameters']):
         try:
             org_id = event['queryStringParameters']['organization_id']
             service_id = event['queryStringParameters']['service_id']
             username = event['queryStringParameters']['username']
             free_call_details = usage_service.get_free_call_details(
                 username, org_id, service_id)
-            return_value = {
-                "statusCode": 200,
-                "headers": {
-                    "Content-Type": "application/json",
-                    "Access-Control-Allow-Origin": "*",
-                    "Access-Control-Allow-Methods": "OPTIONS,POST,GET"
-                },
-                "body": json.dumps(free_call_details)
-            }
+            return_value = make_freecalls_response(
+                StatusCode.SUCCESS_GET_CODE,
+                json.dumps(free_call_details)
+            )
+
         except Exception as e:
             logger.error(e)
-            return_value = {
-                "statusCode": 500,
-                "headers": {
-                    "Content-Type": "application/json",
-                    "Access-Control-Allow-Origin": "*",
-                    "Access-Control-Allow-Methods": "OPTIONS,POST,GET"
-                },
-                "body": json.dumps({
-                    'status': "failed",
-                    'error': "Internal server error"
-                })
-            }
+            return_value = make_freecalls_response(
+                StatusCode.SERVER_ERROR_CODE,
+                json.dumps({"error": StatusMessage.SERVER_ERROR_MSG})
+            )
+
     else:
         logger.error('Request validation failed')
-        return_value = {
-            "statusCode": 400,
-            "headers": {
-                "Content-Type": "application/json",
-                "Access-Control-Allow-Origin": "*",
-                "Access-Control-Allow-Methods": "OPTIONS,POST,GET"
-            },
-            "body": json.dumps({
-                'status': "failed",
-                'error': "Validation failed"
-            })
-        }
+        return_value = make_freecalls_response(
+            StatusCode.BAD_PARAMETERS_CODE,
+            json.dumps({"error": StatusMessage.BAD_PARAMETER})
+        )
+
     return return_value

metering/handlers/usage_handler.py

@@ -1,38 +1,42 @@
 import json
 import logging
 
+from constants import StatusCode, StatusMessage
 from logger import setup_logger
 from services import UsageService
-from utils import validate_usage_body
+from utils import validate_request, make_record_usage_response
 
 usage_service = UsageService()
 
 setup_logger()
 logger = logging.getLogger(__name__)
 
+required_keys = ["organization_id", "service_id", "username", 'usage_value', 'usage_type',
+                 'service_method', 'group_id', 'status', 'start_time', 'end_time']
+
 
 def main(event, context):
     usage_detail_dict = json.loads(event['body'])
 
     try:
-        if validate_usage_body(usage_detail_dict):
+        if validate_request(usage_detail_dict):
             usage_service.save_usage_details(usage_detail_dict)
-            response = {
-                "statusCode": 201,
-                "body": json.dumps({"status": "successful"})
-            }
+            response = make_record_usage_response(
+                StatusCode.SUCCESS_GET_CODE,
+                json.dumps({"status": StatusMessage.SUCCESS_POST_CODE})
+            )
         else:
             logger.error(f'Request validation failed {usage_detail_dict}')
-            response = {
-                "statusCode": 400,
-                "body": json.dumps({"status": "request validation failed"})
-            }
+            response = make_record_usage_response(
+                StatusCode.BAD_PARAMETERS_CODE,
+                json.dumps({"status": StatusMessage.BAD_PARAMETER})
+            )
     except Exception as e:
         logger.error(e)
         logger.error(f'failed for request {usage_detail_dict}')
-        response = {
-            "statusCode": 500,
-            "body": json.dumps({"status": "failed"})
-        }
+        response = make_record_usage_response(
+            StatusCode.SERVER_ERROR_CODE,
+            json.dumps({"status": StatusMessage.SERVER_ERROR_MSG})
+        )
 
     return response

metering/utils.py

@@ -1,13 +1,26 @@
+import json
 import logging
 
 
-def make_response(status_code, body):
+def make_record_usage_response(status_code, body):
     return {
         "statusCode": status_code,
         "body": body
     }
 
 
+def make_freecalls_response(status_code, body):
+    return {
+        "statusCode": status_code,
+        "headers": {
+            "Content-Type": "application/json",
+            "Access-Control-Allow-Origin": "*",
+            "Access-Control-Allow-Methods": "OPTIONS,POST,GET"
+        },
+        "body": body
+    }
+
+
 def configure_log(logger):
     logger.setLevel(logging.INFO)
 
@@ -22,22 +35,12 @@ def configure_log(logger):
     logger.addHandler(handler)
 
 
-def validate_usage_body(request_body):
-    required_keys = ["organization_id", "service_id", "username", 'usage_value', 'usage_type',
-                     'service_method', 'group_id', 'status', 'start_time', 'end_time']
+def validate_request(required_keys, request_body):
     for key in required_keys:
         if key not in request_body:
             return False
     return True
 
 
-def validate_freecalls_request(request):
-    required_keys = ['username', 'organization_id', 'service_id']
-    for key in required_keys:
-        if key not in request:
-            return False
-    return True
-
-
 def validator_usage():
     pass