Add matching local state with an activity

piket_server/__init__.py

@@ -10,3 +10,4 @@ import piket_server.routes.consumptions
 import piket_server.routes.consumption_types
 import piket_server.routes.settlements
 import piket_server.routes.exports
+import piket_server.routes.aardbei

piket_server/aardbei_sync.py

@@ -3,17 +3,20 @@ from __future__ import annotations
 import datetime
 import json
 import logging
+import sys
 from dataclasses import asdict, dataclass
 from enum import Enum
-from typing import Any, Dict, List, NewType, Optional, Tuple
+from typing import Any, Dict, List, NewType, Optional, Tuple, Union
 
 import requests
 
-from piket_server.models import Person
 from piket_server.flask import db
+from piket_server.models import Person
+from piket_server.util import fmt_datetime
 
 # AARDBEI_ENDPOINT = "https://aardbei.app"
 AARDBEI_ENDPOINT = "http://localhost:3000"
+log = logging.getLogger(__name__)
 
 ActivityId = NewType("ActivityId", int)
 PersonId = NewType("PersonId", int)
@@ -23,17 +26,49 @@ ParticipantId = NewType("ParticipantId", int)
 
 @dataclass(frozen=True)
 class AardbeiPerson:
+    """
+    Contains the data on a Person as exposed by Aardbei.
+
+    A Person represents a person in the real world, and maps to a Person in the local database.
+    """
+
     aardbei_id: PersonId
     full_name: str
 
     @classmethod
     def from_aardbei_dict(cls, data: Dict[str, Any]) -> AardbeiPerson:
+        """
+        Load from a dictionary provided by Aardbei.
+
+        >>> AardbeiPerson.from_aardbei_dict(
+          {"person": {"aardbei_id": 1, "full_name": "Henkie Kraggelwenk"}}
+        )
+        AardbeiPerson(aardbei_id=AardbeiId(1), full_name="Henkie Kraggelwenk")
+        """
+
         d = data["person"]
         return cls(full_name=d["full_name"], aardbei_id=PersonId(d["id"]))
 
+    @property
+    def as_json_dict(self) -> Dict[str, Any]:
+        """
+        Serialize to a dictionary as provided by Aardbei.
+
+        >>> AardbeiPerson(aardbei_id=AardbeiId(1), full_name="Henkie Kraggelwenk").as_json_dict
+        {"person": {"id": 1, "full_name": "Henkie Kraggelwenk"}}
+        """
+
+        return {"person": {"id": self.aardbei_id, "full_name": self.full_name}}
+
 
 @dataclass(frozen=True)
 class AardbeiMember:
+    """
+    Contains the data on a Member exposed by Aardbei.
+
+    A Member represents the membership of a Person in a Group in Aardbei.
+    """
+
     person: AardbeiPerson
     aardbei_id: MemberId
     is_leader: bool
@@ -41,7 +76,28 @@ class AardbeiMember:
 
     @classmethod
     def from_aardbei_dict(cls, data: Dict[str, Any]) -> AardbeiMember:
-        logging.debug("Init with data %s", json.dumps(data))
+        """
+        Load from a dictionary provided by Aardbei.
+
+        >>> from_aardbei_dict({
+            "member": {
+                "person": {
+                    "full_name": "Roer Kuggelvork",
+                    "id": 2,
+                },
+                "id": 23,
+                "is_leader": False,
+                "display_name": "Roer",
+            },
+        })
+        AardbeiMember(
+            person=AardbeiPerson(aardbei_id=PersonId(2), full_name="Roer Kuggelvork"),
+            aardbei_id=MemberId(23),
+            is_leader=False,
+            display_name="Roer",
+        )
+        """
+
         d = data["member"]
         person = AardbeiPerson.from_aardbei_dict(d)
         return cls(
@@ -51,9 +107,46 @@ class AardbeiMember:
             display_name=d["display_name"],
         )
 
