add West Oxfordshire, UK

README.md

@@ -1573,6 +1573,7 @@ If your service provider is not listed, feel free to open a [source request issu
 - [West Devon Borough Council](/doc/source/fccenvironment_co_uk.md) / westdevon.gov.uk
 - [West Dunbartonshire Council](/doc/source/west_dunbartonshire_gov_uk.md) / west-dunbarton.gov.uk
 - [West Northamptonshire council](/doc/source/westnorthants_gov_uk.md) / westnorthants.gov.uk
+- [West Oxfordshire District Council](/doc/source/westoxon_gov_uk.md) / westoxon.gov.uk
 - [West Suffolk Council](/doc/source/westsuffolk_gov_uk.md) / westsuffolk.gov.uk
 - [Westmorland & Furness Council, Barrow area](/doc/ics/barrowbc_gov_uk.md) / barrowbc.gov.uk
 - [Westmorland & Furness Council, South Lakeland area](/doc/ics/southlakeland_gov_uk.md) / southlakeland.gov.uk

custom_components/waste_collection_schedule/sources.json

@@ -8466,6 +8466,11 @@
       "module": "westnorthants_gov_uk",
       "default_params": {}
     },
+    {
+      "title": "West Oxfordshire District Council",
+      "module": "westoxon_gov_uk",
+      "default_params": {}
+    },
     {
       "title": "West Suffolk Council",
       "module": "westsuffolk_gov_uk",

custom_components/waste_collection_schedule/waste_collection_schedule/source/westoxon_gov_uk.py

@@ -0,0 +1,299 @@
+import json
+import logging
+import re
+from datetime import date, datetime
+
+import requests
+import urllib3
+from dateutil.parser import parse
+from waste_collection_schedule import Collection  # type: ignore[attr-defined]
+
+# With verify=True the POST fails due to a SSLCertVerificationError.
+# Using verify=False works, but is not ideal. The following links may provide a better way of dealing with this:
+# https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
+# https://urllib3.readthedocs.io/en/1.26.x/user-guide.html#ssl
+# This line suppresses the InsecureRequestWarning when using verify=False
+urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+
+_LOGGER = logging.getLogger(__name__)
+
+TITLE = "West Oxfordshire District Council"
+DESCRIPTION = "Source for West Oxfordshire District Council."
+URL = "https://westoxon.gov.uk/"
+TEST_CASES = {
+    "75 manor road woodstock, ox20 1xr": {
+        "address": "75 manor road woodstock, ox20 1xr"
+    },
+    "test": {"address": "65 MAIN ROAD, LONG HANBOROUGH, WITNEY, OX29 8JX"},
+}
+
+
+ICON_MAP = {
+    "refuse": "mdi:trash-can",
+    "recycling": "mdi:recycle",
+    "food": "mdi:food",
+    "box": "mdi:recycle",
+}
+
+REGEX_AURA_CONFIG = re.compile(r"var\s+auraConfig\s*=\s*(.*?),\n")
+
+API_URL = "https://community.westoxon.gov.uk/s/sfsites/aura"
+SEARCH_PAGE = "https://community.westoxon.gov.uk/s/waste-collection-enquiry"
+HEADERS = {
+    "User-Agent": "Mozilla/5.0 (X11; Linux x86_64; rv:115.0) Gecko/20100101 Firefox/115.0",
+    "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
+}
+
+
+class Source:
+    def __init__(self, address: str):
+        self._address: str = address
+        self._session = requests.Session()
+
+    @staticmethod
+    def _parse_date(date_str: str) -> date:
+        if date_str.lower() == "today":
+            return date.today()
+        if date_str.lower() == "tomorrow":
+            return date.today().replace(day=date.today().day + 1)
+
+        # Tue, 20 August
+        return parse(date_str, default=datetime.now()).date()
+
+    def _init_connection(self):
+        self._session = requests.Session()
+        r = self._session.get(SEARCH_PAGE, verify=False, headers=HEADERS)
+        r.raise_for_status()
+        aura_regex = REGEX_AURA_CONFIG.search(r.text, re.MULTILINE)
+
+        if not aura_regex:
+            raise Exception("Could not find aura config")
+        json_data = json.loads(aura_regex.group(1))
+        fwuid = json_data["context"]["fwuid"]
+        self._aura_context = json.dumps(
+            {
+                "mode": "PROD",
+                "fwuid": fwuid,
+                "app": "siteforce:communityApp",
+                "loaded": {
+                    "APPLICATION@markup://siteforce:communityApp": "vgD8vvaBHzgKYqb_JQjQdw",
+                    "COMPONENT@markup://flowruntime:flowRuntimeForFlexiPage": "6vLCX6RcjM4U8N2_kygrQw",
+                    "COMPONENT@markup://instrumentation:o11ySecondaryLoader": "1JitVv-ZC5qlK6HkuofJqQ",
+                },
+                "dn": [],
+                "globals": {},
+                "uad": False,
+            }
+        )
+
+    def _request(
+        self, r: int, aura_method: str, message: str | dict
+    ) -> requests.Response:
+        if isinstance(message, dict):
+            message = json.dumps(message)
+        response = self._session.post(
+            API_URL,
+            params={
+                "r": r,
+                aura_method: 1,
+            },
+            data={
+                "message": message,
+                "aura.context": self._aura_context,
+                "aura.pageURI": "/s/waste-collection-enquiry",
+                "aura.token": "null",
+            },
+            verify=False,
+            headers=HEADERS,
+        )
+        response.raise_for_status()
+        return response
+
+    def _match_address(self, address: str | None) -> bool:
+        if address is None:
+            return False
+        return self._address.lower().replace(" ", "").replace(".", "").replace(
+            ",", ""
+        ) == address.lower().replace(" ", "").replace(".", "").replace(",", "")
+
+    def fetch(self) -> list[Collection]:
+        self._init_connection()
+        entries = []
+        message1 = {
+            "actions": [
+                {
+                    "id": "85;a",
+                    "descriptor": "aura://FlowRuntimeConnectController/ACTION$startFlow",
+                    "callingDescriptor": "UNKNOWN",
+                    "params": {
+                        "flowDevName": "WebFormWasteCollectionEnquiry",
+                        "arguments": '[{"name":"vClientCode","type":"String","supportsRecordId":false,"value":"WOD"}]',
+                        "enableTrace": False,
+                        "enableRollbackMode": False,
+                        "debugAsUserId": "",
+                        "useLatestSubflow": False,
+                    },
+                }
+            ]
+        }
+        r = self._request(5, "aura.FlowRuntimeConnect.startFlow", message1)
+        serialized_state = r.json()["actions"][0]["returnValue"]["response"][
+            "serializedEncodedState"
+        ]
+
+        message2 = {
+            "actions": [
+                {
+                    "id": "89;a",
+                    "descriptor": "aura://LookupController/ACTION$lookup",
+                    "callingDescriptor": "UNKNOWN",
+                    "params": {
+                        "objectApiName": "Case",
+                        "fieldApiName": "Property__c",
+                        "pageParam": 1,
+                        "pageSize": 25,
+                        "q": self._address,
+                        "searchType": "TypeAhead",
+                        "targetApiName": "Property__c",
+                        "body": {
+                            "sourceRecord": {"apiName": "Case", "fields": {"Id": None}}
+                        },
+                    },
+                }
+            ]
+        }
+        r = self._request(1, "aura.LookupController.lookupaura.Lookup.lookup", message2)
+
+        addresses = r.json()["actions"][0]["returnValue"]["lookupResults"][
+            "Property__c"
+        ]["records"]
+        address_id = None
+        address_name = None
+        address_set = set()
+        for address in addresses:
+            potential_address = address["fields"]["Name"]["value"]
+            address_set.add(potential_address)
+            if self._match_address(potential_address):
+                address_id = address["id"]
+                address_name = potential_address
+                break
+        address_set -= {None, ""}
+        if not address_id:
+            raise Exception(
+                f"Address not found, use one of the following: {list(address_set)}"
+            )
+
+        message3 = {
+            "actions": [
+                {
+                    "id": "114;a",
+                    "descriptor": "aura://RecordUiController/ACTION$getRecordWithFields",
+                    "callingDescriptor": "UNKNOWN",
+                    "params": {"recordId": address_id, "fields": ["Property__c.Name"]},
+                }
+            ]
+        }
+        r = self._request(25, "aura.RecordUi.getRecordWithFields", message3)
+
+        message4 = {
+            "actions": [
+                {
+                    "id": "123;a",
+                    "descriptor": "aura://FlowRuntimeConnectController/ACTION$navigateFlow",
+                    "callingDescriptor": "UNKNOWN",
+                    "params": {
+                        "request": {
+                            "action": "NEXT",
+                            "serializedState": serialized_state,
+                            "fields": [
+                                {
+                                    "field": "Property.recordId",
+                                    "value": address_id,
+                                    "isVisible": True,
+                                },
+                                {
+                                    "field": "Property.recordIds",
+                                    "value": [address_id],
+                                    "isVisible": True,
+                                },
+                                {
+                                    "field": "Property.recordName",
+                                    "value": address_name,
+                                    "isVisible": True,
+                                },
+                            ],
+                            "uiElementVisited": True,
+                            "enableTrace": False,
+                            "lcErrors": {},
+                        }
+                    },
+                }
+            ]
+        }
+
+        r = self._request(26, "aura.FlowRuntimeConnect.navigateFlow", message4)
+        serialized_state = r.json()["actions"][0]["returnValue"]["response"][
+            "serializedEncodedState"
+        ]
+
+        message5 = {
+            "actions": [
+                {
+                    "id": "125;a",
+                    "descriptor": "aura://FlowRuntimeConnectController/ACTION$navigateFlow",
+                    "callingDescriptor": "UNKNOWN",
+                    "params": {
+                        "request": {
+                            "action": "CONTINUE_AFTER_COMMIT",
+                            "serializedState": serialized_state,
+                            "fields": [],
+                            "uiElementVisited": True,
+                            "enableTrace": False,
+                        }
+                    },
+                }
+            ]
+        }
+
+        r = self._request(27, "aura.FlowRuntimeConnect.navigateFlow", message5)
+        serialized_state = r.json()["actions"][0]["returnValue"]["response"][
+            "serializedEncodedState"
+        ]
+
+        message6 = {
+            "actions": [
+                {
+                    "id": "127;a",
+                    "descriptor": "aura://FlowRuntimeConnectController/ACTION$navigateFlow",
+                    "callingDescriptor": "UNKNOWN",
+                    "params": {
+                        "request": {
+                            "action": "CONTINUE_AFTER_COMMIT",
+                            "serializedState": serialized_state,
+                            "fields": [],
+                            "uiElementVisited": True,
+                            "enableTrace": False,
+                        }
+                    },
+                }
+            ]
+        }
+        r = self._request(28, "aura.FlowRuntimeConnect.navigateFlow", message6)
+
+        table_value = r.json()["actions"][0]["returnValue"]["response"]["fields"][1][
+            "inputs"
+        ][3]["value"]
+
+        table = json.loads(table_value)
+
+        for row in table:
+            date_str = row["col2"]
+            bin_type = row["col1"]
+            try:
+                date_ = self._parse_date(date_str)
+            except ValueError:
+                _LOGGER.warning(f"date in unknown format: {date_str}")
+            icon = ICON_MAP.get(bin_type.split()[-1].lower())  # Collection icon
+            entries.append(Collection(date=date_, t=bin_type, icon=icon))
+
+        return entries

doc/source/westoxon_gov_uk.md

@@ -0,0 +1,34 @@
+# West Oxfordshire District Council
+
+Support for schedules provided by [West Oxfordshire District Council](https://westoxon.gov.uk/), serving West Oxfordshire, UK.
+
+## Configuration via configuration.yaml
+
+```yaml
+waste_collection_schedule:
+    sources:
+    - name: westoxon_gov_uk
+      args:
+        address: ADDRESS
+        
+```
+
+### Configuration Variables
+
+**address**  
+*(String) (required)*
+
+## Example
+
+```yaml
+waste_collection_schedule:
+    sources:
+    - name: westoxon_gov_uk
+      args:
+        address: 75 manor road woodstock, ox20 1xr
+        
+```
+
+## How to get the source argument
+
+Visit <https://www.westoxon.gov.uk/bins-and-recycling/check-your-collection-day/> and search for your address, write it exactly as autocompleted by the input form.