Setting organization id in the request headers (#198)

feat: All API requests will now pass the organization context as a request header

Author: ramu-phanimukla

CHANGELOG.rst

@@ -13,6 +13,7 @@ Added
   `submit` and `projects`.
 - Deprecation warning for existing `-i` option for `projects` command.
 - Binder build cache step
+- All API requests will now pass the organization context as a request header
 
 Fixed
 ~~~~~

README.rst

@@ -59,7 +59,7 @@ edge:
 
 .. code-block:: bash
 
-   git clone https://github.com/transcriptic/transcriptic.git
+   git clone https://github.com/strateos/transcriptic.git
    cd transcriptic
    pip install .[jupyter,analysis]
 
@@ -110,7 +110,7 @@ CLI
 ~~~
 
 See the `Transcriptic Developer
-Documentation <https://developers.transcriptic.com/docs/getting-started-with-the-cli>`__
+Documentation <https://developers.strateos.com/docs/getting-started-with-the-cli>`__
 for detailed information about how to use this package, including
 learning about how to package protocols and build releases.
 

test/config_test.py

@@ -92,6 +92,12 @@ def test_aliquot_modify(self):
             "https://fake.transcriptic.com/api/aliquots/23534245/modify_properties",
             json={"id": aliquot_id, "data": {"delete": [], "set": props}},
         )
+        self.assertTrue(
+            session.headers.get("X-Organization-Id") == connection.organization_id
+        )
+        self.assertTrue(
+            session.headers.get("X-Organization-Id") == connection.env_args["org_id"]
+        )
 
     def test_signing(self):
         # Set up a connection with a key from a file
@@ -129,6 +135,12 @@ def test_signing(self):
             },
         )
         prepared_get = connection.session.prepare_request(get_request)
+        self.assertTrue(
+            prepared_get.headers["X-Organization-Id"] == connection.organization_id
+        )
+        self.assertTrue(
+            prepared_get.headers["X-Organization-Id"] == connection.env_args["org_id"]
+        )
 
         get_sig = prepared_get.headers["authorization"]
         self.assertEqual(
@@ -209,6 +221,13 @@ def test_signing_auth_header_not_set_when_calling_non_api_root_endpoint(self):
         )
         prepared_get = connection.session.prepare_request(get_request)
         self.assertFalse("authorization" in prepared_get.headers)
+        self.assertTrue(
+            prepared_get.headers["X-Organization-Id"] == connection.organization_id
+        )
+        self.assertTrue(
+            prepared_get.headers["X-Organization-Id"] == connection.env_args["org_id"]
+        )
+        self.assertTrue(prepared_get.headers["X-User-Email"] == connection.email)
 
     def test_signing_request_body_already_encoded(self):
         # Set up a connection with a key from a file
@@ -249,6 +268,13 @@ def test_signing_request_body_already_encoded(self):
         )
         prepared_post = connection.session.prepare_request(post_request)
         self.assertTrue("authorization" in prepared_post.headers)
+        self.assertTrue(
+            prepared_post.headers["X-Organization-Id"] == connection.organization_id
+        )
+        self.assertTrue(
+            prepared_post.headers["X-Organization-Id"] == connection.env_args["org_id"]
+        )
+        self.assertTrue(prepared_post.headers["X-User-Email"] == connection.email)
         self.assertTrue(isinstance(prepared_post.body, bytes))
 
         # Verify that when `data` is set in the request, the authorization header is generated without error
@@ -263,6 +289,13 @@ def test_signing_request_body_already_encoded(self):
         )
         prepared_post = connection.session.prepare_request(post_request)
         self.assertTrue("authorization" in prepared_post.headers)
+        self.assertTrue(
+            prepared_post.headers["X-Organization-Id"] == connection.organization_id
+        )
+        self.assertTrue(
+            prepared_post.headers["X-Organization-Id"] == connection.env_args["org_id"]
+        )
+        self.assertTrue(prepared_post.headers["X-User-Email"] == connection.email)
         self.assertFalse(isinstance(prepared_post.body, bytes))
 
     def test_bearer_token(self):
