Add support for /users endpoint

Author: eloquence

data/test-get-users.yml

@@ -0,0 +1,36 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      Authorization:
+      - Token eyJleHAiOjE2MDIxNDYxMDIsImFsZyI6IkhTMjU2IiwiaWF0IjoxNjAyMTE3MzAyfQ.eyJpZCI6MX0.z7UGeKx0191qRhU97f0bJJDuY4y4fJi9njDGD0OXrpA
+      Connection:
+      - keep-alive
+      Content-Type:
+      - application/json
+      User-Agent:
+      - python-requests/2.22.0
+    method: GET
+    uri: http://127.0.0.1:8081/api/v1/users
+  response:
+    body:
+      string: '{"users":[{"first_name":"","last_name":"","username":"journalist","uuid":"0a5db1b6-a003-4aa9-812b-53c6abbf1124"},{"first_name":"","last_name":"","username":"dellsberg","uuid":"3325fde8-a339-4847-aa3e-d2be412fbaf7"}]}
+
+        '
+    headers:
+      Content-Length:
+      - '217'
+      Content-Type:
+      - application/json
+      Date:
+      - Thu, 08 Oct 2020 00:35:02 GMT
+      Server:
+      - Werkzeug/0.16.0 Python/3.5.2
+    status:
+      code: 200
+      message: OK
+version: 1

sdclientapi/__init__.py

@@ -17,6 +17,7 @@
     ReplyError,
     Source,
     Submission,
+    User,
     WrongUUIDError,
 )
 
@@ -598,6 +599,29 @@ def get_current_user(self) -> Any:
 
         return data
 
+    def get_users(self) -> List[User]:
+        """
+        Returns a list of all the journalist and admin users registered on the
+        server.
+
+        :returns: List of User objects.
+        """
+        path_query = "api/v1/users"
+        method = "GET"
+
+        data, status_code, headers = self._send_json_request(
+            method, path_query, headers=self.req_headers, timeout=self.default_request_timeout,
+        )
+
+        users = data["users"]
+        result = []  # type: List[User]
+
+        for user in users:
+            u = User(**user)
+            result.append(u)
+
+        return result
+
     def reply_source(self, source: Source, msg: str, reply_uuid: Optional[str] = None) -> Reply:
         """
         This method is used to reply to a given source. The message should be preencrypted with the

sdclientapi/sdlocalobjects.py

@@ -177,3 +177,26 @@ def __init__(self, **kwargs) -> None:  # type: ignore
             if key not in kwargs:
                 AttributeError("Missing key {}".format(key))
             setattr(self, key, kwargs[key])
+
+
+class User:
+    """
+    This class represents a user (journalist or admin) of the Journalist
+    Interface.
+    """
+
+    def __init__(self, **kwargs) -> None:  # type: ignore
+        self.first_name = ""  # type: str
+        self.last_name = ""  # type: str
+        self.username = ""  # type: str
+        self.uuid = ""  # type: str
+
+        for key in [
+            "first_name",
+            "last_name",
+            "username",
+            "uuid",
+        ]:
+            if key not in kwargs:
+                AttributeError("Missing key {}".format(key))
+            setattr(self, key, kwargs[key])

tests/test_api.py

@@ -224,6 +224,20 @@ def test_get_current_user(self):
         self.assertTrue("first_name" in user)
         self.assertTrue("last_name" in user)
 
+    @vcr.use_cassette("data/test-get-users.yml")
+    def test_get_users(self):
+        users = self.api.get_users()
+        for user in users:
+            # Assert expected fields are present
+            assert hasattr(user, "first_name")
+            assert hasattr(user, "last_name")
+            # Every user has a non-empty name and UUID
+            assert user.username
+            assert user.uuid
+            # The API should never return these fields
+            assert not hasattr(user, "last_login")
+            assert not hasattr(user, "is_admin")
+
     @vcr.use_cassette("data/test-error-unencrypted-reply.yml")
     def test_error_unencrypted_reply(self):
         s = self.api.get_sources()[0]