arcane-tiktok 0.1.0__tar.gz

arcane_tiktok-0.1.0/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.4
+Name: arcane-tiktok
+Version: 0.1.0
+Summary: Helpers to request Tiktok API
+Author: Arcane
+Author-email: product@wearcane.com
+Requires-Python: >=3.9,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: arcane-core (==1.7.0)
+Requires-Dist: arcane-datastore (>=1,<2)
+Requires-Dist: arcane-requests (>=0,<1)
+Requires-Dist: backoff (>=1.10.0)
+Requires-Dist: requests
+Description-Content-Type: text/markdown
+
+# Arcane tiktok README
+
+
+## Release history
+To see changes, please see CHANGELOG.md
+

arcane_tiktok-0.1.0/README.md

@@ -0,0 +1,5 @@
+# Arcane tiktok README
+
+
+## Release history
+To see changes, please see CHANGELOG.md

arcane_tiktok-0.1.0/arcane/tiktok/__init__.py

@@ -0,0 +1,4 @@
+from .tiktok import *
+from .const import *
+from .exceptions import *
+from .lib import *

arcane_tiktok-0.1.0/arcane/tiktok/const.py

@@ -0,0 +1,2 @@
+TIKTOK_SERVER_URL = "https://business-api.tiktok.com/open_api/v1.3"
+TIKTOK_OAUTH_CREDENTIALS_KIND = "tiktok-oauth-credentials"

arcane_tiktok-0.1.0/arcane/tiktok/exceptions.py

@@ -0,0 +1,7 @@
+class TikTokAuthError(Exception):
+    """Raised when there is an authentication error with TikTok API"""
+    pass
+
+class TikTokApiError(Exception):
+    """Raised when there is a general API error with TikTok API"""
+    pass

arcane_tiktok-0.1.0/arcane/tiktok/lib.py

@@ -0,0 +1,82 @@
+from typing import Optional
+
+from arcane.datastore import Client as DatastoreClient
+from arcane.core import BadRequestError, BaseAccount, ALL_CLIENTS_RIGHTS, UserRightsEnum, RightsLevelEnum
+from arcane.requests import call_get_route
+
+from .const import TIKTOK_OAUTH_CREDENTIALS_KIND
+
+def get_tiktok_account(
+    base_account: BaseAccount,
+    clients_service_url: Optional[str] = None,
+    firebase_api_key: Optional[str] = None,
+    gcp_service_account: Optional[str] = None,
+    auth_enabled: bool = True
+) -> dict:
+    """Fetch TikTok account details using the base account information.
+
+    Args:
+        base_account (BaseAccount): The base account object.
+        clients_service_url (Optional[str]): URL of the clients service.
+        firebase_api_key (Optional[str]): Firebase API key for authentication.
+        gcp_service_account (Optional[str]): Path to the GCP service account file.
+        auth_enabled (bool): Flag to enable or disable authentication.
+
+    Raises:
+        BadRequestError: Raised when required parameters are missing or invalid.
+
+    Returns:
+        dict: TikTok account.
+    """
+
+    if not (clients_service_url and firebase_api_key and gcp_service_account):
+        raise BadRequestError('clients_service_url or firebase_api_key or gcp_service_account should not be None if tiktok account is not provided')
+
+    url = f"{clients_service_url}/api/tiktok-account?advertiser_id={base_account['id']}&client_id={base_account['client_id']}"
+    accounts = call_get_route(
+        url,
+        firebase_api_key,
+        claims={'features_rights': { UserRightsEnum.AMS_GTP: RightsLevelEnum.VIEWER }, 'authorized_clients': [ALL_CLIENTS_RIGHTS]},
+        auth_enabled=auth_enabled,
+        credentials_path=gcp_service_account
+    )
+    if len(accounts) == 0:
+        raise BadRequestError(f'Error while getting tiktok account with: {base_account}. No account corresponding.')
+    elif len(accounts) > 1:
+        raise BadRequestError(f'Error while getting tiktok account with: {base_account}. Several account corresponding: {accounts}')
+
+    return accounts[0]
+
+
+def get_tikok_user_credentials(
+    user_email: str,
+    gcp_credentials_path: Optional[str],
+    gcp_project: Optional[str],
+    datastore_client: Optional[DatastoreClient]
+    ):
+    """Retrieve and decrypt TikTok user credentials.
+
+    Args:
+        user_email (str): Email of the user whose credentials are to be fetched.
+        secret_key_file (str): Path to the secret key file for decryption.
+        gcp_credentials_path (Optional[str]): Path to GCP credentials.
+        gcp_project (Optional[str]): GCP project ID.
+        datastore_client (Optional[DatastoreClient]): Datastore client instance.
+
+    """
+
+    if not datastore_client:
+        if not gcp_credentials_path and not gcp_project:
+            raise BadRequestError('gcp_credentials_path or gcp_project should not be None if datastore_client is not provided')
+        datastore_client = DatastoreClient.from_service_account_json(gcp_credentials_path, project=gcp_project)
+
+    query = datastore_client.query(kind=TIKTOK_OAUTH_CREDENTIALS_KIND).add_filter('email', '=', user_email)
+    users_credential = list(query.fetch())
+    if len(users_credential) == 0:
+        raise BadRequestError(f'Error while getting tiktok user credentials with mail: {user_email}. No entity corresponding.')
+    elif len(users_credential) > 1:
+        raise BadRequestError(f'Error while getting tiktok user credentials with mail: {user_email}. Several entities corresponding: {users_credential}')
+
+    return users_credential[0]
+
+

