esd-services-api-client 0.9.0__py3-none-any.whl → 0.9.2__py3-none-any.whl

esd_services_api_client/_version.py

@@ -1 +1 @@
-__version__ = '0.9.0'
+__version__ = '0.9.2'

esd_services_api_client/boxer/README.md

@@ -68,3 +68,24 @@ from esd_services_api_client.boxer import BoxerConnector
 conn = BoxerConnector(base_url="https://boxer.test.sneaksanddata.com")
 pub_key = conn.get_consumer_public_key("app_consumer")
 ```
+
+### Using as an authentication provider for other connectors
+```python
+from esd_services_api_client.boxer import BoxerConnector, RefreshableExternalTokenAuth, BoxerTokenAuth
+from esd_services_api_client.crystal import CrystalConnector
+
+auth_method = "example"
+
+def get_external_token() -> str:
+    return "example_token"
+
+# Configure authentication with boxer
+external_auth = RefreshableExternalTokenAuth(lambda: get_external_token(), auth_method)
+boxer_connector = BoxerConnector(base_url="https://example.com", auth=external_auth)
+
+# Inject boxer auth to Crystal connector
+connector = CrystalConnector(base_url="https://example.com", auth=BoxerTokenAuth(boxer_connector))
+
+# Use Crystal connector with boxer auth
+connector.await_runs("algorithm", ["id"])
+```

esd_services_api_client/boxer/_auth.py

@@ -18,6 +18,7 @@
 #
 
 import base64
+from abc import abstractmethod
 from functools import partial
 from typing import Callable, Any
 
@@ -75,12 +76,33 @@ class BoxerAuth(AuthBase):
         return request
 
 
-class ExternalTokenAuth(AuthBase):
-    """Create authentication for external token e.g. for azuread or kubernetes auth policies"""
+class ExternalAuthBase(AuthBase):
+    """Base class for external authentication methods"""
+
+    def __init__(self, authentication_provider):
+        self._authentication_provider = authentication_provider
+
+    @abstractmethod
+    def __call__(self, r: PreparedRequest) -> PreparedRequest:
+        pass
+
+    @property
+    def authentication_provider(self) -> str:
+        """
+        :return authentication provider name
+        """
+        return self._authentication_provider
+
+
+class ExternalTokenAuth(ExternalAuthBase):
+    """
+    Create authentication for external token e.g. for azuread or kubernetes auth policies
+    NOTE: this class is deprecated, use RefreshableExternalTokenAuth instead
+    """
 
     def __init__(self, token: str, authentication_provider: str):
+        super().__init__(authentication_provider)
         self._token = token
-        self._authentication_provider = authentication_provider
 
     def __call__(self, r: PreparedRequest) -> PreparedRequest:
         """
@@ -92,12 +114,55 @@ class ExternalTokenAuth(AuthBase):
         r.headers["Authorization"] = f"Bearer {self._token}"
         return r
 
-    @property
-    def authentication_provider(self) -> str:
+
+class RefreshableExternalTokenAuth(ExternalAuthBase):
+    """
+    Create authentication for external token e.g. for azuread or kubernetes auth policies
+    If the external token is expired, this auth method will try to get new external token and retry the request once
+    """
+
+    def __init__(self, get_token: Callable[[], str], authentication_provider: str):
+        super().__init__(authentication_provider)
+        self._get_token = get_token
+        self._retrying = False
+
+    def __call__(self, r: PreparedRequest) -> PreparedRequest:
         """
-        :return authentication provider name
+          Auth entrypoint
+
+        :param r: Request to authorize
+        :return: Request with Auth header set
         """
-        return self._authentication_provider
+        r.headers["Authorization"] = f"Bearer {self._get_token()}"
+        return r
+
+    def refresh_token(self, response: Response, session: Session, *_, **__):
+        """
+        Refresh token hook if request fails with unauthorized or forbidden status code and retries the request.
+        :param response:  Response received from API server
+        :param session: Session used for original API interaction
+        :param _: Positional arguments
+        :param __: Keyword arguments
+        :return:
+        """
+        if self._retrying:
+            return response
+        if response.status_code == requests.codes["unauthorized"]:
+            self._retrying = True
+            response = session.send(self(response.request))
+            self._retrying = False
+            return response
+        return response
+
+    def get_refresh_hook(
+        self, session: Session
+    ) -> Callable[[Response, Unpack[Any]], Response]:
+        """
+        Generate request hook
+        :param session: Session used for original API interaction
+        :returns
+        """
+        return partial(self.refresh_token, session=session)
 
 
 class BoxerTokenAuth(AuthBase):

esd_services_api_client/boxer/_connector.py

@@ -29,6 +29,8 @@ from esd_services_api_client.boxer._auth import (
     BoxerAuth,
     ExternalTokenAuth,
     BoxerTokenAuth,
+    ExternalAuthBase,
+    RefreshableExternalTokenAuth,
 )
 from esd_services_api_client.boxer._helpers import (
     _iterate_user_claims_response,
@@ -46,7 +48,7 @@ class BoxerConnector(BoxerTokenProvider):
         self,
         *,
         base_url,
-        auth: ExternalTokenAuth,
+        auth: ExternalAuthBase,
         retry_attempts=10,
         session: Optional[Session] = None,
     ):
@@ -59,6 +61,8 @@ class BoxerConnector(BoxerTokenProvider):
         self.http.auth = auth or self._create_boxer_auth()
         if auth:
             self.authentication_provider = auth.authentication_provider
+        if isinstance(auth, RefreshableExternalTokenAuth):
+            self.http.hooks["response"].append(auth.get_refresh_hook(self.http))
         self.retry_attempts = retry_attempts
 
     def push_user_claim(self, claim: BoxerClaim, user_id: str):
@@ -185,8 +189,8 @@ def select_authentication(auth_provider: str, env: str) -> Optional[BoxerTokenAu
     """
     if auth_provider == "azuread":
         proteus_client = AzureClient(subscription_id="")
-        external_auth = ExternalTokenAuth(
-            proteus_client.get_access_token(), auth_provider
+        external_auth = RefreshableExternalTokenAuth(
+            proteus_client.get_access_token, auth_provider
         )
         boxer_connector = BoxerConnector(
             base_url=f"https://boxer.{env}.sneaksanddata.com", auth=external_auth

esd_services_api_client/crystal/_connector.py

@@ -97,6 +97,8 @@ class CrystalConnector:
             retry_count=default_retry_count,
             request_timeout=default_timeout.total_seconds(),
         )
+        if auth and isinstance(auth, BoxerTokenAuth):
+            self.http.hooks["response"].append(auth.get_refresh_hook(self.http))
         self._api_version = api_version
         self._logger = logger
         if isinstance(auth, BoxerTokenAuth):

{esd_services_api_client-0.9.0.dist-info → esd_services_api_client-0.9.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: esd-services-api-client
-Version: 0.9.0
+Version: 0.9.2
 Summary: Python clients for ESD services
 Home-page: https://github.com/SneaksAndData/esd-services-api-client
 License: Apache 2.0

{esd_services_api_client-0.9.0.dist-info → esd_services_api_client-0.9.2.dist-info}/RECORD

@@ -1,22 +1,22 @@
 esd_services_api_client/__init__.py,sha256=rP0njtEgVSMm-sOVayVfcRUrrubl4lme7HI2zS678Lo,598
-esd_services_api_client/_version.py,sha256=_DlwPNmTZTKflLiAF8YIqSr2ao66CTjj4bQtA6hz0jM,22
+esd_services_api_client/_version.py,sha256=HSMl6bLm3r1Ias1jHIPpJeQ0IYNuuSdlT38MTb79ewM,22
 esd_services_api_client/beast/__init__.py,sha256=XU4thkgkY6ZvT4yyDpaqeiIg3yotfcyJEewpo8iica4,743
 esd_services_api_client/beast/_auth.py,sha256=V9m75EaFP8U_Ykf4DE5SWSSUrH8_UP_ugrmayJbwdmw,2666
 esd_services_api_client/beast/_connector.py,sha256=_OGMr1qB1SyfMw0JLrCc2g7Ph4LrZ7JWa2etPbn2JTA,10505
 esd_services_api_client/beast/_models.py,sha256=XOTZqr83mX44SpXG4KBDEHJozVuDQvQcaP_ctmS98hk,9438
-esd_services_api_client/boxer/README.md,sha256=RGwJhADPzPH05qjZm0BaCI-9GOfhUgTnm5Is7zldnR8,2221
+esd_services_api_client/boxer/README.md,sha256=U8kXXtJFi1w0woQ4F_UOdDZiQl6-K7zFmQEUV4EktfM,2983
 esd_services_api_client/boxer/__init__.py,sha256=OYsWvdnLan0kmjUcH4I2-m1rbPeARKp5iqhp8uyudPk,780
-esd_services_api_client/boxer/_auth.py,sha256=EQkNod3RtIwARr5Mn2MbNCbzJI0BPrPCgap98CI2Yh4,5214
+esd_services_api_client/boxer/_auth.py,sha256=vA7T9y0oZV2f17UWQ2or9CK8vAsNnHB10G5HNQe1l1I,7440
 esd_services_api_client/boxer/_base.py,sha256=PSU08QzTKFkXfzx7fF5FIHBOZXshxNEd1J_qKGo0Rd0,976
-esd_services_api_client/boxer/_connector.py,sha256=b4_3Pg-wjHoapTUX4jmdFif7pu5CAq_FN0bICPcxfAQ,8272
+esd_services_api_client/boxer/_connector.py,sha256=OBNQHlXHM3V6LWTlLFBpDBgS-m9Q3n-sLlqSGPAz4rQ,8476
 esd_services_api_client/boxer/_helpers.py,sha256=hjf96CWYEH2iThYDcBB1iEGzalUWn-S9PZJzZJ6bdG0,1736
 esd_services_api_client/boxer/_models.py,sha256=2tdVNRGQ0roR3THfzTq7KF2eQ5mS30PbxpqYhPm1y6A,3105
 esd_services_api_client/common/__init__.py,sha256=rP0njtEgVSMm-sOVayVfcRUrrubl4lme7HI2zS678Lo,598
 esd_services_api_client/crystal/__init__.py,sha256=afSGQRkDic0ECsJfgu3b291kX8CyU57sjreqxj5cx-s,787
 esd_services_api_client/crystal/_api_versions.py,sha256=2BMiQRS0D8IEpWCCys3dge5alVBRCZrOuCR1QAn8UIM,832
-esd_services_api_client/crystal/_connector.py,sha256=3oDR-egxj6zCvlLEWmPYJvKomE-4AhzFYud8S2WRkEE,12015
+esd_services_api_client/crystal/_connector.py,sha256=lWWKhVKvaFtLTsl6abtydFH4rsMoCATD_IMpVOARyl0,12150
 esd_services_api_client/crystal/_models.py,sha256=eRhGAl8LjglCyIFwf1bcFBhjbpSuRYucuF2LO388L2E,4025
-esd_services_api_client-0.9.0.dist-info/LICENSE,sha256=0gS6zXsPp8qZhzi1xaGCIYPzb_0e8on7HCeFJe8fOpw,10693
-esd_services_api_client-0.9.0.dist-info/METADATA,sha256=L3LqysaPF4LyK7Ktuoe_GPQtgKGWmPu9B3xBzwsAkAk,1075
-esd_services_api_client-0.9.0.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-esd_services_api_client-0.9.0.dist-info/RECORD,,
+esd_services_api_client-0.9.2.dist-info/LICENSE,sha256=0gS6zXsPp8qZhzi1xaGCIYPzb_0e8on7HCeFJe8fOpw,10693
+esd_services_api_client-0.9.2.dist-info/METADATA,sha256=aMe49RZg_WaTlwlwSvtaxyWYOmJOhF6WDN7-MZpaqyc,1075
+esd_services_api_client-0.9.2.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+esd_services_api_client-0.9.2.dist-info/RECORD,,