Merge pull request #73 from mawaqit/core-integration

V3.0.0 - Core Integration Version - available

Author: moha-tah

custom_components/mawaqit/__init__.py

@@ -1,4 +1,5 @@
 """Constants for the Islamic Prayer component."""
+
 DOMAIN = "mawaqit"
 NAME = "Mawaqit Prayer Times"
 PRAYER_TIMES_ICON = "mdi:calendar-clock"
@@ -14,10 +15,10 @@
     "Jumua": "Adhan",
     "Jumua 2": "Adhan",
     "next_mawaqit": "time",
-    "Fajr Iqama": "",  
-    "Dhuhr Iqama": "",   
-    "Asr Iqama": "",    
-    "Maghrib Iqama": "",  
+    "Fajr Iqama": "",
+    "Dhuhr Iqama": "",
+    "Asr Iqama": "",
+    "Maghrib Iqama": "",
     "Isha Iqama": "",
     "Next Salat Time": "",
     "Next Salat Name": "",
@@ -27,7 +28,7 @@
     "Mosque_url": "",
     "Mosque_image": "",
 }
-        
+
 CONF_CALC_METHOD = "calculation_method"
 
 CALC_METHODS = ["nearest", "farthest"]
@@ -44,4 +45,33 @@
 PASSWORD = "password"
 
 API = "api"
-CONF_UUID = "uuid"
+CONF_UUID: str = "uuid"
+
+CONF_SEARCH: str = "Keyword"
+
+CONF_TYPE_SEARCH_TRANSLATION_KEY: str = "search_method_choice_translation_key"
+CONF_TYPE_SEARCH: str = "search_method_choice"
+CONF_TYPE_SEARCH_COORDINATES: str = "search_method_coordinates"
+CONF_TYPE_SEARCH_KEYWORD: str = "search_method_keyword"
+
+CONF_CHOICE: str = "choice"
+CONF_CHOICE_TRANSLATION_KEY: str = "choice_translation_key"
+CONF_KEEP: str = "keep"
+CONF_RESET: str = "reset"
+
+
+MAWAQIT_STORAGE_VERSION = 1
+MAWAQIT_STORAGE_KEY = "mawaqit_storage"
+MAWAQIT_TEST_STORAGE_KEY = "mawaqit_test_storage"
+
+MAWAQIT_API_KEY_TOKEN = "MAWAQIT_API_KEY"
+MAWAQIT_ALL_MOSQUES_NN = "all_mosques_NN"
+MAWAQIT_MY_MOSQUE_NN = "my_mosque_NN"
+MAWAQIT_PRAY_TIME = "pray_time"
+MAWAQIT_MOSQ_LIST_DATA = "mosq_list_data"
+
+# Error messages
+
+NO_MOSQUE_FOUND_KEYWORD = "no_mosque_found_keyword"
+CANNOT_CONNECT_TO_SERVER = "cannot_connect_to_server"
+WRONG_CREDENTIAL = "wrong_credential"

custom_components/mawaqit/config_flow.py

@@ -12,7 +12,7 @@
   "iot_class": "cloud_polling",
   "issue_tracker": "https://github.com/mawaqit/home-assistant/issues",
   "requirements": [
-    "mawaqit==0.0.1"
+    "mawaqit==1.0.0"
   ],
-  "version": "2.1.0"
-}
+  "version": "3.0.0"
+}

custom_components/mawaqit/const.py

@@ -1,25 +1,32 @@
+"""Provides a wrapper for interacting with the MAWAQIT API.
+
+It includes functions for testing credentials, retrieving API tokens,
+fetching prayer times, and finding mosques in the neighborhood.
+"""
+
 import logging
-import os
+
 from mawaqit import AsyncMawaqitClient
 from mawaqit.consts import BadCredentialsException
 
 _LOGGER = logging.getLogger(__name__)
 
 
-async def _test_credentials(username, password):
+async def test_credentials(username, password):
     """Return True if the MAWAQIT credentials is valid."""
     try:
         client = AsyncMawaqitClient(username=username, password=password)
         await client.login()
-        return True
     except BadCredentialsException:
         _LOGGER.error("Error : Bad Credentials")
         return False
-    except Exception as e:
-        _LOGGER.error("Error %s", e)
+    except (ConnectionError, TimeoutError) as e:
+        _LOGGER.error("Network-related error: %s", e)
     finally:
         await client.close()
 
+    return True
+
 
 async def get_mawaqit_api_token(username, password):
     """Return the MAWAQIT API token."""
@@ -28,8 +35,8 @@ async def get_mawaqit_api_token(username, password):
         token = await client.get_api_token()
     except BadCredentialsException as e:
         _LOGGER.error("Error on retrieving API Token: %s", e)
