Merge branch 'nanomad-feture/get-user-timezone' into develop

Author: Thomas Salm

src/saic_ismart_client/exceptions.py

@@ -0,0 +1,9 @@
+class SaicApiException(Exception):
+    def __init__(self, msg: str, return_code: int = None):
+        if return_code is not None:
+            self.message = f'return code: {return_code}, message: {msg}'
+        else:
+            self.message = msg
+
+    def __str__(self):
+        return self.message

src/saic_ismart_client/rest_v2/__init__.py

@@ -0,0 +1,47 @@
+from datetime import datetime, timezone
+
+import requests
+
+from saic_ismart_client.exceptions import SaicApiException
+from saic_ismart_client.rest_v2.model import TimeZoneResponse
+
+
+class SaicRestV2Api():
+
+    def __init__(self, base_uri: str):
+        self.__base_uri = base_uri
+
+    def get_user_timezone(self, token: str, uid: str):
+        response = TimeZoneResponse()
+        self.__execute_get('api.app/v1/user/timezone', token, uid=uid, response_holder=response)
+        return response
+
+    def __execute_get(self, endpoint: str, token: str, uid=None, response_holder=None):
+        headers = self.__get_headers(token, uid)
+        try:
+            response = requests.get(url=f'{self.__base_uri}/{endpoint}', headers=headers)
+            if response_holder is None:
+                return response.content.decode()
+            else:
+                return response_holder.init_from_dict(response.json())
+        except requests.exceptions.ConnectionError as ece:
+            raise SaicApiException(f'Connection error: {ece}')
+        except requests.exceptions.Timeout as et:
+            raise SaicApiException(f'Timeout error: {et}')
+        except requests.exceptions.HTTPError as ehttp:
+            status_code = ehttp.response.status_code
+            raise SaicApiException(f'HTTP error. HTTP status: {status_code}, {ehttp}')
+        except requests.exceptions.RequestException as e:
+            raise SaicApiException(f'{e}')
+
+    def __get_headers(self, token, uid=None):
+        headers = {
+            'Content-Type': 'application/json;charset=UTF-8',
+            'APP-SEND-DATE': str(datetime.now().replace(tzinfo=timezone.utc).timestamp() * 1000),
+            'APP-CONTENT-ENCRYPTED': '0',
+            'APP-LANGUAGE-TYPE': 'en',
+            'APP-LOGIN-TOKEN': token,
+        }
+        if uid:
+            headers['APP-USER-ID'] = uid
+        return headers

src/saic_ismart_client/rest_v2/api.py

@@ -0,0 +1,57 @@
+import abc
+import datetime
+import re
+
+
+class BaseData(abc.ABC):
+    def __init__(self):
+        self.code: int | None = None
+        self.message: str | None = None
+
+    def init_from_dict(self, data: dict):
+        self.code = int(data.get('code'))
+        self.message = data.get('message')
+        return self
+
+
+TZ_REGEX = re.compile(r'^(?P<base>GMT|UTC)(?P<sign>[+-])(?P<hour>\d{1,2})(:(?P<minute>\d{2}))?$')
+
+
+class TimeZoneEntity():
+    def __init__(self):
+        self.timezone = None
+
+    def init_from_dict(self, data: dict):
+        self.timezone = data.get('timezone')
+        return self
+
+    def __str__(self):
+        return f'{{"timezone": "{self.timezone}"}}'
+
+    def get_timezone_offset(self):
+        m = TZ_REGEX.match(self.timezone)
+        if m is not None:
+            sign = m.group('sign')
+            hours = int(m.group('hour'))
+            minutes = int(m.group('minute')) if m.group('minute') is not None else 0
+            if sign == '+':
+                offset = datetime.timedelta(hours=hours, minutes=minutes)
+            else:
+                offset = -datetime.timedelta(hours=hours, minutes=minutes)
+            return datetime.timezone(offset=offset, name=self.timezone)
+        else:
+            raise ValueError(f'Invalid timezone: {self.timezone}')
+
+
+class TimeZoneResponse(BaseData):
+    def __init__(self):
+        super().__init__()
+        self.data: TimeZoneEntity | None = None
+
+    def init_from_dict(self, data: dict):
+        super().init_from_dict(data)
+        self.data = TimeZoneEntity().init_from_dict(data.get('data'))
+        return self
+
+    def __str__(self):
+        return f'{{"code": {self.code}, "message": "{self.message}", "data": {self.data}}}'

src/saic_ismart_client/rest_v2/model.py

@@ -11,6 +11,7 @@
 
 from saic_ismart_client.common_model import AbstractMessage, AbstractMessageBody, Header, MessageBodyV2, MessageV2, \
     ScheduledChargingMode, TargetBatteryCode, ChargeCurrentLimitCode
+from saic_ismart_client.exceptions import SaicApiException
 from saic_ismart_client.ota_v1_1.Message import MessageCoderV11
 from saic_ismart_client.ota_v1_1.data_model import AbortSendMessageReq, AlarmSwitch, AlarmSwitchReq, Message, \
     MessageBodyV11, MessageListReq, MessageListResp, MessageV11, MpAlarmSettingType, MpUserLoggingInReq, \
@@ -21,6 +22,8 @@
 from saic_ismart_client.ota_v3_0.Message import MessageBodyV30, MessageCoderV30, MessageV30
 from saic_ismart_client.ota_v3_0.data_model import OtaChrgCtrlReq, OtaChrgCtrlStsResp, OtaChrgHeatReq, \
     OtaChrgHeatResp, OtaChrgMangDataResp, OtaChrgRsvanReq, OtaChrgSetngReq, OtaChrgSetngResp, OtaChrgRsvanResp
+from saic_ismart_client.rest_v2.api import SaicRestV2Api
+from saic_ismart_client.rest_v2.model import TimeZoneEntity
 
 UID_INIT = '0000000000000000000000000000000000000000000000000#'
 AVG_SMS_DELIVERY_TIME = 15
@@ -64,19 +67,15 @@ def convert(message: Message) -> SaicMessage:
                        message.vin)
 
 
-class SaicApiException(Exception):
-    def __init__(self, msg: str, return_code: int = None):
-        if return_code is not None:
-            self.message = f'return code: {return_code}, message: {msg}'
-        else:
-            self.message = msg
-
-    def __str__(self):
-        return self.message
-
-
 class SaicApi:
-    def __init__(self, saic_uri: str, saic_user: str, saic_password: str, relogin_delay: int = None):
+    def __init__(
+            self,
+            saic_uri: str,
+            saic_rest_uri: str,
+            saic_user: str,
+            saic_password: str,
+            relogin_delay: int = None
+    ):
         self.saic_uri = saic_uri
         self.saic_user = saic_user
         self.saic_password = saic_password
