wyzeapy 0.5.27__py3-none-any.whl → 0.5.29__py3-none-any.whl

wyzeapy/wyze_auth_lib.py

@@ -10,7 +10,17 @@ from typing import Dict, Any, Optional
 
 from aiohttp import TCPConnector, ClientSession, ContentTypeError
 
-from .const import API_KEY, PHONE_ID, APP_NAME, APP_VERSION, SC, SV, PHONE_SYSTEM_TYPE, APP_VER, APP_INFO
+from .const import (
+    API_KEY,
+    PHONE_ID,
+    APP_NAME,
+    APP_VERSION,
+    SC,
+    SV,
+    PHONE_SYSTEM_TYPE,
+    APP_VER,
+    APP_INFO,
+)
 from .exceptions import (
     UnknownApiError,
     TwoFactorAuthenticationEnabled,
@@ -19,10 +29,28 @@ from .exceptions import (
 from .utils import create_password, check_for_errors_standard
 
 _LOGGER = logging.getLogger(__name__)
+"""
+Authentication token data and timing management.
+
+This module handles Wyze API authentication tokens, including expiration
+tracking, automatic refresh timing, and secure request methods in WyzeAuthLib.
+"""
 
 
 class Token:
-    # Token is apparently good for 24 hours, so refresh after 23
+    """Represents Wyze API access/refresh token and expiration tracking.
+
+    Attributes:
+        _access_token: Current access token string.
+        _refresh_token: Current refresh token string.
+        expired: Flag indicating if the token is marked expired.
+        _refresh_time: Unix timestamp when token should be refreshed.
+
+    Class Attributes:
+        REFRESH_INTERVAL: Time in seconds before token auto-refresh (23h).
+    """
+
+    # Token is good for 24 hours; schedule refresh after 23 hours
     REFRESH_INTERVAL = 82800
 
     def __init__(self, access_token, refresh_token, refresh_time: float = None):
@@ -79,6 +107,16 @@ class WyzeAuthLib:
         token: Optional[Token] = None,
         token_callback=None,
     ):
+        """Initialize WyzeAuthLib for authentication and token management.
+
+        Args:
+            username: Wyze account email address.
+            password: Plaintext or hashed account password.
+            key_id: Third-party API key ID for Wyze credentials.
+            api_key: Third-party API key for Wyze credentials.
+            token: Existing Token instance for reuse (optional).
+            token_callback: Callback to invoke on token updates.
+        """
         self._username = username
         self._password = password
         self._key_id = key_id
@@ -100,6 +138,22 @@ class WyzeAuthLib:
         token: Optional[Token] = None,
         token_callback=None,
     ):
+        """Factory to instantiate WyzeAuthLib with credentials or existing token.
+
+        Args:
+            username: Wyze account email (optional if token provided).
+            password: Wyze account password (optional if token provided).
+            key_id: Third-party API key ID (required for login).
+            api_key: Third-party API key (required for login).
+            token: Existing Token instance (skip login flow).
+            token_callback: Callback for token refresh events.
+
+        Returns:
+            A configured WyzeAuthLib instance.
+
+        Raises:
+            AttributeError: When neither credentials nor token are provided.
+        """
         self = cls(
             username=username,
             password=password,
@@ -111,7 +165,11 @@ class WyzeAuthLib:
 
         if self._username is None and self._password is None and self.token is None:
             raise AttributeError("Must provide a username, password or token")
-        elif self.token is None and self._username is not None and self._password is not None:
+        elif (
+            self.token is None
+            and self._username is not None
+            and self._password is not None
+        ):
             assert self._username != ""
             assert self._password != ""
 
@@ -120,6 +178,22 @@ class WyzeAuthLib:
     async def get_token_with_username_password(
         self, username, password, key_id, api_key
     ) -> Token:
+        """Authenticate using email/password and retrieve new Token.
+
+        Args:
+            username: Wyze account email.
+            password: Plaintext Wyze account password.
+            key_id: Third-party API key ID.
+            api_key: Third-party API key.
+
+        Returns:
+            A new Token instance with access and refresh tokens.
+
+        Raises:
+            TwoFactorAuthenticationEnabled: When 2FA is required.
+            AccessTokenError: On invalid credentials.
+            UnknownApiError: For other authentication errors.
+        """
         self._username = username
         self._password = create_password(password)
         self._key_id = key_id
@@ -138,42 +212,57 @@ class WyzeAuthLib:
             json=login_payload,
         )
 