-    except Exception as e:
-        _LOGGER.error("Error %s", e)
+    except (ConnectionError, TimeoutError) as e:
+        _LOGGER.error("Network-related error: %s", e)
     finally:
         await client.close()
     return token
@@ -47,14 +54,39 @@ async def all_mosques_neighborhood(
         nearest_mosques = await client.all_mosques_neighborhood()
     except BadCredentialsException as e:
         _LOGGER.error("Error on retrieving mosques: %s", e)
-    except Exception as e:
-        _LOGGER.error("Error %s", e)
+    except (ConnectionError, TimeoutError) as e:
+        _LOGGER.error("Network-related error: %s", e)
     finally:
         await client.close()
 
     return nearest_mosques
 
 
+async def all_mosques_by_keyword(
+    search_keyword, username=None, password=None, token=None
+):
+    """Return mosques in the neighborhood if any. Returns a list of dicts."""
+    try:
+        client = AsyncMawaqitClient(
+            username=username, password=password, token=token, session=None
+        )
+        await client.get_api_token()
+
+        search_mosques = []
+
+        if search_keyword is not None:
+            search_mosques = await client.fetch_mosques_by_keyword(search_keyword)
+
+    except BadCredentialsException as e:
+        _LOGGER.error("Error on retrieving mosques: %s", e)
+    except (ConnectionError, TimeoutError) as e:
+        _LOGGER.error("Network-related error: %s", e)
+    finally:
+        await client.close()
+
+    return search_mosques
+
+
 async def fetch_prayer_times(
     latitude=None, longitude=None, mosque=None, username=None, password=None, token=None
 ):
@@ -69,17 +101,9 @@ async def fetch_prayer_times(
 
     except BadCredentialsException as e:
         _LOGGER.error("Error on retrieving prayer times: %s", e)
-    except Exception as e:
-        _LOGGER.error("Error %s", e)
+    except (ConnectionError, TimeoutError) as e:
+        _LOGGER.error("Network-related error: %s", e)
     finally:
         await client.close()
 
     return dict_calendar
-
-
-def get_mawaqit_token_from_env():
-    return os.environ.get("MAWAQIT_API_KEY", "NA")
-
-
-def set_mawaqit_token_from_env(mawaqit_token):
-    os.environ["MAWAQIT_API_KEY"] = mawaqit_token

custom_components/mawaqit/manifest.json

@@ -1,26 +1,39 @@
 """Platform to retrieve Mawaqit prayer times information for Home Assistant."""
 
-from homeassistant.components.sensor import SensorEntity
-from homeassistant.components.sensor import SensorDeviceClass
+import logging
+from typing import Any
+
+from homeassistant.components.sensor import SensorDeviceClass, SensorEntity
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.core import HomeAssistant
 from homeassistant.helpers.dispatcher import async_dispatcher_connect
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+from homeassistant.helpers.storage import Store
 import homeassistant.util.dt as dt_util
 
-from .const import DATA_UPDATED, DOMAIN, PRAYER_TIMES_ICON, SENSOR_TYPES
-
-import json
-import os
-import logging
-
+from . import utils
+from .const import (
+    DATA_UPDATED,
+    DOMAIN,
+    MAWAQIT_STORAGE_KEY,
+    MAWAQIT_STORAGE_VERSION,
+    PRAYER_TIMES_ICON,
+    SENSOR_TYPES,
+)
 
 _LOGGER = logging.getLogger(__name__)
 
 
-async def async_setup_entry(hass, config_entry, async_add_entities):
+async def async_setup_entry(
+    hass: HomeAssistant,
+    config_entry: ConfigEntry,
+    async_add_entities: AddEntitiesCallback,
+) -> None:
     """Set up the Mawaqit prayer times sensor platform."""
 
     client = hass.data[DOMAIN]
     if not client:
-        _LOGGER.error("Error retrieving client object.")
+        _LOGGER.error("Error retrieving client object")
 
     entities = []
     for sensor_type in SENSOR_TYPES:
@@ -32,7 +45,7 @@ async def async_setup_entry(hass, config_entry, async_add_entities):
             "Maghrib",
             "Isha",
             "Jumua",
-            "Jumua 2",  # "Aid", "Aid 2",
+            "Jumua 2",  # "Aid" and "Aid 2",
             "Fajr Iqama",
             "Shurouq Iqama",
             "Dhuhr Iqama",
@@ -55,38 +68,29 @@ async def async_setup_entry(hass, config_entry, async_add_entities):
 class MawaqitPrayerTimeSensor(SensorEntity):
     """Representation of an Mawaqit prayer time sensor."""
 
-    def __init__(self, sensor_type, client):
+    def __init__(self, sensor_type, client) -> None:
         """Initialize the Mawaqit prayer time sensor."""
         self.sensor_type = sensor_type
         self.client = client
 
     @property
-    def name(self):
+    def name(self) -> str:
         """Return the name of the sensor."""
         return f"{self.sensor_type} {SENSOR_TYPES[self.sensor_type]}"
 
     @property
-    def unique_id(self):
+    def unique_id(self) -> str:
         """Return the unique id of the entity."""
         return self.sensor_type
 
     @property
-    def icon(self):
+    def icon(self) -> str:
         """Icon to display in the front end."""
         return PRAYER_TIMES_ICON
 
-    # @property
-    # def state(self):
-    #     """Return the state of the sensor."""
-    #     return (
-    #         self.client.prayer_times_info.get(self.sensor_type)
-    #         .astimezone(dt_util.UTC)
-    #         .isoformat()
-    #     )
-
     @property
     def native_value(self):
-        """Return the state of the sensor.  .astimezone(dt_util.UTC)"""
+        """Return the state of the sensor.  .astimezone(dt_util.UTC)."""
         if self.sensor_type in [
             "Fajr",
             "Shurouq",
@@ -106,21 +110,24 @@ def native_value(self):
             "Next Salat Preparation",
         ]:
             time = self.client.prayer_times_info.get(self.sensor_type)
+            _LOGGER.debug("[;] before %s Time: %s", self.sensor_type, time)
             if time is not None:
+                _LOGGER.debug(
+                    "[;] %s Time: %s", self.sensor_type, time.astimezone(dt_util.UTC)
+                )
                 return time.astimezone(dt_util.UTC)
-            else:
-                return None
 
-        else:
-            return self.client.prayer_times_info.get(self.sensor_type)
+            return None
+
+        return self.client.prayer_times_info.get(self.sensor_type)
 
     @property
-    def should_poll(self):
+    def should_poll(self) -> bool:
         """Disable polling."""
         return False
 
     @property
-    def device_class(self):
+    def device_class(self) -> SensorDeviceClass | None:
         """Return the device class."""
         if self.sensor_type in [
             "Fajr",
@@ -141,10 +148,9 @@ def device_class(self):
             "Next Salat Preparation",
         ]:
             return SensorDeviceClass.TIMESTAMP
-        else:
-            return None
+        return None
 
-    async def async_added_to_hass(self):
+    async def async_added_to_hass(self) -> None:
         """Handle entity which will be added."""
         self.async_on_remove(
             async_dispatcher_connect(self.hass, DATA_UPDATED, self.async_write_ha_state)
@@ -154,49 +160,44 @@ async def async_added_to_hass(self):
 class MyMosqueSensor(SensorEntity):
     """Representation of a mosque sensor."""
 
-    def __init__(self, name, hass):
+    def __init__(self, name, hass: HomeAssistant) -> None:
         """Initialize the mosque sensor."""
         self.hass = hass
-        self._attributes = {}
+        self._attributes: dict[str, Any] = {}
         self._name = name
         self._state = None
         latitude = self.hass.config.latitude
         longitude = self.hass.config.longitude
         self._latitude = latitude
         self._longitude = longitude
+        self.store: Store = Store(
+            self.hass, MAWAQIT_STORAGE_VERSION, MAWAQIT_STORAGE_KEY
+        )
 
-    # @Throttle(TIME_BETWEEN_UPDATES)
-    async def async_update(self):
+    async def async_update(self) -> None:
         """Get the latest data from the Mawaqit API."""
-        current_dir = os.path.dirname(os.path.realpath(__file__))
-
-        def read():
-            with open("{}/data/my_mosque_NN.txt".format(current_dir), "r") as f:
-                data = json.load(f)
-            return data
-
-        data = await self.hass.async_add_executor_job(read)
+        data_my_mosque_NN = await utils.read_my_mosque_NN_file(self.store)
 
-        for k, v in data.items():
+        for k, v in data_my_mosque_NN.items():
             if str(k) != "uuid" and str(k) != "id" and str(k) != "slug":
                 self._attributes[k] = str(v)
 
     @property
-    def name(self):
+    def name(self) -> str | None:
         """Return the name of the sensor."""
         return self._name
 
     @property
-    def state(self):
+    def native_value(self) -> str | None:
         """Return the state of the sensor."""
         return self._attributes["name"]
 
     @property
-    def icon(self):
+    def icon(self) -> str | None:
         """Return the icon of the sensor."""
         return "mdi:mosque"
 
     @property
-    def extra_state_attributes(self):
+    def extra_state_attributes(self) -> dict[str, Any] | None:
         """Return attributes for the sensor."""
         return self._attributes