Add Portal module with list_organizations function (#37)

* Returns a list of the organizations accessible to the provided
  API key. Includes pagination functionality via the list_metadata
  property.

Author: willmanduffy

tests/test_client.py

@@ -9,6 +9,7 @@ class TestClient(object):
     def setup(self):
         client._audit_trail = None
         client._directory_sync = None
+        client._portal = None
         client._sso = None
 
     def test_initialize_sso(self, set_api_key_and_project_id):
@@ -20,6 +21,9 @@ def test_initialize_audit_log(self, set_api_key_and_project_id):
     def test_initialize_directory_sync(self, set_api_key):
         assert bool(client.directory_sync)
 
+    def test_initialize_portal(self, set_api_key):
+        assert bool(client.portal)
+
     def test_initialize_sso_missing_api_key(self, set_project_id):
         with pytest.raises(ConfigurationException) as ex:
             client.sso
@@ -61,3 +65,11 @@ def test_initialize_directory_sync_missing_api_key(self):
         message = str(ex)
 
         assert "api_key" in message
+
+    def test_initialize_portal_missing_api_key(self):
+        with pytest.raises(ConfigurationException) as ex:
+            client.portal
+
+        message = str(ex)
+
+        assert "api_key" in message

tests/test_directory_sync.py

@@ -8,7 +8,7 @@
 from workos.utils.request import RESPONSE_TYPE_CODE
 
 
-class TestSSO(object):
+class TestDirectorySync(object):
     @pytest.fixture(autouse=True)
     def setup(self, set_api_key):
         self.directory_sync = DirectorySync()

tests/test_portal.py

@@ -0,0 +1,55 @@
+import json
+from requests import Response
+
+import pytest
+
+import workos
+from workos.portal import Portal
+
+
+class TestPortal(object):
+    @pytest.fixture(autouse=True)
+    def setup(self, set_api_key):
+        self.portal = Portal()
+
+    @pytest.fixture
+    def mock_organizations(self):
+        return {
+            "object": "list",
+            "data": [
+                {
+                    "object": "organization",
+                    "id": "org_01EHQMYV6MBK39QC5PZXHY59C3",
+                    "name": "example.com",
+                    "domains": [
+                        {
+                            "object": "organization_domain",
+                            "id": "org_domain_01EHQMYV71XT8H31WE5HF8YK4A",
+                            "domain": "example.com",
+                        }
+                    ],
+                },
+                {
+                    "object": "organization",
+                    "id": "org_01EHQMVDTC2GRAHFCCRNTSKH46",
+                    "name": "example2.com",
+                    "domains": [
+                        {
+                            "object": "organization_domain",
+                            "id": "org_domain_01EHQMVDTZVA27PK614ME4YK7V",
+                            "domain": "example2.com",
+                        }
+                    ],
+                },
+            ],
+            "listMetadata": {"before": "before-id", "after": None},
+        }
+
+    def test_list_organizations(self, mock_organizations, mock_request_method):
+        mock_response = Response()
+        mock_response.status_code = 200
+        mock_response.response_dict = mock_organizations
+        mock_request_method("get", mock_response, 200)
+        response = self.portal.list_organizations()
+        assert response.status_code == 200
+        assert len(response.response_dict["data"]) == 2

workos/client.py

@@ -1,5 +1,6 @@
 from workos.audit_trail import AuditTrail
 from workos.directory_sync import DirectorySync
+from workos.portal import Portal
 from workos.sso import SSO
 
 
@@ -24,5 +25,11 @@ def directory_sync(self):
             self._directory_sync = DirectorySync()
         return self._directory_sync
 
+    @property
+    def portal(self):
+        if not getattr(self, "_portal", None):
+            self._portal = Portal()
+        return self._portal
+
 
 client = Client()

workos/portal.py

@@ -0,0 +1,44 @@
+import workos
+from workos.utils.request import RequestHelper, REQUEST_METHOD_GET
+from workos.utils.validation import PORTAL_MODULE, validate_settings
+
+RESPONSE_LIMIT = 10
+
+
+class Portal(object):
+    @validate_settings(PORTAL_MODULE)
+    def __init__(self):
+        pass
+
+    @property
+    def request_helper(self):
+        if not getattr(self, "_request_helper", None):
+            self._request_helper = RequestHelper()
+        return self._request_helper
+
+    def list_organizations(
+        self, domains=None, limit=RESPONSE_LIMIT, before=None, after=None
+    ):
+        """Retrieve a list of organizations that have connections configured within your WorkOS dashboard.
+
+        Kwargs:
+            domains (list): Filter organizations to only return those that are associated with the provided domains. (Optional)
+            limit (int): Maximum number of records to return. (Optional)
+            before (str): Pagination cursor to receive records before a provided Organization ID. (Optional)
+            after (str): Pagination cursor to receive records after a provided Organization ID. (Optional)
+
+        Returns:
+            dict: Organizations response from WorkOS.
+        """
+        params = {
+            "domains": domains,
+            "limit": limit,
+            "before": before,
+            "after": after,
+        }
+        return self.request_helper.request(
+            "organizations",
+            method=REQUEST_METHOD_GET,
+            params=params,
+            token=workos.api_key,
+        )

workos/utils/validation.py

@@ -5,11 +5,13 @@
 
 AUDIT_TRAIL_MODULE = "AuditTrail"
 DIRECTORY_SYNC_MODULE = "DirectorySync"
+PORTAL_MODULE = "Portal"
 SSO_MODULE = "SSO"
 
 REQUIRED_SETTINGS_FOR_MODULE = {
     AUDIT_TRAIL_MODULE: ["api_key",],
     DIRECTORY_SYNC_MODULE: ["api_key",],
+    PORTAL_MODULE: ["api_key",],
     SSO_MODULE: ["api_key", "project_id",],
 }