-        if response_json.get('errorCode') is not None:
+        if response_json.get("errorCode") is not None:
             _LOGGER.error(f"Unable to login with response from Wyze: {response_json}")
             if response_json["errorCode"] == 1000:
                 raise AccessTokenError
             raise UnknownApiError(response_json)
 
-        if response_json.get('mfa_options') is not None:
+        if response_json.get("mfa_options") is not None:
             # Store the TOTP verification setting in the token and raise exception
             if "TotpVerificationCode" in response_json.get("mfa_options"):
                 self.two_factor_type = "TOTP"
                 # Store the verification_id from the response, it's needed for the 2fa payload.
-                self.verification_id = response_json["mfa_details"]["totp_apps"][0]["app_id"]
+                self.verification_id = response_json["mfa_details"]["totp_apps"][0][
+                    "app_id"
+                ]
                 raise TwoFactorAuthenticationEnabled
                 # 2fa using SMS, store sms as 2fa method in token, send the code then raise exception
             if "PrimaryPhone" in response_json.get("mfa_options"):
                 self.two_factor_type = "SMS"
                 params = {
-                    'mfaPhoneType': 'Primary',
-                    'sessionId': response_json.get("sms_session_id"),
-                    'userId': response_json['user_id'],
+                    "mfaPhoneType": "Primary",
+                    "sessionId": response_json.get("sms_session_id"),
+                    "userId": response_json["user_id"],
                 }
-                response_json = await self.post('https://auth-prod.api.wyze.com/user/login/sendSmsCode',
-                                                headers=headers, data=params)
+                response_json = await self.post(
+                    "https://auth-prod.api.wyze.com/user/login/sendSmsCode",
+                    headers=headers,
+                    data=params,
+                )
                 # Store the session_id from this response, it's needed for the 2fa payload.
-                self.session_id = response_json['session_id']
+                self.session_id = response_json["session_id"]
                 raise TwoFactorAuthenticationEnabled
 
-        self.token = Token(response_json['access_token'], response_json['refresh_token'])
+        self.token = Token(
+            response_json["access_token"], response_json["refresh_token"]
+        )
         await self.token_callback(self.token)
         return self.token
 
     async def get_token_with_2fa(self, verification_code) -> Token:
+        """Complete login flow using two-factor authentication code.
+
+        Args:
+            verification_code: 6-digit TOTP or SMS code for 2FA.
+
+        Returns:
+            A new Token instance after successful 2FA verification.
+        """
         headers = {
-            'Phone-Id': PHONE_ID,
-            'User-Agent': APP_INFO,
-            'X-API-Key': API_KEY,
+            "Phone-Id": PHONE_ID,
+            "User-Agent": APP_INFO,
+            "X-API-Key": API_KEY,
         }
         # TOTP Payload
         if self.two_factor_type == "TOTP":
@@ -182,7 +271,7 @@ class WyzeAuthLib:
                 "password": self._password,
                 "mfa_type": "TotpVerificationCode",
                 "verification_id": self.verification_id,
-                "verification_code": verification_code
+                "verification_code": verification_code,
             }
         # SMS Payload
         else:
@@ -191,22 +280,26 @@ class WyzeAuthLib:
                 "password": self._password,
                 "mfa_type": "PrimaryPhone",
                 "verification_id": self.session_id,
-                "verification_code": verification_code
+                "verification_code": verification_code,
             }
 
         response_json = await self.post(
-            'https://auth-prod.api.wyze.com/user/login',
-            headers=headers, json=payload)
+            "https://auth-prod.api.wyze.com/user/login", headers=headers, json=payload
+        )
 
-        self.token = Token(response_json['access_token'], response_json['refresh_token'])
+        self.token = Token(
+            response_json["access_token"], response_json["refresh_token"]
+        )
         await self.token_callback(self.token)
         return self.token
 
     @property
     def should_refresh(self) -> bool:
