amazon-creatorsapi-python-sdk 1.0.0__py3-none-any.whl

creatorsapi_python_sdk/api_response.py

@@ -0,0 +1,21 @@
+"""API response object."""
+
+from __future__ import annotations
+from typing import Optional, Generic, Mapping, TypeVar
+from pydantic import Field, StrictInt, StrictBytes, BaseModel
+
+T = TypeVar("T")
+
+class ApiResponse(BaseModel, Generic[T]):
+    """
+    API response object
+    """
+
+    status_code: StrictInt = Field(description="HTTP status code")
+    headers: Optional[Mapping[str, str]] = Field(None, description="HTTP headers")
+    data: T = Field(description="Deserialized data given the data type")
+    raw_data: StrictBytes = Field(description="Raw data (HTTP response body)")
+
+    model_config = {
+        "arbitrary_types_allowed": True
+    }

creatorsapi_python_sdk/auth/__init__.py

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+"""
+  Copyright 2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+  Licensed under the Apache License, Version 2.0 (the "License").
+  You may not use this file except in compliance with the License.
+  A copy of the License is located at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  or in the "license" file accompanying this file. This file is distributed
+  on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+  express or implied. See the License for the specific language governing
+  permissions and limitations under the License.
+"""
+
+from creatorsapi_python_sdk.auth.oauth2_config import OAuth2Config
+from creatorsapi_python_sdk.auth.oauth2_token_manager import OAuth2TokenManager
+
+__all__ = ['OAuth2Config', 'OAuth2TokenManager']

creatorsapi_python_sdk/auth/oauth2_config.py

@@ -0,0 +1,123 @@
+# coding: utf-8
+
+"""
+  Copyright 2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+  Licensed under the Apache License, Version 2.0 (the "License").
+  You may not use this file except in compliance with the License.
+  A copy of the License is located at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  or in the "license" file accompanying this file. This file is distributed
+  on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+  express or implied. See the License for the specific language governing
+  permissions and limitations under the License.
+"""
+
+"""
+OAuth2 configuration class that manages version-specific cognito endpoints
+"""
+
+
+class OAuth2Config:
+    """OAuth2 configuration class that manages version-specific cognito endpoints"""
+    
+    # Constants
+    SCOPE = "creatorsapi/default"
+    GRANT_TYPE = "client_credentials"
+
+    def __init__(self, credential_id, credential_secret, version, auth_endpoint):
+        """
+        Creates an OAuth2Config instance
+        
+        :param credential_id: The OAuth2 credential Id
+        :param credential_secret: The OAuth2 credential secret
+        :param version: The credential version (determines the token endpoint)
+        :param auth_endpoint: Optional custom auth endpoint URL
+        """
+        self.credential_id = credential_id
+        self.credential_secret = credential_secret
+        self.version = version
+        self.auth_endpoint = auth_endpoint
+        self.cognito_endpoint = self.determine_token_endpoint(version, auth_endpoint)
+
+    def determine_token_endpoint(self, version, auth_endpoint):
+        """
+        Determines the appropriate OAuth2 token endpoint based on version or custom endpoint
+        
+        :param version: The credential version
+        :param auth_endpoint: Optional custom auth endpoint URL
+        :return: The OAuth2 token endpoint URL
+        :raises ValueError: If the version is not supported and no custom endpoint provided
+        """
+        if auth_endpoint and auth_endpoint.strip():
+            return auth_endpoint
+        
+        # Fall back to version-based defaults
+        if version == "2.1":
+            return "https://creatorsapi.auth.us-east-1.amazoncognito.com/oauth2/token"
+        elif version == "2.2":
+            return "https://creatorsapi.auth.eu-south-2.amazoncognito.com/oauth2/token"
+        elif version == "2.3":
+            return "https://creatorsapi.auth.us-west-2.amazoncognito.com/oauth2/token"
+        else:
+            raise ValueError("Unsupported version: {}. Supported versions are: 2.1, 2.2, 2.3".format(version))
+
+    def get_token_endpoint(self, version):
+        """
+        Gets the appropriate OAuth2 token endpoint based on the credential version
+        
+        :param version: The credential version
+        :return: The OAuth2 token endpoint URL
+        :raises ValueError: If the version is not supported
+        """
+        return self.determine_token_endpoint(version, None)
+
+    def get_credential_id(self):
+        """
+        Gets the credential Id
+        
+        :return: The credential Id
+        """
+        return self.credential_id
+
+    def get_credential_secret(self):
+        """
+        Gets the credential secret
+        
+        :return: The credential secret
+        """
+        return self.credential_secret
+
+    def get_version(self):
+        """
+        Gets the credential version
+        
+        :return: The credential version
+        """
+        return self.version
+
+    def get_cognito_endpoint(self):
+        """
+        Gets the Cognito token endpoint URL
+        
+        :return: The token endpoint URL
+        """
+        return self.cognito_endpoint
+
+    def get_scope(self):
+        """
+        Gets the OAuth2 scope
+        
+        :return: The OAuth2 scope
+        """
+        return OAuth2Config.SCOPE
+
+    def get_grant_type(self):
+        """
+        Gets the OAuth2 grant type
+        
+        :return: The OAuth2 grant type
+        """
+        return OAuth2Config.GRANT_TYPE

