Merge pull request #106 from oslokommune/299-update-team-members

T#299 Add method for updating team members

Author: Petter H. Juliussen

CHANGELOG.md

@@ -1,3 +1,9 @@
+## ?.?.?
+
+* New method `TeamClient.get_user_by_username` for looking up Keycloak users.
+* New method `TeamClient.update_team_members` for adding and/or removing
+  members to/from a team.
+
 ## 2.2.1
 
 * Fixed a bug in `TeamClient.update_team_attribute` when `value` is falsy.

okdata/sdk/team/client.py

@@ -67,3 +67,15 @@ def update_team_attribute(self, team_id, attribute, value):
         return self.patch(
             url, {"attributes": {attribute: [value] if value else []}}
         ).json()
+
+    def update_team_members(self, team_id, usernames):
+        """Update members of a team and return the resulting member list."""
+        url = "{}/teams/{}/members".format(self.api_url, quote(team_id))
+        log.info(f"SDK:Updating team members: {url}")
+        return self.put(url, usernames).json()
+
+    def get_user_by_username(self, username):
+        """Search Keycloak user by `username`."""
+        url = "{}/teams/users/{}".format(self.api_url, quote(username))
+        log.info(f"SDK:Searching user: {url}")
+        return self.get(url).json()

tests/team/test_client.py

@@ -77,3 +77,30 @@ def test_update_team_attribute(requests_mock):
         status_code=200,
     )
     assert TeamClient().update_team_attribute(team_id, "a", "b") == team
+
+
+def test_update_team_members(requests_mock):
+    team_id = "abc"
+    members = [
+        {"name": "Foo", "username": "foo"},
+        {"name": "Bar", "username": "bar"},
+    ]
+    requests_mock.register_uri(
+        "PUT",
+        re.compile(f"teams/{team_id}/members"),
+        text=json.dumps(members),
+        status_code=200,
+    )
+    assert TeamClient().update_team_members(team_id, ["foo", "bar"]) == members
+
+
+def test_get_user_by_username(requests_mock):
+    username = "foo"
+    member = {"name": "Foo", "username": username}
+    requests_mock.register_uri(
+        "GET",
+        re.compile(f"teams/users/{username}"),
+        text=json.dumps(member),
+        status_code=200,
+    )
+    assert TeamClient().get_user_by_username("foo") == member