celitech-sdk 1.2.5__tar.gz → 1.3.4__tar.gz

{celitech_sdk-1.2.5/src/celitech_sdk.egg-info → celitech_sdk-1.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: celitech-sdk
-Version: 1.2.5
+Version: 1.3.4
 Summary: Welcome to the CELITECH API documentation!  Useful links: [Homepage](https://www.celitech.com) | [Support email](mailto:support@celitech.com) | [Blog](https://www.celitech.com/blog/) 
 License: MIT
 Requires-Python: >=3.7
@@ -8,14 +8,14 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests>=2.31.0
 
-# Celitech Python SDK 1.2.5<a id="celitech-python-sdk-125"></a>
+# Celitech Python SDK 1.3.4<a id="celitech-python-sdk-134"></a>
 
 Welcome to the Celitech SDK documentation. This guide will help you get started with integrating and using the Celitech SDK in your project.
 
 ## Versions<a id="versions"></a>
 
 - API version: `1.1.0`
-- SDK version: `1.2.5`
+- SDK version: `1.3.4`
 
 ## About the API<a id="about-the-api"></a>
 
@@ -26,6 +26,8 @@ Welcome to the CELITECH API documentation! Useful links: [Homepage](https://www.
 - [Setup & Configuration](#setup--configuration)
   - [Supported Language Versions](#supported-language-versions)
   - [Installation](#installation)
+- [Authentication](#authentication)
+  - [OAuth Authentication](#oauth-authentication)
   - [Environment Variables](#environment-variables)
 - [Setting a Custom Timeout](#setting-a-custom-timeout)
 - [Sample Usage](#sample-usage)
@@ -47,6 +49,30 @@ To get started with the SDK, we recommend installing using `pip`:
 pip install celitech-sdk
 ```
 
+## Authentication<a id="authentication"></a>
+
+### OAuth Authentication<a id="oauth-authentication"></a>
+
+The Celitech API uses OAuth for authentication.
+
+You need to provide the OAuth parameters when initializing the SDK.
+
+```py
+sdk = Celitech(
+    client_id="client-id",
+    client_secret="client-secret",
+    client_id="CLIENT_ID",
+    client_secret="CLIENT_SECRET"
+)
+```
+
+If you need to set or update the OAuth parameters after the SDK initialization, you can use:
+
+```py
+sdk.set_client_id("CLIENT_ID")
+sdk.set_client_secret("CLIENT_SECRET")
+```
+
 ## Environment Variables<a id="environment-variables"></a>
 
 These are the environment variables for the SDK:
@@ -79,7 +105,9 @@ from celitech import Celitech
 
 sdk = Celitech(
     client_id="client-id",
-    client_secret="client-secret"
+    client_secret="client-secret",
+    client_id="CLIENT_ID",
+    client_secret="CLIENT_SECRET"
 )
 
 result = sdk.destinations.list_destinations()
@@ -97,6 +125,7 @@ The SDK provides various services to interact with the API.
 
 | Name         |
 | :----------- |
+| o_auth       |
 | destinations |
 | packages     |
 | purchases    |
@@ -113,6 +142,8 @@ The SDK includes several models that represent the data structures used in API r
 
 | Name                             | Description |
 | :------------------------------- | :---------- |
+| GetAccessTokenRequest            |             |
+| GetAccessTokenOkResponse         |             |
 | ListDestinationsOkResponse       |             |
 | ListPackagesOkResponse           |             |
 | ListPurchasesOkResponse          |             |

{celitech_sdk-1.2.5 → celitech_sdk-1.3.4}/PyPI_README.md

@@ -1,11 +1,11 @@
-# Celitech Python SDK 1.2.5<a id="celitech-python-sdk-125"></a>
+# Celitech Python SDK 1.3.4<a id="celitech-python-sdk-134"></a>
 
 Welcome to the Celitech SDK documentation. This guide will help you get started with integrating and using the Celitech SDK in your project.
 
 ## Versions<a id="versions"></a>
 
 - API version: `1.1.0`
-- SDK version: `1.2.5`
+- SDK version: `1.3.4`
 
 ## About the API<a id="about-the-api"></a>
 
@@ -16,6 +16,8 @@ Welcome to the CELITECH API documentation! Useful links: [Homepage](https://www.
 - [Setup & Configuration](#setup--configuration)
   - [Supported Language Versions](#supported-language-versions)
   - [Installation](#installation)
+- [Authentication](#authentication)
+  - [OAuth Authentication](#oauth-authentication)
   - [Environment Variables](#environment-variables)
 - [Setting a Custom Timeout](#setting-a-custom-timeout)
 - [Sample Usage](#sample-usage)
@@ -37,6 +39,30 @@ To get started with the SDK, we recommend installing using `pip`:
 pip install celitech-sdk
 ```
 
+## Authentication<a id="authentication"></a>
+
+### OAuth Authentication<a id="oauth-authentication"></a>
+
+The Celitech API uses OAuth for authentication.
+
+You need to provide the OAuth parameters when initializing the SDK.
+
+```py
+sdk = Celitech(
+    client_id="client-id",
+    client_secret="client-secret",
+    client_id="CLIENT_ID",
+    client_secret="CLIENT_SECRET"
+)
+```
+
+If you need to set or update the OAuth parameters after the SDK initialization, you can use:
+
+```py
+sdk.set_client_id("CLIENT_ID")
+sdk.set_client_secret("CLIENT_SECRET")
+```
+
 ## Environment Variables<a id="environment-variables"></a>
 
 These are the environment variables for the SDK:
@@ -69,7 +95,9 @@ from celitech import Celitech
 
 sdk = Celitech(
     client_id="client-id",
-    client_secret="client-secret"
+    client_secret="client-secret",
+    client_id="CLIENT_ID",
+    client_secret="CLIENT_SECRET"
 )
 
 result = sdk.destinations.list_destinations()
@@ -87,6 +115,7 @@ The SDK provides various services to interact with the API.
 
 | Name         |
 | :----------- |
+| o_auth       |
 | destinations |
 | packages     |
 | purchases    |
@@ -103,6 +132,8 @@ The SDK includes several models that represent the data structures used in API r
 
 | Name                             | Description |
 | :------------------------------- | :---------- |
+| GetAccessTokenRequest            |             |
+| GetAccessTokenOkResponse         |             |
 | ListDestinationsOkResponse       |             |
 | ListPackagesOkResponse           |             |
 | ListPurchasesOkResponse          |             |

{celitech_sdk-1.2.5 → celitech_sdk-1.3.4}/README.md

@@ -1,11 +1,11 @@
-# Celitech Python SDK 1.2.5
+# Celitech Python SDK 1.3.4
 
 Welcome to the Celitech SDK documentation. This guide will help you get started with integrating and using the Celitech SDK in your project.
 
 ## Versions
 
 - API version: `1.1.0`
-- SDK version: `1.2.5`
+- SDK version: `1.3.4`
 
 ## About the API
 
@@ -16,6 +16,8 @@ Welcome to the CELITECH API documentation! Useful links: [Homepage](https://www.
 - [Setup & Configuration](#setup--configuration)
   - [Supported Language Versions](#supported-language-versions)
   - [Installation](#installation)
+- [Authentication](#authentication)
+  - [OAuth Authentication](#oauth-authentication)
   - [Environment Variables](#environment-variables)
 - [Setting a Custom Timeout](#setting-a-custom-timeout)
 - [Sample Usage](#sample-usage)
@@ -37,6 +39,30 @@ To get started with the SDK, we recommend installing using `pip`:
 pip install celitech-sdk
 ```
 
+## Authentication
+
+### OAuth Authentication
+
+The Celitech API uses OAuth for authentication.
+
+You need to provide the OAuth parameters when initializing the SDK.
+
+```py
+sdk = Celitech(
+    client_id="client-id",
+    client_secret="client-secret",
+    client_id="CLIENT_ID",
+    client_secret="CLIENT_SECRET"
+)
+```
+
+If you need to set or update the OAuth parameters after the SDK initialization, you can use:
+
+```py
+sdk.set_client_id("CLIENT_ID")
+sdk.set_client_secret("CLIENT_SECRET")
+```
+
 ## Environment Variables
 
 These are the environment variables for the SDK:
@@ -69,7 +95,9 @@ from celitech import Celitech
 
 sdk = Celitech(
     client_id="client-id",
-    client_secret="client-secret"
+    client_secret="client-secret",
+    client_id="CLIENT_ID",
+    client_secret="CLIENT_SECRET"
 )
 
 result = sdk.destinations.list_destinations()
@@ -87,6 +115,7 @@ The SDK provides various services to interact with the API.
 
 | Name                                                                 |
 | :------------------------------------------------------------------- |
+| [OAuthService](documentation/services/OAuthService.md)               |
 | [DestinationsService](documentation/services/DestinationsService.md) |
 | [PackagesService](documentation/services/PackagesService.md)         |
 | [PurchasesService](documentation/services/PurchasesService.md)       |
@@ -103,6 +132,8 @@ The SDK includes several models that represent the data structures used in API r
 
 | Name                                                                                         | Description |
 | :------------------------------------------------------------------------------------------- | :---------- |
+| [GetAccessTokenRequest](documentation/models/GetAccessTokenRequest.md)                       |             |
+| [GetAccessTokenOkResponse](documentation/models/GetAccessTokenOkResponse.md)                 |             |
 | [ListDestinationsOkResponse](documentation/models/ListDestinationsOkResponse.md)             |             |
 | [ListPackagesOkResponse](documentation/models/ListPackagesOkResponse.md)                     |             |
 | [ListPurchasesOkResponse](documentation/models/ListPurchasesOkResponse.md)                   |             |

{celitech_sdk-1.2.5 → celitech_sdk-1.3.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "celitech-sdk"
-version = "1.2.5"
+version = "1.3.4"
 license = { text = "MIT" }
 description = """Welcome to the CELITECH API documentation!  Useful links: [Homepage](https://www.celitech.com) | [Support email](mailto:support@celitech.com) | [Blog](https://www.celitech.com/blog/) """
 readme = "PyPI_README.md"

celitech_sdk-1.3.4/src/celitech/hooks/hook.py

@@ -0,0 +1,35 @@
+class Request:
+    def __init__(self, method, url, headers, body=""):
+        self.method = method
+        self.url = url
+        self.headers = headers
+        self.body = body
+
+    def __str__(self):
+        return f"method={self.method}, url={self.url}, headers={self.headers}, body={self.body})"
+
+
+class Response:
+    def __init__(self, status, headers, body):
+        self.status = status
+        self.headers = headers
+        self.body = body
+
+    def __str__(self):
+        return "Response(status={}, headers={}, body={})".format(
+            self.status, self.headers, self.body
+        )
+
+
+class DefaultHook:
+
+    def before_request(self, request: Request, **kwargs):
+        pass
+
+    def after_response(self, request: Request, response: Response, **kwargs):
+        pass
+
+    def on_error(
+        self, error: Exception, request: Request, response: Response, **kwargs
+    ):
+        pass

{celitech_sdk-1.2.5 → celitech_sdk-1.3.4}/src/celitech/models/__init__.py

@@ -1,3 +1,5 @@
+from .get_access_token_request import GetAccessTokenRequest, GrantType
+from .get_access_token_ok_response import GetAccessTokenOkResponse
 from .list_destinations_ok_response import ListDestinationsOkResponse, Destinations
 from .list_packages_ok_response import ListPackagesOkResponse, Packages
 from .list_purchases_ok_response import ListPurchasesOkResponse, Purchases

celitech_sdk-1.3.4/src/celitech/models/get_access_token_ok_response.py

@@ -0,0 +1,33 @@
+from .utils.json_map import JsonMap
+from .utils.base_model import BaseModel
+
+
+@JsonMap({})
+class GetAccessTokenOkResponse(BaseModel):
+    """GetAccessTokenOkResponse
+
+    :param access_token: access_token, defaults to None
+    :type access_token: str, optional
+    :param token_type: token_type, defaults to None
+    :type token_type: str, optional
+    :param expires_in: expires_in, defaults to None
+    :type expires_in: int, optional
+    """
+
+    def __init__(
+        self, access_token: str = None, token_type: str = None, expires_in: int = None
+    ):
+        """GetAccessTokenOkResponse
+
+        :param access_token: access_token, defaults to None
+        :type access_token: str, optional
+        :param token_type: token_type, defaults to None
+        :type token_type: str, optional
+        :param expires_in: expires_in, defaults to None
+        :type expires_in: int, optional
+        """
+        self.access_token = self._define_str(
+            "access_token", access_token, nullable=True
+        )
+        self.token_type = self._define_str("token_type", token_type, nullable=True)
+        self.expires_in = self._define_number("expires_in", expires_in, nullable=True)

celitech_sdk-1.3.4/src/celitech/models/get_access_token_request.py

@@ -0,0 +1,59 @@
+from enum import Enum
+from .utils.json_map import JsonMap
+from .utils.base_model import BaseModel
+
+
+class GrantType(Enum):
+    """An enumeration representing different categories.
+
+    :cvar CLIENTCREDENTIALS: "client_credentials"
+    :vartype CLIENTCREDENTIALS: str
+    """
+
+    CLIENTCREDENTIALS = "client_credentials"
+
+    def list():
+        """Lists all category values.
+
+        :return: A list of all category values.
+        :rtype: list
+        """
+        return list(map(lambda x: x.value, GrantType._member_map_.values()))
+
+
+@JsonMap({})
+class GetAccessTokenRequest(BaseModel):
+    """GetAccessTokenRequest
+
+    :param grant_type: grant_type, defaults to None
+    :type grant_type: GrantType, optional
+    :param client_id: client_id, defaults to None
+    :type client_id: str, optional
+    :param client_secret: client_secret, defaults to None
+    :type client_secret: str, optional
+    """
+
+    def __init__(
+        self,
+        grant_type: GrantType = None,
+        client_id: str = None,
+        client_secret: str = None,
+    ):
+        """GetAccessTokenRequest
+
+        :param grant_type: grant_type, defaults to None
+        :type grant_type: GrantType, optional
+        :param client_id: client_id, defaults to None
+        :type client_id: str, optional
+        :param client_secret: client_secret, defaults to None
+        :type client_secret: str, optional
+        """
+        self.grant_type = (
+            self._enum_matching(grant_type, GrantType.list(), "grant_type")
+            if grant_type
+            else None
+        )
+        self.client_id = self._define_str("client_id", client_id, nullable=True)
+        self.client_secret = self._define_str(
+            "client_secret", client_secret, nullable=True
+        )

celitech_sdk-1.3.4/src/celitech/net/oauth/token_manager.py

@@ -0,0 +1,85 @@
+from typing import Set
+from time import time
+
+
+class OauthToken:
+    def __init__(self, access_token: str, scopes: Set[str], expires_at: int):
+        self.access_token = access_token
+        self.scopes = scopes
+        self.expires_at = expires_at
+
+
+class TokenManager:
+    def __init__(self, base_oauth_url: str):
+        self._base_oauth_url = base_oauth_url
+        self._token = None
+        self.client_id = None
+        self.client_secret = None
+
+    def set_base_oauth_url(self, base_oauth_url: str):
+        """
+        Sets the base oAuth URL
+        """
+        self._base_oauth_url = base_oauth_url
+        return self
+
+    def set_client_id(self, client_id: str):
+        """
+        Sets the client_id.
+        """
+        self.client_id = client_id
+        return self
+
+    def set_client_secret(self, client_secret: str):
+        """
+        Sets the client_secret.
+        """
+        self.client_secret = client_secret
+        return self
+
+    def get_token(self, scopes: Set[str]) -> OauthToken:
+        """
+        Get an OAuth token with the given scopes
+
+        :param scopes: The scopes to request
+        :type scopes: Set[str]
+
+        :return: The OAuth token
+        :rtype: OauthToken
+        """
+        if self._token and self._token.scopes.issuperset(scopes):
+            return self._token
+
+        if self._token:
+            scopes.update(self._token.scopes)
+
+        response = self._get_access_token(scopes)
+        self._token = OauthToken(
+            access_token=response.access_token,
+            scopes=scopes,
+            expires_at=(
+                response.expires_in + int(time())
+                if hasattr(response, "expires_in")
+                else None
+            ),
+        )
+        return self._token
+
+    def clean(self):
+        """
+        Clean the token manager to force a new token request
+        """
+        self._token = None
+
+    def _get_access_token(self, scopes: Set[str]):
+        # We need to import the service here, to avoid a circular reference error.
+        from ...services.o_auth import OAuthService
+
+        service = OAuthService(base_url=self._base_oauth_url, token_manager=self)
+        return service.get_access_token(
+            request_body={
+                "grant_type": "client_credentials",
+                "client_id": self.client_id,
+                "client_secret": self.client_secret,
+            }
+        )

{celitech_sdk-1.2.5 → celitech_sdk-1.3.4}/src/celitech/net/request_chain/handlers/hook_handler.py

@@ -2,7 +2,7 @@ from typing import Generator, Optional, Tuple
 
 
 from .base_handler import BaseHandler
-from ....hooks.hook import CustomHook
+from ....hooks.hook import DefaultHook
 from ...transport.request import Request
 from ...transport.response import Response
 from ...transport.request_error import RequestError
@@ -20,7 +20,7 @@ class HookHandler(BaseHandler):
         Initialize a new instance of HookHandler.
         """
         super().__init__()
-        self._hook = CustomHook()
+        self._hook = DefaultHook()
 
         self._additional_variables = additional_variables
 

celitech_sdk-1.3.4/src/celitech/net/request_chain/handlers/oauth_handler.py

@@ -0,0 +1,51 @@
+from typing import Generator, Optional, Tuple
+
+from ...oauth.token_manager import OauthToken, TokenManager
+from ...transport.request import Request
+from ...transport.request_error import RequestError
+from ...transport.response import Response
+from .base_handler import BaseHandler
+
+
+class OauthHandler(BaseHandler):
+    def __init__(self, token_manager: TokenManager):
+        """
+        Initialize a new instance of OauthHandler.
+        """
+        super().__init__()
+        self._token_manager = token_manager
+
+    def handle(
+        self, request: Request
+    ) -> Tuple[Optional[Response], Optional[RequestError]]:
+        if self._next_handler is None:
+            raise RequestError("Handler chain is incomplete")
+
+        if request.scopes is None:
+            # This endpoint is not using Oauth
+            return self._next_handler.handle(request)
+
+        token = self._token_manager.get_token(request.scopes)
+        self._update_token(request, token)
+
+        return self._next_handler.handle(request)
+
+    def stream(
+        self, request: Request
+    ) -> Generator[Tuple[Optional[Response], Optional[RequestError]], None, None]:
+        if self._next_handler is None:
+            raise RequestError("Handler chain is incomplete")
+
+        if request.scopes is None:
+            # This endpoint is not using Oauth
+            for response, error in self._next_handler.stream(request):
+                yield response, error
+
+        token = self._token_manager.get_token(request.scopes)
+        self._update_token(request, token)
+
+        for response, error in self._next_handler.stream(request):
+            yield response, error
+
+    def _update_token(self, request: Request, token: OauthToken):
+        request.headers["Authorization"] = f"Bearer {token.access_token}"

{celitech_sdk-1.2.5 → celitech_sdk-1.3.4}/src/celitech/sdk.py

@@ -1,9 +1,11 @@
 from typing import Union
+from .services.o_auth import OAuthService
 from .services.destinations import DestinationsService
 from .services.packages import PackagesService
 from .services.purchases import PurchasesService
 from .services.e_sim import ESimService
 from .net.environment import Environment
+from .net.oauth.token_manager import TokenManager
 
 
 class Celitech:
@@ -11,20 +13,40 @@ class Celitech:
         self,
         client_id: str = None,
         client_secret: str = None,
+        client_id: str = None,
+        client_secret: str = None,
         base_url: Union[Environment, str] = Environment.DEFAULT,
         timeout: int = 60000,
+        base_oauth_url: str = None,
     ):
         """
         Initializes Celitech the SDK class.
         """
+        self.base_oauth_url = (
+            base_oauth_url if base_oauth_url else "https://auth.celitech.net"
+        )
+        self._token_manager = TokenManager(base_oauth_url=self.base_oauth_url)
 
         self._base_url = (
             base_url.value if isinstance(base_url, Environment) else base_url
         )
-        self.destinations = DestinationsService(base_url=self._base_url)
-        self.packages = PackagesService(base_url=self._base_url)
-        self.purchases = PurchasesService(base_url=self._base_url)
-        self.e_sim = ESimService(base_url=self._base_url)
+        self.o_auth = OAuthService(
+            base_url=self._base_url, token_manager=self._token_manager
+        )
+        self.destinations = DestinationsService(
+            base_url=self._base_url, token_manager=self._token_manager
+        )
+        self.packages = PackagesService(
+            base_url=self._base_url, token_manager=self._token_manager
+        )
+        self.purchases = PurchasesService(
+            base_url=self._base_url, token_manager=self._token_manager
+        )
+        self.e_sim = ESimService(
+            base_url=self._base_url, token_manager=self._token_manager
+        )
+        self.set_client_id(client_id)
+        self.set_client_secret(client_secret)
         self.set_additional_variables(client_id, client_secret)
         self.set_timeout(timeout)
 
@@ -39,6 +61,7 @@ class Celitech:
             base_url.value if isinstance(base_url, Environment) else base_url
         )
 
+        self.o_auth.set_base_url(self._base_url)
         self.destinations.set_base_url(self._base_url)
         self.packages.set_base_url(self._base_url)
         self.purchases.set_base_url(self._base_url)
@@ -46,12 +69,22 @@ class Celitech:
 
         return self
 
+    def set_base_oauth_url(self, base_oauth_url):
+        """
+        Sets the base oAuth URL for the entire SDK.
+        """
+        self.base_oauth_url = base_oauth_url
+        self._token_manager.set_base_oauth_url(base_oauth_url)
+
+        return self
+
     def set_additional_variables(
         self, client_id: str = None, client_secret: str = None
     ):
         """
         Sets the additional variables for the entire SDK.
         """
+        self.o_auth.set_additional_variables(client_id, client_secret)
         self.destinations.set_additional_variables(client_id, client_secret)
         self.packages.set_additional_variables(client_id, client_secret)
         self.purchases.set_additional_variables(client_id, client_secret)
@@ -66,6 +99,7 @@ class Celitech:
         :param int timeout: The timeout (ms) to be set.
         :return: The SDK instance.
         """
+        self.o_auth.set_timeout(timeout)
         self.destinations.set_timeout(timeout)
         self.packages.set_timeout(timeout)
         self.purchases.set_timeout(timeout)
@@ -73,5 +107,25 @@ class Celitech:
 
         return self
 
+    def set_client_id(self, client_id: str):
+        """
+        Sets the client_id for the entire SDK.
+
+        :param str client_id: The client_id to be set.
+        :return: The SDK instance.
+        """
+        self._token_manager.set_client_id(client_id)
+        return self
+
+    def set_client_secret(self, client_secret: str):
+        """
+        Sets the client_secret for the entire SDK.
+
+        :param str client_secret: The client_secret to be set.
+        :return: The SDK instance.
+        """
+        self._token_manager.set_client_secret(client_secret)
+        return self
+
 
 # c029837e0e474b76bc487506e8799df5e3335891efe4fb02bda7a1441840310c

{celitech_sdk-1.2.5 → celitech_sdk-1.3.4}/src/celitech/services/destinations.py

@@ -22,6 +22,7 @@ class DestinationsService(BaseService):
             Serializer(f"{self.base_url}/destinations", self.get_default_headers())
             .serialize()
             .set_method("GET")
+            .set_scopes({})
         )
 
         response = self.send_request(serialized_request)

{celitech_sdk-1.2.5 → celitech_sdk-1.3.4}/src/celitech/services/e_sim.py

@@ -32,6 +32,7 @@ class ESimService(BaseService):
             .add_query("iccid", iccid)
             .serialize()
             .set_method("GET")
+            .set_scopes({})
         )
 
         response = self.send_request(serialized_request)
@@ -59,6 +60,7 @@ class ESimService(BaseService):
             .add_path("iccid", iccid)
             .serialize()
             .set_method("GET")
+            .set_scopes({})
         )
 
         response = self.send_request(serialized_request)
@@ -86,6 +88,7 @@ class ESimService(BaseService):
             .add_path("iccid", iccid)
             .serialize()
             .set_method("GET")
+            .set_scopes({})
         )
 
         response = self.send_request(serialized_request)
@@ -113,6 +116,7 @@ class ESimService(BaseService):
             .add_path("iccid", iccid)
             .serialize()
             .set_method("GET")
+            .set_scopes({})
         )
 
         response = self.send_request(serialized_request)

celitech_sdk-1.3.4/src/celitech/services/o_auth.py

@@ -0,0 +1,35 @@
+from .utils.validator import Validator
+from .utils.base_service import BaseService
+from ..net.transport.serializer import Serializer
+from ..models.utils.cast_models import cast_models
+from ..models import GetAccessTokenOkResponse, GetAccessTokenRequest
+
+
+class OAuthService(BaseService):
+
+    @cast_models
+    def get_access_token(
+        self, request_body: GetAccessTokenRequest
+    ) -> GetAccessTokenOkResponse:
+        """This endpoint was added by liblab
+
+        :param request_body: The request body.
+        :type request_body: GetAccessTokenRequest
+        ...
+        :raises RequestError: Raised when a request fails, with optional HTTP status code and details.
+        ...
+        :return: Successful Response
+        :rtype: GetAccessTokenOkResponse
+        """
+
+        Validator(GetAccessTokenRequest).validate(request_body)
+
+        serialized_request = (
+            Serializer(f"{self.base_url}/oauth2/token", self.get_default_headers())
+            .serialize()
+            .set_method("POST")
+            .set_body(request_body, "application/x-www-form-urlencoded")
+        )
+
+        response = self.send_request(serialized_request)
+        return GetAccessTokenOkResponse._unmap(response)

{celitech_sdk-1.2.5 → celitech_sdk-1.3.4}/src/celitech/services/packages.py

@@ -65,6 +65,7 @@ class PackagesService(BaseService):
             .add_query("duration", duration)
             .serialize()
             .set_method("GET")
+            .set_scopes({})
         )
 
         response = self.send_request(serialized_request)

{celitech_sdk-1.2.5 → celitech_sdk-1.3.4}/src/celitech/services/purchases.py

@@ -74,6 +74,7 @@ class PurchasesService(BaseService):
             .add_query("before", before)
             .serialize()
             .set_method("GET")
+            .set_scopes({})
         )
 
         response = self.send_request(serialized_request)
@@ -100,6 +101,7 @@ class PurchasesService(BaseService):
             Serializer(f"{self.base_url}/purchases", self.get_default_headers())
             .serialize()
             .set_method("POST")
+            .set_scopes({})
             .set_body(request_body)
         )
 
@@ -125,6 +127,7 @@ class PurchasesService(BaseService):
             Serializer(f"{self.base_url}/purchases/topup", self.get_default_headers())
             .serialize()
             .set_method("POST")
+            .set_scopes({})
             .set_body(request_body)
         )
 
@@ -152,6 +155,7 @@ class PurchasesService(BaseService):
             Serializer(f"{self.base_url}/purchases/edit", self.get_default_headers())
             .serialize()
             .set_method("POST")
+            .set_scopes({})
             .set_body(request_body)
         )
 
@@ -183,6 +187,7 @@ class PurchasesService(BaseService):
             .add_path("purchaseId", purchase_id)
             .serialize()
             .set_method("GET")
+            .set_scopes({})
         )
 
         response = self.send_request(serialized_request)

{celitech_sdk-1.2.5 → celitech_sdk-1.3.4}/src/celitech/services/utils/base_service.py

@@ -7,6 +7,8 @@ from ...net.request_chain.request_chain import RequestChain
 from ...net.request_chain.handlers.hook_handler import HookHandler
 from ...net.request_chain.handlers.http_handler import HttpHandler
 from ...net.request_chain.handlers.retry_handler import RetryHandler
+from ...net.oauth.token_manager import TokenManager
+from ...net.request_chain.handlers.oauth_handler import OauthHandler
 
 
 class BaseService:
@@ -17,7 +19,7 @@ class BaseService:
     :ivar dict _default_headers: A dictionary of default headers.
     """
 
-    def __init__(self, base_url: str) -> None:
+    def __init__(self, base_url: str, token_manager: TokenManager) -> None:
         """
         Initializes a BaseService instance.
 
@@ -29,6 +31,8 @@ class BaseService:
 
         self._additional_variables = {}
 
+        self._token_manager = token_manager
+
         self._update_request_handler()
 
     def set_additional_variables(
@@ -101,6 +105,7 @@ class BaseService:
         return (
             RequestChain()
             .add_handler(RetryHandler())
+            .add_handler(OauthHandler(self._token_manager))
             .add_handler(HookHandler(self._additional_variables))
             .add_handler(HttpHandler(self._timeout))
         )

{celitech_sdk-1.2.5 → celitech_sdk-1.3.4/src/celitech_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: celitech-sdk
-Version: 1.2.5
+Version: 1.3.4
 Summary: Welcome to the CELITECH API documentation!  Useful links: [Homepage](https://www.celitech.com) | [Support email](mailto:support@celitech.com) | [Blog](https://www.celitech.com/blog/) 
 License: MIT
 Requires-Python: >=3.7
@@ -8,14 +8,14 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests>=2.31.0
 
-# Celitech Python SDK 1.2.5<a id="celitech-python-sdk-125"></a>
+# Celitech Python SDK 1.3.4<a id="celitech-python-sdk-134"></a>
 
 Welcome to the Celitech SDK documentation. This guide will help you get started with integrating and using the Celitech SDK in your project.
 
 ## Versions<a id="versions"></a>
 
 - API version: `1.1.0`
-- SDK version: `1.2.5`
+- SDK version: `1.3.4`
 
 ## About the API<a id="about-the-api"></a>
 
@@ -26,6 +26,8 @@ Welcome to the CELITECH API documentation! Useful links: [Homepage](https://www.
 - [Setup & Configuration](#setup--configuration)
   - [Supported Language Versions](#supported-language-versions)
   - [Installation](#installation)
+- [Authentication](#authentication)
+  - [OAuth Authentication](#oauth-authentication)
   - [Environment Variables](#environment-variables)
 - [Setting a Custom Timeout](#setting-a-custom-timeout)
 - [Sample Usage](#sample-usage)
@@ -47,6 +49,30 @@ To get started with the SDK, we recommend installing using `pip`:
 pip install celitech-sdk
 ```
 
+## Authentication<a id="authentication"></a>
+
+### OAuth Authentication<a id="oauth-authentication"></a>
+
+The Celitech API uses OAuth for authentication.
+
+You need to provide the OAuth parameters when initializing the SDK.
+
+```py
+sdk = Celitech(
+    client_id="client-id",
+    client_secret="client-secret",
+    client_id="CLIENT_ID",
+    client_secret="CLIENT_SECRET"
+)
+```
+
+If you need to set or update the OAuth parameters after the SDK initialization, you can use:
+
+```py
+sdk.set_client_id("CLIENT_ID")
+sdk.set_client_secret("CLIENT_SECRET")
+```
+
 ## Environment Variables<a id="environment-variables"></a>
 
 These are the environment variables for the SDK:
@@ -79,7 +105,9 @@ from celitech import Celitech
 
 sdk = Celitech(
     client_id="client-id",
-    client_secret="client-secret"
+    client_secret="client-secret",
+    client_id="CLIENT_ID",
+    client_secret="CLIENT_SECRET"
 )
 
 result = sdk.destinations.list_destinations()
@@ -97,6 +125,7 @@ The SDK provides various services to interact with the API.
 
 | Name         |
 | :----------- |
+| o_auth       |
 | destinations |
 | packages     |
 | purchases    |
@@ -113,6 +142,8 @@ The SDK includes several models that represent the data structures used in API r
 
 | Name                             | Description |
 | :------------------------------- | :---------- |
+| GetAccessTokenRequest            |             |
+| GetAccessTokenOkResponse         |             |
 | ListDestinationsOkResponse       |             |
 | ListPackagesOkResponse           |             |
 | ListPurchasesOkResponse          |             |

{celitech_sdk-1.2.5 → celitech_sdk-1.3.4}/src/celitech_sdk.egg-info/SOURCES.txt

@@ -11,6 +11,8 @@ src/celitech/models/create_purchase_ok_response.py
 src/celitech/models/create_purchase_request.py
 src/celitech/models/edit_purchase_ok_response.py
 src/celitech/models/edit_purchase_request.py
+src/celitech/models/get_access_token_ok_response.py
+src/celitech/models/get_access_token_request.py
 src/celitech/models/get_esim_device_ok_response.py
 src/celitech/models/get_esim_history_ok_response.py
 src/celitech/models/get_esim_mac_ok_response.py
@@ -31,12 +33,14 @@ src/celitech/net/environment/__init__.py
 src/celitech/net/environment/environment.py
 src/celitech/net/headers/__init__.py
 src/celitech/net/headers/base_header.py
+src/celitech/net/oauth/token_manager.py
 src/celitech/net/request_chain/__init__.py
 src/celitech/net/request_chain/request_chain.py
 src/celitech/net/request_chain/handlers/__init__.py
 src/celitech/net/request_chain/handlers/base_handler.py
 src/celitech/net/request_chain/handlers/hook_handler.py
 src/celitech/net/request_chain/handlers/http_handler.py
+src/celitech/net/request_chain/handlers/oauth_handler.py
 src/celitech/net/request_chain/handlers/retry_handler.py
 src/celitech/net/transport/__init__.py
 src/celitech/net/transport/request.py
@@ -47,6 +51,7 @@ src/celitech/net/transport/utils.py
 src/celitech/services/__init__.py
 src/celitech/services/destinations.py
 src/celitech/services/e_sim.py
+src/celitech/services/o_auth.py
 src/celitech/services/packages.py
 src/celitech/services/purchases.py
 src/celitech/services/utils/__init__.py

celitech_sdk-1.2.5/src/celitech/hooks/hook.py

@@ -1,84 +0,0 @@
-import requests
-import os
-from typing import Dict
-import time
-
-CURRENT_TOKEN = ""
-CURRENT_EXPIRY = -1
-
-
-class Request:
-    def __init__(self, method, url, headers, body=""):
-        self.method = method
-        self.url = url
-        self.headers = headers
-        self.body = body
-
-    def __str__(self):
-        return f"Request(method={self.method}, url={self.url}, headers={self.headers}, body={self.body})"
-
-
-class Response:
-    def __init__(self, status, headers, body):
-        self.status = status
-        self.headers = headers
-        self.body = body
-
-    def __str__(self):
-        return (
-            f"Response(status={self.status}, headers={self.headers}, body={self.body})"
-        )
-
-
-class CustomHook:
-
-    def getToken(self, client_id, client_secret):
-        full_url = "https://auth.celitech.net/oauth2/token"
-        headers = {"Content-type": "application/x-www-form-urlencoded"}
-        data = {
-            "client_id": client_id,
-            "client_secret": client_secret,
-            "grant_type": "client_credentials",
-        }
-
-        resp = requests.post(full_url, headers=headers, data=data)
-        return resp.json()
-
-    def before_request(self, request: Request, **kwargs):
-        client_id = kwargs.get("client_id")
-        client_secret = kwargs.get("client_secret")
-
-        if not client_id or not client_secret:
-            raise Exception(
-                "Missing client_id and/or client_secret constructor parameters"
-            )
-
-        global CURRENT_TOKEN, CURRENT_EXPIRY
-
-        if not CURRENT_TOKEN or CURRENT_EXPIRY < round(time.time() * 1000):
-
-            token_response = self.getToken(client_id, client_secret)
-
-            if token_response.get("error"):
-                raise Exception(token_response.get("error"))
-
-            expires_in = token_response.get("expires_in")
-            access_token = token_response.get("access_token")
-
-            if not expires_in or not access_token:
-                raise Exception("There is an issue with getting the oauth token")
-
-            CURRENT_EXPIRY = round(time.time() * 1000) + expires_in * 1000
-            CURRENT_TOKEN = access_token
-
-        authorization = f"Bearer {CURRENT_TOKEN}"
-
-        request.headers.update({"Authorization": authorization})
-
-    def after_response(self, request: Request, response: Response, **kwargs):
-        pass
-
-    def on_error(
-        self, error: Exception, request: Request, response: Response, **kwargs
-    ):
-        pass