+        """Check whether the current token has reached its refresh time."""
         return time.time() >= self.token.refresh_time
 
     async def refresh_if_should(self):
+        """Refresh the token proactively if expired or past refresh_time."""
         if self.should_refresh or self.token.expired:
             async with self.refresh_lock:
                 if self.should_refresh or self.token.expired:
@@ -214,6 +307,12 @@ class WyzeAuthLib:
                     await self.refresh()
 
     async def refresh(self) -> None:
+        """Exchange the refresh token for a new access token and update internal Token.
+
+        Raises:
+            AccessTokenError: If refresh fails due to invalid refresh token.
+            UnknownApiError: For other errors during refresh.
+        """
         payload = {
             "phone_id": PHONE_ID,
             "app_name": APP_NAME,
@@ -223,25 +322,33 @@ class WyzeAuthLib:
             "phone_system_type": PHONE_SYSTEM_TYPE,
             "app_ver": APP_VER,
             "ts": int(time.time()),
-            "refresh_token": self.token.refresh_token
+            "refresh_token": self.token.refresh_token,
         }
 
-        headers = {
-            "X-API-Key": API_KEY
-        }
+        headers = {"X-API-Key": API_KEY}
 
-        async with ClientSession(connector=TCPConnector(ttl_dns_cache=(30 * 60))) as _session:
-            response = await _session.post("https://api.wyzecam.com/app/user/refresh_token", headers=headers,
-                                           json=payload)
+        async with ClientSession(
+            connector=TCPConnector(ttl_dns_cache=(30 * 60))
+        ) as _session:
+            response = await _session.post(
+                "https://api.wyzecam.com/app/user/refresh_token",
+                headers=headers,
+                json=payload,
+            )
         response_json = await response.json()
         check_for_errors_standard(self, response_json)
 
-        self.token.access_token = response_json['data']['access_token']
-        self.token.refresh_token = response_json['data']['refresh_token']
+        self.token.access_token = response_json["data"]["access_token"]
+        self.token.refresh_token = response_json["data"]["refresh_token"]
         await self.token_callback(self.token)
         self.token.expired = False
 
     def sanitize(self, data):
+        """Recursively sanitize sensitive fields in dicts for safe logging.
+
+        Args:
+            data: The dict to sanitize; returned sanitized copy.
+        """
         if data and type(data) is dict:
             # value is unused, but it prevents us from having to split the tuple to check against SANITIZE_FIELDS
             for key, value in data.items():
@@ -252,7 +359,20 @@ class WyzeAuthLib:
         return data
 
     async def post(self, url, json=None, headers=None, data=None) -> Dict[Any, Any]:
-        async with ClientSession(connector=TCPConnector(ttl_dns_cache=(30 * 60))) as _session:
+        """Send an HTTP POST request with sanitized logging.
+
+        Args:
+            url: Request URL.
+            json: Optional JSON payload.
+            headers: Optional headers.
+            data: Optional form data.
+
+        Returns:
+            Parsed JSON response.
+        """
+        async with ClientSession(
+            connector=TCPConnector(ttl_dns_cache=(30 * 60))
+        ) as _session:
             response = await _session.post(url, json=json, headers=headers, data=data)
             # Relocated these below as the sanitization seems to modify the data before it goes to the post.
             _LOGGER.debug("Request:")
@@ -267,9 +387,15 @@ class WyzeAuthLib:
             except ContentTypeError:
                 _LOGGER.debug(f"Response: {response}")
             return await response.json()
-    
+
     async def put(self, url, json=None, headers=None, data=None) -> Dict[Any, Any]:
-        async with ClientSession(connector=TCPConnector(ttl_dns_cache=(30 * 60))) as _session:
+        """Send an HTTP PUT request with sanitized logging.
+
+        See `post` for parameter details.
+        """
+        async with ClientSession(
+            connector=TCPConnector(ttl_dns_cache=(30 * 60))
+        ) as _session:
             response = await _session.put(url, json=json, headers=headers, data=data)
             # Relocated these below as the sanitization seems to modify the data before it goes to the post.
             _LOGGER.debug("Request:")
@@ -286,7 +412,19 @@ class WyzeAuthLib:
             return await response.json()
 
     async def get(self, url, headers=None, params=None) -> Dict[Any, Any]:
-        async with ClientSession(connector=TCPConnector(ttl_dns_cache=(30 * 60))) as _session:
+        """Send an HTTP GET request with sanitized logging.
+
+        Args:
+            url: Request URL.
+            headers: Optional headers.
+            params: Optional query parameters.
+
+        Returns:
+            Parsed JSON response.
+        """
+        async with ClientSession(
+            connector=TCPConnector(ttl_dns_cache=(30 * 60))
+        ) as _session:
             response = await _session.get(url, params=params, headers=headers)
             # Relocated these below as the sanitization seems to modify the data before it goes to the post.
             _LOGGER.debug("Request:")
@@ -302,8 +440,16 @@ class WyzeAuthLib:
             return await response.json()
 
     async def patch(self, url, headers=None, params=None, json=None) -> Dict[Any, Any]:
-        async with ClientSession(connector=TCPConnector(ttl_dns_cache=(30 * 60))) as _session:
-            response = await _session.patch(url, headers=headers, params=params, json=json)
+        """Send an HTTP PATCH request with sanitized logging.
+
+        See `get`/`post` for parameter details.
+        """
+        async with ClientSession(
+            connector=TCPConnector(ttl_dns_cache=(30 * 60))
+        ) as _session:
+            response = await _session.patch(
+                url, headers=headers, params=params, json=json
+            )
             # Relocated these below as the sanitization seems to modify the data before it goes to the post.
             _LOGGER.debug("Request:")
             _LOGGER.debug(f"url: {url}")
@@ -319,7 +465,19 @@ class WyzeAuthLib:
             return await response.json()
 
     async def delete(self, url, headers=None, json=None) -> Dict[Any, Any]:
-        async with ClientSession(connector=TCPConnector(ttl_dns_cache=(30 * 60))) as _session:
+        """Send an HTTP DELETE request with sanitized logging.
+
+        Args:
+            url: Request URL.
+            headers: Optional headers.
+            json: Optional JSON payload.
+
+        Returns:
+            Parsed JSON response.
+        """
+        async with ClientSession(
+            connector=TCPConnector(ttl_dns_cache=(30 * 60))
+        ) as _session:
             response = await _session.delete(url, headers=headers, json=json)
             # Relocated these below as the sanitization seems to modify the data before it goes to the post.
             _LOGGER.debug("Request:")

wyzeapy-0.5.29.dist-info/METADATA

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: wyzeapy
+Version: 0.5.29
+Summary: A library for interacting with Wyze devices
+Author-email: Katie Mulliken <katie@mulliken.net>
+License: GPL-3.0-only
+Requires-Python: >=3.11.0
+Requires-Dist: aiodns<4.0.0,>=3.2.0
+Requires-Dist: aiohttp<4.0.0,>=3.11.12
+Requires-Dist: pycryptodome<4.0.0,>=3.21.0
+Provides-Extra: dev
+Requires-Dist: pdoc<16.0.0,>=15.0.3; extra == 'dev'
+Requires-Dist: pytest<9.0.0,>=7.0.0; extra == 'dev'

wyzeapy-0.5.29.dist-info/RECORD