arcane_tiktok-0.1.0/arcane/tiktok/tiktok.py

@@ -0,0 +1,89 @@
+import json
+from typing import Optional, cast
+import backoff
+import requests
+
+from arcane.core import BaseAccount, BadRequestError
+from arcane.datastore import Client as DatastoreClient
+
+from .const import TIKTOK_SERVER_URL
+from .exceptions import TikTokAuthError, TikTokApiError
+from .lib import get_tiktok_account, get_tikok_user_credentials
+
+class TiktokClient:
+    def __init__(
+        self,
+        gcp_service_account: str,
+        base_account: Optional[BaseAccount] = None,
+        user_email: Optional[str] = None,
+        clients_service_url: Optional[str] = None,
+        firebase_api_key: Optional[str] = None,
+        gcp_credentials_path: Optional[str] = None,
+        datastore_client: Optional[DatastoreClient] = None,
+        gcp_project: Optional[str] = None,
+        auth_enabled: bool = True
+    ) -> None:
+
+        creator_email = None
+
+        if gcp_service_account and (base_account or user_email):
+            if user_email:
+                creator_email = user_email
+            else:
+                base_account = cast(BaseAccount, base_account)
+                tiktok_account = get_tiktok_account(
+                    base_account=base_account,
+                    clients_service_url=clients_service_url,
+                    firebase_api_key=firebase_api_key,
+                    gcp_service_account=gcp_service_account,
+                    auth_enabled=auth_enabled
+                )
+
+                creator_email = cast(str, tiktok_account['creator_email'])
+
+            if creator_email is None:
+                raise BadRequestError('creator_email should not be None while using user access protocol')
+
+            credentials = get_tikok_user_credentials(
+                user_email=creator_email,
+                gcp_credentials_path=gcp_credentials_path,
+                gcp_project=gcp_project,
+                datastore_client=datastore_client
+            )
+
+            self._access_token = credentials['access_token']
+        else:
+            raise BadRequestError('gcp_service_account and (base_account or user_email) should be provided to initialize TiktokClient')
+
+
+    @backoff.on_exception(backoff.expo, requests.exceptions.HTTPError, max_tries=5)
+    def _make_request(self, endpoint: str, method: str, params: Optional[dict] = None, headers: Optional[dict] = None, **kwargs) -> dict:
+        """Send a request to TikTok API"""
+
+        default_headers = {"Access-Token": self._access_token}
+        if headers:
+            default_headers.update(headers)
+
+        response = requests.request(method=method, url=f"{TIKTOK_SERVER_URL}{endpoint}", headers=default_headers, params=params, **kwargs)
+        response.raise_for_status()
+
+        response = response.json()
+        # tiktok return error codes in 200 HTTP responses
+        api_code = response.get('code')
+        if api_code != 0:
+            if api_code in [40104, 40105, 40106]:
+                raise TikTokAuthError(f"{response.get('message')}")
+            raise TikTokApiError(f"{response.get('message')}")
+
+        return response.get('data', {})
+
+    def get_advertiser_info(self, advertiser_ids: list[str]) -> dict:
+        """Get advertiser info"""
+        params = {"advertiser_ids": json.dumps(advertiser_ids)}
+
+        response = self._make_request(
+            endpoint="/advertiser/info/",
+            method="GET",
+            params=params
+            )
+        return response.get('list', {})

arcane_tiktok-0.1.0/pyproject.toml

@@ -0,0 +1,24 @@
+[tool.poetry]
+name = "arcane-tiktok"
+version = "0.1.0"
+description = "Helpers to request Tiktok API"
+readme = "README.md"
+authors = ["Arcane <product@wearcane.com>"]
+packages = [
+    { include = "arcane" }
+]
+
+[tool.poetry.dependencies]
+python = "^3.9"
+requests = '*'
+backoff = ">=1.10.0"
+arcane-core = "1.7.0"
+arcane-datastore = "^1"
+arcane-requests = "^0"
+
+
+[tool.poetry.group.dev.dependencies]
+
+[build-system]
+requires = ["poetry>=0.12"]
+build-backend = "poetry.masonry.api"