symphony_bdk_python 2.11.1__tar.gz → 3.0.0b0__tar.gz

symphony_bdk_python-3.0.0b0/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: symphony_bdk_python
+Version: 3.0.0b0
+Summary: Symphony Bot Development Kit for Python
+License: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Author: Symphony Platform Solutions
+Author-email: symphony@finos.org
+Requires-Python: >=3.9, !=2.7.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*, !=3.8.*
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+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: PyJWT (>=2.10.0,<3.0.0)
+Requires-Dist: aiohttp (>=3.12.14,<4.0.0)
+Requires-Dist: aiohttp-retry (>=2.9.1,<3.0.0)
+Requires-Dist: cryptography (>=44.0.1,<45.0.0)
+Requires-Dist: defusedxml (>=0.7.1,<0.8.0)
+Requires-Dist: docutils (==0.16)
+Requires-Dist: nulltype (>=2.3.1,<3.0.0)
+Requires-Dist: pydantic (>=2.11.7,<3.0.0)
+Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
+Requires-Dist: pyyaml (>=6.0,<7.0)
+Requires-Dist: tenacity (>=8.0.1,<9.0.0)
+Requires-Dist: urllib3 (>=2.5.0,<3)
+Project-URL: Documentation, https://symphony-bdk-python.finos.org/
+Project-URL: Repository, https://github.com/finos/symphony-bdk-python
+Description-Content-Type: text/markdown
+
+[![FINOS - Active](https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-active.svg)](https://community.finos.org/docs/governance/Software-Projects/stages/active)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)](https://www.python.org/downloads/)
+[![Pypi](https://img.shields.io/pypi/v/symphony-bdk-python)](https://pypi.org/project/symphony-bdk-python/)
+![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/finos/symphony-bdk-python/build/main)
+
+# Symphony BDK for Python
+
+This is the Symphony BDK for Python to help develop bots and interact with the [Symphony REST APIs](https://rest-api.symphony.com).
+
+## Project Overview
+
+Symphony BDK for Python provides tools for building bots and integrating with Symphony APIs. This document outlines its usage, installation, and contribution guidelines.
+
+## Prerequisites
+
+- Python 3.9 or higher
+- [Poetry](https://python-poetry.org/docs/#installation)
+
+## Installation Steps
+
+### Option 1: Build from Source
+- Install dependencies: `poetry install`
+- Build the package: `poetry build`
+- Run tests: `poetry run pytest`
+- Perform a lint scan locally: `poetry run ruff check .`
+- Format code locally: `poetry run ruff format .`
+- Generate documentation locally: `cd docsrc && make html`
+
+### Setting Up Git Hooks
+This project uses `pre-commit` with `ruff` to automatically format and lint code. This is the recommended setup for contributors to ensure code style consistency.
+
+1. **Install development dependencies** (this will also install `pre--commit` and `ruff`):
+   ```bash
+   poetry install
+   ```
+2. **Install the git hooks**:
+   ```bash
+   poetry run pre-commit install
+   ```
+Now, `ruff` will automatically run on every commit, formatting your code and checking for linting errors.
+
+### Verification
+Verify the successful installation by running any of the following commands:
+```
+poetry --version
+```
+
+## External Documents
+
+Refer to the following for additional guidance:
+- [Reference Documentation](https://symphony-bdk-python.finos.org/)
+- [Getting Started Guide](https://symphony-bdk-python.finos.org/markdown/getting_started.html)
+
+## Roadmap
+
+The next milestone is the [2.5.x](https://github.com/finos/symphony-bdk-python/milestone/6), focused on delivering improvements and bug fixes.
+
+## Contributing
+
+To contribute:
+1. Fork the repository.
+2. Create a feature branch: `git checkout -b feature/fooBar`
+3. Read the [Contribution Guidelines](CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct)
+4. Commit changes: `git commit -am 'Add some fooBar'`
+5. Push changes: `git push origin feature/fooBar`
+6. Open a Pull Request.
+
+_NOTE:_ Ensure you have an active Individual Contributor License Agreement (ICLA) or Corporate Contribution License Agreement (CCLA) with FINOS.
+
+For further inquiries, email [help@finos.org](mailto:help@finos.org).
+
+### Updating Generated Code
+
+Python BDK uses [OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator/) to generate code. 
+To update the generated code, follow these steps:
+
+1. Download desired version of openapi generator.
+     ```bash
+     cd api_client_generation
+     curl -L https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.14.0/openapi-generator-cli-7.14.0.jar      -o openapi-generator-cli.jar
+     ```
+2. Adjust the commit for which the code is generated(inside generate.sh script)
+3. Execute the generation script: 
+   ```bash
+   ./generate.sh
+   ```
+4. Commit and push the newly generated code along with the updated JAR file.
+
+Note: There are a few files that are not replaced(EX. api_client.py), those files require some modifications after code is generated.
+
+
+### OLD Updating Generated Code (Deprecated)
+
+Python BDK uses [OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator/) to generate code. 
+To update the generated code, follow these steps:
+
+1. Checkout the latest branch of the fork (e.g., [sym-python-5.5.0](https://github.com/SymphonyPlatformSolutions/openapi-generator/tree/sym-python-5.5.0)).
+2. Update the fork source code, review, and merge it.
+3. Generate the JAR file in `openapi-generatormodules/openapi-generator-cli/target/openapi-generator-cli.jar`:
+   - Use Maven: 
+     ```bash
+     mvn clean install -Dmaven.test.skip=true && mvn clean package -Dmaven.test.skip=true
+     ```
+   - Alternatively, use IntelliJ's build button to build the project and generate the JAR file.
+4. Copy the JAR file to the Python BDK repository: `symphony-api-client-python/api_client_generation/openapi-generator-cli.jar`.
+5. Execute the generation script: 
+   ```bash
+   ./generate.sh
+   ```
+6. Commit and push the newly generated code along with the updated JAR file.
+
+
+## License
+
+Copyright 2021 Symphony LLC
+
+Distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
+
+SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0).
+

symphony_bdk_python-3.0.0b0/README.md

@@ -0,0 +1,120 @@
+[![FINOS - Active](https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-active.svg)](https://community.finos.org/docs/governance/Software-Projects/stages/active)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)](https://www.python.org/downloads/)
+[![Pypi](https://img.shields.io/pypi/v/symphony-bdk-python)](https://pypi.org/project/symphony-bdk-python/)
+![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/finos/symphony-bdk-python/build/main)
+
+# Symphony BDK for Python
+
+This is the Symphony BDK for Python to help develop bots and interact with the [Symphony REST APIs](https://rest-api.symphony.com).
+
+## Project Overview
+
+Symphony BDK for Python provides tools for building bots and integrating with Symphony APIs. This document outlines its usage, installation, and contribution guidelines.
+
+## Prerequisites
+
+- Python 3.9 or higher
+- [Poetry](https://python-poetry.org/docs/#installation)
+
+## Installation Steps
+
+### Option 1: Build from Source
+- Install dependencies: `poetry install`
+- Build the package: `poetry build`
+- Run tests: `poetry run pytest`
+- Perform a lint scan locally: `poetry run ruff check .`
+- Format code locally: `poetry run ruff format .`
+- Generate documentation locally: `cd docsrc && make html`
+
+### Setting Up Git Hooks
+This project uses `pre-commit` with `ruff` to automatically format and lint code. This is the recommended setup for contributors to ensure code style consistency.
+
+1. **Install development dependencies** (this will also install `pre--commit` and `ruff`):
+   ```bash
+   poetry install
+   ```
+2. **Install the git hooks**:
+   ```bash
+   poetry run pre-commit install
+   ```
+Now, `ruff` will automatically run on every commit, formatting your code and checking for linting errors.
+
+### Verification
+Verify the successful installation by running any of the following commands:
+```
+poetry --version
+```
+
+## External Documents
+
+Refer to the following for additional guidance:
+- [Reference Documentation](https://symphony-bdk-python.finos.org/)
+- [Getting Started Guide](https://symphony-bdk-python.finos.org/markdown/getting_started.html)
+
+## Roadmap
+
+The next milestone is the [2.5.x](https://github.com/finos/symphony-bdk-python/milestone/6), focused on delivering improvements and bug fixes.
+
+## Contributing
+
+To contribute:
+1. Fork the repository.
+2. Create a feature branch: `git checkout -b feature/fooBar`
+3. Read the [Contribution Guidelines](CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct)
+4. Commit changes: `git commit -am 'Add some fooBar'`
+5. Push changes: `git push origin feature/fooBar`
+6. Open a Pull Request.
+
+_NOTE:_ Ensure you have an active Individual Contributor License Agreement (ICLA) or Corporate Contribution License Agreement (CCLA) with FINOS.
+
+For further inquiries, email [help@finos.org](mailto:help@finos.org).
+
+### Updating Generated Code
+
+Python BDK uses [OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator/) to generate code. 
+To update the generated code, follow these steps:
+
+1. Download desired version of openapi generator.
+     ```bash
+     cd api_client_generation
+     curl -L https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.14.0/openapi-generator-cli-7.14.0.jar      -o openapi-generator-cli.jar
+     ```
+2. Adjust the commit for which the code is generated(inside generate.sh script)
+3. Execute the generation script: 
+   ```bash
+   ./generate.sh
+   ```
+4. Commit and push the newly generated code along with the updated JAR file.
+
+Note: There are a few files that are not replaced(EX. api_client.py), those files require some modifications after code is generated.
+
+
+### OLD Updating Generated Code (Deprecated)
+
+Python BDK uses [OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator/) to generate code. 
+To update the generated code, follow these steps:
+
+1. Checkout the latest branch of the fork (e.g., [sym-python-5.5.0](https://github.com/SymphonyPlatformSolutions/openapi-generator/tree/sym-python-5.5.0)).
+2. Update the fork source code, review, and merge it.
+3. Generate the JAR file in `openapi-generatormodules/openapi-generator-cli/target/openapi-generator-cli.jar`:
+   - Use Maven: 
+     ```bash
+     mvn clean install -Dmaven.test.skip=true && mvn clean package -Dmaven.test.skip=true
+     ```
+   - Alternatively, use IntelliJ's build button to build the project and generate the JAR file.
+4. Copy the JAR file to the Python BDK repository: `symphony-api-client-python/api_client_generation/openapi-generator-cli.jar`.
+5. Execute the generation script: 
+   ```bash
+   ./generate.sh
+   ```
+6. Commit and push the newly generated code along with the updated JAR file.
+
+
+## License
+
+Copyright 2021 Symphony LLC
+
+Distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
+
+SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0).

symphony_bdk_python-3.0.0b0/pyproject.toml

@@ -0,0 +1,94 @@
+[tool.poetry]
+name = "symphony_bdk_python"
+version = "3.0.0-beta"
+license = "Apache-2.0"
+description = "Symphony Bot Development Kit for Python"
+readme = "README.md"
+authors = ["Symphony Platform Solutions <symphony@finos.org>"]
+repository = "https://github.com/finos/symphony-bdk-python"
+documentation = "https://symphony-bdk-python.finos.org/"
+packages = [
+    { include = "symphony" }
+]
+
+[tool.poetry.dependencies]
+python = ">3.9.0,<3.9.1 || >3.9.1,<4.0"
+nulltype = "^2.3.1"
+python-dateutil = "^2.8.2"
+urllib3 = ">=2.5.0,<3"
+aiohttp = "^3.12.14"
+pyyaml = "^6.0"
+PyJWT = "^2.10.0"
+cryptography = "^44.0.1"
+tenacity = "^8.0.1"
+defusedxml = "^0.7.1"
+docutils = "0.16"
+pydantic = "^2.11.7"
+aiohttp-retry = "^2.9.1"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.3.3"
+pytest-cov = "^5.0.0"
+pytest-asyncio = "^0.24.0"
+Sphinx = "^4.4.0"
+jinja2 = "^3.1.6"
+recommonmark = "^0.7.1"
+furo = "^2022.3.4"
+hazelcast-python-client = "^5.0.1"
+safety = "^2.3.5"
+setuptools = "^79.0.0"
+liccheck = "^0.9.2"
+coverage = {version = "^6.0b1", extras = ["toml"]}
+ruff = "^0.12.8"
+pre-commit = "^4.3.0"
+
+[tool.poetry.requires-plugins]
+poetry-plugin-export = ">=1.8"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+addopts = "--junitxml=test-results/junit.xml --cov --cov-report=html"
+testpaths = ["tests"]
+markers = ["e2e: marks tests as end-to-end tests"]
+norecursedirs = ["*.egg", ".*", "build", "dist", "venv", "legacy"]
+junit_logging = "all"
+
+[tool.coverage.run]
+branch = true
+source = ["symphony"]
+omit = ["symphony/bdk/gen/*"]
+
+[tool.coverage.report]
+fail_under = 90.0
+
+[tool.liccheck]
+authorized_licenses = [
+    "BSD",
+    "GNU Library or Lesser General Public License (LGPL)",
+    "MIT",
+    "Apache Software",
+    "Apache-2.0",
+    "Python Software Foundation"
+]
+
+
+
+[tool.ruff]
+include = ["pyproject.toml", "symphony/**/*.py", "examples/**/*.py"]
+exclude = [
+    "symphony/bdk/gen",
+]
+
+target-version = "py39"
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "W", "F", "I"]
+ignore = ["E501"]
+
+[tool.ruff.format]
+quote-style = "double"
+

symphony_bdk_python-3.0.0b0/symphony/bdk/core/auth/ext_app_authenticator.py

@@ -0,0 +1,176 @@
+"""Module containing extension app authenticator classes."""
+
+from abc import ABC, abstractmethod
+
+from symphony.bdk.core.auth.auth_session import AppAuthSession
+from symphony.bdk.core.auth.jwt_helper import create_signed_jwt, validate_jwt
+from symphony.bdk.core.auth.tokens_repository import InMemoryTokensRepository, TokensRepository
+from symphony.bdk.core.config.model.bdk_retry_config import BdkRetryConfig
+from symphony.bdk.core.config.model.bdk_rsa_key_config import BdkRsaKeyConfig
+from symphony.bdk.core.retry import retry
+from symphony.bdk.core.retry.strategy import authentication_retry
+from symphony.bdk.gen.auth_api.certificate_authentication_api import CertificateAuthenticationApi
+from symphony.bdk.gen.auth_api.certificate_pod_api import CertificatePodApi
+from symphony.bdk.gen.auth_model.extension_app_authenticate_request import (
+    ExtensionAppAuthenticateRequest,
+)
+from symphony.bdk.gen.login_api.authentication_api import AuthenticationApi
+from symphony.bdk.gen.login_model.authenticate_extension_app_request import (
+    AuthenticateExtensionAppRequest,
+)
+from symphony.bdk.gen.login_model.extension_app_tokens import ExtensionAppTokens
+from symphony.bdk.gen.pod_api.pod_api import PodApi
+from symphony.bdk.gen.pod_model.pod_certificate import PodCertificate
+
+
+class ExtensionAppAuthenticator(ABC):
+    """Base abstract class to handle extension app authentication."""
+
+    def __init__(self, app_id: str, tokens_repository: TokensRepository = None):
+        """
+
+        :param app_id: the application ID
+        :param tokens_repository: the tokens repository to store existing valid sessions.
+          Defaults to InMemoryTokensRepository
+        """
+        self._app_id = app_id
+        self._tokens_repository = tokens_repository or InMemoryTokensRepository()
+
+    async def authenticate_extension_app(self, app_token: str) -> AppAuthSession:
+        """Authenticates an extension app.
+
+        :param app_token: the token generated by the application backend
+        :return: the extension app authentication session
+        """
+        auth_session = AppAuthSession(self, app_token)
+        await auth_session.refresh()
+
+        return auth_session
+
+    async def validate_jwt(self, jwt: str) -> dict:
+        """Validates a jwt against the pod certificate.
+
+        :param jwt: the jwt to be validated
+        :return: the dictionary of jwt claims
+        :raise AuthInitializationError: If the pod certificate or jwt are invalid.
+        """
+        pod_certificate = await self._get_pod_certificate()
+        return validate_jwt(jwt, pod_certificate.certificate, self._app_id)
+
+    async def authenticate_and_retrieve_tokens(self, app_token: str) -> ExtensionAppTokens:
+        """Actually authenticates and retrieves the tokens.
+        Save the tokens in the tokens repository.
+
+        :param app_token: the token generated by the application backend
+        :return: the extension app tokens
+        """
+        ext_app_tokens = await self._retrieve_tokens(app_token)
+        await self._tokens_repository.save(ext_app_tokens.app_token, ext_app_tokens.symphony_token)
+
+        return ext_app_tokens
+
+    async def is_token_pair_valid(self, app_token: str, symphony_token: str) -> bool:
+        """Validates if appToken and symphonyToken corresponds to an existing session.
+
+        :param app_token: the application token
+        :param symphony_token: the Symphony token
+        :return: True if token pair is valid, False otherwise
+        """
+        retrieved_sym_token = await self._tokens_repository.get(app_token)
+        return retrieved_sym_token is not None and retrieved_sym_token == symphony_token
+
+    @abstractmethod
+    async def _get_pod_certificate(self) -> PodCertificate:
+        """Retrieves the pod certificate. Used when validating JWT tokens.
+
+        :return: the pod certificate
+        """
+
+    @abstractmethod
+    async def _retrieve_tokens(self, app_token: str) -> ExtensionAppTokens:
+        """Actually authenticates and retrieves the tokens.
+
+        :param app_token: the token generated by the application backend
+        :return: the extension app tokens
+        """
+
+
+class ExtensionAppAuthenticatorRsa(ExtensionAppAuthenticator):
+    """A subclass of :class:`ExtensionAppAuthenticator` specific to extension app RSA authentication."""
+
+    def __init__(
+        self,
+        authentication_api: AuthenticationApi,
+        pod_api: PodApi,
+        app_id: str,
+        private_key_config: BdkRsaKeyConfig,
+        retry_config: BdkRetryConfig,
+        tokens_repository: TokensRepository = None,
+    ):
+        """
+
+        :param authentication_api: the AuthenticationApi instance
+        :param pod_api: the PodApi instance
+        :param app_id: the application ID
+        :param private_key_config: the private key configuration of the extension app
+        :param retry_config: retry configuration
+        :param tokens_repository: the tokens repository to store existing valid sessions.
+          Defaults to InMemoryTokensRepository
+        """
+        super().__init__(app_id, tokens_repository)
+        self._authentication_api = authentication_api
+        self._pod_api = pod_api
+        self._private_key_config = private_key_config
+        self._retry_config = retry_config
+
+    @retry(retry=authentication_retry)
+    async def _retrieve_tokens(self, app_token: str) -> ExtensionAppTokens:
+        jwt = create_signed_jwt(self._private_key_config, self._app_id)
+        authentication_request = AuthenticateExtensionAppRequest(
+            app_token=app_token, auth_token=jwt
+        )
+
+        return await self._authentication_api.v1_pubkey_app_authenticate_extension_app_post(
+            authenticate_request=authentication_request
+        )
+
+    @retry(retry=authentication_retry)
+    async def _get_pod_certificate(self) -> PodCertificate:
+        return await self._pod_api.v1_podcert_get()
+
+
+class ExtensionAppAuthenticatorCert(ExtensionAppAuthenticator):
+    """A subclass of :class:`ExtensionAppAuthenticator` specific to extension app certificate authentication."""
+
+    def __init__(
+        self,
+        certificate_authentication_api: CertificateAuthenticationApi,
+        certificate_pod_api: CertificatePodApi,
+        app_id: str,
+        retry_config: BdkRetryConfig,
+        tokens_repository: TokensRepository = None,
+    ):
+        """
+
+        :param certificate_authentication_api: the CertificateAuthenticationApi instance
+        :param certificate_pod_api: the CertificatePodApi instance
+        :param app_id: the application ID
+        :param retry_config: Retry configuration
+        :param tokens_repository: the tokens repository to store existing valid sessions.
+          Defaults to InMemoryTokensRepository
+        """
+        super().__init__(app_id, tokens_repository)
+        self._certificate_authentication_api = certificate_authentication_api
+        self._certificate_pod_api = certificate_pod_api
+        self._retry_config = retry_config
+
+    @retry(retry=authentication_retry)
+    async def _retrieve_tokens(self, app_token: str) -> ExtensionAppTokens:
+        authentication_request = ExtensionAppAuthenticateRequest(app_token=app_token)
+        return await self._certificate_authentication_api.v1_authenticate_extension_app_post(
+            auth_request=authentication_request
+        )
+
+    @retry(retry=authentication_retry)
+    async def _get_pod_certificate(self) -> PodCertificate:
+        return await self._certificate_pod_api.v1_app_pod_certificate_get()