anaplan-sdk 0.4.2__tar.gz → 0.4.3a1__tar.gz

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3a1}/.gitignore

@@ -9,6 +9,7 @@ __pycache__/
 .idea
 .iml
 
+app.py
 debug.py
 # Distribution / packaging
 .Python

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anaplan-sdk
-Version: 0.4.2
+Version: 0.4.3a1
 Summary: Streamlined Python Interface for Anaplan
 Project-URL: Homepage, https://vinzenzklass.github.io/anaplan-sdk/
 Project-URL: Repository, https://github.com/VinzenzKlass/anaplan-sdk

anaplan_sdk-0.4.3a1/anaplan_sdk/__init__.py

@@ -0,0 +1,5 @@
+from ._async_clients import AsyncClient
+from ._clients import Client
+from ._oauth import AsyncOauth, Oauth
+
+__all__ = ["AsyncClient", "AsyncOauth", "Client", "Oauth", "models", "exceptions"]

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3a1}/anaplan_sdk/_async_clients/_bulk.py

@@ -6,7 +6,7 @@ from typing import AsyncIterator, Iterator
 import httpx
 from typing_extensions import Self
 
-from anaplan_sdk._auth import AuthCodeCallback, AuthTokenRefreshCallback, create_auth
+from anaplan_sdk._auth import AuthCodeCallback, AuthTokenRefreshCallback, _create_auth
 from anaplan_sdk._base import _AsyncBaseClient, action_url
 from anaplan_sdk.exceptions import AnaplanActionError, InvalidIdentifierException
 from anaplan_sdk.models import (
@@ -58,6 +58,8 @@ class AsyncClient(_AsyncBaseClient):
         oauth2_scope: str = "openid profile email offline_access",
         on_auth_code: AuthCodeCallback = None,
         on_token_refresh: AuthTokenRefreshCallback = None,
+        oauth_token: dict[str, str] | None = None,
+        token: str | None = None,
         timeout: float | httpx.Timeout = 30,
         retry_count: int = 2,
         status_poll_delay: int = 1,
@@ -130,7 +132,9 @@ class AsyncClient(_AsyncBaseClient):
         """
         _client = httpx.AsyncClient(
             auth=(
-                create_auth(
+                _create_auth(
+                    token=token,
+                    oauth_token=oauth_token,
                     user_email=user_email,
                     password=password,
                     certificate=certificate,

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3a1}/anaplan_sdk/_auth.py

@@ -50,6 +50,18 @@ class _AnaplanAuth(httpx.Auth):
         self._token: str = response.json()["tokenInfo"]["tokenValue"]
 
 
+class StaticTokenAuth(httpx.Auth):
+    def __init__(self, token: str):
+        logger.warning("Using static token authentication. Tokens will not be refreshed.")
+        self._token = token
+
+    def auth_flow(self, request):
+        request.headers["Authorization"] = f"AnaplanAuthToken {self._token}"
+        response = yield request
+        if response.status_code == 401:
+            raise InvalidCredentialsException("Your token is invalid or expired.")
+
+
 class AnaplanBasicAuth(_AnaplanAuth):
     def __init__(self, user_email: str, password: str):
         self.user_email = user_email
@@ -229,7 +241,7 @@ class AnaplanOauth2AuthCodeAuth(_AnaplanAuth):
             raise InvalidCredentialsException("Error during OAuth2 authorization flow.") from error
 
 
-def create_auth(
+def _create_auth(
     user_email: str | None = None,
     password: str | None = None,
     certificate: str | bytes | None = None,
@@ -242,7 +254,25 @@ def create_auth(
     oauth2_scope: str = "openid profile email offline_access",
     on_auth_code: AuthCodeCallback = None,
     on_token_refresh: AuthTokenRefreshCallback = None,
-) -> _AnaplanAuth:
+    token: str | None = None,
+    oauth_token: dict[str, str] | None = None,
+) -> httpx.Auth:
+    if token:
+        # TODO: If other parameters are provided that allow refreshing the token, use them to create
+        #  use them to create one of the other auth classes instead.
+        return StaticTokenAuth(token)
+    if oauth_token:
+        if not isinstance(oauth_token, dict) and all(
+            f in oauth_token for f in ("access_token", "refresh_token", "token_type", "scope")
+        ):
+            raise ValueError(
+                "oauth_token must be a dictionary with at least 'access_token', 'refresh_token', "
+                "'token_type', and 'scope' keys."
+            )
+        # TODO: If client_id, client_secret, and redirect_uri are provided, use them to create an
+        #  AnaplanOauth2AuthCodeAuth (extend to accept existing `access_token` instance. Else, use
+        #  the StaticTokenAuth directly.
+        return StaticTokenAuth(oauth_token["access_token"])
     if certificate and private_key:
         return AnaplanCertAuth(certificate, private_key, private_key_password)
     if user_email and password:

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3a1}/anaplan_sdk/_clients/_bulk.py

@@ -8,7 +8,7 @@ from typing import Callable, Iterator
 import httpx
 from typing_extensions import Self
 
-from anaplan_sdk._auth import create_auth
+from anaplan_sdk._auth import _create_auth
 from anaplan_sdk._base import _BaseClient, action_url
 from anaplan_sdk.exceptions import AnaplanActionError, InvalidIdentifierException
 from anaplan_sdk.models import (
@@ -60,6 +60,8 @@ class Client(_BaseClient):
         oauth2_scope: str = "openid profile email offline_access",
         on_auth_code: Callable[[str], str] | None = None,
         on_token_refresh: Callable[[dict[str, str]], None] | None = None,
+        oauth_token: dict[str, str] | None = None,
+        token: str | None = None,
         timeout: float | httpx.Timeout = 30,
         retry_count: int = 2,
         status_poll_delay: int = 1,
@@ -124,7 +126,9 @@ class Client(_BaseClient):
         """
         _client = httpx.Client(
             auth=(
-                create_auth(
+                _create_auth(
+                    token=token,
+                    oauth_token=oauth_token,
                     user_email=user_email,
                     password=password,
                     certificate=certificate,

anaplan_sdk-0.4.3a1/anaplan_sdk/_oauth.py

@@ -0,0 +1,198 @@
+import logging
+from typing import Callable
+
+import httpx
+
+from .exceptions import AnaplanException, InvalidCredentialsException
+
+logger = logging.getLogger("anaplan_sdk")
+
+
+class _BaseOauth:
+    def __init__(
+        self,
+        client_id: str,
+        client_secret: str,
+        redirect_url: str,
+        authorization_url: str = "https://us1a.app.anaplan.com/auth/prelogin",
+        token_url: str = "https://us1a.app.anaplan.com/oauth/token",
+        validation_url: str = "https://auth.anaplan.com/token/validate",
+        scope: str = "openid profile email offline_access",
+        state_generator: Callable[[], str] | None = None,
+    ):
+        """
+        Initializes the OAuth Client. This class provides the two utilities needed to implement
+        the OAuth 2.0 authorization code flow for user-facing Web Applications. It differs from the
+        other Authentication Strategies in this SDK in two main ways:
+
+        1. You must implement the actual authentication flow in your application. You cannot pass
+        the credentials directly to the `Client` or `AsyncClient`, and this class does not
+        implement the SDK internal authentication flow, i.e. it does not subclass `httpx.Auth`.
+
+        2. You then simply pass the resulting token to the `Client` or `AsyncClient`, rather than
+        passing the credentials directly, which will internally construct an `httpx.Auth` instance
+
+        Note that this class exist for convenience only, and you can implement the OAuth 2.0 Flow
+        yourself in your preferred library, or bring an existing implementation. For details on the
+        Anaplan OAuth 2.0 Flow, see the [the Docs](https://anaplanoauth2service.docs.apiary.io/#reference/overview-of-the-authorization-code-grant).
+        :param client_id: The client ID of your Anaplan Oauth 2.0 application. This Application
+               must be an Authorization Code Grant application.
+        :param client_secret: The client secret of your Anaplan Oauth 2.0 application.
+        :param redirect_url: The URL to which the user will be redirected after authorizing the
+               application.
+        :param authorization_url: The URL to which the user will be redirected to authorize the
+               application. Defaults to the Anaplan Prelogin Page, where the user can select the
+               login method.
+        :param token_url: The URL to post the authorization code to in order to fetch the access
+               token.
+        :param validation_url: The URL to validate the access token.
+        :param scope: The scope of the access request.
+        :param state_generator: A callable that generates a random state string. You can optionally
+                pass this if you need to customize the state generation logic. If not provided,
+                the state will be generated by `oauthlib`.
+        """
+        self._client_id = client_id
+        self._client_secret = client_secret
+        self._redirect_url = redirect_url
+        self._authorization_url = authorization_url
+        self._token_url = token_url
+        self._validation_url = validation_url
+        self._scope = scope
+
+        try:
+            from oauthlib.oauth2 import WebApplicationClient
+        except ImportError as e:
+            raise AnaplanException(
+                "oauthlib is not available. Please install anaplan-sdk with the oauth extra "
+                "`pip install anaplan-sdk[oauth]` or install oauthlib separately."
+            ) from e
+        self._oauth = WebApplicationClient(client_id=client_id, client_secret=client_secret)
+        self._state_generator = state_generator if state_generator else self._oauth.state_generator
+
+    def authorization_url(
+        self, authorization_url: str | None = None, state: str | None = None
+    ) -> tuple[str, str]:
+        """
+        Generates the authorization URL for the OAuth 2.0 flow.
+        :param authorization_url: You can optionally pass a custom authorization URL. This is
+               useful if you want to redirect i.e. redirect the user directly to the Anaplan login
+               page rather than the Prelogin page in only one scenario, while still reusing the
+               Client.
+        :param state: You can optionally pass a custom state string. If not provided, a random
+                state string will be generated by the `oauthlib` library, or by the
+                `state_generator` callable if provided.
+        :return: A tuple containing the authorization URL and the state string.
+        """
+        auth_url = authorization_url or self._authorization_url
+        state = state or self._state_generator()
+        url, _, _ = self._oauth.prepare_authorization_request(
+            auth_url, state, self._redirect_url, self._scope
+        )
+        return url, state
+
+
+class AsyncOauth(_BaseOauth):
+    """
+    Asynchronous Variant of the Anaplan OAuth client for interactive OAuth Flows in Web
+    Applications.
+    """
+
+    async def fetch_token(self, authorization_response: str) -> dict[str, str]:
+        """
+        Fetches the token using the authorization response from the OAuth 2.0 flow.
+        :param authorization_response: The full URL that the user was redirected to after
+               authorizing the application. This URL will contain the authorization code and state.
+        :return: The token as a dictionary containing the access token, refresh token, scope,
+                 expires_in, and type.
+        """
+        from oauthlib.oauth2 import OAuth2Error
+
+        try:
+            url, headers, body = self._oauth.prepare_token_request(
+                authorization_response=authorization_response,
+                token_url=self._token_url,
+                redirect_url=self._redirect_url,
+                client_secret=self._client_secret,
+            )
+            async with httpx.AsyncClient() as client:
+                response = await client.post(url=url, headers=headers, content=body)
+            if not response.is_success:
+                raise InvalidCredentialsException(
+                    f"Token request failed: {response.status_code} {response.text}"
+                )
+            return response.json()
+        except (httpx.HTTPError, ValueError, TypeError, OAuth2Error) as error:
+            logger.error(error)
+            raise AnaplanException("Error during token creation.") from error
+
+    async def validate_token(self, token: str) -> dict[str, str | dict[str, str]]:
+        """
+        Validates the provided token by checking its validity with the Anaplan Authentication API.
+        If the token is not valid, an `InvalidCredentialsException` is raised.
+        :param token: The access token to validate.
+        :return: The Token information as a dictionary containing the token's details.
+        """
+        try:
+            async with httpx.AsyncClient() as client:
+                response = await client.get(
+                    url=self._validation_url, headers={"Authorization": f"AnaplanAuthToken {token}"}
+                )
+            if not response.is_success:
+                raise InvalidCredentialsException
+            return response.json()
+        except httpx.HTTPError as error:
+            logger.error(error)
+            raise AnaplanException("Error during token validation.") from error
+
+
+class Oauth(_BaseOauth):
+    """
+    Synchronous Variant of the Anaplan OAuth client for interactive OAuth Flows in Web
+    Applications.
+    """
+
+    def fetch_token(self, authorization_response: str) -> dict[str, str]:
+        """
+        Fetches the token using the authorization response from the OAuth 2.0 flow.
+        :param authorization_response: The full URL that the user was redirected to after
+               authorizing the application. This URL will contain the authorization code and state.
+        :return: The token as a dictionary containing the access token, refresh token, scope,
+                 expires_in, and type.
+        """
+        from oauthlib.oauth2 import OAuth2Error
+
+        try:
+            url, headers, body = self._oauth.prepare_token_request(
+                authorization_response=authorization_response,
+                token_url=self._token_url,
+                redirect_url=self._redirect_url,
+                client_secret=self._client_secret,
+            )
+            with httpx.Client() as client:
+                response = client.post(url=url, headers=headers, content=body)
+            if not response.is_success:
+                raise AnaplanException(
+                    f"Token request failed: {response.status_code} {response.text}"
+                )
+            return response.json()
+        except (httpx.HTTPError, ValueError, TypeError, OAuth2Error) as error:
+            raise AnaplanException("Error during token creation.") from error
+
+    def validate_token(self, token: str) -> dict[str, str | dict[str, str]]:
+        """
+        Validates the provided token by checking its validity with the Anaplan Authentication API.
+        If the token is not valid, an `InvalidCredentialsException` is raised.
+        :param token: The access token to validate.
+        :return: The Token information as a dictionary containing the token's details.
+        """
+        try:
+            with httpx.Client() as client:
+                response = client.get(
+                    url=self._validation_url, headers={"Authorization": f"AnaplanAuthToken {token}"}
+                )
+            if not response.is_success:
+                raise InvalidCredentialsException
+            return response.json()
+        except httpx.HTTPError as error:
+            logger.error(error)
+            raise AnaplanException("Error during token validation.") from error

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3a1}/docs/api/async/async_alm_client.md

@@ -3,3 +3,9 @@
     instance of [AsyncClient](async_client.md). For more details, see the [Guide](../../guides/alm.md).
 
 ::: anaplan_sdk._async_clients._AsyncAlmClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3a1}/docs/api/async/async_audit_client.md

@@ -3,3 +3,9 @@
     instance of [AsyncClient](async_client.md). For more details, see the [Guide](../../guides/audit.md).
 
 ::: anaplan_sdk._async_clients._AsyncAuditClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

anaplan_sdk-0.4.3a1/docs/api/async/async_client.md

@@ -0,0 +1,9 @@
+# Bulk API Client (`AsyncClient`)
+
+::: anaplan_sdk.AsyncClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3a1}/docs/api/async/async_cw_client.md

@@ -3,3 +3,9 @@
     instance of [AsyncClient](async_client.md). For more details, see the [Guide](../../guides/cloud_works.md).
 
 ::: anaplan_sdk._async_clients._AsyncCloudWorksClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3a1}/docs/api/async/async_flows_client.md

@@ -3,3 +3,9 @@
     instance of [AsyncClient](async_client.md). For more details, see the [Guide](../../guides/cloud_works.md).
 
 ::: anaplan_sdk._async_clients._cw_flow._AsyncFlowClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

anaplan_sdk-0.4.3a1/docs/api/async/async_oauth_client.md

@@ -0,0 +1,9 @@
+# AsyncOauth
+
+::: anaplan_sdk._oauth.AsyncOauth
+    options:
+        inherited_members: true
+        members:
+        - __init__
+        - authorization_url
+        - fetch_token

anaplan_sdk-0.4.3a1/docs/api/async/async_transactional_client.md

@@ -0,0 +1,11 @@
+???+ note
+     This Class is not meant to be instantiated directly, but rather accessed through the `transactional` Property on an
+     instance of [AsyncClient](async_client.md). For more details, see the [Guide](../../guides/transactional.md).
+
+::: anaplan_sdk._async_clients._AsyncTransactionalClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

anaplan_sdk-0.4.3a1/docs/api/exceptions.md

@@ -0,0 +1,9 @@
+::: anaplan_sdk.exceptions
+    options:
+        show_bases: true
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

anaplan_sdk-0.4.3a1/docs/api/models/alm.md

@@ -0,0 +1,7 @@
+::: anaplan_sdk.models._alm
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

anaplan_sdk-0.4.3a1/docs/api/models/bulk.md

@@ -0,0 +1,7 @@
+::: anaplan_sdk.models._bulk
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

anaplan_sdk-0.4.3a1/docs/api/models/cloud_works.md

@@ -0,0 +1,7 @@
+::: anaplan_sdk.models.cloud_works
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

anaplan_sdk-0.4.3a1/docs/api/models/flows.md

@@ -0,0 +1,7 @@
+::: anaplan_sdk.models.flows
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

anaplan_sdk-0.4.3a1/docs/api/models/transactional.md

@@ -0,0 +1,7 @@
+::: anaplan_sdk.models._transactional
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3a1}/docs/api/sync/sync_alm_client.md

