feature/finish-db-models

cdp_backend/bin/create_cdp_database_uml.py

@@ -66,7 +66,7 @@ def _construct_dot_file(output_file: str):
 
  # First pass: create nodes for each model
  for model_name, cls in inspect.getmembers(models, inspect.isclass):
- if model_name not in ["Model", "datetime"]:
+ if model_name not in models._BUILD_IGNORE_CLASSES:
  # Attach fields for each model by using the Example
  fields = []
  m = cls.Example()
@@ -106,7 +106,7 @@ def _construct_dot_file(output_file: str):
 
  # Second pass: Create DAG
  for model_name, cls in inspect.getmembers(models, inspect.isclass):
- if model_name not in ["Model", "datetime"]:
+ if model_name not in models._BUILD_IGNORE_CLASSES:
  # Attach fields for each model by using the Example
  m = cls.Example()
 

cdp_backend/database/models.py

@@ -8,6 +8,17 @@
 
 from . import validators
 from ..utils import file_utils
+from .types import IndexedField, IndexedFieldSet, Order
+
+###############################################################################
+
+_BUILD_IGNORE_CLASSES = [
+ "Model",
+ "datetime",
+ "IndexedField",
+ "IndexedFieldSet",
+ "Order",
+]
 
 ###############################################################################
 
@@ -142,5 +153,356 @@ def Example(cls):
  role.start_datetime = datetime.utcnow()
  return role
 
