added status for the demon record usage call

Author: pratik-vii

metering/handlers/freecall_handler.py

@@ -1,35 +1,59 @@
 import json
+import logging
 
 from services import UsageService
-from utils import make_response
+from logger import setup_logger
+from utils import validate_freecalls_request
 
 usage_service = UsageService()
 
-
-def get_and_validate_requried_params(event):
-    try:
-        org_id = event['queryStringParameters']['organization_id']
-        service_id = event['queryStringParameters']['service_id']
-        user_id = event['queryStringParameters']['username']
-    except Exception as e:
-        raise e
-
-    return org_id, service_id, user_id
+setup_logger()
+logger = logging.getLogger(__name__)
 
 
 def main(event, context):
-    org_id, service_id, username = get_and_validate_requried_params(event)
-    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)
-    }
-
+    if validate_freecalls_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)
+            }
+        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"
+                })
+            }
+    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 return_value

metering/handlers/usage_handler.py

@@ -1,28 +1,38 @@
 import json
+import logging
 
+from logger import setup_logger
 from services import UsageService
-from utils import make_response, check_given_key
+from utils import validate_usage_body
 
 usage_service = UsageService()
 
-
-def get_and_validate_requried_params(event):
-    try:
-        body = json.loads(event['body'])
-        if not check_given_key('organization_id', body):
-            raise Exception("Org id is compulsory parameter in body request")
-    except Exception as e:
-        raise e
-    return body
+setup_logger()
+logger = logging.getLogger(__name__)
 
 
 def main(event, context):
-    usage_detail_dict = get_and_validate_requried_params(event)
-    usage_service.save_usage_details(usage_detail_dict)
+    usage_detail_dict = json.loads(event['body'])
 
-    response = {
-        "statusCode": 201,
-        "body": json.dumps({"status": "successfull"})
-    }
+    try:
+        if validate_usage_body(usage_detail_dict):
+            usage_service.save_usage_details(usage_detail_dict)
+            response = {
+                "statusCode": 201,
+                "body": json.dumps({"status": "successful"})
+            }
+        else:
+            logger.error(f'Request validation failed {usage_detail_dict}')
+            response = {
+                "statusCode": 400,
+                "body": json.dumps({"status": "request validation failed"})
+            }
+    except Exception as e:
+        logger.error(e)
+        logger.error(f'failed for request {usage_detail_dict}')
+        response = {
+            "statusCode": 500,
+            "body": json.dumps({"status": "failed"})
+        }
 
     return response

metering/logger.py

@@ -0,0 +1,57 @@
+import logging.config
+
+
+def setup_logger():
+    logging.config.dictConfig({
+        "version": 1,
+        "disable_existing_loggers": True,
+        "formatters": {
+            "simple": {
+                "format": "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+            }
+        },
+
+        "handlers": {
+            "console": {
+                "class": "logging.StreamHandler",
+                "level": "DEBUG",
+                "formatter": "simple",
+                "stream": "ext://sys.stdout"
+            },
+
+            "info_file_handler": {
+                "class": "logging.handlers.RotatingFileHandler",
+                "level": "INFO",
+                "formatter": "simple",
+                "filename": "info.log",
+            },
+
+            "error_file_handler": {
+                "class": "logging.handlers.RotatingFileHandler",
+                "level": "ERROR",
+                "formatter": "simple",
+                "filename": "error.log",
+                "encoding": "utf8"
+            }
+        },
+
+        "loggers": {
+            "sqlalchemy": {
+                "level": "ERROR",
+                "handlers": ["console"]
+            },
+            "freecall_handler": {
+                "level": "ERROR",
+                "handlers": ["console"]
+            },
+            "": {
+                "level": "ERROR",
+                "handlers": ["console"]
+            }
+        },
+
+        "root": {
+            "level": "ERROR",
+            "handlers": ["console"]
+        }
+    })

metering/repository/base_repository.py

@@ -25,6 +25,13 @@ def create_item(self, item, session=None):
         session.flush()
         return item
 
+    def create_all_items(self, items, session=None):
+        session = self.get_default_session(session)
+        session.add_all(items)
+        session.commit()
+        session.flush()
+        return items
+
     def remove_item(self, item, session=None):
         pass
 

metering/repository/org_service_config_repository.py

@@ -11,12 +11,14 @@ def get_service_config(self, org_id, service_id, optin_time):
                 .filter(OrgServiceConfigModel.org_id == org_id) \
                 .filter(OrgServiceConfigModel.service_id == service_id) \
                 .filter(OrgServiceConfigModel.effective_start_date <= optin_time) \
-                .filter(OrgServiceConfigModel.effective_end_date >= optin_time).first()
+                .filter(OrgServiceConfigModel.effective_end_date >= optin_time).all()
         else:
             service_config = session.query(OrgServiceConfigModel.free_calls.label('free_calls')) \
                 .filter(OrgServiceConfigModel.org_id == org_id) \
-                .filter(OrgServiceConfigModel.service_id == service_id)\
-                .order_by(OrgServiceConfigModel.created_at.desc()).first()
+                .filter(OrgServiceConfigModel.service_id == service_id) \
+                .order_by(OrgServiceConfigModel.created_at.desc()).all()
         session.commit()
         session.flush()
-        return service_config
+        if len(service_config) == 0:
+            return None
+        return service_config[0].free_calls

metering/services.py

@@ -10,8 +10,6 @@ def get_free_call_details(self, username, org_id, service_id, group_id=None):
 
         if not free_calls:
             free_calls = 0
-        else:
-            free_calls = free_calls[0]
         if not total_calls:
             total_calls = 0
 

metering/storage.py

@@ -54,7 +54,7 @@ def add_usage_data(self, usage_details):
             usage_type=usage_details['usage_type'],
             usage_value=usage_details['usage_value'],
             start_time=usage_details['start_time'],
-            end_time=usage_details['start_time']
+            end_time=usage_details['end_time']
         )
         self.usage_repo.create_item(usage_record)
 