@@ -3,3 +3,9 @@
     instance of [Client](sync_client.md). For more details, see the [Guide](../../guides/alm.md).
 
 ::: anaplan_sdk._clients._AlmClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3a1}/docs/api/sync/sync_audit_client.md

@@ -3,3 +3,9 @@
     instance of [Client](sync_client.md). For more details, see the [Guide](../../guides/audit.md).
 
 ::: anaplan_sdk._clients._AuditClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

anaplan_sdk-0.4.3a1/docs/api/sync/sync_client.md

@@ -0,0 +1,9 @@
+# Bulk API Client (`Client`)
+
+::: anaplan_sdk.Client
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3a1}/docs/api/sync/sync_cw_client.md

@@ -3,3 +3,9 @@
     instance of [Client](sync_client.md). For more details, see the [Guide](../../guides/cloud_works.md).
 
 ::: anaplan_sdk._async_clients._AsyncCloudWorksClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3a1}/docs/api/sync/sync_flows_client.md

@@ -3,3 +3,9 @@
     instance of [Client](sync_client.md). For more details, see the [Guide](../../guides/cloud_works.md).
 
 ::: anaplan_sdk._async_clients._cw_flow._AsyncFlowClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

anaplan_sdk-0.4.3a1/docs/api/sync/sync_oauth_client.md

