Implemented long_poll back into the mix

Author: jeeftor

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "intellifire4py"
-version = "4.1.7"
+version = "4.1.8"
 description = "Intellifire4Py"
 authors = ["Jeff Stein <[email protected]>"]
 license = "MIT"

src/intellifire4py/cloud_api.py

@@ -6,18 +6,17 @@
 
 from asyncio import Task
 from typing import Any
-
+import json
 import aiohttp
 from aiohttp import CookieJar, ClientSession, ClientTimeout
 
 from .exceptions import CloudError
 from .model import (
-    IntelliFireFireplaceCloud,
     IntelliFireUserData,
 )
 from .model import IntelliFirePollData
 
-from .const import IntelliFireCommand, IntelliFireApiMode
+from .const import IntelliFireCommand, IntelliFireApiMode, IntelliFireCloudPollType
 
 from .control import IntelliFireController
 from .read import IntelliFireDataProvider
@@ -30,6 +29,7 @@ class IntelliFireAPICloud(IntelliFireController, IntelliFireDataProvider):
     """Api for cloud access."""
 
     _control_mode = IntelliFireApiMode.CLOUD
+    _poll_mode = IntelliFireCloudPollType.LONG
 
     def __init__(
         self,
@@ -87,8 +87,6 @@ def __init__(
         # Full data set on the user
         self._user_data: IntelliFireUserData = IntelliFireUserData()
 
-        self.last_send = None
-
     def _get_session(self, timeout_seconds: float = 10.0) -> ClientSession:
         """Ensure that the aiohttp ClientSession is created and open."""
         timeout = ClientTimeout(timeout_seconds)
@@ -150,7 +148,7 @@ async def _send_cloud_command(
             422 Invalid Parameter (invalid command id or command value)
             """
             if response.status == 204:
-                self.last_send = datetime.now()
+                self._last_send = datetime.now()
                 return
             # elif (
             #     response.status == 403
@@ -165,7 +163,7 @@ async def _send_cloud_command(
             else:
                 raise Exception(f"Unexpected return code {response.status}")
 
-    async def long_poll(self, fireplace: IntelliFireFireplaceCloud) -> bool:
+    async def long_poll(self) -> bool:
         """Perform a LongPoll to wait for a Status update.
 
         Only returns a status update when the fireplace’s status actually changes (excluding normal periodic
@@ -192,30 +190,43 @@ async def long_poll(self, fireplace: IntelliFireFireplaceCloud) -> bool:
             bool: `True` if status changed, `False` if it did not
         """
 
-        self._log.debug("Long Poll: Start")
-
-        async with self._get_session().get(
-            f"{self.prefix}://iftapi.net/a/{self._serial}/applongpoll", timeout=61
-        ) as response:
-            self._log.debug("Long Poll Status Code %d", response.status)
-            if response.status == 200:
-                self._log.debug("Long poll: 200 - Received data")
-                self.last_long_poll = datetime.now()
-                return True
-            elif response.status == 408:
-                self._log.debug("Long poll: 408 - No Data changed")
-                self.last_long_poll = datetime.now()
-                return False
-            elif response.status == 403:
-                raise CloudError("Not authorized")
-            elif response.status == 404:
-                raise CloudError("Fireplace not found (bad serial number)")
-            else:
-                response_text = await response.text()
-                self._log.error(
-                    f"Unexpected status code: {response.status}, Response: {response_text}"
-                )
-                raise CloudError(f"Unexpected status code: {response.status}")
+        long_poll_url = f"{self.prefix}://iftapi.net/a/{self._serial}/applongpoll"
+        self._log.debug(f"long_poll() {long_poll_url}")
+
+        async with self._get_session() as session:
+            try:
+                response = await session.get(long_poll_url, timeout=61)
+
+                self._log.debug("Long Poll Status Code %d", response.status)
+                if response.status == 200:
+                    self._log.debug("Long poll: 200 - Received data")
+
+                    # Data has text/html header type so we need to manually convert it to json
+                    json_data = json.loads(await response.text())
+
+                    self._data = IntelliFirePollData(**json_data)
+                    self._log.debug(f"poll() complete: {self._data}")
+
+                    self._last_poll = datetime.now()
+                    return True
+                elif response.status == 408:
+                    self._log.debug("Long poll: 408 - No Data changed")
+                    self._last_poll = datetime.now()
+                    return False
+            except aiohttp.ClientResponseError as e:
+                if e.status == 403:
+                    raise CloudError("Not authorized") from e
+                if e.status == 404:
+                    raise CloudError("Fireplace not found (bad serial number)") from e
+                else:
+                    response_text = await response.text()
+                    self._log.error(
+                        f"Unexpected status code: {response.status}, Response: {response_text}"
+                    )
+                    raise CloudError(
+                        f"Unexpected status code: {response.status}"
+                    ) from e
+        return False
 
     async def poll(self, timeout_seconds: float = 10.0) -> None:
         """Return a fireplace’s status in JSON.
@@ -266,8 +277,7 @@ async def poll(self, timeout_seconds: float = 10.0) -> None:
 
         """
 
-        serial = self._serial
-        poll_url = f"{self.prefix}://iftapi.net/a/{serial}//apppoll"
+        poll_url = f"{self.prefix}://iftapi.net/a/{self._serial}//apppoll"
 
         self._log.debug(f"poll() {poll_url}")
         async with self._get_session() as session:
@@ -278,7 +288,7 @@ async def poll(self, timeout_seconds: float = 10.0) -> None:
                 self._data = IntelliFirePollData(**json_data)
                 self._log.debug(f"poll() complete: {self._data}")
 
-                self.last_poll = datetime.now()
+                self._last_poll = datetime.now()
 
             except aiohttp.ClientResponseError as e:
                 if e.status == 403:
@@ -324,14 +334,20 @@ async def __background_poll(self, minimum_wait_in_seconds: int = 15) -> None:
             self._log.debug("__background_poll:: Loop start time %f", start)
 
             try:
-                #     new_data = await self.long_poll()
+                if self._poll_mode == IntelliFireCloudPollType.LONG:
+                    await self.long_poll()
+                else:
+                    await self.poll()
+
                 #
-                #     if new_data:
-                #         self._log.debug(self.data)
+                # #     has_new_data = await self.long_poll()
+                # #
+                # #     if new_data:
+                # #         self._log.debug(self.data)
+                # #
+                # # Long poll didn't seem to be working so switched to normal polling again
                 #
-                # Long poll didn't seem to be working so switched to normal polling again
-
-                await self.poll()
+                # await self.poll()
 
                 end = time.time()
                 duration: float = end - start
@@ -361,3 +377,7 @@ def data(self) -> IntelliFirePollData:
         ):  # pragma: no cover - the tests SHOULD be hitting this but dont appear to be
             self._log.warning("Returning uninitialized poll data")  # pragma: no cover
         return self._data
+
+    def set_poll_mode(self, mode: IntelliFireCloudPollType):
+        """Set the poll mode."""
+        self._poll_mode = mode

src/intellifire4py/const.py

@@ -18,6 +18,13 @@ class IntelliFireApiMode(Enum):
     NONE = "none"
 
 
+class IntelliFireCloudPollType(Enum):
+    """Polling type."""
+
+    LONG = "long"
+    SHORT = "short"
+
+
 class IntelliFireErrorCode(MultiValueEnum):  # type: ignore
     """The following is a description of various error codes. These were obtained by decompiling the Android APK.
 

src/intellifire4py/control.py

@@ -16,7 +16,7 @@ def __init__(self, control_mode: IntelliFireApiMode):  # pragma: no cover
         """Initialize the controller knowing whether its local or cloud based."""
         self._control_mode = control_mode
         self._data = IntelliFirePollData()
-        self.last_send: datetime | None = None
+        self._last_send: datetime | None = None
 
     async def flame_on(self) -> None:
         """Turn on the flame."""

src/intellifire4py/local_api.py

@@ -205,7 +205,7 @@ async def poll(
                     json_data = await response.json(content_type=None)
                     self._data = IntelliFirePollData(**json_data)
                     self._log.debug(f"poll() complete: {self._data}")
-                    self.last_poll = datetime.now()
+                    self._last_poll = datetime.now()
                 except JSONDecodeError as error:
                     if not suppress_warnings:
                         self._log.warning("Error decoding JSON: [%s]", response.text)
@@ -339,7 +339,7 @@ async def _send_local_command(
                             self._log.debug(
                                 "_send_local_command:: Response Code [%d]", resp.status
                             )
-                            self.last_send = datetime.now()
+                            self._last_send = datetime.now()
                     except asyncio.TimeoutError as error:
                         self._log.warning("Control Endpoint Timeout Error %s", error)
                         continue

src/intellifire4py/read.py

@@ -13,10 +13,14 @@ class IntelliFireDataProvider(ABC):
     def __init__(self) -> None:
         """Define simple initializer."""
         self._data = IntelliFirePollData()
-        self.last_poll: datetime | None = None
-        self.last_long_poll: datetime | None = None
+        self._last_poll: datetime | None = None
         pass
 
+    @property
+    def last_poll(self) -> datetime | None:
+        """Return the last poll time."""
+        return self._last_poll
+
     @property
     @abstractmethod
     def data(self) -> IntelliFirePollData: