Feature/ch4527-32/sdk-updates-for-dashboard2 (#50)

* added clientID to sso.py params

* use clientID in __init__.py, updated values in sso.py, tests, and README for sdk

* added environment_id to object field of event_action.py

* removed project_id from object field in event_action.py

* update test fixtures to use environment_id instead of project_id

* removed project_id environment variable from __init__.py

* improving client_id test fixtures after merging feature/ch4528/python-use-client-id-in-init-py

* fixing tests

* fixed formatting errors with black

* re-ran black with black==19.10b0 instead of latest version to match with semaphore

* requested changes made

* requested changes to sso.py

* requested changes made, falling back to project_id with deprecation

Author: loferris

README.md

@@ -16,12 +16,12 @@ python setup.py install
 
 ## Getting Started
 
-The package will need to be configured with your [api key](https://dashboard.workos.com/api-keys) at a minimum and [project id](https://dashboard.workos.com/sso/configuration) if you plan on utilizing SSO:
+The package will need to be configured with your [api key](https://dashboard.workos.com/api-keys) at a minimum and [client id](https://dashboard.workos.com/sso/configuration) if you plan on utilizing SSO:
 ```python
 import workos
 
 workos.api_key = sk_abdsomecharactersm284
-workos.project_id = project_b27needthisforssotemxo
+workos.client_id = client_b27needthisforssotemxo
 ```
 
 For your convenience, a client is available as an entry point for accessing the WorkOS feature set:

tests/conftest.py

@@ -19,11 +19,21 @@ def set_api_key(monkeypatch):
     monkeypatch.setattr(workos, "api_key", "sk_abdsomecharactersm284")
 
 
+@pytest.fixture
+def set_client_id(monkeypatch):
+    monkeypatch.setattr(workos, "client_id", "client_b27needthisforssotemxo")
+
+
 @pytest.fixture
 def set_project_id(monkeypatch):
     monkeypatch.setattr(workos, "project_id", "project_b27needthisforssotemxo")
 
 
+@pytest.fixture
+def set_api_key_and_client_id(set_api_key, set_client_id):
+    pass
+
+
 @pytest.fixture
 def set_api_key_and_project_id(set_api_key, set_project_id):
     pass

tests/test_audit_trail.py

@@ -10,7 +10,7 @@
 
 class TestAuditTrail(object):
     @pytest.fixture(autouse=True)
-    def setup(self, set_api_key_and_project_id):
+    def setup(self, set_api_key):
         self.audit_trail = AuditTrail()
 
     def test_create_audit_trail_event_succeeds(self, mock_request_method):
@@ -60,7 +60,7 @@ def test_get_events_succeeds(self, mock_request_method):
             "action": {
                 "id": "evt_action_123",
                 "name": "house.created",
-                "project_id": "project_123",
+                "environment_id": "environment_123",
             },
             "type": "C",
             "actor_name": "Daiki Miyagi",
@@ -92,7 +92,7 @@ def test_get_events_correctly_includes_occured_at_filter(
             "action": {
                 "id": "evt_action_123",
                 "name": "house.created",
-                "project_id": "project_123",
+                "environment_id": "environment_123",
             },
             "type": "C",
             "actor_name": "Daiki Miyagi",
@@ -136,7 +136,7 @@ def test_get_events_correctly_includes_occurred_at_gte(
             "action": {
                 "id": "evt_action_123",
                 "name": "house.created",
-                "project_id": "project_123",
+                "environment_id": "environment_123",
             },
             "type": "C",
             "actor_name": "Daiki Miyagi",
@@ -173,7 +173,7 @@ def test_get_events_correctly_includes_occured_at_lte(
             "action": {
                 "id": "evt_action_123",
                 "name": "house.created",
-                "project_id": "project_123",
+                "environment_id": "environment_123",
             },
             "type": "C",
             "actor_name": "Daiki Miyagi",

tests/test_client.py

@@ -16,7 +16,7 @@ def setup(self):
     def test_initialize_sso(self, set_api_key_and_project_id):
         assert bool(client.sso)
 
-    def test_initialize_audit_log(self, set_api_key_and_project_id):
+    def test_initialize_audit_log(self, set_api_key):
         assert bool(client.audit_trail)
 
     def test_initialize_directory_sync(self, set_api_key):
@@ -37,7 +37,7 @@ def test_initialize_sso_missing_api_key(self, set_project_id):
         assert "api_key" in message
         assert "project_id" not in message
 
-    def test_initialize_sso_missing_project_id(self, set_api_key):
+    def test_initialize_sso_missing_client_id(self, set_api_key):
         with pytest.raises(ConfigurationException) as ex:
             client.sso
 

workos/__init__.py

@@ -5,4 +5,5 @@
 
 api_key = os.getenv("WORKOS_API_KEY")
 project_id = os.getenv("WORKOS_PROJECT_ID")
+client_id = os.getenv("WORKOS_CLIENT_ID")
 base_api_url = "https://api.workos.com/"

workos/audit_trail.py

@@ -28,13 +28,13 @@ def create_event(self, event, idempotency_key=None):
         Args:
             event (dict) - An event object
                 event[action] (str) - Specific activity performed by the actor.
-                event[action_type] (str) - Corresponding CRUD category of the 
+                event[action_type] (str) - Corresponding CRUD category of the
                     event. Can be one of C, R, U, or D.
                 event[actor_name] (str) - Display name of the entity performing the action
                 event[actor_id] (str) - Unique identifier of the entity performing the action
                 event[group] (str) - A single organization containing related .
                     members. This will normally be the customer of a vendor's application
-                event[location] (str) - Identifier for where the event 
+                event[location] (str) - Identifier for where the event
                     originated. This will be an IP address (IPv4 or IPv6),
                     hostname, or device ID.
                 event[occurred_at] (str) - ISO-8601 datetime at which the event

workos/resources/base.py

@@ -1,6 +1,6 @@
 class WorkOSBaseResource(object):
     """Representation of a WorkOS Resource as returned through the API.
-    
+
     Attributes:
         OBJECT_FIELDS (list): List of fields a Resource is comprised of.
     """
@@ -25,7 +25,7 @@ def construct_from_response(cls, response):
 
     def to_dict(self):
         """Returns a dict representation of the WorkOSBaseResource.
-            
+
         Returns:
             dict: A dict representation of the WorkOSBaseResource
         """

workos/resources/event.py

@@ -4,7 +4,7 @@
 
 class WorkOSEvent(WorkOSBaseResource):
     """Representation of an Event as returned by WorkOS through the Audit Trail feature.
-    
+
     Attributes:
         OBJECT_FIELDS (list): List of fields a WorkOSEvent is comprised of.
     """

workos/resources/event_action.py

@@ -3,13 +3,9 @@
 
 class WorkOSEventAction(WorkOSBaseResource):
     """Representation of an Event Action as returned by WorkOS through the Audit Trail feature.
-    
+
     Attributes:
         OBJECT_FIELDS (list): List of fields a WorkOSEventAction is comprised of.
     """
 
-    OBJECT_FIELDS = [
-        "id",
-        "name",
-        "project_id",
-    ]
+    OBJECT_FIELDS = ["id", "name", "environment_id"]

workos/sso.py

@@ -50,7 +50,7 @@ def get_authorization_url(
             str: URL to redirect a User to to begin the OAuth workflow with WorkOS
         """
         params = {
-            "client_id": workos.project_id,
+            "client_id": workos.client_id,
             "redirect_uri": redirect_uri,
             "response_type": RESPONSE_TYPE_CODE,
         }
@@ -69,6 +69,13 @@ def get_authorization_url(
         if state is not None:
             params["state"] = state
 
+        if workos.project_id is not None:
+            params["client_id"] = workos.project_id
+            warn(
+                "'project_id' is deprecated. Use 'client_id' instead.",
+                DeprecationWarning,
+            )
+
         prepared_request = Request(
             "GET",
             self.request_helper.generate_api_url(AUTHORIZATION_PATH),
@@ -90,12 +97,19 @@ def get_profile(self, code):
             WorkOSProfile: WorkOSProfile object representing the User
         """
         params = {
-            "client_id": workos.project_id,
+            "client_id": workos.client_id,
             "client_secret": workos.api_key,
             "code": code,
             "grant_type": OAUTH_GRANT_TYPE,
         }
 
+        if workos.project_id is not None:
+            params["client_id"] = workos.project_id
+            warn(
+                "'project_id' is deprecated. Use 'client_id' instead.",
+                DeprecationWarning,
+            )
+
         response = self.request_helper.request(
             TOKEN_PATH, method=REQUEST_METHOD_POST, params=params
         )
@@ -109,7 +123,7 @@ def promote_draft_connection(self, token):
         been promoted will enable Enterprise users of the domain to begin signing in via SSO.
 
         Args:
-            token (str): The token supplied via the response when a draft connection is created via 
+            token (str): The token supplied via the response when a draft connection is created via
             the WorkOS.js embed
 
         Returns: