Merge pull request #99 from oslokommune/262-team-by-name

T#262 Add `TeamClient.get_team_by_name`

Author: simenheg

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## ?.?.?
 
+* New method `TeamClient.get_team_by_name`.
 * Fixed a deprecation warning from urllib3.
 
 ## 2.0.0

okdata/sdk/team/client.py

@@ -31,3 +31,9 @@ def get_team(self, team_id):
         url = "{}/teams/{}".format(self.api_url, quote(team_id))
         log.info(f"SDK:Getting team from: {url}")
         return self.get(url).json()
+
+    def get_team_by_name(self, team_name):
+        """Return details for a team by name."""
+        url = "{}/teams/name/{}".format(self.api_url, quote(team_name))
+        log.info(f"SDK:Getting team from: {url}")
+        return self.get(url).json()

tests/team/test_client.py

@@ -25,3 +25,15 @@ def test_get_team(requests_mock):
         status_code=200,
     )
     assert TeamClient().get_team(team_id) == team
+
+
+def test_get_team_by_name(requests_mock):
+    team_name = "Foo"
+    team = {"team_id": "abc", "name": team_name}
+    requests_mock.register_uri(
+        "GET",
+        re.compile(f"teams/name/{team_name}"),
+        text=json.dumps(team),
+        status_code=200,
+    )
+    assert TeamClient().get_team_by_name(team_name) == team