@@ -0,0 +1,10 @@
+# Oauth
+
+::: anaplan_sdk._oauth.Oauth
+    options:
+        inherited_members: true
+        members:
+        - __init__
+        - authorization_url
+        - fetch_token
+

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3a1}/docs/api/sync/sync_transactional_client.md

@@ -3,3 +3,9 @@
     instance of [Client](sync_client.md). For more details, see the [Guide](../../guides/transactional.md).
 
 ::: anaplan_sdk._clients._TransactionalClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3a1}/docs/css/styles.css

@@ -35,7 +35,7 @@
     color: #D55FDE
 }
 
-.hljs-addition, .hljs-attribute, .hljs-meta .hljs-string, .hljs-regexp, .hljs-string {
+.hljs-addition, .hljs-attribute, .hljs-string, .hljs-regexp, .hljs-string {
     color: #2fb170
 }
 
@@ -43,7 +43,7 @@
     color: #abb2bf
 }
 
-.hljs-type {
+.hljs-type, .hljs-meta {
     color: #E4B962;
 }
 
@@ -51,7 +51,7 @@
     color: #d0864a
 }
 
-.hljs-bullet, .hljs-link, .hljs-meta, .hljs-selector-id, .hljs-symbol, .hljs-title, .hljs-class .hljs-title, .hljs-title.class_ {
+.hljs-bullet, .hljs-link, .hljs-selector-id, .hljs-symbol, .hljs-title, .hljs-class .hljs-title, .hljs-title.class_ {
     color: #5488e8
 }