creatorsapi_python_sdk/auth/oauth2_token_manager.py

@@ -0,0 +1,120 @@
+# coding: utf-8
+
+"""
+  Copyright 2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+  Licensed under the Apache License, Version 2.0 (the "License").
+  You may not use this file except in compliance with the License.
+  A copy of the License is located at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  or in the "license" file accompanying this file. This file is distributed
+  on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+  express or implied. See the License for the specific language governing
+  permissions and limitations under the License.
+"""
+
+"""
+OAuth2 Token Manager for handling token refresh and caching.
+
+Note: ApiClient automatically manages token caching for optimal performance.
+Direct instantiation is only needed for advanced use cases.
+"""
+
+import requests
+import time
+import json
+
+
+class OAuth2TokenManager:
+    """Manages OAuth2 token lifecycle including acquisition, caching, and automatic refresh"""
+
+    def __init__(self, config):
+        """
+        Creates an OAuth2TokenManager instance
+        
+        :param config: The OAuth2Config instance
+        """
+        self.config = config
+        self.access_token = None
+        self.expires_at = None
+
+    def get_token(self):
+        """
+        Gets a valid OAuth2 access token, refreshing if necessary
+        
+        :return: A valid access token
+        :raises Exception: If token acquisition fails
+        """
+        if self.is_token_valid():
+            return self.access_token
+        return self.refresh_token()
+
+    def is_token_valid(self):
+        """
+        Checks if the current token is valid and not expired
+        
+        :return: True if the token is valid, false otherwise
+        """
+        return self.access_token and self.expires_at and time.time() < self.expires_at
+
+    def refresh_token(self):
+        """
+        Refreshes the OAuth2 access token using client credentials grant
+        
+        :return: The new access token
+        :raises Exception: If token refresh fails
+        """
+        try:
+            request_data = {
+                'grant_type': self.config.get_grant_type(),
+                'client_id': self.config.get_credential_id(),
+                'client_secret': self.config.get_credential_secret(),
+                'scope': self.config.get_scope()
+            }
+
+            headers = {
+                'Content-Type': 'application/x-www-form-urlencoded'
+            }
+
+            response = requests.post(
+                self.config.get_cognito_endpoint(),
+                data=request_data,
+                headers=headers
+            )
+            if response.status_code != 200:
+                raise Exception("OAuth2 token request failed with status {}: {}".format(response.status_code, response.text))
+
+            data = response.json()
+            
+            if 'access_token' not in data:
+                raise Exception('No access token received from OAuth2 endpoint')
+
+            self.access_token = data['access_token']
+            # Set expiration time with a 30-second buffer to avoid edge cases
+            expires_in = data.get('expires_in', 3600)  # Default to 1 hour if not provided
+            expires_in_with_buffer = expires_in - 30
+            self.expires_at = time.time() + expires_in_with_buffer
+            
+            return self.access_token
+            
+        except requests.exceptions.RequestException as e:
+            # Clear existing token on failure
+            self.clear_token()
+            raise Exception("OAuth2 token request failed: {}".format(str(e)))
+        except json.JSONDecodeError as e:
+            # Clear existing token on failure
+            self.clear_token()
+            raise Exception("Failed to parse OAuth2 token response: {}".format(str(e)))
+        except Exception as e:
+            # Clear existing token on failure
+            self.clear_token()
+            raise e
+
+    def clear_token(self):
+        """
+        Clears the cached token, forcing a refresh on the next get_token() call
+        """
+        self.access_token = None
+        self.expires_at = None