add teamMembershipStatus dataclass

Author: Lingling Peng

synapseclient/models/__init__.py

@@ -34,7 +34,7 @@
     TableUpdateTransaction,
     UploadToTableRequest,
 )
-from synapseclient.models.team import Team, TeamMember
+from synapseclient.models.team import Team, TeamMember, TeamMembershipStatus
 from synapseclient.models.user import UserGroupHeader, UserPreference, UserProfile
 from synapseclient.models.virtualtable import VirtualTable
 
@@ -50,6 +50,7 @@
     "Annotations",
     "Team",
     "TeamMember",
+    "TeamMembershipStatus",
     "UserProfile",
     "UserPreference",
     "UserGroupHeader",

synapseclient/models/protocols/team_protocol.py

@@ -6,7 +6,7 @@
 from synapseclient import Synapse
 
 if TYPE_CHECKING:
-    from synapseclient.models import Team, TeamMember
+    from synapseclient.models import Team, TeamMember, TeamMembershipStatus
 
 
 class TeamSynchronousProtocol(Protocol):
@@ -166,7 +166,7 @@ def get_user_membership_status(
         team: Union[int, str],
         *,
         synapse_client: Optional[Synapse] = None,
-    ) -> Dict[str, str]:
+    ) -> "TeamMembershipStatus":
         """Retrieve a user's Team Membership Status bundle.
 
         <https://rest-docs.synapse.org/rest/GET/team/id/member/principalId/membershipStatus.html>
@@ -179,6 +179,8 @@ def get_user_membership_status(
                 instance from the Synapse class constructor.
 
         Returns:
-            A dictionary of TeamMembershipStatus
+            TeamMembershipStatus object
         """
-        return {}
+        from synapseclient.models.team import TeamMembershipStatus
+
+        return TeamMembershipStatus().fill_from_dict({})

synapseclient/models/team.py

@@ -57,6 +57,79 @@ def fill_from_dict(
         return self
 
 
+@dataclass
+class TeamMembershipStatus:
+    """
+    Contains information about a user's membership status in a Team.
+    In practice the constructor is not called directly by the client.
+
+    Attributes:
+        team_id: The synapse ID of the team
+        user_id: The synapse ID of the user
+        is_member: Whether the user is a member of the team
+        has_open_invitation: Whether the user has an open invitation to join the team
+        has_open_request: Whether the user has an open request to join the team
+        can_join: Whether the user can join the team
+        membership_approval_required: Whether membership approval is required for the team
+        has_unmet_access_requirement: Whether the user has unmet access requirements
+        can_send_email: Whether the user can send email to the team
+    """
+
+    team_id: Optional[str] = None
+    """The ID of the team"""
+
+    user_id: Optional[str] = None
+    """The ID of the user"""
+
+    is_member: Optional[bool] = None
+    """Whether the user is a member of the team"""
+
+    has_open_invitation: Optional[bool] = None
+    """Whether the user has an open invitation to join the team"""
+
+    has_open_request: Optional[bool] = None
+    """Whether the user has an open request to join the team"""
+
+    can_join: Optional[bool] = None
+    """Whether the user can join the team"""
+
+    membership_approval_required: Optional[bool] = None
+    """Whether membership approval is required for the team"""
+
+    has_unmet_access_requirement: Optional[bool] = None
+    """Whether the user has unmet access requirements"""
+
+    can_send_email: Optional[bool] = None
+    """Whether the user can send email to the team"""
+
+    def fill_from_dict(
+        self, membership_status_dict: Dict[str, Union[str, bool]]
+    ) -> "TeamMembershipStatus":
+        """
+        Converts a response from the REST API into this dataclass.
+
+        Arguments:
+            membership_status_dict: The response from the REST API.
+
+        Returns:
+            The TeamMembershipStatus object.
+        """
+        self.team_id = membership_status_dict.get("teamId", None)
+        self.user_id = membership_status_dict.get("userId", None)
+        self.is_member = membership_status_dict.get("isMember", None)
+        self.has_open_invitation = membership_status_dict.get("hasOpenInvitation", None)
+        self.has_open_request = membership_status_dict.get("hasOpenRequest", None)
+        self.can_join = membership_status_dict.get("canJoin", None)
+        self.membership_approval_required = membership_status_dict.get(
+            "membershipApprovalRequired", None
+        )
+        self.has_unmet_access_requirement = membership_status_dict.get(
+            "hasUnmetAccessRequirement", None
+        )
+        self.can_send_email = membership_status_dict.get("canSendEmail", None)
+        return self
+
+
 @dataclass
 @async_to_sync
 class Team(TeamSynchronousProtocol):
@@ -364,7 +437,7 @@ async def get_user_membership_status_async(
         team: Union[str, int],
         *,
         synapse_client: Optional[Synapse] = None,
-    ) -> str:
+    ) -> TeamMembershipStatus:
         """Retrieve a user's Team Membership Status bundle for this team.
 
         Arguments:
@@ -375,12 +448,12 @@ async def get_user_membership_status_async(
                 instance from the Synapse class constructor.
 
         Returns:
-            A dictionary of TeamMembershipStatus
+            TeamMembershipStatus object
         """
         from synapseclient import Synapse
 
         client = Synapse.get_client(synapse_client=synapse_client)
         status = await get_membership_status(
             user_id=user_id, team=team, synapse_client=client
         )
