Merge pull request #4 from RutgerRauws/fix/refactor-structure

Refactor structure

Author: RutgerRauws

examples/find_speaker.py

@@ -2,14 +2,14 @@
 import sys, os
 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
 
-import notubiz
-import notubiz.api.speakers
+from notubiz import ApiClient, Configuration
+from notubiz.api.clients import SpeakersClient
 
-configuration = notubiz.Configuration(organisation_id = 686) # Gemeente Eindhoven
+configuration = Configuration(organisation_id = 686) # Gemeente Eindhoven
 
-api_client = notubiz.ApiClient(configuration)
+api_client = ApiClient(configuration)
 
-speakers = notubiz.api.NotubizSpeakers(api_client).get()
+speakers = SpeakersClient(api_client).get()
 
 speaker = speakers.find_by_person_id(194366) 
 

examples/get_events.py

@@ -4,14 +4,14 @@
 
 from datetime import datetime
 
-import notubiz
-import notubiz.api.event
+from notubiz import ApiClient, Configuration
+from notubiz.api.clients import EventsClient
 
-configuration = notubiz.Configuration(organisation_id = 686) # Gemeente Eindhoven
+configuration = Configuration(organisation_id = 686) # Gemeente Eindhoven
 
-api_client = notubiz.ApiClient(configuration)
+api_client = ApiClient(configuration)
 
-event_client = notubiz.api.event.EventApi(api_client)
+event_client = EventsClient(api_client)
 
 start_date = datetime(2019, 1, 1)
 end_date = datetime(2020, 3, 31, 23, 59, 59)

examples/get_meeting.py

@@ -2,14 +2,14 @@
 import sys, os
 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
 
-import notubiz
-import notubiz.api.meeting
+from notubiz import ApiClient, Configuration
+from notubiz.api.clients.meeting_client import MeetingClient
 
-configuration = notubiz.Configuration(organisation_id = 686) # Gemeente Eindhoven
+configuration = Configuration(organisation_id = 686) # Gemeente Eindhoven
 
-api_client = notubiz.ApiClient(configuration)
+api_client = ApiClient(configuration)
 
-meeting_client = notubiz.api.NotubizMeeting(api_client)
+meeting_client = MeetingClient(api_client)
 
 meeting = meeting_client.get(1147925)
 

notubiz/api/__init__.py

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

notubiz/api/clients/__init__.py

@@ -0,0 +1,37 @@
+from notubiz import ApiClient
+from notubiz.api.dataclasses import Event
+from datetime import datetime
+
+class EventsClient:
+    api_client : ApiClient
+    
+    def __init__(self, api_client : ApiClient):
+        self.api_client = api_client
+
+
+    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]

notubiz/api/clients/events_client.py

@@ -0,0 +1,12 @@
+from notubiz import ApiClient
+from notubiz.api.dataclasses import Meeting
+
+class MeetingClient:
+    api_client : ApiClient
+
+    def __init__(self, api_client : ApiClient):
+        self.api_client = api_client
+
+    def get(self, meeting_id : int) -> Meeting:
+        json_object = self.api_client.get("events/meetings/{}".format(meeting_id))
+        return Meeting.from_json(json_object)

notubiz/api/clients/meeting_client.py

@@ -0,0 +1,12 @@
+from notubiz.api_client import ApiClient
+from notubiz.api.dataclasses import Speakers
+
+class SpeakersClient:
+    api_client : ApiClient
+
+    def __init__(self, api_client : ApiClient):
+        self.api_client = api_client
+
+    def get(self) -> Speakers:
+        json_object = self.api_client.get("speakers")
+        return Speakers.from_json(json_object)

notubiz/api/clients/speakers_client.py

@@ -0,0 +1,5 @@
+from notubiz.api.dataclasses.event import Event
+from notubiz.api.dataclasses.meeting import Meeting
+from notubiz.api.dataclasses.document import Document
+from notubiz.api.dataclasses.agenda_item import AgendaItem
+from notubiz.api.dataclasses.speakers import Speaker, Speakers

notubiz/api/dataclasses/__init__.py

@@ -5,7 +5,7 @@
 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
+from notubiz.api.dataclasses.document import Document
 
 @define
 class AgendaItem:
@@ -19,6 +19,18 @@ class AgendaItem:
     documents: list[Document]
     agenda_items : list['AgendaItem'] = field(factory=list)
 
