add source for abfallnavi.de

This source replaces the regioit.de source

README.md

@@ -28,13 +28,14 @@ Currently the following service providers are supported:
 
 - [Abfall.IO / AbfallPlus.de](./doc/source/abfall_io.md)
 - [Abfall_Kreis_Tuebingen.de](./doc/source/abfall_kreis_tuebingen_de.md)
+- [AbfallNavi.de (RegioIT.de)](./doc/source/abfallnavi_de.md)
 - [Abfallwirtschaft Stuttgart](./doc/source/stuttgard_de.md)
 - [AWBKoeln.de](./doc/source/awbkoeln_de.md)
 - [BSR.de / Berliner Stadtreinigungsbetriebe](./doc/source/bsr_de.md)
 - [Generic ICS File](./doc/source/ics.md)
 - [Jumomind.de](./doc/source/jumomind_de.md)
 - [Muellmax.de](./doc/source/muellmax_de.md)
-- [RegioIT.de / AbfallNavi](./doc/source/regioit_de.md)
+- [RegioIT.de / AbfallNavi [deprecated]](./doc/source/regioit_de.md)
 - [Stadtreinigung.Hamburg](./doc/source/stadtreinigung_hamburg.md)
 
 ## Configuration via configuration.yaml

custom_components/waste_collection_schedule/package/source/abfallnavi_de.py

@@ -0,0 +1,55 @@
+import requests
+import datetime
+import icalendar
+import json
+from collections import OrderedDict
+
+from ..helpers import CollectionAppointment
+
+
+DESCRIPTION = "Source for AbfallNavi (= regioit.de) based services"
+URL = "https://www.regioit.de"
+TEST_CASES = OrderedDict(
+    [
+        (
+            "Aachen, Abteiplatz 7",
+            {"service": "aachen", "strasse": 5985352, "hausnummer": 5985357},
+        ),
+        ("Lindlar, Aggerweg", {"service": "lindlar", "strasse": 56076}),
+        ("Roetgen, Am Sportplatz 2", {"service": "roe", "strasse": 52073}),
+    ]
+)
+
+
+class Source:
+    def __init__(self, service, strasse, hausnummer=None):
+        self._url = f"https://{service}-abfallapp.regioit.de/abfall-app-{service}/rest"
+        if hausnummer is not None:
+            self._url += f"/hausnummern/{hausnummer}"
+        else:
+            self._url += f"/strassen/{strasse}"
+
+    def fetch(self):
+        # get fraktionen
+        r = requests.get(f"{self._url}/fraktionen")
+        r.encoding = "utf-8"  # requests doesn't guess the encoding correctly
+        fraktionen_list = json.loads(r.text)
+        fraktionen = {}
+        for fraktion in fraktionen_list:
+            fraktionen[fraktion["id"]] = fraktion["name"]
+
+        # retrieve appointments
+        args = []
+        for f in fraktionen.keys():
+            args.append(("fraktion", f))
+
+        r = requests.get(f"{self._url}/termine", params=args)
+        results = json.loads(r.text)
+
+        entries = []
+        for r in results:
+            date = datetime.datetime.strptime(r["datum"], "%Y-%m-%d").date()
+            fraktion = fraktionen[r["bezirk"]["fraktionId"]]
+            entries.append(CollectionAppointment(date, fraktion))
+
+        return entries

custom_components/waste_collection_schedule/package/wizard/abfallnavi_de.py

