Feat/adding vicpark wa gov au (#2130)

* feat: added town of vic park council

* docs: added exported vars to docs

* fix: updated icons

* fix: switched to raw string for regex

* reformatting

---------

Co-authored-by: 5ila5 <5ila5@users.noreply.github.com>

README.md

@@ -69,6 +69,7 @@ Waste collection schedules in the following formats and countries are supported.
 - [Stonnington City Council](/doc/source/stonnington_vic_gov_au.md) / stonnington.vic.gov.au
 - [The Hawkesbury City Council, Sydney](/doc/source/hawkesbury_nsw_gov_au.md) / hawkesbury.nsw.gov.au
 - [The Hills Shire Council, Sydney](/doc/source/thehills_nsw_gov_au.md) / thehills.nsw.gov.au
+- [Town of Victoria Park](/doc/source/victoriapark_wa_gov_au.md) / victoriapark.wa.gov.au
 - [Unley City Council (SA)](/doc/source/unley_sa_gov_au.md) / unley.sa.gov.au
 - [Whittlesea City Council](/doc/source/whittlesea_vic_gov_au.md) / whittlesea.vic.gov.au/community-support/my-neighbourhood
 - [Wollondilly Shire Council](/doc/source/wollondilly_nsw_gov_au.md) / wollondilly.nsw.gov.au

custom_components/waste_collection_schedule/waste_collection_schedule/source/victoriapark_wa_gov_au.py

@@ -0,0 +1,175 @@
+import re
+from datetime import datetime, timedelta
+
+import requests
+from waste_collection_schedule import Collection  # type: ignore[attr-defined]
+
+TITLE = "Town of Victoria Park"
+DESCRIPTION = "Source for www.victoriapark.wa.gov.au Waste Collection Services"
+URL = "https://www.victoriapark.wa.gov.au"
+TEST_CASES = {
+    "Monday": {"address": "51 Cookham Road, Lathlain"},  # Monday
+    "Town of Vic Park (Tues)": {
+        "address": "99 Shepperton Road, VICTORIA PARK",
+        "predict": True,
+    },  # Tuesday
+    "Wednesday": {"address": "156 Oats St, Carlisle"},  # Wednesday
+    "Park Centre (Thurs)": {
+        "address": "789 Albany hwy, EAST VICTORIA PARK"
+    },  # Thursday
+    "Aqualife (Thurs)": {"address": "42 Somerset St, East Victoria Park"},  # Thursday
+    "Friday": {
+        "address": "90 Canterbury Terrace, East Victoria Park",
+        "predict": True,
+    },  # Friday
+}
+
+ICON_MAP = {
+    "Rubbish": "mdi:trash-can",
+    "Recycling": "mdi:recycle",
+    "Bulk Waste": "mdi:microwave",
+    "Green Waste": "mdi:tree",
+    "Go Bin": "mdi:leaf",
+}
+
+
+def clean_months(start_date, date_str):
+    date_cleaned = start_date + re.sub(r"^\d+", "", date_str)
+    date_cleaned = re.sub(r"Janu?a?r?y?", "Jan", date_cleaned, flags=re.IGNORECASE)
+    date_cleaned = re.sub(r"Febr?u?a?r?y?", "Feb", date_cleaned, flags=re.IGNORECASE)
+    date_cleaned = re.sub(r"Marc?h?", "Mar", date_cleaned, flags=re.IGNORECASE)
+    date_cleaned = re.sub(r"Apri?l?", "Apr", date_cleaned, flags=re.IGNORECASE)
+    date_cleaned = re.sub(r"June?", "Jun", date_cleaned, flags=re.IGNORECASE)
+    date_cleaned = re.sub(r"July?", "Jul", date_cleaned, flags=re.IGNORECASE)
+    date_cleaned = re.sub(r"Augu?s?t?", "Aug", date_cleaned, flags=re.IGNORECASE)
+    date_cleaned = re.sub(r"Sept?e?m?b?e?r?", "Sep", date_cleaned, flags=re.IGNORECASE)
+    date_cleaned = re.sub(r"Octo?b?e?r?", "Oct", date_cleaned, flags=re.IGNORECASE)
+    date_cleaned = re.sub(r"Nov?e?m?b?e?r?", "Nov", date_cleaned, flags=re.IGNORECASE)
+    date_cleaned = re.sub(r"Dec?e?m?b?e?r?", "Dec", date_cleaned, flags=re.IGNORECASE)
+    return date_cleaned
+
+
+class Source:
+    def __init__(self, address, predict=False):
+        address = address.strip()
+        address = re.sub(" +", " ", address)
+        address = re.sub("hwy", "highway", address, flags=re.IGNORECASE)
+        address = re.sub(
+            r"western australia (\d{4})", "WA \\1", address, flags=re.IGNORECASE
+        )
+        address = re.sub(r" wa (\d{4})", "  WA  \\1", address, flags=re.IGNORECASE)
+        self._address = address
+        if not isinstance(predict, bool):
+            raise Exception("'predict' must be a boolean value")
+        self._predict = predict
+
+    def collect_dates(self, start_date, weeks):
+        dates = []
+        dates.append(start_date)
+        for _ in range(1, 4 // weeks):
+            start_date = start_date + timedelta(days=(weeks * 7))
+            dates.append(start_date)
+        return dates
+
+    def fetch(self):
+        entries = []
+        # initiate a session
+        url = "https://maps.vicpark.wa.gov.au/IntraMaps22B/ApplicationEngine/Integration/api/search"
+
+        payload = {}
+        params = {
+            "configId": "00000000-0000-0000-0000-000000000000",
+            "form": "4a7d4da6-26b5-40ce-a0b3-814f5e82c0f3",
+            "fields": self._address,
+        }
+        headers = {"Authorization": "apikey 8b1fdca5-5d16-4724-99cd-df3a32c650a0"}
+
+        r = requests.get(url, headers=headers, data=payload, params=params)
+        r.raise_for_status()
+
+        j = r.json()
+
+        if len(j) == 0:
+            raise Exception("address not found")
+
+        # Just picking first date
+        j = j[0]
+
+        # search for the address
+        url = "https://maps.vicpark.wa.gov.au/IntraMaps22B/ApplicationEngine/Integration/api/search"
+
+        fields_dict = {item["name"]: item["value"] for item in j}
+
+        params = {
+            "configId": "00000000-0000-0000-0000-000000000000",
+            "form": "f3f264a3-94f5-499a-a697-0fac668cd027",
+            "fields": fields_dict.get("mapkey") + "," + fields_dict.get("dbkey"),
+        }
+
+        r = requests.get(url, headers=headers, data=payload, params=params)
+        r.raise_for_status()
+
+        fields_json = r.json()[0]
+
+        data_dict = {item["name"]: item for item in fields_json}
+
+        day_rubbish = data_dict.get("General_Bin")["value"].split(" - ")[0]
+        date_recycling = data_dict.get("Recycling_Bin")["value"][:11]
+        date_go = data_dict.get("GO_Bin")["value"][:11]
+        raw_green_waste = data_dict.get("Green_Waste")["value"]
+        raw_bulk_waste = data_dict.get("Bulk_Waste")["value"]
+        # 15-16 Jul 2023, 9-10 Dec 2023
+        # Months are inconsistent and a range
+        green_waste_bits = re.split(r"\s*[\-,()]\s*", raw_green_waste)
+        date_green_waste = clean_months(green_waste_bits[0], green_waste_bits[1])
+        date_green_waste2 = clean_months(green_waste_bits[2], green_waste_bits[3])
+
+        bulk_waste_bits = re.split(r"\s*[\-,()]\s*", raw_bulk_waste)
+        date_bulk_waste = clean_months(bulk_waste_bits[0], bulk_waste_bits[1])
+        date_bulk_waste2 = clean_months(bulk_waste_bits[2], bulk_waste_bits[3])
+
+        date_rubbish = datetime.today() + timedelta(days=-1)
+        while date_rubbish.strftime("%A").lower() != day_rubbish.lower():
+            date_rubbish = date_rubbish + timedelta(days=1)
+
+        if self._predict:
+            rub_dates = self.collect_dates(date_rubbish.date(), 1)
+            rec_dates = self.collect_dates(
+                datetime.strptime(date_recycling, "%d %b %Y").date(), 2
+            )
+            go_dates = self.collect_dates(
+                datetime.strptime(date_go, "%d %b %Y").date(), 2
+            )
+            grn_dates = [
+                datetime.strptime(date_green_waste, "%d %b %Y").date(),
+                datetime.strptime(date_green_waste2, "%d %b %Y").date(),
+            ]
+            blk_dates = [
+                datetime.strptime(date_bulk_waste, "%d %b %Y").date(),
+                datetime.strptime(date_bulk_waste2, "%d %b %Y").date(),
+            ]
+        else:
+            rub_dates = [date_rubbish.date()]
+            rec_dates = [datetime.strptime(date_recycling, "%d %b %Y").date()]
+            go_dates = [datetime.strptime(date_go, "%d %b %Y").date()]
+            grn_dates = [datetime.strptime(date_green_waste, "%d %b %Y").date()]
+            blk_dates = [datetime.strptime(date_bulk_waste, "%d %b %Y").date()]
+
+        collections = []
+        collections.append({"type": "Rubbish", "dates": rub_dates})
+        collections.append({"type": "Recycling", "dates": rec_dates})
+        collections.append({"type": "Go Bin", "dates": go_dates})
+        collections.append({"type": "Green Waste", "dates": grn_dates})
+        collections.append({"type": "Bulk Waste", "dates": blk_dates})
+
+        for collection in collections:
+            for date in collection["dates"]:
+                entries.append(
+                    Collection(
+                        date=date,
+                        t=collection["type"],
+                        icon=ICON_MAP.get(collection["type"]),
+                    )
+                )
+
+        return entries

doc/source/victoriapark_wa_gov_au.md

@@ -0,0 +1,40 @@
+# Town of Victoria Park Council
+
+Support for schedules provided by [Town of Victoria Park Bins and collections](https://www.victoriapark.wa.gov.au/residents/waste-and-recycling/bins-and-collections.aspx).
+
+## Configuration via configuration.yaml
+
+```yaml
+waste_collection_schedule:
+  sources:
+    - name: victoriapark_wa_gov_au
+      args:
+        address: ADDRESS
+```
+
+### Configuration Variables
+
+**address**  
+*(string) (required)*
+
+## Example
+
+```yaml
+waste_collection_schedule:
+  sources:
+    - name: victoriapark_wa_gov_au
+      args:
+        address: 99 Shepperton Road East Victoria Park 6101
+```
+
+## How to get the source arguments
+
+Visit the [Town of Victoria Park Bins and collections](https://www.victoriapark.wa.gov.au/residents/waste-and-recycling/bins-and-collections.aspx) page and search for your address. The arguments should exactly match the results of the property.
+
+Currently exporting out:
+
+- Rubbish
+- Recycling
+- Go Bin
+- Green Waste
+- Bulk Waste