metering/tests/test_total_calls.py

@@ -0,0 +1,98 @@
+import unittest
+
+from models import OrgServiceConfigModel, UsageModel, UserOrgGroupModel
+from repository.org_service_config_repository import OrgServiceRepo
+from repository.usage_repository import UsageRepository
+from repository.user_org_group_repository import UserOrgGroupRepository
+from storage import DatabaseStorage
+
+
+class TestTotalCalls(unittest.TestCase):
+    def setUp(self):
+        self.org_service_repository = OrgServiceRepo()
+        self.usage_repository = UsageRepository()
+        self.user_org_group_repository = UserOrgGroupRepository()
+        self.storage_service = DatabaseStorage()
+        self.org_service_repository.get_default_session().query(OrgServiceConfigModel).delete()
+        self.org_service_repository.get_default_session().query(UsageModel).delete()
+        self.org_service_repository.get_default_session().query(UserOrgGroupModel).delete()
+        service_items = list()
+        service_items.append(
+            OrgServiceConfigModel(
+                org_id='snet',
+                service_id='example-service',
+                free_calls=100,
+                effective_end_date='2030-09-12 00:00:00',
+                effective_start_date='2011-09-12 00:00:00'
+            )
+        )
+        self.org_service_repository.create_all_items(service_items)
+
+    def test_free_calls(self):
+        self.assertEqual((0, 100), self.storage_service.get_usage_details(
+            user_name='user@snet', org_id='snet', service_id='example-service'))
+        self.org_service_repository.get_default_session().query(UsageModel).delete()
+
+    def test_success_usage_record(self):
+        self.storage_service.add_usage_data({
+            "type": "response",
+            "registry_address_key": "0x5156fde2ca71da4398f8c76763c41bc9633875e4",
+            "ethereum_json_rpc_endpoint": "https://ropsten.infura.io",
+            "request_id": "bl5tuet35nkvoh9gt9q0",
+            "organization_id": "snet",
+            "service_id": "example-service",
+            "group_id": "3cFvmyLn9UO1jrtuZLerzbgLj6AOtqGo+IBQHtZzV1Q=",
+            "service_method": "/example_service.Calculator/add",
+            "response_sent_time": "2019-08-08 14:07:15.883501805",
+            "request_received_time": "2019-08-08 14:07:15.337318252",
+            "response_time": "0.5461",
+            "response_code": "Unavailable",
+            "error_message": "",
+            "version": "v1.0.0",
+            'username': 'user@snet',
+            "operation": "read",
+            "usage_type": "apicall",
+            "status": "success",
+            "start_time": "2019-08-08 14:07:15.337318252",
+            "end_time": "2019-08-08 14:07:15.883501805",
+            "usage_value": 1,
+            "time_zone": "IST",
+
+        })
+        self.storage_service.add_usage_data({
+            "type": "response",
+            "registry_address_key": "0x5156fde2ca71da4398f8c76763c41bc9633875e4",
+            "ethereum_json_rpc_endpoint": "https://ropsten.infura.io",
+            "request_id": "bl5tuet35nkvoh9gt9q0",
+            "organization_id": "snet",
+            "service_id": "example-service",
+            "group_id": "3cFvmyLn9UO1jrtuZLerzbgLj6AOtqGo+IBQHtZzV1Q=",
+            "service_method": "/example_service.Calculator/add",
+            "response_sent_time": "2019-08-08 14:07:15.883501805",
+            "request_received_time": "2019-08-08 14:07:15.337318252",
+            "response_time": "0.5461",
+            "response_code": "Unavailable",
+            "error_message": "",
+            "version": "v1.0.0",
+            'username': 'user@snet',
+            "operation": "read",
+            "usage_type": "apicall",
+            "status": "failed",
+            "start_time": "2019-08-08 14:07:15.337318252",
+            "end_time": "2019-08-08 14:07:15.883501805",
+            "usage_value": 1,
+            "time_zone": "IST",
+
+        })
+        self.assertEqual((1, 100), self.storage_service.get_usage_details(
+            user_name='user@snet', org_id='snet', service_id='example-service'))
+        self.org_service_repository.get_default_session().query(UsageModel).delete()
+
+    def tearDown(self):
+        self.org_service_repository.get_default_session().query(OrgServiceConfigModel).delete()
+        self.org_service_repository.get_default_session().query(UsageModel).delete()
+        self.org_service_repository.get_default_session().query(UserOrgGroupModel).delete()
+
+
+if __name__ == '__main__':
+    unittest.main()

metering/utils.py

@@ -22,7 +22,22 @@ def configure_log(logger):
     logger.addHandler(handler)
 
 
-def check_given_key(key, dict):
-    if key in dict:
-        return True
-    return False
+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']
+    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