+    @property
+    def as_json_dict(self) -> Dict[str, Any]:
+        """
+        Serialize to a dict as provided by Aardbei.
+
+        >>> AardbeiMember(
+            person=AardbeiPerson(aardbei_id=PersonId(2), full_name="Roer Kuggelvork"),
+            aardbei_id=MemberId(23),
+            is_leader=False,
+            display_name="Roer",
+        )
+        {
+            "member": {
+                "person": {
+                    "full_name": "Roer Kuggelvork",
+                    "id": 2,
+                },
+                "id": 23,
+                "is_leader": False,
+                "display_name": "Roer",
+            }
+        }
+        """
+        res = {
+            "id": self.aardbei_id,
+            "is_leader": self.is_leader,
+            "display_name": self.display_name,
+        }
+        res.update(self.person.as_json_dict)
+        return res
+
 
 @dataclass(frozen=True)
 class AardbeiParticipant:
+    """
+    Represents a Participant as exposed by Aardbei.
+
+    A Participant represents the participation of a Person (optionally as a Member in a Group) in an Activity.
+    """
+
     person: AardbeiPerson
     member: Optional[AardbeiMember]
     aardbei_id: ParticipantId
@@ -63,6 +156,10 @@ class AardbeiParticipant:
 
     @property
     def name(self) -> str:
+        """
+        Return the name to show for this Participant.
+        This is the display_name if a Member is present, else the Participant's Person's full name.
+        """
         if self.member is not None:
             return self.member.display_name
 
@@ -70,6 +167,9 @@ class AardbeiParticipant:
 
     @classmethod
     def from_aardbei_dict(cls, data: Dict[str, Any]) -> AardbeiParticipant:
+        """
+        Load from a dictionary as provided by Aardbei.
+        """
         d = data["participant"]
         person = AardbeiPerson.from_aardbei_dict(d)
 
@@ -88,24 +188,53 @@ class AardbeiParticipant:
             notes=d["notes"],
         )
 
+    @property
+    def as_json_dict(self) -> Dict[str, Any]:
+        """
+        Serialize to a dict as provided by Aardbei.
+        """
+        res = {
+            "participant": {
+                "id": self.aardbei_id,
+                "attending": self.attending,
+                "is_organizer": self.is_organizer,
+                "notes": self.notes,
+            }
+        }
+        res.update(self.person.as_json_dict)
+        if self.member is not None:
+            res.update(self.member.as_json_dict)
+
+        return res
+
 
 class NoResponseAction(Enum):
+    """Represents the "no response action" attribute of Activities in Aardbei."""
+
     Present = "present"
     Absent = "absent"
 
 
 @dataclass(frozen=True)
 class ResponseCounts:
+    """Represents the "response counts" attribute of Activities in Aardbei."""
+
     present: int
     absent: int
     unknown: int
 
     @classmethod
     def from_aardbei_dict(cls, data: Dict[str, int]) -> ResponseCounts:
+        """Load from a dict as provided by Aardbei."""
         return cls(
             present=data["present"], absent=data["absent"], unknown=data["unknown"]
         )
 
+    @property
+    def as_json_dict(self) -> Dict[str, int]:
+        """Serialize to a dict as provided by Aardbei."""
+        return {"present": self.present, "absent": self.absent, "unknown": self.unknown}
+
 
 @dataclass(frozen=True)
 class SparseAardbeiActivity:
@@ -139,6 +268,7 @@ class SparseAardbeiActivity:
 
     @classmethod
     def from_aardbei_dict(cls, data: Dict[str, Any]) -> SparseAardbeiActivity:
+        """Load from a dict as provided by Aardbei."""
         start: datetime.datetime = datetime.datetime.fromisoformat(
             data["activity"]["start"]
         )
@@ -176,31 +306,99 @@ class SparseAardbeiActivity:
             response_counts=response_counts,
         )
 
