@camstack/addon-waste-collections 0.0.0-stage → 0.1.1

package/python/vendor/waste_collection_schedule/source/impactapps_com_au.py

@@ -0,0 +1,611 @@
+from datetime import date, timedelta
+from typing import TypedDict, cast
+
+import requests
+from waste_collection_schedule import Collection, Icons  # type: ignore[attr-defined]
+from waste_collection_schedule.exceptions import (
+    SourceArgumentExceptionMultiple,
+    SourceArgumentNotFoundWithSuggestions,
+)
+
+TITLE = "Impact Apps"
+DESCRIPTION = (
+    "Source for councils using Impact Apps (waste-info.com.au) for waste collection."
+)
+URL = "https://impactapps.com.au"
+TEST_CASES = {
+    "Random Redland Bay": {
+        "service": "redland",
+        "suburb": "Redland Bay",
+        "street_name": "Boundary Street",
+        "street_number": "1",
+    },
+    "Teneriffe Green Beacon": {
+        "service": "https://brisbane.waste-info.com.au",
+        "suburb": "Teneriffe",
+        "street_name": "Helen St",
+        "street_number": "26",
+    },
+    "Test Penrith Address": {
+        "service": "Penrith City Council",
+        "property_id": 71794,
+    },
+    "Random Penrith Address": {
+        "service": "Penrith City Council",
+        "suburb": "Emu Plains",
+        "street_name": "Beach Street",
+        "street_number": "3",
+    },
+    "Blue Mountains": {
+        "service": "Blue Mountains City Council",
+        "suburb": "Katoomba",
+        "street_name": "Katoomba Street",
+        "street_number": "110",
+    },
+    "Bayside Council, NSW": {
+        "service": "Bayside Council",
+        "suburb": "Eastlakes",
+        "street_name": "Universal Street",
+        "street_number": "5",
+    },
+    "Wollongong": {
+        "service": "wollongong",
+        "property_id": 21444,
+    },
+    "Ballarat": {
+        "service": "ballarat",
+        "property_id": 34195,
+    },
+    "Bega Valley": {
+        "service": "bega",
+        "property_id": 43106,
+    },
+    "Burwood": {
+        "service": "burwood",
+        "property_id": 7821,
+    },
+    "Campbelltown": {
+        "service": "campbelltown",
+        "property_id": 255933,
+    },
+    "Canada Bay": {
+        "service": "canada-bay",
+        "property_id": 10475,
+    },
+    "Cowra": {
+        "service": "cowra",
+        "property_id": 3585,
+    },
+    "Cumberland": {
+        "service": "cumberland",
+        "property_id": 260324,
+    },
+    "Forbes": {
+        "service": "forbes",
+        "property_id": 1694,
+    },
+    "Gwydir": {
+        "service": "gwydir",
+        "property_id": 645,
+    },
+    "Lithgow": {
+        "service": "lithgow",
+        "suburb": "Clarence",
+        "street_name": "Chifley Road",
+        "street_number": "590",
+    },
+    "Livingstone": {
+        "service": "livingstone",
+        "property_id": 26730,
+    },
+    "Moira": {
+        "service": "moira",
+        "property_id": 24492,
+    },
+    "Moree Plains": {
+        "service": "moree",
+        "property_id": 4570,
+    },
+    "Port Stephens": {
+        "service": "port-stephens",
+        "property_id": 5149,
+    },
+    "PMHC": {
+        "service": "pmhc",
+        "property_id": 19297,
+    },
+    "QPRC": {
+        "service": "qprc",
+        "property_id": 116719,
+    },
+    "South Burnett": {
+        "service": "south-burnett",
+        "property_id": 30012,
+    },
+    "Wellington": {
+        "service": "wellington",
+        "property_id": 1456,
+    },
+    "Baw-Baw": {"service": "baw-baw", "property_id": 12894},
+    "Snowy Valleys": {
+        "service": "snowy-valleys",
+        "property_id": 6787,
+    },
+    "Gympie": {
+        "service": "gympie",
+        "suburb": "Cooloola Cove",
+        "street_name": "Investigator Av",
+        "street_number": "11",
+    },
+    "Benalla": {
+        "service": "benalla",
+        "suburb": "Benalla",
+        "street_name": "Arundel Street",
+        "street_number": "110",
+    },
+    "Coffs Coast": {
+        "service": "coffs-coast",
+        "suburb": "North Dorrigo",
+        "street_name": "Tyringham Road",
+        "street_number": "666",
+    },
+    "Ku-ring-gai": {
+        "service": "ku-ring-gai",
+        "suburb": "St Ives",
+        "street_name": "Kitchener Street",
+        "street_number": "99/2-8",
+    },
+    "Horsham Rural City": {
+        "service": "hrcc",
+        "suburb": "Mckenzie Creek",
+        "street_name": "Henty Highway",
+        "street_number": "3999",
+    },
+    "Murrindindi Shire Council": {
+        "service": "murrindindi",
+        "suburb": "Yea",
+        "street_name": "The Parade",
+        "street_number": "44",
+    },
+    "Clarence Valley Council": {
+        "service": "clarence",
+        "suburb": "Yamba",
+        "street_name": "Wattle Drive",
+        "street_number": "24",
+    },
+}
+
+HEADERS = {"user-agent": "Mozilla/5.0"}
+
+ICON_MAP = {
+    "waste": Icons.GENERAL_WASTE,
+    "recycle": Icons.RECYCLING,
+    "organic": Icons.ORGANIC,
+    "greenwaste": Icons.GARDEN,
+    "clean_up": Icons.EVENT,
+    "special": Icons.EVENT,
+    "glass": Icons.GLASS,
+    "paper": Icons.PAPER,
+}
+
+SERVICE_MAP = [  # supported calendars can be found at https://calendars.impactapps.com.au/
+    {
+        "name": "City of Ballarat",
+        "url": "https://ballarat.waste-info.com.au",
+        "website": "https://www.ballarat.vic.gov.au",
+    },
+    {
+        "name": "Baw Baw Shire Council",
+        "url": "https://baw-baw.waste-info.com.au",
+        "website": "https://www.bawbawshire.vic.gov.au",
+    },
+    {
+        "name": "Bayside Council",
+        "url": "https://rockdale.waste-info.com.au",
+        "website": "https://www.bayside.nsw.gov.au",
+    },
+    {
+        "name": "Bega Valley Shire Council",
+        "url": "https://bega.waste-info.com.au",
+        "website": "https://www.begavalley.nsw.gov.au",
+    },
+    {
+        "name": "Blue Mountains City Council",
+        "url": "https://bmcc.waste-info.com.au",
+        "website": "https://www.bmcc.nsw.gov.au",
+    },
+    {
+        "name": "Brisbane City Council",
+        "url": "https://brisbane.waste-info.com.au",
+        "website": "https://www.brisbane.qld.gov.au",
+    },
+    {
+        "name": "Burwood City Council",
+        "url": "https://burwood-waste.waste-info.com.au",
+        "website": "https://www.burwood.nsw.gov.au",
+    },
+    {
+        "name": "Campbelltown City Council",
+        "url": "https://campbelltown.waste-info.com.au",
+        "website": "https://www.campbelltown.nsw.gov.au",
+    },
+    {
+        "name": "City of Canada Bay Council",
+        "url": "https://canada-bay.waste-info.com.au",
+        "website": "https://www.canadabay.nsw.gov.au",
+    },
+    {
+        "name": "Cowra Council",
+        "url": "https://cowra.waste-info.com.au",
+        "website": "https://www.cowracouncil.com.au/",
+    },
+    {
+        "name": "Cumberland City Council",
+        "url": "https://cumberland.waste-info.com.au",
+        "website": "https://www.cumberland.nsw.gov.au",
+    },
+    {
+        "name": "Forbes Shire Council",
+        "url": "https://forbes.waste-info.com.au",
+        "website": "https://www.forbes.nsw.gov.au",
+    },
+    {
+        "name": "Gwydir Shire Council",
+        "url": "https://gwydir.waste-info.com.au",
+        "website": "https://www.gwydir.nsw.gov.au",
+    },
+    {
+        "name": "Lithgow City Council",
+        "url": "https://lithgow.waste-info.com.au",
+        "website": "https://council.lithgow.com/",
+    },
+    {
+        "name": "Livingstone Shire Council",
+        "url": "https://livingstone.waste-info.com.au",
+        "website": "https://www.livingstone.qld.gov.au",
+    },
+    {
+        "name": "Moira Shire Council",
+        "url": "https://moira.waste-info.com.au",
+        "website": "https://www.moira.vic.gov.au",
+    },
+    {
+        "name": "Moree Plains Shire Council",
+        "url": "https://moree.waste-info.com.au",
+        "website": "https://www.mpsc.nsw.gov.au",
+    },
+    {
+        "name": "Penrith City Council",
+        "url": "https://penrith.waste-info.com.au",
+        "website": "https://www.penrithcity.nsw.gov.au",
+    },
+    {
+        "name": "Port Stephens Council",
+        "url": "https://port-stephens.waste-info.com.au",
+        "website": "https://www.portstephens.nsw.gov.au",
+    },
+    {
+        "name": "Port Macquarie Hastings Council",
+        "url": "https://pmhc.waste-info.com.au",
+        "website": "https://www.pmhc.nsw.gov.au",
+    },
+    {
+        "name": "Queanbeyan-Palerang Regional Council",
+        "url": "https://qprc.waste-info.com.au",
+        "website": "https://www.qprc.nsw.gov.au",
+    },
+    {
+        "name": "Redland City Council",
+        "url": "https://redland.waste-info.com.au",
+        "website": "https://www.redland.qld.gov.au",
+    },
+    {
+        "name": "Snowy Valleys Council",
+        "url": "https://snowy-valleys.waste-info.com.au",
+        "website": "https://www.snowyvalleys.nsw.gov.au",
+    },
+    {
+        "name": "South Burnett Regional Council",
+        "url": "https://south-burnett.waste-info.com.au",
+        "website": "https://www.southburnett.qld.gov.au",
+    },
+    {
+        "name": "Wellington Shire Council",
+        "url": "https://wellington.waste-info.com.au",
+        "website": "https://www.wellington.vic.gov.au",
+    },
+    {
+        "name": "Wollongong City Council",
+        "url": "https://wollongong.waste-info.com.au",
+        "website": "https://www.wollongong.nsw.gov.au",
+    },
+    {
+        "name": "Gympie Regional Council",
+        "url": "https://gympie.waste-info.com.au",
+        "website": "https://www.gympie.qld.gov.au",
+    },
+    {
+        "name": "Benalla Rural City Council",
+        "url": "https://benalla.waste-info.com.au",
+        "website": "https://www.benalla.vic.gov.au/",
+    },
+    {
+        "name": "Coffs Coast Waste Services",
+        "url": "https://coffs-coast.waste-info.com.au",
+        "website": "https://www.coffsharbour.nsw.gov.au",
+    },
+    {
+        "name": "Ku-ring-gai Council",
+        "url": "https://ku-ring-gai.waste-info.com.au",
+        "website": "https://www.krg.nsw.gov.au",
+    },
+    {
+        "name": "Horsham Rural City Council",
+        "url": "https://hrcc.waste-info.com.au",
+        "website": "https://www.hrcc.vic.gov.au",
+    },
+    {
+        "name": "Murrindindi Shire Council",
+        "url": "https://murrindindi.waste-info.com.au",
+        "website": "https://www.murrindindi.vic.gov.au",
+    },
+    {
+        "name": "Clarence Valley Council",
+        "url": "https://clarence.waste-info.com.au",
+        "website": "https://www.clarence.nsw.gov.au",
+    },
+]
+
+SERVICE_MAP_LOOKUP = {council["name"]: council for council in SERVICE_MAP}
+
+# Misspelled SERVICE_MAP names that shipped previously, mapped to the corrected
+# name. EXTRA_INFO() publishes each council's name as its `service` default_param,
+# so the config flow stored the misspelling verbatim in existing config entries.
+# Without this, correcting SERVICE_MAP would drop those users through to the
+# "assume the service is a council name" branch below and build a nonsense host
+# ("https://Murrindindi Shire Counci.waste-info.com.au").
+LEGACY_SERVICE_NAMES = {
+    "Murrindindi Shire Counci": "Murrindindi Shire Council",
+    "Campbeltown City Council": "Campbelltown City Council",
+}
+
+
+def EXTRA_INFO():
+    return [
+        {
+            "title": council["name"],
+            "url": council["website"],
+            "default_params": {"service": council["name"]},
+        }
+        for council in SERVICE_MAP
+    ]
+
+
+class LocalityResponse(TypedDict):
+    id: int
+    name: str
+    postcode: int | None
+    council: str
+
+
+class StreetResponse(TypedDict):
+    id: int
+    name: str
+    locality: str
+
+
+class PropertyResponse(TypedDict):
+    id: int
+    name: str
+    zone: str
+    voucher_preferences: int
+
+
+class OneOffEventResponse(TypedDict):
+    start: str
+    event_type: str
+    name: str
+    color: str
+    textColor: str
+    borderColor: str
+
+
+class RecurringEventResponse(TypedDict):
+    start_date: str
+    event_type: str
+    name: str
+    color: str
+    textColor: str
+    borderColor: str
+    dow: list[int]
+    daysOfWeek: list[int]
+
+
+def generate_recurring_dates(
+    event: RecurringEventResponse, start_date: date, end_date: date
+) -> list[date]:
+    # Generate a list of dates for the recurring event
+    recurring_dates = []
+    # Event days of week are indexed with Monday being 1 (1 = Monday, 7 = Sunday)
+    start_date = date.fromisoformat(event["start_date"])
+    for i in range((end_date - start_date).days + 1):
+        current_date = start_date + timedelta(days=i)
+        if current_date.weekday() + 1 in event["daysOfWeek"]:
+            recurring_dates.append(current_date)
+    return recurring_dates
+
+
+class LocationFinder:
+    def __init__(self, api_url: str):
+        self.api_url = api_url
+
+    def find_suburb_id(self, session: requests.Session, suburb: str) -> int:
+        url = f"{self.api_url}/api/v1/localities.json"
+        response = session.get(url)
+        response.raise_for_status()
+        suburbs: list[LocalityResponse] = response.json()["localities"]
+        suburb_id = next(
+            (item["id"] for item in suburbs if item["name"] == suburb), None
+        )
+        if suburb_id is None:
+            raise SourceArgumentNotFoundWithSuggestions(
+                "suburb", suburb, [item["name"] for item in suburbs]
+            )
+        return suburb_id
+
+    def find_street_id(
+        self, session: requests.Session, suburb_id: int, street_name: str
+    ) -> int:
+        url = f"{self.api_url}/api/v1/streets.json"
+        response = session.get(url, params={"locality": suburb_id})
+        response.raise_for_status()
+        streets: list[StreetResponse] = response.json()["streets"]
+        street_id = next(
+            (item["id"] for item in streets if item["name"] == street_name), None
+        )
+        if street_id is None:
+            raise SourceArgumentNotFoundWithSuggestions(
+                "street_name", street_name, [item["name"] for item in streets]
+            )
+        return street_id
+
+    def find_property_id(
+        self,
+        session: requests.Session,
+        street_id: int,
+        street_number: str,
+        street_name: str,
+        suburb: str,
+    ) -> int:
+        url = f"{self.api_url}/api/v1/properties.json"
+        response = session.get(url, params={"street": street_id})
+        response.raise_for_status()
+        properties: list[PropertyResponse] = response.json()["properties"]
+        property_id = next(
+            (
+                item["id"]
+                for item in properties
+                if item["name"] == f"{street_number} {street_name} {suburb}"
+            ),
+            None,
+        )
+        if property_id is None:
+            raise SourceArgumentNotFoundWithSuggestions(
+                "street_number",
+                street_number,
+                [
+                    item["name"].split(f" {street_name} {suburb}")[0]
+                    for item in properties
+                    if f" {street_name} {suburb}" in item["name"]
+                ],
+            )
+        return property_id
+
+
+class Source:
+    def __init__(
+        self,
+        service: str,
+        property_id: int | None = None,
+        suburb: str | None = None,
+        street_name: str | None = None,
+        street_number: str | None = None,
+    ):
+        service = LEGACY_SERVICE_NAMES.get(service, service)
+        if service in SERVICE_MAP_LOOKUP:
+            api_url = SERVICE_MAP_LOOKUP[service]["url"]
+        else:
+            if service.startswith("https://"):
+                api_url = service
+            else:
+                # Assume the service is a council name
+                api_url = f"https://{service}.waste-info.com.au"
+
+        self.api_url = api_url
+        self.property_id = property_id
+
+        if not property_id:
+            if not suburb or not street_name or not street_number:
+                errors = []
+                if suburb is None:
+                    errors.append("suburb")
+                if street_name is None:
+                    errors.append("street_name")
+                if street_number is None:
+                    errors.append("street_number")
+                if len(errors) == 3:
+                    errors.append("property_id")
+
+                raise SourceArgumentExceptionMultiple(
+                    errors,
+                    "You must provide a (property ID) or a (suburb, street name and street number)",
+                )
+            self.suburb = suburb
+            self.street_name = street_name
+            self.street_number = street_number
+            self.location_finder = LocationFinder(self.api_url)
+
+    def fetch(self) -> list[Collection]:
+        start_date = date.today()
+        end_date = start_date + timedelta(365)
+
+        session = requests.Session()
+        session.headers.update(HEADERS)
+
+        if not self.property_id:
+            suburb_id = self.location_finder.find_suburb_id(session, self.suburb)
+            street_id = self.location_finder.find_street_id(
+                session, suburb_id, self.street_name
+            )
+            self.property_id = self.location_finder.find_property_id(
+                session, street_id, self.street_number, self.street_name, self.suburb
+            )
+
+        # Retrieve the collection events for the property
+        url = f"{self.api_url}/api/v1/properties/{self.property_id}.json"
+        response = session.get(
+            url, params={"start": start_date.isoformat(), "end": end_date.isoformat()}
+        )
+        events: list[RecurringEventResponse | OneOffEventResponse] = response.json()
+
+        collections: list[Collection] = []
+        for event in events:
+            # determine waste type for icon
+            try:
+                event_type = event["event_type"]
+            except KeyError:  # some entries do not contain a waste collection event, so move to next item in list
+                continue
+            icon = ICON_MAP.get(event_type)
+
+            # determine waste type for title (some entries contain additional info)
+            try:
+                event_type = f"{event['event_type']} ({event['name']})"
+            except KeyError:  # not all service return "name"
+                event_type = event["event_type"]
+
+            # Events with a start key are one off events
+            # Events with a start_date key are recurring events
+            is_recurring = "start_date" in event
+
+            if is_recurring:
+                recurring_event = cast(RecurringEventResponse, event)
+                collection_dates = generate_recurring_dates(
+                    recurring_event, start_date, end_date
+                )
+            else:
+                one_off_event = cast(OneOffEventResponse, event)
+                collection_dates = [date.fromisoformat(one_off_event["start"])]
+
+            for collection_date in collection_dates:
+                collections.append(
+                    Collection(
+                        date=collection_date,
+                        t=event_type,
+                        icon=icon,
+                    )
+                )
+
+        # Order the collections by date
+        collections = sorted(collections, key=lambda x: x.date)
+
+        return collections

