Merge pull request #2 from RutgerRauws/feature/extending-agenda-item

Extending agenda item

Author: RutgerRauws

examples/get_meeting.py

@@ -16,3 +16,6 @@
 print(meeting.title)
 for agenda_item in meeting.agenda_items:
     print("  {} - {}".format(agenda_item.start_date, agenda_item.title))
+
+    for sub_agenda_item in agenda_item.agenda_items:
+        print("                      - {}".format(sub_agenda_item.title))

notubiz/api/agenda_item.py

@@ -1,10 +1,11 @@
-from attrs import define
+from attrs import define, field
 import cattrs
 
 from datetime import datetime
 from typing import Optional, Dict, Any
 
 from notubiz.api._helpers import parse_date, get_attribute, get_title, get_description
+from notubiz.api.document import Document, NotubizDocument
 
 @define
 class AgendaItem:
@@ -15,17 +16,28 @@ class AgendaItem:
     start_date : Optional[datetime]
     end_date : Optional[datetime]
     is_heading : bool
+    documents: list[Document]
+    agenda_items : list['AgendaItem'] = field(factory=list)
 
 
 def get_start_date(attributes) -> datetime:
-    return parse_date(get_attribute(attributes, 82))
+    try:
+        return parse_date(get_attribute(attributes, 82))
+    except Exception: # The nested agenda items seem to have no start dates.
+        return None
 
 def get_end_date(attributes) -> datetime:
-    return parse_date(get_attribute(attributes, 83))
-
+    try:
+        return parse_date(get_attribute(attributes, 83))
+    except Exception: # The nested agenda items seem to have no end dates.
+        return None
 
 def agenda_item_structure_hook(data: Dict[str, Any], cls: type) -> AgendaItem:
-    attributes = data["type_data"]["attributes"]
+    type_data = data.get("type_data", {})
+    attributes = type_data["attributes"]
+
+    documents = [NotubizDocument.from_json(item) for item in data["documents"]]
+    agenda_items = NotubizAgendaItems.from_json(data["agenda_items"])
 
     return AgendaItem(
         id=data["id"],
@@ -34,7 +46,9 @@ def agenda_item_structure_hook(data: Dict[str, Any], cls: type) -> AgendaItem:
         description = get_description(attributes),
         start_date = get_start_date(attributes),
         end_date = get_end_date(attributes),
-        is_heading = data["type_data"]["heading"]
+        is_heading = data["type_data"]["heading"],
+        documents = documents,
+        agenda_items = agenda_items
     )
 
 
@@ -45,7 +59,7 @@ def from_json(json_object : any) -> list[AgendaItem]:
         c.register_structure_hook(datetime, lambda date_string, _: parse_date(date_string))
         c.register_structure_hook(AgendaItem, agenda_item_structure_hook)
 
-        agenda_items =  [c.structure(item, AgendaItem) for item in json_object]
+        agenda_items = [c.structure(item, AgendaItem) for item in json_object]
 
         return agenda_items
 

notubiz/api/document.py

@@ -0,0 +1,27 @@
+from attrs import define, field
+import cattrs
+from typing import Optional, Dict, Any, List
+from datetime import datetime
+
+@define
+class DocumentVersion:
+    id: int
+    file_name: str
+    file_size: int
+    mime_type: Optional[str] = field(default="") # Apparently some documents have no MIME type
+
+@define
+class Document:
+    last_modified: datetime
+    title: str
+    version: int
+    url: str
+    versions: List[DocumentVersion]
+    id: Optional[int] = field(default=None) # Apparently some documents have no ID
+
+class NotubizDocument:
+    def from_json(json_object : any) -> Document:
+        c = cattrs.Converter()
+        c.register_structure_hook(datetime, lambda d, _: datetime.strptime(d, "%Y-%m-%d %H:%M:%S"))
+
+        return c.structure(json_object, Document)

notubiz/api_client.py

@@ -9,7 +9,11 @@ class ApiClient:
     configuration : Configuration
 
     def get_base_payload(self) -> dict:
-        return {'format': 'json', 'organisation': self.configuration.organisation_id}
+        return {
+            'format': 'json',
+            'version': self.configuration.api_version,
+            'organisation': self.configuration.organisation_id
+        }
 
     def get(self, relative_path : str, extra_payload : dict = None) -> any:
         request_url = self.configuration.base_url + relative_path

notubiz/configuration.py

@@ -3,4 +3,5 @@
 @define
 class Configuration:
     organisation_id : int
+    api_version : str = "1.10.8" # To keep the used API stable
     base_url : str = "https://api.notubiz.nl/"

test/test_meeting.py

@@ -16,7 +16,7 @@ def input_json():
 def input_meeting():
     return NotubizMeeting.from_json(test_file_path)
 
-def test_deserialization(input_json):
+def test_meeting_general_info(input_json):
     meeting = NotubizMeeting.from_json(input_json)
 
     # We test all fields because they are not straight-up deserialized
@@ -26,6 +26,10 @@ def test_deserialization(input_json):
     assert meeting.location == "Raadzaal"
     assert len(meeting.agenda_items) == 7
 
+
+def test_basic_agenda_item(input_json):
+    meeting = NotubizMeeting.from_json(input_json)
+
     agenda_item = meeting.agenda_items[2]
     assert agenda_item.id == 8329704
     assert agenda_item.last_modified == datetime(2024, 3, 29, 10, 8, 56)
@@ -34,3 +38,20 @@ def test_deserialization(input_json):
     assert agenda_item.start_date == datetime(2024, 4, 16, 18, 0, 0)
     assert agenda_item.end_date == datetime(2024, 4, 16, 19, 0, 0)
     assert agenda_item.is_heading == True
+
+def test_nested_agenda_items(input_json):
+    meeting = NotubizMeeting.from_json(input_json)
+    agenda_items = meeting.agenda_items
+
+    assert len(agenda_items[0].agenda_items) == 0
+    assert len(agenda_items[1].agenda_items) == 0
+    assert len(agenda_items[2].agenda_items) == 0
+    assert len(agenda_items[3].agenda_items) == 1
+    assert len(agenda_items[4].agenda_items) == 2
+    assert len(agenda_items[5].agenda_items) == 0
+    assert len(agenda_items[6].agenda_items) == 0
+
+    # Check content of the nested agenda items
+    assert len(agenda_items[3].agenda_items[0].agenda_items) == 0
+    assert len(agenda_items[4].agenda_items[0].agenda_items) == 0
+    assert len(agenda_items[4].agenda_items[1].agenda_items) == 0