@@ -87,6 +86,7 @@ def __init__(self, saic_uri: str, saic_user: str, saic_password: str, relogin_de
         self.message_v1_1_coder = MessageCoderV11()
         self.message_V2_1_coder = MessageCoderV21()
         self.message_V3_0_coder = MessageCoderV30()
+        self.rest_v2_api = SaicRestV2Api(saic_rest_uri)
         self.cookies = None
         self.uid = ''
         self.token = ''
@@ -845,6 +845,9 @@ def get_token(self):
                 self.login()
         return self.token
 
+    def get_user_timezone(self):
+        return self.rest_v2_api.get_user_timezone(self.get_token(), self.uid)
+
     def handle_error(self, message_body: AbstractMessageBody, iteration: int):
         if iteration > 0:
             waiting_time = AVG_SMS_DELIVERY_TIME * iteration

src/saic_ismart_client/saic_api.py

@@ -10,7 +10,7 @@
 from saic_ismart_client.ota_v1_1.data_model import MessageV11, MpUserLoggingInRsp, MessageBodyV11, VinInfo, \
     MpAlarmSettingType
 from saic_ismart_client.ota_v2_1.Message import MessageCoderV21
-from saic_ismart_client.ota_v2_1.data_model import OtaRvmVehicleStatusResp25857, RvsPosition, RvsWayPoint,\
+from saic_ismart_client.ota_v2_1.data_model import OtaRvmVehicleStatusResp25857, RvsPosition, RvsWayPoint, \
     RvsWgs84Point, Timestamp4Short, RvsBasicStatus25857, OtaRvcStatus25857
 from saic_ismart_client.ota_v3_0.Message import MessageBodyV30, MessageV30, MessageCoderV30
 from saic_ismart_client.ota_v3_0.data_model import OtaChrgMangDataResp, RvsChargingStatus
@@ -48,29 +48,29 @@ def create_vin_info(vin: str) -> VinInfo:
     vin_info.brand_name = b'brandName'
     vin_info.model_name = b'modelName'
     vin_info.active = True
-    vin_info.model_configuration_json_str = 'name:Tire pressure monitoring system,code:J17,value:1;'\
-                                            + 'name:Regular airbags,code:Q00,value:1;'\
-                                            + 'name:Front-seat airbags,code:Q01,value:1;'\
-                                            + 'name:Airbag switch,code:Q09,value:1;'\
-                                            + 'name:Sun Roof,code:S35,value:0;'\
-                                            + 'name:Remote control,code:S61,value:1;'\
-                                            + 'name:Air conditioning,code:T11,value:1;'\
-                                            + 'name:Electric Power Steering,code:EPS,value:1;'\
-                                            + 'name:Security alert,code:SA64,value:0111110000000000001000000100101000000010100000000000000000000110;'\
-                                            + 'name:Bonnut Status,code:BONNUT,value:1;'\
-                                            + 'name:Door Status,code:DOOR,value:1111;'\
-                                            + 'name:Boot Status,code:BOOT,value:1;'\
-                                            + 'name:Engine Status,code:ENGINE,value:1;'\
-                                            + 'name:Electric Vehicle,code:EV,value:0;'\
-                                            + 'name:HeatedSeat,code:HeatedSeat,value:0;'\
-                                            + 'name:Key Position,code:KEYPOS,value:1;'\
-                                            + 'name:Energy state,code:ENERGY,value:0;'\
-                                            + 'name:Battery Voltage,code:BATTERY,value:1;'\
-                                            + 'name:Interior Temperature,code:INTEMP,value:1;'\
-                                            + 'name:Exterior Temperature,code:EXTEMP,value:1;'\
-                                            + 'name:Window Status,code:WINDOW,value:0000;'\
-                                            + 'name:Left-Right Driving,code:LRD,value:0;'\
-                                            + 'name:Bluetooth Key,code:BTKEY,value:0;'\
+    vin_info.model_configuration_json_str = 'name:Tire pressure monitoring system,code:J17,value:1;' \
+                                            + 'name:Regular airbags,code:Q00,value:1;' \
+                                            + 'name:Front-seat airbags,code:Q01,value:1;' \
+                                            + 'name:Airbag switch,code:Q09,value:1;' \
+                                            + 'name:Sun Roof,code:S35,value:0;' \
+                                            + 'name:Remote control,code:S61,value:1;' \
+                                            + 'name:Air conditioning,code:T11,value:1;' \
+                                            + 'name:Electric Power Steering,code:EPS,value:1;' \
+                                            + 'name:Security alert,code:SA64,value:0111110000000000001000000100101000000010100000000000000000000110;' \
+                                            + 'name:Bonnut Status,code:BONNUT,value:1;' \
+                                            + 'name:Door Status,code:DOOR,value:1111;' \
+                                            + 'name:Boot Status,code:BOOT,value:1;' \
+                                            + 'name:Engine Status,code:ENGINE,value:1;' \
+                                            + 'name:Electric Vehicle,code:EV,value:0;' \
+                                            + 'name:HeatedSeat,code:HeatedSeat,value:0;' \
+                                            + 'name:Key Position,code:KEYPOS,value:1;' \
+                                            + 'name:Energy state,code:ENERGY,value:0;' \
+                                            + 'name:Battery Voltage,code:BATTERY,value:1;' \
+                                            + 'name:Interior Temperature,code:INTEMP,value:1;' \
+                                            + 'name:Exterior Temperature,code:EXTEMP,value:1;' \
+                                            + 'name:Window Status,code:WINDOW,value:0000;' \
+                                            + 'name:Left-Right Driving,code:LRD,value:0;' \
+                                            + 'name:Bluetooth Key,code:BTKEY,value:0;' \
                                             + 'name:Battery Type,code:BType,value:2'
     return vin_info
 
@@ -262,7 +262,7 @@ def res():
 
 class TestSaicApi(TestCase):
     def setUp(self) -> None:
-        self.saic_api = SaicApi('https://tap-eu.soimt.com', '[email protected]', 'secret')
+        self.saic_api = SaicApi('https://tap-eu.soimt.com', 'https://gateway-eu.soimt.com', '[email protected]', 'secret')
         self.message_coder_v1_1 = MessageCoderV11()
         self.message_coder_v2_1 = MessageCoderV21()
         self.message_coder_v3_0 = MessageCoderV30()