feat: Use Home Assistant's shared aiohttp client session (#210)

* feat: Use Home Assistant's shared aiohttp client session

* Instantiate GasBuddy API client once before the price lookup loop.

Author: firstof9

custom_components/gasbuddy/config_flow.py

@@ -11,8 +11,9 @@
 
 from homeassistant import config_entries
 from homeassistant.config_entries import ConfigFlowResult
-from homeassistant.core import callback
+from homeassistant.core import HomeAssistant, callback
 from homeassistant.helpers import config_validation as cv
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
 
 from .const import (
     CONF_GPS,
@@ -49,16 +50,22 @@ async def validate_url(url: str) -> bool:
     return bool(re.match(pattern, url))
 
 
-async def validate_station(station: int, solver: str | None = None) -> bool:
+async def validate_station(
+    hass: HomeAssistant, station: int, solver: str | None = None
+) -> bool:
     """Validate statation ID."""
-    check = await py_gasbuddy.GasBuddy(solver_url=solver, station_id=station).price_lookup()
+    check = await py_gasbuddy.GasBuddy(
+        solver_url=solver,
+        station_id=station,
+        session=async_get_clientsession(hass),
+    ).price_lookup()
 
     if "errors" in check:
         return False
     return True
 
 
-async def _get_station_list(hass, user_input) -> dict[str, Any]:
+async def _get_station_list(hass: HomeAssistant, user_input) -> dict[str, Any]:
     """Return list of utilities by lat/lon."""
     lat = None
     lon = None
@@ -77,9 +84,10 @@ async def _get_station_list(hass, user_input) -> dict[str, Any]:
         solver = user_input[CONF_SOLVER]
         _LOGGER.debug("Using solver URL: %s", solver)
 
-    stations = await py_gasbuddy.GasBuddy(solver_url=solver).location_search(
-        lat=lat, lon=lon, zipcode=postal
-    )
+    stations = await py_gasbuddy.GasBuddy(
+        solver_url=solver,
+        session=async_get_clientsession(hass),
+    ).location_search(lat=lat, lon=lon, zipcode=postal)
     stations_list = {}
     _LOGGER.debug("search reply: %s", stations)
 
@@ -267,7 +275,7 @@ async def async_step_manual(self, user_input=None):
                     self._errors[CONF_SOLVER] = "invalid_url"
                     return await self._show_config_manual(user_input)
 
-            validate = await validate_station(user_input[CONF_STATION_ID], user_input[CONF_SOLVER])
+            validate = await validate_station(self.hass, user_input[CONF_STATION_ID], user_input[CONF_SOLVER])
             if not validate:
                 self._errors[CONF_STATION_ID] = "station_id"
             else:
@@ -427,7 +435,7 @@ async def async_step_reconfigure(self, user_input: dict[str, Any] | None = None)
             else:
                 user_input[CONF_SOLVER] = None
 
-            validate = await validate_station(user_input[CONF_STATION_ID], user_input[CONF_SOLVER])
+            validate = await validate_station(self.hass, user_input[CONF_STATION_ID], user_input[CONF_SOLVER])
             if not validate:
                 self._errors[CONF_STATION_ID] = "station_id"
 

custom_components/gasbuddy/coordinator.py

@@ -11,6 +11,7 @@
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
 
 from .const import CONF_INTERVAL, CONF_SOLVER, CONF_STATION_ID, CONF_TIMEOUT, DOMAIN
@@ -33,6 +34,7 @@ def __init__(self, hass: HomeAssistant, config: ConfigEntry) -> None:
             station_id=config.data[CONF_STATION_ID],
             cache_file=self._cache_file,
             timeout=config.data[CONF_TIMEOUT],
+            session=async_get_clientsession(hass),
         )
 
         _LOGGER.debug("Data will be update every %s", self.interval)

custom_components/gasbuddy/manifest.json

@@ -8,7 +8,7 @@
     "iot_class": "cloud_polling",
     "issue_tracker": "https://github.com/firstof9/ha-gasbuddy/issues",
     "loggers": ["gasbuddy"],
-    "requirements": ["aiofiles", "backoff", "py_gasbuddy==0.4.2"],
+    "requirements": ["aiofiles", "backoff", "py_gasbuddy==0.4.3"],
     "version": "0.0.0-dev"
   }
 

custom_components/gasbuddy/services.py

@@ -16,6 +16,7 @@
     callback,
 )
 from homeassistant.helpers import config_validation as cv, device_registry as dr
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
 
 from .const import (
     ATTR_DEVICE_ID,
@@ -99,13 +100,14 @@ async def _price_lookup_gps(self, service: ServiceCall) -> ServiceResponse:
             solver = service.data[ATTR_SOLVER]
 
         results = {}
+        api = GasBuddy(solver_url=solver, session=async_get_clientsession(self.hass))
         for entity_id in entity_ids:
             try:
                 entity = self.hass.states.get(entity_id)
                 if entity:
                     lat = entity.attributes[ATTR_LATITUDE]
                     lon = entity.attributes[ATTR_LONGITUDE]
-                    results[entity_id] = await GasBuddy(solver_url=solver).price_lookup_service(
+                    results[entity_id] = await api.price_lookup_service(
                         lat=lat, lon=lon, limit=limit
                     )
             except (APIError, LibraryError, CSRFTokenMissing) as ex:
@@ -128,9 +130,10 @@ async def _price_lookup_zip(self, service: ServiceCall) -> ServiceResponse:
 
         results = {}
         try:
-            results = await GasBuddy(solver_url=solver).price_lookup_service(
-                zipcode=zipcode, limit=limit
-            )
+            results = await GasBuddy(
+                solver_url=solver,
+                session=async_get_clientsession(self.hass),
+            ).price_lookup_service(zipcode=zipcode, limit=limit)
         except (APIError, LibraryError, CSRFTokenMissing) as ex:
             _LOGGER.error("Error checking prices: %s", ex)