@@ -0,0 +1,22 @@
+wyzeapy/__init__.py,sha256=PeZ7J6Q9P8CsNrtpoUU7j8_OHMzupjn9pAKV7ba4ECQ,16850
+wyzeapy/const.py,sha256=3PV2Uq7wDD1X0ZmJBg8GWXYGHrpJvszyr9FuvwjHyus,1249
+wyzeapy/crypto.py,sha256=ApzPL0hrrd0D4k2jB5psNatJvUSzx1Kxui6_l4NJGO8,2057
+wyzeapy/exceptions.py,sha256=uKVWooofK22DZ3o9kwxnlJXnhk0VMJXnp-26pNavAis,1136
+wyzeapy/payload_factory.py,sha256=HbkVMUsJgFiRnoOh2ppmTAQobRMgFX8DcEuGg9AMQ2k,19735
+wyzeapy/types.py,sha256=5VP2ltvYsGZQCovYWmEefTNopz3lHxsbeFiOUtRDYfM,6591
+wyzeapy/utils.py,sha256=EXnsZFBxgI3LsIh9Ttg4gq3Aq1VMLOxBUPCspWJX9IQ,7407
+wyzeapy/wyze_auth_lib.py,sha256=CiWdl_UAzYxKLS8yCfjXxEI87gStJede2eS4g7KlnjE,18273
+wyzeapy/services/__init__.py,sha256=hbdyglbWQjM4XlNqPIACOEbspdsEEm4k5VXZ1hI0gc8,77
+wyzeapy/services/base_service.py,sha256=wMxWIlQyW_Kmsu_U7TvIZR0ax-k22zwZywCKOG8xcPM,31671
+wyzeapy/services/bulb_service.py,sha256=DNuT9PBmFhXpaD9rcjoYZMt-TLWWEAC3o0Yyvw_itHA,7825
+wyzeapy/services/camera_service.py,sha256=vaJIChKDMg3zWcoC_JqITDBjw4sgFdyUEkl3_w2ML8I,11170
+wyzeapy/services/hms_service.py,sha256=lQojRASz9AlwqkRfj7W7gOKXpLHrHHVwBGMw5WJ23Nc,2450
+wyzeapy/services/lock_service.py,sha256=NBjlr7pL5zJqdJaH33v1i6BbLHb7TXCkoCql4hCr8J8,2234
+wyzeapy/services/sensor_service.py,sha256=WSNz0OOLoZKru4d1ZwZ80-pdJ321HssUnwEgVfwX2zM,3578
+wyzeapy/services/switch_service.py,sha256=2O3J8-hP3vOgGVi0cKiKG_3j71zI6rHiqQd3u7CEKcE,2244
+wyzeapy/services/thermostat_service.py,sha256=_d-UbD65JArhwsslawvwpTmfVC4tMksY-L1Uu7HW0m4,5360
+wyzeapy/services/update_manager.py,sha256=5pZJmnyN4rlYJwMtEY13NlPBssnRLhtlLLmXr9t990Q,6770
+wyzeapy/services/wall_switch_service.py,sha256=cBKmnB2InHKIuoPwQ47t1rDtDplyOyGQYvnfX4fXFcc,4339
+wyzeapy-0.5.29.dist-info/METADATA,sha256=xYN-zwQtZz2SYcJ0f9HetzIj7VShIyrDZzHtPQiCCyQ,445
+wyzeapy-0.5.29.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+wyzeapy-0.5.29.dist-info/RECORD,,