- _PRIMARY_KEYS = ("title", "person", "body", "seat")
+ _PRIMARY_KEYS = ("title", "person_ref", "body_ref", "seat_ref")
+ _INDEXES = ()
+
+
+class Matter(Model):
+ """
+ A matter is a specific legislative document. A bill, resolution, initiative, etc.
+ """
+
+ name = fields.TextField(required=True)
+ matter_type = fields.TextField(required=True)
+ title = fields.TextField(required=True)
+ external_source_id = fields.TextField()
+
+ @classmethod
+ def Example(cls):
+ matter = cls()
+ matter.name = "CB 119858"
+ matter.matter_type = "Council Bill"
+ matter.title = (
+ "AN ORDINANCE relating to the financing of the West Seattle Bridge "
+ "Immediate Response project; creating a fund for depositing proceeds of "
+ "taxable limited tax general obligation bonds in 2021; authorizing the "
+ "loan of funds in the amount of $50,000,000 from the Construction and "
+ "Inspections Fund and $20,000,000 from the REET II Capital Projects Fund "
+ "to the 2021 LTGO Taxable Bond Fund for early phases of work on the bridge "
+ "repair and replacement project; amending Ordinance 126000, which adopted "
+ "the 2020 Budget, including the 2020-2025 Capital Improvement Program "
+ "(CIP); changing appropriations to the Seattle Department of "
+ "Transportation; and revising project allocations and spending plans for "
+ "certain projects in the 2020-2025 CIP."
+ )
+ return matter
+
+ _PRIMARY_KEYS = ("name",)
+ _INDEXES = ()
+
+
+class MatterStatus(Model):
+ """
+ A matter status is the status of a matter at any given time. Useful for tracking
+ the timelines of matters. I.E. Return me a timeline of matter x.
+
+ The same matter will have multiple matter statuses.
+ 1. MatterStatus of submitted
+ 2. MatterStatus of passed
+ 3. MatterStatus of signed
+ 4. etc.
+ """
+
+ matter_ref = fields.ReferenceField(Matter, required=True)
+ status = fields.TextField(required=True)
+ update_datetime = fields.DateTime(required=True)
+ external_source_id = fields.TextField()
+
+ @classmethod
+ def Example(cls):
+ matter_status = cls()
+ matter_status.matter_ref = Matter.Example()
+ matter_status.status = "Passed"
+ matter_status.update_datetime = datetime.utcnow()
+ return matter_status
+
+ _PRIMARY_KEYS = ("matter_ref",)
+ _INDEXES = ()
+
+
+class MatterFile(Model):
+ """
+ A document related to a matter.
+
+ This file is usually not stored in CDP infrastructure but a remote source.
+ """
+
+ matter_ref = fields.ReferenceField(Matter, required=True)
+ name = fields.TextField(required=True)
+ uri = fields.TextField(required=True, validator=validators.resource_exists)
+ external_source_id = fields.TextField()
+
+ @classmethod
+ def Example(cls):
+ matter_file = cls()
+ matter_file.matter_ref = Matter.Example()
+ matter_file.name = "Amendment 3 (Sawant) - Sunset"
+ matter_file.uri = (
+ "http:https://legistar2.granicus.com/seattle/attachments/"
+ "789a0c9f-dd9c-401b-aaf5-6c67c2a897b0.pdf"
+ )
+ return matter_file
+
+ _PRIMARY_KEYS = ("matter_ref", "name", "uri")
+ _INDEXES = (
+ IndexedFieldSet(
+ (
+ IndexedField(name="matter_ref", order=Order.ASCENDING),
+ IndexedField(name="name", order=Order.ASCENDING),
+ )
+ ),
+ )
+
+
+class MatterSponsor(Model):
+ """
+ A connection between a matter and it's sponsor, a Person.
+ """
+
+ matter_ref = fields.ReferenceField(Matter, required=True)
+ person_ref = fields.ReferenceField(Person, required=True)
+ external_source_id = fields.TextField()
+
+ @classmethod
+ def Example(cls):
+ matter_sponsor = cls()
+ matter_sponsor.matter_ref = Matter.Example()
+ matter_sponsor.person_ref = Person.Example()
+ return matter_sponsor
+
+ _PRIMARY_KEYS = ("matter_ref", "person_ref")
+ _INDEXES = ()
+
+
+class MinutesItem(Model):
+ """
+ An item referenced during a meeting.
+ This can be a matter but it can be a presentation or budget file, etc.
+ """
+
+ name = fields.TextField(required=True)
+ description = fields.TextField()
+ matter_ref = fields.ReferenceField(Matter) # Note optional.
+ external_source_id = fields.TextField()
+
+ @classmethod
+ def Example(cls):
+ minutes_item = cls()
+ minutes_item.name = "Inf 1656"
+ minutes_item.description = (
+ "Roadmap to defunding the Police and investing in community."
+ )
+ return minutes_item
+
+ _PRIMARY_KEYS = ("name",)
+ _INDEXES = ()
+
+
+class Event(Model):
+ """
+ An event can be a normally scheduled meeting, a special event such as a press
+ conference or election debate, and, can be upcoming or historical.
+ """
+
+ body_ref = fields.ReferenceField(Body, required=True)
+ event_datetime = fields.DateTime(required=True)
+ static_thumbnail_ref = fields.ReferenceField(File)
+ hover_thumbnail_ref = fields.ReferenceField(File)
+ agenda_uri = fields.TextField(validator=validators.resource_exists)
+ minutes_uri = fields.TextField(validator=validators.resource_exists)
+ external_source_id = fields.TextField()
+
+ @classmethod
+ def Example(cls):
+ event = cls()
+ event.body_ref = Body.Example()
+ event.event_datetime = datetime.utcnow()
+ event.agenda_uri = (
+ "http:https://legistar2.granicus.com/seattle/meetings/2019/11/"
+ "4169_A_Select_Budget_Committee_19-11-01_Committee_Agenda.pdf"
+ )
+ event.minutes_uri = (
+ "http:https://legistar2.granicus.com/seattle/meetings/2019/7/"
+ "4041_M_Council_Briefing_19-07-22_Committee_Minutes.pdf"
+ )
+ return event
+
+ _PRIMARY_KEYS = ("body_ref", "event_datetime")
+ _INDEXES = (
+ IndexedFieldSet(
+ (
+ IndexedField(name="body_ref", order=Order.ASCENDING),
+ IndexedField(name="event_datetime", order=Order.ASCENDING),
+ )
+ ),
+ IndexedFieldSet(
+ (
+ IndexedField(name="body_ref", order=Order.ASCENDING),
+ IndexedField(name="event_datetime", order=Order.DESCENDING),
+ )
+ ),
+ )
+
+
+class Session(Model):
+ """
+ A session is a working period for an event.
+ An event could have a morning and afternoon session.
+ """
+
+ event_ref = fields.ReferenceField(Event, required=True)
+ session_datetime = fields.DateTime(required=True)
+ session_index = fields.NumberField(required=True)
+ video_uri = fields.TextField(required=True, validator=validators.resource_exists)
+ caption_uri = fields.TextField(validator=validators.resource_exists)
+ external_source_id = fields.TextField()
+
+ @classmethod
+ def Example(cls):
+ session = cls()
+ session.event_ref = Event.Example()
+ session.session_index = 0
+ session.video_uri = (
+ "https://video.seattle.gov/media/council/brief_072219_2011957V.mp4"
+ )
+ return session
+
+ _PRIMARY_KEYS = ("event_ref", "video_uri")
+ _INDEXES = ()
+
+
+class Transcript(Model):
+ """
+ A transcript is a document per-session.
+ """
+
+ session_ref = fields.ReferenceField(Session, required=True)
+ file_ref = fields.ReferenceField(File, required=True)
+ confidence = fields.NumberField(required=True)
+ created = fields.DateTime(required=True)
+
+ @classmethod
+ def Example(cls):
+ transcript = cls()
+ transcript.session_ref = Session.Example()
+ transcript.file_ref = File.Example()
+ transcript.confidence = 0.943
+ transcript.created = datetime.utcnow()
+ return transcript
+
+ _PRIMARY_KEYS = ("session_ref", "file_ref")
+ _INDEXES = (
+ IndexedFieldSet(
+ (
+ IndexedField(name="session_ref", order=Order.ASCENDING),
+ IndexedField(name="created", order=Order.DESCENDING),
+ )
+ ),
+ IndexedFieldSet(
+ (
+ IndexedField(name="session_ref", order=Order.ASCENDING),
+ IndexedField(name="confidence", order=Order.DESCENDING),
+ )
+ ),
+ )
+
+
+class EventMinutesItem(Model):
+ """
+ A reference tying a specific minutes item to a specific event.
+ """
+
+ event_ref = fields.ReferenceField(Event, required=True)
+ minutes_item_ref = fields.ReferenceField(MinutesItem, required=True)
+ index = fields.NumberField(required=True)
+ decision = fields.TextField()
+ external_source_id = fields.TextField()
+
+ @classmethod
+ def Example(cls):
+ emi = cls()
+ emi.event_ref = Event.Example()
+ emi.minutes_item_ref = MinutesItem.Example()
+ emi.index = 0
+ emi.decision = "Passed"
+ return emi
+
+ _PRIMARY_KEYS = ("event_ref", "minutes_item_ref")
+ _INDEXES = (
+ IndexedFieldSet(
+ (
+ IndexedField(name="event_ref", order=Order.ASCENDING),
+ IndexedField(name="index", order=Order.ASCENDING),
+ )
+ ),
+ IndexedFieldSet(
+ (
+ IndexedField(name="event_ref", order=Order.ASCENDING),
+ IndexedField(name="index", order=Order.DESCENDING),
+ )
+ ),
+ )
+
+
+class EventMinutesItemFile(Model):
+ """
+ Supporting files for an event minutes item.
+ """
+
+ event_minutes_item_ref = fields.ReferenceField(EventMinutesItem, required=True)
+ name = fields.TextField(required=True)
+ uri = fields.TextField(required=True, validator=validators.resource_exists)
+ external_source_id = fields.TextField()
+
+ @classmethod
+ def Example(cls):
+ emif = cls()
+ emif.event_minutes_item_ref = EventMinutesItem.Example()
+ emif.name = "Levy to Move Seattle Quartly Report"
+ emif.uri = (
+ "http:https://legistar2.granicus.com/seattle/attachments/"
+ "ec6595cf-e2c3-449d-811b-047675d047df.pdf"
+ )
+ return emif
+
+ _PRIMARY_KEYS = ("event_minutes_item_ref", "uri")
+ _INDEXES = (
+ IndexedFieldSet(
+ (
+ IndexedField(name="event_minutes_item_ref", order=Order.ASCENDING),
+ IndexedField(name="name", order=Order.ASCENDING),
+ )
+ ),
+ )
+
+
+class Vote(Model):
+ "A reference typing a specific person, and an event minutes item together."
+
+ matter_ref = fields.ReferenceField(Matter, required=True)
+ event_ref = fields.ReferenceField(Event, required=True)
+ event_minutes_item_ref = fields.ReferenceField(EventMinutesItem, required=True)
+ person_ref = fields.ReferenceField(Person, required=True)
+ decision = fields.TextField(required=True)
+ in_majority = fields.BooleanField(required=True)
+ external_source_id = fields.TextField()
+
+ @classmethod
+ def Example(cls):
+ vote = cls()
+ vote.matter_ref = Matter.Example()
+ vote.event_ref = Event.Example()
+ vote.event_minutes_item_ref = EventMinutesItem.Example()
+ vote.person_ref = Person.Example()
+ vote.decision = "Approve"
+ vote.in_majority = True
+ return vote
+
+ _PRIMARY_KEYS = (
+ "matter_ref",
+ "event_ref",
+ "event_minutes_item_ref",
+ "person_ref",
+ "decision",
+ )
  _INDEXES = ()