atk-common 1.9.0__py3-none-any.whl → 1.10.0__py3-none-any.whl

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/enums/__init__.py

@@ -1,8 +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'
+    'SpeedControlStatusType',
+    'ApiErrorType',
+    'ResponseStatus',
+    'HttpStatus',
 ]

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/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/enums/response_status_enum.py

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

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/http_utils.py

@@ -1,26 +1,14 @@
 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_status_code_ok(status_code):
-    return status_code >= 200 and status_code < 300
+def is_http_status_ok(status_code):
+    return status_code >= HttpStatus.OK.value and status_code < HttpStatus.REDIRECT.value
 
-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
+def is_http_status_internal(status_code):
+    return status_code >= HttpStatus.INTERNAL.value
 
 def get_test_response(docker_container_data, component):
     data = {}

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/response_utils.py

@@ -1,6 +1,11 @@
-def create_save_resp(status, status_code, response_msg):
+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.9.0.dist-info → atk_common-1.10.0.dist-info}/METADATA

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

{atk_common-1.9.0.dist-info → atk_common-1.10.0.dist-info}/RECORD

@@ -1,14 +1,19 @@
-atk_common/__init__.py,sha256=9aedYjZ5adS3zor4HPYubrFAmq2LuxhdtfwUKjDS6dE,956
+atk_common/__init__.py,sha256=nG-PFquhz5ycFh1zY1zLqAFPOCbalD80_YmLcJ4vqr0,1093
 atk_common/datetime_utils.py,sha256=qsVF7l90P1-xukG2tV_jLqG9J_Yfl5wTpyfrdPBlyMo,239
+atk_common/db_utils.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atk_common/docker_utils.py,sha256=nkUhp2OhwJsm41JDujHDY-JxQfdDjy91duprH59Esfk,2084
 atk_common/env_utils.py,sha256=66v-S0vlkJNaun6ay1XcOGRtYJb4Ce4odJsWxuaHsQc,373
-atk_common/error_utils.py,sha256=JBc-yl5_29BSZ6d2kZBEX3X17qCDvEa_GZ7FC7sYwdc,2115
-atk_common/http_utils.py,sha256=IQDVPgnu3L1FuMbBOWWfxpL80-YNAQYF93iMK9l1uA4,1189
-atk_common/log_utils.py,sha256=DGGwXjD5jvpMZJNW1QBoJRdDaTY1e1Z69j0LSOOzsWA,419
+atk_common/error_utils.py,sha256=wRS6o691hleAPdTE-R90Q6xNSLTvxTuDswaBHiivuC0,2389
+atk_common/http_utils.py,sha256=gbXTNIQsl4wLZzZVkaIcZWQT8VrngnmdJySZXZH07RM,789
+atk_common/log_utils.py,sha256=k7VaknmSGvHQV6-eznltNUa3BOAywjFHkhVzDT1P0Hs,496
+atk_common/mq_utils.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atk_common/rabbitmq_consumer.py,sha256=4MhuwZs47Jt1fX4sUxr1MKRe7o2QRbPe9_utXEsa8QE,1907
-atk_common/response_utils.py,sha256=ezqTSNdGwueFXzijKB7CKPWxZml39bqjAZOeIMWMntk,197
-atk_common/enums/__init__.py,sha256=oW0aVnwewfH6sNu14jjZ5_uP4iRN4pRmGdTNC204rHo,236
+atk_common/response_utils.py,sha256=jlCm3a7GKolV6zR1emIEGmMH93V6yktiv-lgNa3TNEw,349
+atk_common/enums/__init__.py,sha256=0XQUbLYh9phfGd_dw3OqwJrdo1QLxCMTaKKXr4YwwLI,487
+atk_common/enums/api_error_type_enum.py,sha256=9oW6ZaZ3lhMwR8r2sVNWGliS9C_jV-otiOYdezAuTp0,91
 atk_common/enums/command_status_enum.py,sha256=M2Nln27a_DbzI07-gfytWQk2X087JhkU6Fmard5qVHs,127
+atk_common/enums/http_status_enum.py,sha256=bJSTmkLxHnb04fWSDKuhTWrh_v9iCQM7otAVr731JDk,139
+atk_common/enums/response_status_enum.py,sha256=ogYXlGm0gJJDGlY6Fwq9Kvl861aGPop2qzfXXExzMKw,99
 atk_common/enums/speed_control_status_enum.py,sha256=qpURh0K1L1tSpbrzVnckoe4hUn1illIkbo7k4mLfzIM,182
 atk_package/__init__.py,sha256=EceDa352WFHTdC_LxYANXf_TS9pGzK3MCx87bwAKTvg,811
 atk_package/datetime_utils.py,sha256=qsVF7l90P1-xukG2tV_jLqG9J_Yfl5wTpyfrdPBlyMo,239
@@ -22,8 +27,8 @@ atk_package/enums/__init__.py,sha256=oW0aVnwewfH6sNu14jjZ5_uP4iRN4pRmGdTNC204rHo
 atk_package/enums/command_status_enum.py,sha256=M2Nln27a_DbzI07-gfytWQk2X087JhkU6Fmard5qVHs,127
 atk_package/enums/speed_control_status_enum.py,sha256=qpURh0K1L1tSpbrzVnckoe4hUn1illIkbo7k4mLfzIM,182
 shared_python_atk_enforcement/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-atk_common-1.9.0.dist-info/METADATA,sha256=RW86i4Zpx9h0Yp8GwBjyGLDdfpzJjeKxiBqV6jvBoWM,1193
-atk_common-1.9.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-atk_common-1.9.0.dist-info/license.txt,sha256=_0O6fWM00-wTurDjnZhUP_N5QiwGhItaQZqHq5eqadA,1063
-atk_common-1.9.0.dist-info/top_level.txt,sha256=4CwRjkLnheIdI4jQwc4tK3dbRc58WqUmoqjkdDTWlME,41
-atk_common-1.9.0.dist-info/RECORD,,
+atk_common-1.10.0.dist-info/METADATA,sha256=1W7R0zeJiJLUfLBLny5W8tI1Y8_F8hGv6nWrq08_ZQs,1194
+atk_common-1.10.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+atk_common-1.10.0.dist-info/license.txt,sha256=_0O6fWM00-wTurDjnZhUP_N5QiwGhItaQZqHq5eqadA,1063
+atk_common-1.10.0.dist-info/top_level.txt,sha256=4CwRjkLnheIdI4jQwc4tK3dbRc58WqUmoqjkdDTWlME,41
+atk_common-1.10.0.dist-info/RECORD,,