atk-common 1.8.0__tar.gz → 1.10.0__tar.gz

{atk_common-1.8.0 → atk_common-1.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: atk_common
-Version: 1.8.0
+Version: 1.10.0
 Summary: ATK common methods
 Home-page: https://github.com/pypa/atk_common
 Author: Roger

{atk_common-1.8.0 → atk_common-1.10.0}/setup.py

@@ -36,7 +36,7 @@ setup(
     # For a discussion on single-sourcing the version across setup.py and the
     # project code, see
     # https://packaging.python.org/guides/single-sourcing-package-version/
-    version="1.8.0",  # Required
+    version="1.10.0",  # Required
     # This is a one-line description or tagline of what your project does. This
     # corresponds to the "Summary" metadata field:
     # https://packaging.python.org/specifications/core-metadata/#summary

{atk_common-1.8.0 → atk_common-1.10.0}/src/atk_common/__init__.py

@@ -1,11 +1,11 @@
 # __init__.py
 from atk_common.datetime_utils import date_time_utc, get_utc_date_time
 from atk_common.env_utils import get_env_value
-from atk_common.error_utils import get_message, get_error_entity, handle_error, get_response_error, get_error_type
-from atk_common.http_utils import is_status_code_ok, get_test_response
+from atk_common.error_utils import get_message, create_error_log, get_error_entity, handle_error, get_response_error, get_error_type
+from atk_common.http_utils import is_http_status_ok, is_http_status_internal, get_test_response
 from atk_common.log_utils import add_log_item, add_log_item_http
 from atk_common.rabbitmq_consumer import RabbitMQConsumer
-from atk_common.response_utils import create_save_resp
+from atk_common.response_utils import create_response, is_response_ok
 from atk_common.docker_utils import get_current_container_info
 
 __all__ = [
@@ -13,15 +13,18 @@ __all__ = [
     'get_utc_date_time',
     'get_env_value',
     'get_message',
+    'create_error_log',
     'get_error_entity',
     'handle_error',
     'get_response_error',
     'get_error_type',
-    'is_status_code_ok',
+    'is_http_status_ok',
+    'is_http_status_internal',
     'get_test_response',
     'add_log_item',
     'add_log_item_http',
     'RabbitMQConsumer',
-    'create_save_resp',
+    'create_response',
+    'is_response_ok',
     'get_current_container_info',
 ]

atk_common-1.10.0/src/atk_common/enums/__init__.py

@@ -0,0 +1,14 @@
+# __init__.py
+from atk_common.enums.command_status_enum import CommandStatusType
+from atk_common.enums.speed_control_status_enum import SpeedControlStatusType
+from atk_common.enums.api_error_type_enum import ApiErrorType
+from atk_common.enums.response_status_enum import ResponseStatus
+from atk_common.enums.http_status_enum import HttpStatus
+
+__all__ = [
+    'CommandStatusType',
+    'SpeedControlStatusType',
+    'ApiErrorType',
+    'ResponseStatus',
+    'HttpStatus',
+]

atk_common-1.10.0/src/atk_common/enums/api_error_type_enum.py

@@ -0,0 +1,5 @@
+from enum import Enum
+ 
+class ApiErrorType(Enum):
+    CONNECTION = 1
+    INTERNAL = 2

atk_common-1.10.0/src/atk_common/enums/http_status_enum.py

@@ -0,0 +1,8 @@
+from enum import Enum
+ 
+class HttpStatus(Enum):
+    INFO = 100
+    OK = 200
+    REDIRECT = 300
+    CLIENT = 400
+    INTERNAL = 500

atk_common-1.10.0/src/atk_common/enums/response_status_enum.py

@@ -0,0 +1,6 @@
+from enum import Enum
+ 
+class ResponseStatus(Enum):
+    OK = 0
+    HTTP = 1
+    INTERNAL = 2

{atk_common-1.8.0 → atk_common-1.10.0}/src/atk_common/error_utils.py

@@ -1,6 +1,9 @@
 from datetime import datetime
 import json
 from atk_common.datetime_utils import get_utc_date_time
+from atk_common.enums.api_error_type_enum import ApiErrorType
+from atk_common.enums.http_status_enum import HttpStatus
+from atk_common.http_utils import is_http_status_internal
 from atk_common.log_utils import add_log_item
 from atk_common.response_utils import create_save_resp
 
@@ -35,13 +38,13 @@ def get_error_entity(app, error, method, error_type, status_code, container_info
     if app is not None:
         return app.response_class(
             response=json.dumps(data),
-            status=500,
+            status=HttpStatus.INTERNAL,
             mimetype='application/json'
         )
     return None
 
 def handle_error(resp, status):
-    if resp.status_code == 500:
+    if is_http_status_internal(resp.status_code):
         add_log_item(resp.json().get('message'))
         return create_save_resp(status, resp.status_code, resp.json())
     else:
@@ -49,7 +52,7 @@ def handle_error(resp, status):
         return create_save_resp(status, resp.status_code, resp.text)
 
 def get_response_error(resp):
-    if resp.status_code == 500:
+    if is_http_status_internal(resp.status_code):
         return resp.json()
     else:
         return resp.text
@@ -59,5 +62,5 @@ def get_response_error(resp):
 # 2 - Internal error
 def get_error_type(conn):
     if conn is None:
-        return 1
-    return 2
+        return ApiErrorType.CONNECTION
+    return ApiErrorType.INTERNAL

atk_common-1.10.0/src/atk_common/http_utils.py

@@ -0,0 +1,21 @@
+import json
+from atk_common.datetime_utils import get_utc_date_time
+from atk_common.docker_utils import get_current_container_info
+from atk_common.enums.http_status_enum import HttpStatus
+from atk_common.env_utils import get_env_value
+
+def is_http_status_ok(status_code):
+    return status_code >= HttpStatus.OK.value and status_code < HttpStatus.REDIRECT.value
+
+def is_http_status_internal(status_code):
+    return status_code >= HttpStatus.INTERNAL.value
+
+def get_test_response(docker_container_data, component):
+    data = {}
+    data['utcDateTime'] = get_utc_date_time()
+    if docker_container_data is None:
+        data['containerData'] = None
+        data['component'] = component
+    else:
+        data['containerData'] = docker_container_data
+    return data

{atk_common-1.8.0 → atk_common-1.10.0}/src/atk_common/log_utils.py

@@ -1,4 +1,5 @@
 from atk_common.datetime_utils import get_utc_date_time
+from atk_common.http_utils import is_http_status_internal
 
 def create_date_time():
     date_time = get_utc_date_time()
@@ -8,7 +9,7 @@ def add_log_item(text):
     print(create_date_time() + text)
 
 def add_log_item_http(resp):
-    if resp.status_code == 500:
+    if is_http_status_internal(resp.status_code):
         err_resp_json = resp.json().get('message')
         add_log_item(err_resp_json)
     else:

atk_common-1.10.0/src/atk_common/response_utils.py

@@ -0,0 +1,11 @@
+from atk_common.enums.response_status_enum import ResponseStatus
+
+def create_response(status, status_code, response_msg):
+    data = {}
+    data['status'] = status
+    data['statusCode'] = status_code
+    data['responseMsg'] = response_msg
+    return data
+
+def is_response_ok(response):
+    return response['status'] == ResponseStatus.OK

{atk_common-1.8.0 → atk_common-1.10.0}/src/atk_common.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: atk_common
-Version: 1.8.0
+Version: 1.10.0
 Summary: ATK common methods
 Home-page: https://github.com/pypa/atk_common
 Author: Roger

{atk_common-1.8.0 → atk_common-1.10.0}/src/atk_common.egg-info/SOURCES.txt

@@ -5,11 +5,13 @@ setup.cfg
 setup.py
 src/atk_common/__init__.py
 src/atk_common/datetime_utils.py
+src/atk_common/db_utils.py
 src/atk_common/docker_utils.py
 src/atk_common/env_utils.py
 src/atk_common/error_utils.py
 src/atk_common/http_utils.py
 src/atk_common/log_utils.py
+src/atk_common/mq_utils.py
 src/atk_common/rabbitmq_consumer.py
 src/atk_common/response_utils.py
 src/atk_common.egg-info/PKG-INFO
@@ -18,7 +20,10 @@ src/atk_common.egg-info/dependency_links.txt
 src/atk_common.egg-info/requires.txt
 src/atk_common.egg-info/top_level.txt
 src/atk_common/enums/__init__.py
+src/atk_common/enums/api_error_type_enum.py
 src/atk_common/enums/command_status_enum.py
+src/atk_common/enums/http_status_enum.py
+src/atk_common/enums/response_status_enum.py
 src/atk_common/enums/speed_control_status_enum.py
 src/shared_python_atk_enforcement/__init__.py
 tests/test_docker_utils.py

{atk_common-1.8.0 → atk_common-1.10.0}/tests/test_http_utils.py

@@ -5,7 +5,7 @@ from atk_common.http_utils import get_test_response
 class TestHttpUtils(unittest.TestCase):
 
     def test_get_test_response_none(self):
-        resp_json = get_test_response()
+        resp_json = get_test_response(None, 'bo-config-db-api')
         self.assertIsNotNone(resp_json)
 
 if __name__ == "__main__":

atk_common-1.8.0/src/atk_common/enums/__init__.py

@@ -1,8 +0,0 @@
-# __init__.py
-from atk_common.enums.command_status_enum import CommandStatusType
-from atk_common.enums.speed_control_status_enum import SpeedControlStatusType
-
-__all__ = [
-    'CommandStatusType',
-    'SpeedControlStatusType'
-]

atk_common-1.8.0/src/atk_common/http_utils.py

@@ -1,23 +0,0 @@
-import json
-from atk_common.datetime_utils import get_utc_date_time
-from atk_common.docker_utils import get_current_container_info
-from atk_common.env_utils import get_env_value
-
-def is_status_code_ok(status_code):
-    return status_code >= 200 and status_code < 300
-
-def get_test_response():
-    data = {}
-    container_info = get_current_container_info()
-    if container_info is not None:
-        data['imageName'] = container_info['imageName']
-        data['imageVersion'] = container_info['imageVersion']
-        data['containerName'] = container_info['containerName']
-        data['containerPorts'] = container_info['ports']
-    else:
-        data['imageName'] = None
-        data['imageVersion'] = None
-        data['containerName'] = None
-        data['containerPorts'] = None
-    data['timestamp'] = get_utc_date_time()
-    return data

atk_common-1.8.0/src/atk_common/response_utils.py

@@ -1,6 +0,0 @@
-def create_save_resp(status, status_code, response_msg):
-    data = {}
-    data['status'] = status
-    data['statusCode'] = status_code
-    data['responseMsg'] = response_msg
-    return data