feat: Lock Status Method

Lock Status: Add lock_status method to SDK

Author: JacobAndrewSmith92

smartcar/types.py

@@ -266,6 +266,31 @@ def format_capabilities(capabilities_list: List[dict]) -> List[Capability]:
 
 Response = NamedTuple("Response", [("body", dict), ("meta", namedtuple)])
 
+# ===========================================
+# Lock Status Tuples
+# ===========================================
+
+Door = NamedTuple("Door", [("type", str), ("status", str)])
+Window = NamedTuple("Window", [("type", str), ("status", str)])
+Sunroof = NamedTuple("Sunroof", [("type", str), ("status", str)])
+Storage = NamedTuple("Storage", [("type", str), ("status", str)])
+ChargingPort = NamedTuple("ChargingPort", [("type", str), ("status", str)])
+
+
+LockStatus = NamedTuple(
+    "LockStatus",
+    [
+        ("is_locked", bool),
+        ("doors", List[Door]),
+        ("windows", List[Window]),
+        ("sunroof", List[Sunroof]),
+        ("storage", List[Storage]),
+        ("charging_port", List[ChargingPort]),
+        ("meta", namedtuple),
+    ],
+)
+
+
 # ===========================================
 # Named Tuple Selector Function
 # ===========================================
@@ -378,7 +403,16 @@ def select_named_tuple(path: str, response_or_dict) -> NamedTuple:
             Paging(data["paging"]["count"], data["paging"]["offset"]),
             headers,
         )
-
+    elif path == "security":
+        return LockStatus(
+            data["isLocked"],
+            data["doors"],
+            data["windows"],
+            data["sunroof"],
+            data["storage"],
+            data["chargingPort"],
+            headers,
+        )
     elif path == "subscribe":
         return Subscribe(data["webhookId"], data["vehicleId"], headers)
 

smartcar/vehicle.py

@@ -264,6 +264,30 @@ def get_charge_limit(self) -> types.ChargeLimit:
         response = helpers.requester("GET", url, headers=headers)
         return types.select_named_tuple(path, response)
 
+    def lock_status(self) -> types.LockStatus:
+        """
+            GET Vehicle.lock_status
+
+            Returns:
+                LockStatus = NamedTuple("LockStatus", [
+                    ("is_locked", bool)
+                    ("doors", List[Door]),
+                    ("windows", List[Window]),
+                    ("sunroof", List[Sunroof]),
+                    ("storage", List[Storage]),
+                    ("charging_port", List[ChargingPort]),
+                    ("meta", namedtuple)
+                ]
+        )
+            Raises:
+                SmartcarException
+        """
+        path = "security"
+        url = self._format_url(path)
+        headers = self._get_headers()
+        response = helpers.requester("GET", url, headers=headers)
+        return types.select_named_tuple(path, response)
+
     # ===========================================
     # Action (POST) Requests
     # ===========================================

tests/auth_helpers.py

@@ -38,6 +38,7 @@
     "read_charge",
     "required:read_engine_oil",
     "required:read_tires",
+    "required:read_security",
 ]
 
 

tests/e2e/test_vehicle.py

@@ -89,6 +89,21 @@ def test_get_charge_limit(ford_car):
     assert charge_limit._fields == ("limit", "meta")
 
 
+def test_lock_status(chevy_volt):
+    lock_status = chevy_volt.lock_status()
+    assert lock_status is not None
+    assert type(lock_status) == types.LockStatus
+    assert lock_status._fields == (
+        "is_locked",
+        "doors",
+        "windows",
+        "sunroof",
+        "storage",
+        "charging_port",
+        "meta",
+    )
+
+
 def test_lock(chevy_volt):
     response = chevy_volt.lock()
     assert response.status == "success"