+class AgendaItems:
+    @staticmethod
+    def from_json(json_object : any) -> list[AgendaItem]:
+        c = cattrs.Converter()
+        
+        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]
+
+        return agenda_items
+    
 
 def get_start_date(attributes) -> datetime:
     try:
@@ -36,8 +48,8 @@ def agenda_item_structure_hook(data: Dict[str, Any], cls: type) -> AgendaItem:
     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"])
+    documents = [Document.from_json(item) for item in data["documents"]]
+    agenda_items = AgendaItems.from_json(data["agenda_items"])
 
     return AgendaItem(
         id=data["id"],
@@ -51,15 +63,3 @@ def agenda_item_structure_hook(data: Dict[str, Any], cls: type) -> AgendaItem:
         agenda_items = agenda_items
     )
 
-
-class NotubizAgendaItems:
-    def from_json(json_object : any) -> list[AgendaItem]:
-        c = cattrs.Converter()
-        
-        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]
-
-        return agenda_items
-    

notubiz/api/agenda_item.py notubiz/api/dataclasses/agenda_item.py

@@ -1,6 +1,6 @@
 from attrs import define, field
 import cattrs
-from typing import Optional, Dict, Any, List
+from typing import Optional, List
 from datetime import datetime
 
 @define
@@ -19,8 +19,8 @@ class Document:
     versions: List[DocumentVersion]
     id: Optional[int] = field(default=None) # Apparently some documents have no ID
 
-class NotubizDocument:
-    def from_json(json_object : any) -> Document:
+    @staticmethod
+    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"))
 

notubiz/api/document.py notubiz/api/dataclasses/document.py

@@ -1,4 +1,3 @@
-
 from attrs import define, field
 import cattrs
 from cattrs import transform_error
@@ -8,8 +7,6 @@
 from datetime import datetime
 from notubiz.api._helpers import parse_date, get_title, get_location
 
-from notubiz import ApiClient
-
 @define
 class Planning:
     # Auto-filled
@@ -57,38 +54,4 @@ def from_json(json_object : any) -> 'Event':
         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, 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]
+        return meeting

notubiz/api/event.py notubiz/api/dataclasses/event.py

@@ -0,0 +1,39 @@
+from attrs import define, field
+import cattrs
+from cattrs import transform_error
+
+from notubiz.api._helpers import get_title, get_location
+from notubiz.api.dataclasses.agenda_item import AgendaItem, AgendaItems
+
+from typing import Optional, Dict, Any
+
+@define
+class Meeting:
+    # Auto-filled
+    id : int
+    url : str
+
+    # Manually filled
+    title : Optional[str] = field(init=False)
+    location : Optional[str] = field(init=False)
+    agenda_items : list[AgendaItem] = field(init=False)
+
+    @staticmethod
+    def from_json(json_object : any) -> 'Meeting':
+        c = cattrs.Converter()
+
+        meeting_json = json_object.get("meeting", {})
+
+        try:
+            meeting = c.structure(meeting_json, Meeting)
+        except Exception as exc:
+            print("\n".join(transform_error(exc)))
+            quit()
+
+        attributes = meeting_json.get("attributes", [])
+        meeting.title = get_title(attributes)
+        meeting.location = get_location(attributes)
+
+        meeting.agenda_items = AgendaItems.from_json(meeting_json.get("agenda_items"))
+
+        return meeting

notubiz/api/dataclasses/meeting.py

@@ -2,9 +2,6 @@
 import cattrs
 from cattrs import transform_error
 from cattrs.gen import make_dict_unstructure_fn, make_dict_structure_fn, override
-from typing import Optional
-
-from notubiz.api_client import ApiClient
 
 @define
 class SpeakerAttributes:
@@ -48,17 +45,8 @@ def find_by_person_id(self, person_id : int):
 
         return None
 
-class NotubizSpeakers:
-    api_client : ApiClient
-
-    def __init__(self, api_client : ApiClient):
-        self.api_client = api_client
-
-    def get(self) -> Speakers:
-        json_object = self.api_client.get("speakers")
-        return NotubizSpeakers.from_json(json_object)
-    
-    def from_json(json_object : any) -> Speakers:
+    @staticmethod
+    def from_json(json_object : any) -> 'Speakers':
         c = cattrs.Converter()
 
         unst_hook = make_dict_unstructure_fn(Speakers, c, speakers=override(rename="speaker"))