+    @property
+    def as_json_dict(self) -> Dict[str, Any]:
+        """Serialize to a dict as provided by Aardbei."""
+        return {
+            "activity": {
+                "id": self.aardbei_id,
+                "name": self.name,
+                "description": self.description,
+                "location": self.location,
+                "start": fmt_datetime(self.start),
+                "end": fmt_datetime(self.end),
+                "deadline": fmt_datetime(self.deadline),
+                "reminder_at": fmt_datetime(self.reminder_at),
+                "no_response_action": self.no_response_action.value,
+                "response_counts": self.response_counts.as_json_dict,
+            }
+        }
+
 
 @dataclass(frozen=True)
 class AardbeiActivity(SparseAardbeiActivity):
+    """Contains the data of an Activity as exposed by Aardbei."""
+
     participants: List[AardbeiParticipant]
 
     @classmethod
     def from_aardbei_dict(cls, data: Dict[str, Any]) -> AardbeiActivity:
+        """Load from a dict as provided by Aardbei."""
+        # Ugly: This is a copy of the Sparse variant with added participants.
+        # This is not ideal, but I don't care enough to fix this right now.
         participants: List[AardbeiParticipant] = [
             AardbeiParticipant.from_aardbei_dict(x)
             for x in data["activity"]["participants"]
         ]
 
-        sparse = super().from_aardbei_dict(data)
+        start: datetime.datetime = datetime.datetime.fromisoformat(
+            data["activity"]["start"]
+        )
+        end: Optional[datetime.datetime] = None
+
+        if data["activity"]["end"] is not None:
+            end = datetime.datetime.fromisoformat(data["activity"]["end"])
+
+        deadline: Optional[datetime.datetime] = None
+        if data["activity"]["deadline"] is not None:
+            deadline = datetime.datetime.fromisoformat(data["activity"]["deadline"])
+
+        reminder_at: Optional[datetime.datetime] = None
+        if data["activity"]["reminder_at"] is not None:
+            reminder_at = datetime.datetime.fromisoformat(
+                data["activity"]["reminder_at"]
+            )
+
+        no_response_action = NoResponseAction(data["activity"]["no_response_action"])
+
+        response_counts = ResponseCounts.from_aardbei_dict(
+            data["activity"]["response_counts"]
+        )
+
+        return cls(
+            aardbei_id=ActivityId(data["activity"]["id"]),
+            name=data["activity"]["name"],
+            description=data["activity"]["description"],
+            location=data["activity"]["location"],
+            start=start,
+            end=end,
+            deadline=deadline,
+            reminder_at=reminder_at,
+            no_response_action=no_response_action,
+            response_counts=response_counts,
+            participants=participants,
+        )
 
-        return cls(participants=participants, **asdict(sparse))
+    @property
+    def as_json_dict(self) -> Dict[str, Any]:
+        """Serialize to a dict as provided by Aardbei."""
+        res = super().as_json_dict
+        res["participants"] = [p.as_json_dict for p in self.participants]
+        return res
 
 
 @dataclass(frozen=True)
 class AardbeiMatch:
+    """Represents a match between a local Person and a Person present in Aardbei's data."""
+
     local: Person
     remote: AardbeiMember
 
 
 @dataclass(frozen=True)
 class AardbeiLink:
+    """Represents a set of differences between the local state and Aardbei's set of people."""
+
     matches: List[AardbeiMatch]
     """People that exist on both sides, but aren't linked in the people table."""
     altered_name: List[AardbeiMatch]
@@ -208,12 +406,36 @@ class AardbeiLink:
     remote_only: List[AardbeiMember]
     """People that only exist on the remote."""
 
+    @property
+    def num_changes(self) -> int:
+        """Return the amount of mismatching people between Aardbei and the local state."""
+        return len(self.matches) + len(self.altered_name) + len(self.remote_only)
 
