Add ability to dump a Tile to a dict (#91)

Author: bachya

pytile/tile.py

@@ -1,7 +1,7 @@
 """Define a Tile object."""
 from datetime import datetime
 import logging
-from typing import Awaitable, Callable, Optional
+from typing import Any, Awaitable, Callable, Dict, Optional
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -143,6 +143,28 @@ def _save_timestamps(self, tile_data: dict) -> None:
             tile_data["result"]["last_tile_state"]["lost_timestamp"] / 1000
         )
 
+    def as_dict(self) -> Dict[str, Any]:
+        """Return dictionary version of this Tile."""
+        return {
+            "accuracy": self.accuracy,
+            "altitude": self.altitude,
+            "archetype": self.archetype,
+            "dead": self.dead,
+            "firmware_version": self.firmware_version,
+            "hardware_version": self.hardware_version,
+            "kind": self.kind,
+            "last_timestamp": self.last_timestamp,
+            "latitude": self.latitude,
+            "longitude": self.longitude,
+            "lost": self.lost,
+            "lost_timestamp": self.lost_timestamp,
+            "name": self.name,
+            "ring_state": self.ring_state,
+            "uuid": self.uuid,
+            "visible": self.visible,
+            "voip_state": self.voip_state,
+        }
+
     async def async_update(self) -> None:
         """Get the latest measurements from the Tile."""
         data = await self._async_request("get", f"tiles/{self.uuid}")

tests/test_tile.py

@@ -165,6 +165,78 @@ async def test_missing_last_tile_state(aresponses, create_session_response):
         assert not tile.longitude
 
 
+@pytest.mark.asyncio
+async def test_tile_as_dict(aresponses, create_session_response):
+    """Test dumping a Tile as a dictionary."""
+    aresponses.add(
+        "production.tile-api.com",
+        f"/api/v1/clients/{TILE_CLIENT_UUID}",
+        "put",
+        aresponses.Response(
+            text=load_fixture("create_client_response.json"),
+            status=200,
+            headers={"Content-Type": "application/json"},
+        ),
+    )
+    aresponses.add(
+        "production.tile-api.com",
+        f"/api/v1/clients/{TILE_CLIENT_UUID}/sessions",
+        "post",
+        aresponses.Response(
+            text=json.dumps(create_session_response),
+            status=200,
+            headers={"Content-Type": "application/json"},
+        ),
+    )
+    aresponses.add(
+        "production.tile-api.com",
+        "/api/v1/tiles/tile_states",
+        "get",
+        aresponses.Response(
+            text=load_fixture("tile_states_response.json"),
+            status=200,
+            headers={"Content-Type": "application/json"},
+        ),
+    )
+    aresponses.add(
+        "production.tile-api.com",
+        f"/api/v1/tiles/{TILE_TILE_UUID}",
+        "get",
+        aresponses.Response(
+            text=load_fixture("tile_details_response.json"),
+            status=200,
+            headers={"Content-Type": "application/json"},
+        ),
+    )
+
+    async with aiohttp.ClientSession() as session:
+        api = await async_login(
+            TILE_EMAIL, TILE_PASSWORD, session, client_uuid=TILE_CLIENT_UUID
+        )
+        tiles = await api.async_get_tiles()
+        assert len(tiles) == 1
+        tile = tiles[TILE_TILE_UUID]
+        assert tile.as_dict() == {
+            "accuracy": 13.496111,
+            "altitude": 0.4076319168123,
+            "archetype": "WALLET",
+            "dead": False,
+            "firmware_version": "01.12.14.0",
+            "hardware_version": "02.09",
+            "kind": "TILE",
+            "last_timestamp": datetime(2020, 8, 12, 17, 55, 26),
+            "latitude": 51.528308,
+            "longitude": -0.3817765,
+            "lost": False,
+            "lost_timestamp": datetime(1969, 12, 31, 23, 59, 59, 999000),
+            "name": "Wallet",
+            "ring_state": "STOPPED",
+            "uuid": "19264d2dffdbca32",
+            "visible": True,
+            "voip_state": "OFFLINE",
+        }
+
+
 @pytest.mark.asyncio
 async def test_tile_update(
     aresponses, create_session_response, tile_details_update_response