{wyzeapy-0.5.27.dist-info → wyzeapy-0.5.29.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.0
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

wyzeapy/tests/test_bulb_service.py

@@ -1,135 +0,0 @@
-import unittest
-from unittest.mock import AsyncMock, MagicMock
-from wyzeapy.services.bulb_service import BulbService, Bulb
-from wyzeapy.types import DeviceTypes, PropertyIDs
-
-
-class TestBulbService(unittest.IsolatedAsyncioTestCase):
-    async def asyncSetUp(self):
-        mock_auth_lib = MagicMock()
-        self.bulb_service = BulbService(auth_lib=mock_auth_lib)
-        self.bulb_service._get_property_list = AsyncMock()
-        self.bulb_service.get_updated_params = AsyncMock()
-
-    async def test_update_bulb_basic_properties(self):
-        mock_bulb = Bulb({
-            "device_type": "Light",
-            "product_model": "WLPA19",
-            "mac": "TEST123",
-            "raw_dict": {},
-            "device_params": {"ip": "192.168.1.100"},
-            "prop_map": {},
-            'product_type': DeviceTypes.MESH_LIGHT.value
-        })
-
-        # Mock the property list response
-        self.bulb_service._get_property_list.return_value = [
-            (PropertyIDs.BRIGHTNESS, "75"),
-            (PropertyIDs.COLOR_TEMP, "4000"),
-            (PropertyIDs.ON, "1"),
-            (PropertyIDs.AVAILABLE, "1")
-        ]
-
-        updated_bulb = await self.bulb_service.update(mock_bulb)
-
-        self.assertEqual(updated_bulb.brightness, 75)
-        self.assertEqual(updated_bulb.color_temp, 4000)
-        self.assertTrue(updated_bulb.on)
-        self.assertTrue(updated_bulb.available)
-
-    async def test_update_bulb_lightstrip_properties(self):
-        mock_bulb = Bulb({
-            "device_type": "Light",
-            "product_model": "WLST19",
-            "mac": "TEST456",
-            "raw_dict": {},
-            "device_params": {"ip": "192.168.1.101"},
-            "prop_map": {},
-            'product_type': DeviceTypes.LIGHTSTRIP.value
-        })
-        mock_bulb.product_type = DeviceTypes.LIGHTSTRIP
-
-        # Mock the property list response with the corrected color format (no # symbol)
-        self.bulb_service._get_property_list.return_value = [
-            (PropertyIDs.COLOR, "FF0000"),  # Removed the # symbol
-            (PropertyIDs.COLOR_MODE, "1"),
-            (PropertyIDs.LIGHTSTRIP_EFFECTS, "rainbow"),
-            (PropertyIDs.LIGHTSTRIP_MUSIC_MODE, "1"),
-            (PropertyIDs.ON, "1"),
-            (PropertyIDs.AVAILABLE, "1")
-        ]
-
-        updated_bulb = await self.bulb_service.update(mock_bulb)
-
-        self.assertEqual(updated_bulb.color, "FF0000")
-        self.assertEqual(updated_bulb.color_mode, "1")
-        self.assertEqual(updated_bulb.effects, "rainbow")
-        self.assertTrue(updated_bulb.music_mode)
-        self.assertTrue(updated_bulb.on)
-        self.assertTrue(updated_bulb.available)
-
-    async def test_update_bulb_sun_match(self):
-        mock_bulb = Bulb({
-            "device_type": "Light",
-            "product_model": "WLPA19",
-            "mac": "TEST789",
-            "raw_dict": {},
-            "device_params": {"ip": "192.168.1.102"},
-            "prop_map": {},
-            'product_type': DeviceTypes.MESH_LIGHT.value
-        })
-
-        # Mock the property list response
-        self.bulb_service._get_property_list.return_value = [
-            (PropertyIDs.SUN_MATCH, "1"),
-            (PropertyIDs.ON, "1"),
-            (PropertyIDs.AVAILABLE, "1")
-        ]
-
-        updated_bulb = await self.bulb_service.update(mock_bulb)
-
-        self.assertTrue(updated_bulb.sun_match)
-        self.assertTrue(updated_bulb.on)
-        self.assertTrue(updated_bulb.available)
-
-    async def test_update_bulb_invalid_color_temp(self):
-        mock_bulb = Bulb({
-            "device_type": "Light",
-            "product_model": "WLPA19",
-            "mac": "TEST101",
-            "raw_dict": {},
-            "device_params": {"ip": "192.168.1.103"},
-            "prop_map": {},
-            'product_type': DeviceTypes.MESH_LIGHT.value
-        })
-
-        # Mock the property list response with invalid color temp
-        self.bulb_service._get_property_list.return_value = [
-            (PropertyIDs.COLOR_TEMP, "invalid"),
-            (PropertyIDs.ON, "1")
-        ]
-
-        updated_bulb = await self.bulb_service.update(mock_bulb)
-
-        # Should default to 2700K when invalid
-        self.assertEqual(updated_bulb.color_temp, 2700)
-        self.assertTrue(updated_bulb.on)
-
-    async def test_get_bulbs(self):
-        mock_device = MagicMock()
-        mock_device.type = DeviceTypes.LIGHT
-        mock_device.raw_dict = {
-            "device_type": "Light",
-            "product_model": "WLPA19",
-            "device_params": {"ip": "192.168.1.104"},
-            "prop_map": {},
-            'product_type': DeviceTypes.MESH_LIGHT.value
-        }
-
-        self.bulb_service.get_object_list = AsyncMock(return_value=[mock_device])
-
-        bulbs = await self.bulb_service.get_bulbs()
-
-        self.assertEqual(len(bulbs), 1)
-        self.assertIsInstance(bulbs[0], Bulb)
-        self.bulb_service.get_object_list.assert_awaited_once()