-def get_aardbei_people(token: str) -> List[AardbeiMember]:
-    resp = requests.get(
-        f"{AARDBEI_ENDPOINT}/api/groups/0/", headers={"Authorization": f"Group {token}"}
-    )
-    resp.raise_for_status()
+
+class AardbeiSyncError(Enum):
+    """Represents errors that might occur when retrieving data from Aardbei."""
+
+    CantConnect = "connect_fail"
+    HTTPError = "http_fail"
+
+
+def get_aardbei_people(
+    token: str, endpoint: str = AARDBEI_ENDPOINT
+) -> Union[List[AardbeiMember], AardbeiSyncError]:
+    """Retrieve the set of People in a Group from Aardbei, and parse this to
+    AardbeiPerson objects. Return a AardbeiSyncError if something fails."""
+    try:
+        resp: requests.Response = requests.get(
+            f"{AARDBEI_ENDPOINT}/api/groups/0/",
+            headers={"Authorization": f"Group {token}"},
+        )
+        resp.raise_for_status()
+
+    except requests.ConnectionError:
+        return AardbeiSyncError.CantConnect
+
+    except requests.HTTPError:
+        return AardbeiSyncError.HTTPError
 
     members = resp.json()["group"]["members"]
 
@@ -221,6 +443,10 @@ def get_aardbei_people(token: str) -> List[AardbeiMember]:
 
 
 def match_local_aardbei(aardbei_members: List[AardbeiMember]) -> AardbeiLink:
+    """Inspect the local state and compare it with the set of given
+    AardbeiMembers (containing AardbeiPersons). Return a AardbeiLink that
+    indicates which local people don't match the remote state."""
+
     matches: List[AardbeiMatch] = []
     altered_name: List[AardbeiMatch] = []
     remote_only: List[AardbeiMember] = []
@@ -259,6 +485,12 @@ def match_local_aardbei(aardbei_members: List[AardbeiMember]) -> AardbeiLink:
 
 
 def link_matches(matches: List[AardbeiMatch]) -> None:
+    """
+    Update local people to add the remote ID to the local state.
+    This only enqueues the changes in the local SQLAlchemy session, committing
+    needs to be done separately.
+    """
+
     for match in matches:
         match.local.aardbei_id = match.remote.aardbei_id
         match.local.display_name = match.remote.display_name
@@ -274,6 +506,12 @@ def link_matches(matches: List[AardbeiMatch]) -> None:
 
 
 def create_missing(missing: List[AardbeiMember]) -> None:
+    """
+    Create local people for all remote people that don't exist locally.
+    This only enqueues the changes in the local SQLAlchemy session, committing
+    needs to be done separately.
+    """
+
     for member in missing:
         pnew = Person(
             full_name=member.person.full_name,
@@ -291,6 +529,14 @@ def create_missing(missing: List[AardbeiMember]) -> None:
 
 
 def update_names(matches: List[AardbeiMatch]) -> None:
+    """
+    Update the local full and display names of people that were already linked
+    to a remote person, and who changed names on the remote.
+
+    This only enqueues the changes in the local SQLAlchemy session, committing
+    needs to be done separately.
+    """
+
     for match in matches:
         p = match.local
         member = match.remote
@@ -327,21 +573,79 @@ def update_names(matches: List[AardbeiMatch]) -> None:
         db.session.add(p)
 
 
-def get_activities(token: str) -> List[SparseAardbeiActivity]:
+def get_activities(
+    token: str, endpoint: str = AARDBEI_ENDPOINT
+) -> Union[List[SparseAardbeiActivity], AardbeiSyncError]:
+    """
+    Get the list of activities present on the remote and return these
+    activities, ordered by the temporal distance to the current time.
+    """
+
     result: List[SparseAardbeiActivity] = []
 
     for category in ("upcoming", "current", "previous"):
+        try:
+            resp = requests.get(
+                f"{endpoint}/api/groups/0/{category}_activities",
+                headers={"Authorization": f"Group {token}"},
+            )
+
+            resp.raise_for_status()
+
+        except requests.HTTPError as e:
+            log.exception(e)
+            return AardbeiSyncError.HTTPError
+
+        except requests.ConnectionError as e:
+            log.exception(e)
+            return AardbeiSyncError.CantConnect
+
+        for item in resp.json():
+            result.append(SparseAardbeiActivity.from_aardbei_dict(item))
+
+    now = datetime.datetime.now()
+    result.sort(key=lambda x: SparseAardbeiActivity.distance(x, now))
+    return result
+
+
+def get_activity(
+    activity_id: ActivityId, token: str, endpoint: str
+) -> Union[AardbeiActivity, AardbeiSyncError]:
+    """
+    Get all data (including participants) from the remote about one activity
+    with a given ID.
+    """
+
+    try:
         resp = requests.get(
-            f"{AARDBEI_ENDPOINT}/api/groups/0/{category}_activities",
+            f"{endpoint}/api/activities/{activity_id}",
             headers={"Authorization": f"Group {token}"},
         )
 
         resp.raise_for_status()
 
-        for item in resp.json():
-            result.append(SparseAardbeiActivity.from_aardbei_dict(item))
+    except requests.HTTPError as e:
+        log.exception(e)
+        return AardbeiSyncError.HTTPError
 
-    return result
+    except requests.ConnectionError as e:
+        return AardbeiSyncError.CantConnect
+
+    return AardbeiActivity.from_aardbei_dict(resp.json())
+
+
+def match_activity(activity: AardbeiActivity) -> None:
+    """
+    Update the local state to have mark all people present at the given
+    activity as active, and all other people as inactive.
+    """
+    ps = activity.participants
+    pids: List[PersonId] = [p.person.aardbei_id for p in ps]
+
+    Person.query.update(values={"active": False})
+    Person.query.filter(Person.aardbei_id.in_(pids)).update(
+        values={"active": True}, synchronize_session="fetch"
+    )
 
 
 if __name__ == "__main__":
@@ -349,8 +653,19 @@ if __name__ == "__main__":
 
     token = input("Token: ")
     aardbei_people = get_aardbei_people(token)
+
+    if isinstance(aardbei_people, AardbeiSyncError):
+        logging.error("Could not get people: %s", aardbei_people.value)
+        sys.exit(1)
+
     activities = get_activities(token)
+
+    if isinstance(activities, AardbeiSyncError):
+        logging.error("Could not get activities: %s", activities.value)
+        sys.exit(1)
+
     link = match_local_aardbei(aardbei_people)
+
     link_matches(link.matches)
     create_missing(link.remote_only)
     update_names(link.altered_name)

piket_server/alembic/env.py

@@ -12,26 +12,24 @@ config = context.config
 # This line sets up loggers basically.
 fileConfig(config.config_file_name)
 
-# add your model's MetaData object here
-# for 'autogenerate' support
-# from myapp import mymodel
-# target_metadata = mymodel.Base.metadata
-import piket_server
-
-target_metadata = piket_server.db.Model.metadata
-
 # other values from the config, defined by the needs of env.py,
 # can be acquired:
 # my_important_option = config.get_main_option("my_important_option")
 # ... etc.
-from piket_server import CONFIG_DIR, DB_URL
+from piket_server.flask import CONFIG_DIR, DB_URL, db
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = db.Model.metadata
 
 os.makedirs(os.path.expanduser(CONFIG_DIR), mode=0o744, exist_ok=True)
 
 config.file_config["alembic"]["sqlalchemy.url"] = DB_URL
 
 
-def run_migrations_offline():
+def run_migrations_offline() -> None:
     """Run migrations in 'offline' mode.
 
     This configures the context with just a URL
@@ -50,7 +48,7 @@ def run_migrations_offline():
         context.run_migrations()
 
 
-def run_migrations_online():
+def run_migrations_online() -> None:
     """Run migrations in 'online' mode.
 
     In this scenario we need to create an Engine

piket_server/routes/aardbei.py

@@ -0,0 +1,121 @@
+from typing import Any, Dict, List, Tuple, Union
+
+from flask import request
+
+from piket_server.aardbei_sync import (
+    AARDBEI_ENDPOINT,
+    ActivityId,
+    get_activity,
+    AardbeiLink,
+    AardbeiSyncError,
+    create_missing,
+    get_aardbei_people,
+    match_activity,
+    get_activities,
+    link_matches,
+    match_local_aardbei,
+    update_names,
+)
+from piket_server.flask import app, db
+
+
+def common_prepare_aardbei_sync(
+    token: str, endpoint: str
+) -> Union[AardbeiSyncError, AardbeiLink]:
+    aardbei_people = get_aardbei_people(token, endpoint)
+
+    if isinstance(aardbei_people, AardbeiSyncError):
+        return aardbei_people
+
+    aardbei_activities = get_activities(token, endpoint)
+
+    if isinstance(aardbei_activities, AardbeiSyncError):
+        return aardbei_activities
+
+    return match_local_aardbei(aardbei_people)
+
+
+@app.route("/people/aardbei_diff", methods=["POST"])
+def aardbei_diff() -> Tuple[Dict[str, Any], int]:
+    data: Dict[str, str] = request.json
+    link = common_prepare_aardbei_sync(
+        data["token"], data.get("endpoint", AARDBEI_ENDPOINT)
+    )
+
+    if isinstance(link, AardbeiSyncError):
+        return {"error": link.value}, 503
+
+    return (
+        {
+            "num_changes": link.num_changes,
+            "new_people": [member.person.full_name for member in link.remote_only],
+            "link_existing": [match.local.name for match in link.matches],
+            "altered_name": [match.local.name for match in link.matches],
+        },
+        200,
+    )
+
+
+@app.route("/people/aardbei_apply", methods=["POST"])
+def aardbei_apply() -> Union[Tuple[Dict[str, Any], int]]:
+    data: Dict[str, str] = request.json
+    link = common_prepare_aardbei_sync(
+        data["token"], data.get("endpoint", AARDBEI_ENDPOINT)
+    )
+
+    if isinstance(link, AardbeiSyncError):
+        return {"error": link.value}, 503
+
+    link_matches(link.matches)
+    create_missing(link.remote_only)
+    update_names(link.altered_name)
+
+    db.session.commit()
+
+    return (
+        {
+            "num_changes": link.num_changes,
+            "new_people": [member.person.full_name for member in link.remote_only],
+            "link_existing": [match.local.name for match in link.matches],
+            "altered_name": [match.local.name for match in link.matches],
+        },
+        200,
+    )
+
+
+@app.route("/aardbei/get_activities", methods=["POST"])
+def aardbei_get_activities() -> Tuple[Dict[str, object], int]:
+    data: Dict[str, str] = request.json
+    activities = get_activities(data["token"], data.get("endpoint", AARDBEI_ENDPOINT))
+
+    if isinstance(activities, AardbeiSyncError):
+        return {"error": activities.value}, 503
+
+    return {"activities": [x.as_json_dict for x in activities]}, 200
+
+
+@app.route("/aardbei/apply_activity", methods=["POST"])
+def aardbei_apply_activity() -> Tuple[Dict[str, Any], int]:
+    data: Dict[str, Union[str, int]] = request.json
+    aid = data["activity_id"]
+    token = data["token"]
+    endpoint = data["endpoint"]
+
+    if not isinstance(aid, int):
+        return {"error": "nonnumeric_activity_id"}, 400
+
+    if not isinstance(token, str):
+        return {"error": "illtyped_token"}, 400
+
+    if not isinstance(endpoint, str):
+        return {"error": "illtyped_endpoint"}, 400
+
+    activity = get_activity(activity_id=ActivityId(aid), token=token, endpoint=endpoint)
+
+    if isinstance(activity, AardbeiSyncError):
+        return {"error": activity.value}, 503
+
+    match_activity(activity)
+    db.session.commit()
+
+    return (activity.as_json_dict, 200)

piket_server/util.py

@@ -0,0 +1,10 @@
+import datetime
+from typing import Optional
+
+
+def fmt_datetime(x: Optional[datetime.datetime]) -> Optional[str]:
+    """Format a datetime as ISO 8601, if it's not None."""
+    if x is not None:
+        return x.isoformat()
+
+    return None