@@ -296,6 +329,13 @@ def test_bearer_token(self):
 
         authorization_header_value = prepared_get.headers["authorization"]
         self.assertEqual(bearer_token, authorization_header_value)
+        self.assertTrue(
+            prepared_get.headers["X-Organization-Id"] == connection.organization_id
+        )
+        self.assertTrue(
+            prepared_get.headers["X-Organization-Id"] == connection.env_args["org_id"]
+        )
+        self.assertTrue(prepared_get.headers["X-User-Email"] == connection.email)
 
     def test_bearer_token_not_set_when_calling_non_api_root_endpoint(self):
         """Verify that the authorization header is NOT set when non-API root is called"""
@@ -326,6 +366,13 @@ def test_bearer_token_not_set_when_calling_non_api_root_endpoint(self):
         get_request = requests.Request("GET", "http://bar:5555/get")
         prepared_get = connection.session.prepare_request(get_request)
         self.assertFalse("authorization" in prepared_get.headers)
+        self.assertTrue(
+            prepared_get.headers["X-Organization-Id"] == connection.organization_id
+        )
+        self.assertTrue(
+            prepared_get.headers["X-Organization-Id"] == connection.env_args["org_id"]
+        )
+        self.assertTrue(prepared_get.headers["X-User-Email"] == connection.email)
 
     def test_malformed_bearer_token(self):
         """Verify that an exception is thrown when a malformed JWT bearer token is provided"""
@@ -369,4 +416,10 @@ def test_user_token_supersedes_bearer_token(self):
         get_request = requests.Request("GET", "http://foo:5555/get")
         prepared_get = connection.session.prepare_request(get_request)
         self.assertFalse("authorization" in prepared_get.headers)
-        self.assertTrue("X-User-Email" in prepared_get.headers)
+        self.assertTrue(
+            prepared_get.headers["X-Organization-Id"] == connection.organization_id
+        )
+        self.assertTrue(
+            prepared_get.headers["X-Organization-Id"] == connection.env_args["org_id"]
+        )
+        self.assertTrue(prepared_get.headers["X-User-Email"] == connection.email)

transcriptic/config.py

@@ -68,7 +68,7 @@ class Connection(object):
         from transcriptic.config import Connection
         api = Connection.from_file("~/.transcriptic")
 
-    For those using Jupyter notebooks on secure.transcriptic.com (beta), a
+    For those using Jupyter notebooks on secure.strateos.com (beta), a
     Connection object is automatically instantiated as api.
 
     .. code-block:: python
@@ -107,7 +107,7 @@ def __init__(
         email=None,
         token=None,
         organization_id=None,
-        api_root="https://secure.transcriptic.com",
+        api_root="https://secure.strateos.com",
         cookie=None,
         verbose=False,
         analytics=True,
@@ -120,7 +120,6 @@ def __init__(
         # Initialize environment args used for computing routes
         self.env_args = dict()
         self.api_root = api_root
-        self.organization_id = organization_id
 
         # Initialize session headers
         if session is None:
@@ -133,11 +132,12 @@ def __init__(
         self._rsa_key = None
         self._rsa_key_path = None
         self._rsa_secret = None
-        # Set/Load rsa_key from arguement as string or Path
+        # Set/Load rsa_key from argument as string or Path
         self.rsa_key = rsa_key
 
         # NB: These many setattr calls update self.session.headers
         # cookie authentication is mutually exclusive from token authentication
+        self.organization_id = organization_id
         if cookie:
             if email is not None or token is not None:
                 warnings.warn(
@@ -218,12 +218,13 @@ def api_root(self, value):
     @property
     def organization_id(self):
         try:
-            return self.env_args["org_id"]
+            return self.session.headers["X-Organization-Id"]
         except (NameError, KeyError):
             raise ValueError("organization_id is not set.")
 
     @organization_id.setter
     def organization_id(self, value):
+        self.update_headers(**{"X-Organization-Id": value})
         self.update_environment(org_id=value)
 
     @property