@@ -0,0 +1,99 @@
+#!/usr/bin/python3
+
+import inquirer
+import requests
+import json
+
+
+def main():
+    # select service
+    service_choices = [
+        ("Aachen", "aachen"),
+        ("AWA Entsorgungs GmbH", "zew2"),
+        ("Bergisch Gladbach", "aw-bgl2"),
+        ("Bergischer Abfallwirtschaftverbund", "bav"),
+        ("Dinslaken", "din"),
+        ("Dorsten", "dorsten"),
+        ("Gütersloh", "gt2"),
+        ("Halver", "hlv"),
+        ("Kreis Coesfeld", "coe"),
+        ("Kreis Heinsberg", "krhs"),
+        ("Kreis Pinneberg", "pi"),
+        ("Kreis Warendorf", "krwaf"),
+        ("Lindlar", "lindlar"),
+        ("Lüdenscheid", "stl"),
+        ("Norderstedt", "nds"),
+        ("Nürnberg", "nuernberg"),
+        ("Roetgen", "roe"),
+        ("EGW Westmünsterland", "wml2"),
+    ]
+    questions = [
+        inquirer.List(
+            "service",
+            choices=service_choices,
+            message="Select service provider for district [Landkreis]",
+        )
+    ]
+    answers = inquirer.prompt(questions)
+
+    SERVICE_URL = f"https://{answers['service']}-abfallapp.regioit.de/abfall-app-{answers['service']}"
+
+    # get cities
+    r = requests.get(f"{SERVICE_URL}/rest/orte")
+    r.encoding = "utf-8"  # requests doesn't guess the encoding correctly
+    cities = json.loads(r.text)
+    city_choices = []
+    for city in cities:
+        city_choices.append((city["name"], city["id"]))
+
+    questions = [
+        inquirer.List(
+            "city_id", choices=city_choices, message="Select municipality [Kommune/Ort]"
+        )
+    ]
+    ort = inquirer.prompt(questions)["city_id"]
+
+    # get streets
+    r = requests.get(f"{SERVICE_URL}/rest/orte/{ort}/strassen")
+    r.encoding = "utf-8"  # requests doesn't guess the encoding correctly
+    streets = json.loads(r.text)
+    street_choices = []
+    for street in streets:
+        street_choices.append((street["name"], street["id"]))
+
+    questions = [
+        inquirer.List("strasse", choices=street_choices, message="Select street")
+    ]
+    answers.update(inquirer.prompt(questions))
+
+    # get list of house numbers
+    r = requests.get(f"{SERVICE_URL}/rest/strassen/{answers['strasse']}")
+    r.encoding = "utf-8"  # requests doesn't guess the encoding correctly
+    house_numbers = json.loads(r.text)
+    house_number_choices = []
+    for hausNr in house_numbers.get("hausNrList", {}):
+        # {"id":5985445,"name":"Adalbert-Stifter-Straße","hausNrList":[{"id":5985446,"nr":"1"},
+        house_number_choices.append((hausNr["nr"], hausNr["id"]))
+
+    if len(house_number_choices) > 0:
+        questions = [
+            inquirer.List(
+                "hausnummer",
+                choices=house_number_choices,
+                message="Select house number",
+            )
+        ]
+        answers.update(inquirer.prompt(questions))
+
+    print("Copy the following statements into your configuration.yaml:\n")
+    print("# waste_collection_schedule source configuration")
+    print("waste_collection_schedule:")
+    print("  sources:")
+    print("    - name: abfallnavi_de")
+    print("      args:")
+    for key, value in answers.items():
+        print(f"        {key}: {value}")
+
+
+if __name__ == "__main__":
+    main()

doc/source/abfallnavi_de.md

@@ -0,0 +1,45 @@
+# AbfallNavi.de
+
+Support for schedules provided by [Abfallnavi.de](https://www.abfallnavi.de). The service is hosted under [regioit.de](https://regioit.de).
+
+## Configuration via configuration.yaml
+
+```yaml
+waste_collection_schedule:
+  sources:
+    - name: abfallnavi_de
+      args:
+        service: SERVICE
+        strasse: STRASSE
+        hausnummer: hausnummer
+```
+
+### Configuration Variables
+
+**service**<br>
+*(string) (required)*
+
+**strasse**<br>
+*(integer) (required)*
+
+**hausnummer**<br>
+*(integer) (optional)*
+
+## Example
+
+```yaml
+waste_collection_schedule:
+  sources:
+    - name: abfallnavi_de
+      args:
+        service: lindlar
+        strasse: 53585
+```
+
+## How to get the source arguments
+
+There is a script with an interactive command line interface which generates the required source configuration:
+
+[https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/custom_components/waste_collection_schedule/package/wizard/abfallnavi_de.py](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/custom_components/waste_collection_schedule/package/wizard/abfallnavi_de.py).
+
+Just run this script from a shell and answer the questions.

doc/source/regioit_de.md

@@ -1,5 +1,7 @@
 # RegioIT.de / AbfallNavi
 
+NOTE: THIS SOURCE IS DEPRECATED! Use [Abfallnavi.de](./abfallnavi_de.md) instead!
+
 Support for schedules provided by [RegioIT.de](https://www.regioit.de). The official service uses the name **AbfallNavi** instead.
 
 ## Configuration via configuration.yaml

info.md

@@ -30,11 +30,12 @@ Currently the following service providers are supported:
 
 - [Abfall.IO / AbfallPlus.de](./doc/source/abfall_io.md)
 - [Abfall_Kreis_Tuebingen.de](./doc/source/abfall_kreis_tuebingen_de.md)
+- [AbfallNavi (RegioIT.de)](./doc/source/abfallnavi_de.md)
 - [Abfallwirtschaft Stuttgart](./doc/source/stuttgard_de.md)
 - [AWBKoeln.de](./doc/source/awbkoeln_de.md)
 - [BSR.de / Berliner Stadtreinigungsbetriebe](./doc/source/bsr_de.md)
 - [Generic ICS File](./doc/source/ics.md)
 - [Jumomind.de](./doc/source/jumomind_de.md)
 - [Muellmax.de](./doc/source/muellmax_de.md)
-- [RegioIT.de / AbfallNavi](./doc/source/regioit_de.md)
+- [RegioIT.de / AbfallNavi [deprecated]](./doc/source/regioit_de.md)
 - [Stadtreinigung.Hamburg](./doc/source/stadtreinigung_hamburg.md)