Merge pull request #5 from RutgerRauws/feature/get-assembly

Add Assembly support and big refactoring using hooks instead of from_json functions

Author: RutgerRauws

examples/get_assembly.py

@@ -0,0 +1,20 @@
+# Add the notubiz folder to the path
+import sys, os
+sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
+
+from notubiz import ApiClient, Configuration
+from notubiz.api.clients import AssemblyClient, MeetingClient
+
+configuration = Configuration(organisation_id = 686) # Gemeente Eindhoven
+
+api_client = ApiClient(configuration)
+
+assembly_client = AssemblyClient(api_client)
+meeting_client = MeetingClient(api_client)
+
+assembly = assembly_client.get(1253866)
+
+for assembly_meeting in assembly.meetings:
+    meeting = meeting_client.get(assembly_meeting.id)
+
+    print("{} - {} ({})".format(assembly_meeting.plannings[0].start_date, meeting.title, meeting.location))

examples/get_events.py

@@ -13,8 +13,8 @@
 
 event_client = EventsClient(api_client)
 
-start_date = datetime(2019, 1, 1)
-end_date = datetime(2020, 3, 31, 23, 59, 59)
+start_date = datetime(2025, 1, 5)
+end_date = datetime(2025, 1, 7, 23, 59, 59)
 
 events = event_client.get(start_date, end_date)
 

notubiz/api/_converter.py

@@ -0,0 +1,15 @@
+from cattr import Converter
+from datetime import datetime
+
+from notubiz.api._helpers import parse_date
+from notubiz.api._hooks_registry import Hooks
+
+def get_converter() -> Converter:
+    converter = Converter()
+    converter.register_structure_hook(datetime, lambda date_string, _: parse_date(date_string))
+    
+    # Custom hooks
+    for cls, hook in Hooks.items():
+        converter.register_structure_hook(cls, hook)
+
+    return converter

notubiz/api/_hooks_registry.py

@@ -0,0 +1,12 @@
+from notubiz.api.dataclasses import Event, event_hook
+from notubiz.api.dataclasses import Meeting, meeting_hook
+from notubiz.api.dataclasses import AgendaItem, agenda_item_hook
+from notubiz.api.dataclasses import Speakers, Speaker, speakers_hook, speaker_hook
+
+Hooks = {
+    Event: event_hook,
+    Meeting: meeting_hook,
+    AgendaItem: agenda_item_hook,
+    Speakers: speakers_hook,
+    Speaker: speaker_hook
+}

notubiz/api/clients/__init__.py

@@ -1,3 +1,4 @@
 from notubiz.api.clients.events_client import EventsClient
 from notubiz.api.clients.meeting_client import MeetingClient
-from notubiz.api.clients.speakers_client import SpeakersClient
+from notubiz.api.clients.speakers_client import SpeakersClient
+from notubiz.api.clients.assembly_client import AssemblyClient

notubiz/api/clients/assembly_client.py

@@ -0,0 +1,17 @@
+from notubiz import ApiClient
+from notubiz.api.dataclasses.assembly import Assembly
+
+from notubiz.api._converter import get_converter
+
+class AssemblyClient:
+    api_client : ApiClient
+    
+    def __init__(self, api_client : ApiClient):
+        self.api_client = api_client
+
+    def get(self, assembly_event_id : int) -> Assembly:
+        json_object = self.api_client.get("events/assemblies/{}".format(assembly_event_id))
+        
+        json_assembly = json_object["assembly"]
+
+        return get_converter().structure(json_assembly, Assembly)

notubiz/api/clients/events_client.py

@@ -2,6 +2,8 @@
 from notubiz.api.dataclasses import Event
 from datetime import datetime
 
+from notubiz.api._converter import get_converter
+
 class EventsClient:
     api_client : ApiClient
 
@@ -10,6 +12,7 @@ def __init__(self, api_client : ApiClient):
 
 
     def get(self, date_from: datetime, date_to: datetime, gremia: list[int] = None) -> list[Event]:
+        converter = get_converter()
 
         json_events : list[dict] = []
         has_more_pages = True
@@ -34,4 +37,4 @@ def get(self, date_from: datetime, date_to: datetime, gremia: list[int] = None)
             page += 1
 
         # Now run the deserialization based on the merged events
-        return [Event.from_json(json_event) for json_event in json_events]
+        return [converter.structure(json_event, Event) for json_event in json_events]

notubiz/api/clients/meeting_client.py

@@ -1,5 +1,6 @@
 from notubiz import ApiClient
 from notubiz.api.dataclasses import Meeting
+from notubiz.api._converter import get_converter
 
 class MeetingClient:
     api_client : ApiClient
@@ -9,4 +10,5 @@ def __init__(self, api_client : ApiClient):
 
     def get(self, meeting_id : int) -> Meeting:
         json_object = self.api_client.get("events/meetings/{}".format(meeting_id))
-        return Meeting.from_json(json_object)
+
+        return get_converter().structure(json_object, Meeting)

notubiz/api/clients/speakers_client.py

@@ -1,5 +1,6 @@
 from notubiz.api_client import ApiClient
 from notubiz.api.dataclasses import Speakers
+from notubiz.api._converter import get_converter
 
 class SpeakersClient:
     api_client : ApiClient
@@ -9,4 +10,4 @@ def __init__(self, api_client : ApiClient):
 
     def get(self) -> Speakers:
         json_object = self.api_client.get("speakers")
-        return Speakers.from_json(json_object)
+        return get_converter().structure(json_object, Speakers)

notubiz/api/dataclasses/__init__.py

@@ -1,5 +1,6 @@
-from notubiz.api.dataclasses.event import Event
-from notubiz.api.dataclasses.meeting import Meeting
+from notubiz.api.dataclasses.event import Event, event_hook
+from notubiz.api.dataclasses.meeting import Meeting, meeting_hook
+from notubiz.api.dataclasses.assembly import Assembly
 from notubiz.api.dataclasses.document import Document
-from notubiz.api.dataclasses.agenda_item import AgendaItem
-from notubiz.api.dataclasses.speakers import Speaker, Speakers
+from notubiz.api.dataclasses.agenda_item import AgendaItem, agenda_item_hook
+from notubiz.api.dataclasses.speakers import Speakers, Speaker, speakers_hook, speaker_hook