Merge pull request #97 from dknowles2/user-name

Handle the case where friendlyName is None

pyschlage/user.py

@@ -9,7 +9,7 @@
 class User:
     """A Schlage API user account."""
 
-    name: str = ""
+    name: str | None = None
     """The username associated with the account."""
 
     email: str = ""
@@ -36,7 +36,7 @@ def from_json(cls, json) -> User:
         :meta private:
         """
         return User(
-            name=json["friendlyName"],
+            name=json.get("friendlyName"),
             email=json["email"],
             user_id=json["identityId"],
         )

tests/conftest.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from unittest import mock
 
 from pytest import fixture
@@ -13,7 +15,7 @@ def mock_auth():
 
 
 @fixture
-def lock_users_json():
+def lock_users_json() -> list[dict]:
     return [
         {
             "consentRecords": [],

tests/test_user.py

@@ -1,12 +1,18 @@
-from unittest import mock
+from __future__ import annotations
 
 from pyschlage.user import User
 
 
-def test_from_json(lock_users_json):
+def test_from_json(lock_users_json: list[dict]):
     user = User(
         name="asdf",
         email="[email protected]",
         user_id="user-uuid",
     )
     assert User.from_json(lock_users_json[0]) == user
+
+
+def test_from_json_no_name(lock_users_json: list[dict]):
+    for user_json in lock_users_json:
+        user_json.pop("friendlyName")
+        assert User.from_json(user_json).name is None