package/python/vendor/waste_collection_schedule/source/imst_at.py

@@ -0,0 +1,83 @@
+from typing import ClassVar
+
+from waste_collection_schedule import Icons  # type: ignore[attr-defined]
+from waste_collection_schedule.service.RiSKommunalAT import RiSKommunalSource
+
+TITLE = "Imst"
+DESCRIPTION = "Waste collection schedule for Stadtgemeinde Imst, Austria."
+URL = "https://www.imst.gv.at"
+COUNTRY = "at"
+SOURCE_CODEOWNERS = ["@bbr111"]
+
+TEST_CASES = {
+    "Auf Arzill 154": {
+        "strasse": "Auf Arzill",
+        "hausnummer": "154",
+    },
+    "Adlerweg 2": {
+        "strasse": "Adlerweg",
+        "hausnummer": "2",
+    },
+}
+
+ICON_MAP = {
+    "Restmüll": Icons.GENERAL_WASTE,
+    "Biomüll": Icons.ORGANIC,
+    "Gelbe Säcke": Icons.PLASTIC_PACKAGING,
+    "Altpapier": Icons.PAPER,
+    "Sperrmüll": Icons.BULKY,
+    "Problemstoff": Icons.HAZARDOUS,
+    "Altglas": Icons.GLASS,
+    "Grünschnitt": Icons.GARDEN,
+}
+
+PARAM_TRANSLATIONS = {
+    "en": {
+        "strasse": "Street",
+        "hausnummer": "House number",
+    },
+    "de": {
+        "strasse": "Straße",
+        "hausnummer": "Hausnummer",
+    },
+}
+
+PARAM_DESCRIPTIONS = {
+    "en": {
+        "strasse": "Street name as listed in the Imst waste calendar dropdown.",
+        "hausnummer": "House number as listed in the Imst waste calendar dropdown.",
+    },
+    "de": {
+        "strasse": "Straßenname wie in der Abfallkalender-Auswahl von Imst aufgeführt.",
+        "hausnummer": "Hausnummer wie in der Abfallkalender-Auswahl von Imst aufgeführt.",
+    },
+}
+
+HOW_TO_GET_ARGUMENTS_DESCRIPTION = {
+    "en": (
+        "Open https://www.imst.gv.at/Muellabfuhrplaene_1, pick your street and "
+        "house number from the dropdowns, and use the same values for "
+        "'strasse' and 'hausnummer'."
+    ),
+    "de": (
+        "Öffnen Sie https://www.imst.gv.at/Muellabfuhrplaene_1, wählen Sie Ihre "
+        "Straße und Hausnummer aus den Dropdown-Menüs, und verwenden Sie "
+        "dieselben Werte für 'strasse' und 'hausnummer'."
+    ),
+}
+
+_MENUONR = "222722602"
+
+
+class Source(RiSKommunalSource):
+    BASE_URL = "https://www.imst.gv.at"
+    ICON_MAP = ICON_MAP
+    SELECTION_URL = "https://www.imst.gv.at/Muellabfuhrplaene_1"
+    RAISE_ON_EMPTY = True
+    QUERY_PARAMS: ClassVar = {
+        "sprache": "1",
+        "menuonr": _MENUONR,
+    }
+
+    def __init__(self, strasse: str, hausnummer: str | int):
+        super().__init__(strasse=strasse, hausnummer=hausnummer)