Changed EventApi to get list of events instead of single event

Author: RutgerRauws

examples/get_event.py renamed to examples/get_events.py

@@ -2,6 +2,8 @@
 import sys, os
 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
 
+from datetime import datetime
+
 import notubiz
 import notubiz.api.event
 
@@ -11,8 +13,10 @@
 
 event_client = notubiz.api.event.EventApi(api_client)
 
-event = event_client.get(1229974)
+start_date = datetime(2019, 1, 1)
+end_date = datetime(2020, 3, 31, 23, 59, 59)
+
+events = event_client.get(start_date, end_date)
 
-print(event.title)
-# for event. in meeting.agenda_items:
-#     print("  {} - {}".format(agenda_item.start_date, agenda_item.title))
+for event in events:
+    print("{} - {} ({})".format(event.plannings[0].start_date, event.title, event.location))

notubiz/api/event.py

@@ -1,60 +1,94 @@
-from attrs import define
+
+from attrs import define, field
 import cattrs
 from cattrs import transform_error
-from cattrs.gen import make_dict_structure_fn, override
+
+from typing import Optional
 
 from datetime import datetime
+from notubiz.api._helpers import parse_date, get_title, get_location
 
-from notubiz.api.meeting import Meeting, meeting_structure_hook
-from notubiz.api.agenda_item import AgendaItem, agenda_item_structure_hook
 from notubiz import ApiClient
 
 @define
-class Event:
-    title : str
-    description : str
-    location : str
-    chairman : str
-    clerk : str
-    secretary : str
-
-    # TODO: media
-    # TODO: speakers 
+class Planning:
+    # Auto-filled
+    start_date : datetime
+    end_date : Optional[datetime]
 
-    agenda : list[AgendaItem]
-
-    # meeting_id : int
-    # type : str
-    # start_date : datetime
-    # end_date : datetime
+@define
+class Event:
+    # Auto-filled
+    id: int
+    type: str
+    permission_group: str
+    body: str
+    confidential: bool
+    announcement: bool
+    canceled: bool
+    inactive: bool
+    creation_date: datetime
+    last_modified: datetime
+    live: bool
+    archive_state: str
+    archive_state_last_modified: Optional[datetime]
+    allow_subscriptions: bool
+    plannings: list[Planning]
 
-    # meetings : list[Meeting]
+    # Manually filled
+    title: str = field(init=False)
+    location: str = field(init=False)
+    gremium_id: int = field(init=False)
 
     @staticmethod
     def from_json(json_object : any) -> 'Event':
         c = cattrs.Converter()
-        c.register_structure_hook(Meeting, meeting_structure_hook)
-        # c.register_structure_hook(AgendaItem, agenda_item_structure_hook)
-        st_hook = make_dict_structure_fn(
-            AgendaItem, c, agenda=override(struct_hook=lambda v, _: agenda_item_structure_hook(v["agendaitem"])))
-        c.register_structure_hook(AgendaItem, st_hook)
+
+        c.register_structure_hook(datetime, lambda date_string, _: parse_date(date_string))
 
         try:
-            meeting = c.structure(json_object["event"][0], Event)
+            meeting = c.structure(json_object, Event)
         except Exception as exc:
             print("\n".join(transform_error(exc)))
             quit()
 
+        attributes = json_object.get("attributes", [])
+        meeting.title = get_title(attributes)
+        meeting.location = get_location(attributes)
+        meeting.gremium_id = json_object["gremium"]["id"]
+
         return meeting
 
 class EventApi:
     api_client : ApiClient
-
 
     def __init__(self, api_client : ApiClient):
         self.api_client = api_client
 
-    def get(self, event_id : int) -> Event:
-        json_object = self.api_client.get("events/{}".format(event_id))
-        return Event.from_json(json_object)
-    
+
+    def get(self, date_from: datetime, date_to: datetime, gremia: list[int] = None) -> list[Event]:
+
+        json_events : list[dict] = []
+        has_more_pages = True
+        page = 1 # Notubiz uses 1-based paging
+
+        # We loop over the pages until no more pages are left
+        while has_more_pages:
+
+            additional_payload = {
+                'date_from': date_from.strftime("%Y-%m-%d %H:%M:%S"),
+                'date_to': date_to.strftime("%Y-%m-%d %H:%M:%S"),
+                # For some reason this endpoint requires 'organisation_id' instead of 'organisation"
+                'organisation_id': self.api_client.configuration.organisation_id,
+                'gremia': gremia,
+                'page': page
+            }
+
+            json_events_page = self.api_client.get("events/", additional_payload)
+            json_events.extend(json_events_page["events"])
+
+            has_more_pages = json_events_page["pagination"]["has_more_pages"]
+            page += 1
+        
+        # Now run the deserialization based on the merged events
+        return [Event.from_json(json_event) for json_event in json_events]