-        return status
+        return TeamMembershipStatus().fill_from_dict(status)

tests/integration/synapseclient/models/async/test_team_async.py

@@ -157,11 +157,8 @@ async def test_get_user_membership_status(self) -> None:
 
             # THEN the creator should have membership status indicating they are a member
             assert creator_status is not None
-            assert "teamId" in creator_status
-            assert creator_status["teamId"] == str(test_team.id)
-            assert "userId" in creator_status
-            assert "isMember" in creator_status
-            assert creator_status["isMember"] is True
+            assert creator_status.team_id == str(test_team.id)
+            assert creator_status.is_member is True
 
             # WHEN I invite a test user to the team
             invite = await test_team.invite_async(
@@ -177,11 +174,11 @@ async def test_get_user_membership_status(self) -> None:
 
             # THEN the invited user should show they have an open invitation
             assert invited_status is not None
-            assert invited_status["teamId"] == str(test_team.id)
-            assert invited_status["hasOpenInvitation"] is True
-            assert invited_status["membershipApprovalRequired"] is True
-            assert invited_status["canSendEmail"] is True
-            assert invited_status["isMember"] is False
+            assert invited_status.team_id == str(test_team.id)
+            assert invited_status.has_open_invitation is True
+            assert invited_status.membership_approval_required is True
+            assert invited_status.can_send_email is True
+            assert invited_status.is_member is False
 
         finally:
             # Clean up

tests/unit/synapseclient/models/synchronous/unit_test_team.py

@@ -5,7 +5,7 @@
 import pytest
 
 from synapseclient import Synapse
-from synapseclient.models.team import Team, TeamMember
+from synapseclient.models.team import Team, TeamMember, TeamMembershipStatus
 from synapseclient.models.user import UserGroupHeader
 
 
@@ -25,6 +25,38 @@ def test_fill_from_dict(self) -> None:
         assert team_member.is_admin is True
 
 
+class TestTeamMembershipStatus:
+    """Tests for the TeamMembershipStatus class."""
+
+    def test_fill_from_dict(self) -> None:
+        # GIVEN a blank TeamMembershipStatus
+        status = TeamMembershipStatus()
+        # WHEN I fill it with a dictionary
+        status.fill_from_dict(
+            {
+                "teamId": "123",
+                "userId": "456",
+                "isMember": False,
+                "hasOpenInvitation": True,
+                "hasOpenRequest": False,
+                "canJoin": False,
+                "membershipApprovalRequired": True,
+                "hasUnmetAccessRequirement": False,
+                "canSendEmail": True,
+            }
+        )
+        # THEN I expect all fields to be set
+        assert status.team_id == "123"
+        assert status.user_id == "456"
+        assert status.is_member is False
+        assert status.has_open_invitation is True
+        assert status.has_open_request is False
+        assert status.can_join is False
+        assert status.membership_approval_required is True
+        assert status.has_unmet_access_requirement is False
+        assert status.can_send_email is True
+
+
 class TestTeam:
     """Tests for the Team class."""