chatapult 0.1.0__tar.gz

chatapult-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

chatapult-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,35 @@
+# .pre-commit-config.yaml
+# Run `pre-commit install` to set up the git hook scripts.
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-added-large-files
+        args: ['--maxkb=500']
+      - id: check-ast
+      - id: check-merge-conflict
+      - id: requirements-txt-fixer
+
+  - repo: https://github.com/psf/black
+    rev: 26.3.1
+    hooks:
+      - id: black
+        language_version: python3
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.7
+    hooks:
+      - id: ruff
+        args: [ --fix ]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.19.1
+    hooks:
+      - id: mypy
+        additional_dependencies: [types-requests]

chatapult-0.1.0/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "python-envs.defaultEnvManager": "ms-python.python:system"
+}

chatapult-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,90 @@
+# Contributing to Chatapult
+
+First, thank you for your interest in contributing to Chatapult. Building a robust, async-ready Python API wrapper for Google Chat webhooks is a community effort, and we welcome contributions of all kinds—from bug reports and documentation improvements to new feature implementations.
+
+This document outlines the standard processes and coding guidelines for contributing to the Chatapult repository. By following these steps, you help ensure that the integration process is smooth, efficient, and transparent.
+
+## Table of Contents
+
+1. [Code of Conduct](#code-of-conduct)
+2. [Reporting Bugs and Requesting Features](#reporting-bugs-and-requesting-features)
+3. [Development Guidelines](#development-guidelines)
+4. [Commit Message Stands](#commit-message-standards)
+5. [Pull Request Process](#pull-request-process)
+
+## Code of Conduct
+
+We are committed to providing a welcoming and inspiring community for everyone. Be professional, respectful, and constructive in your communications. Harassment or abusive behavior will not be tolerated.
+
+## Reporting Bugs and Requesting Features
+
+GitHub Issues will be used to track public bugs and feature requests.
+
+### Bug Reports
+
+If you find a bug in the webhook client, please open an issue and include:
+* A clear, descriptive title.
+* The version of Python and Chatapult you are using.
+* Steps to reproduce the unexpected behavior.
+* Expected results versus actual results.
+* Relevant tracebacks or error messages.
+
+### Feature Requests
+
+When requesting new features (such as support for new Google Workspace API cards or widgets), please provide:
+* A clear description of the proposed feature.
+* The specific use case or problem it solves.
+* Any relevant links to the official Google Chat developer documentation.
+
+## Development Guidelines
+
+To ensure the codebase remains maintainable, highly adoptable, and standard across all contributors, we strictly adhere to automated code quality checks using `pre-commit`.
+
+### Setting Up Pre-Commit Hooks
+
+We use `pre-commit` to automatically run formatting (`black`), linting (`ruff`), and type-checking (`mypy`) every time you make a commit. This catches errors locally before the code is added to the codebase.
+
+1. **Install the pre-commit package:**
+```bash
+pip install pre-commit
+```
+2. ** Install the git hooks:** Run this once in your local repository.
+```bash
+pre-commit install
+```
+
+Now, every time you run `git commit`, the hooks will automatically format your code and check for errors.
+
+### Coding Standards
+
+* **Type Hinting:** All new functions, methods, and classes must include strict Python type hints (`typing` module). The `mypy` pre-commit hook will fail if types are missing or incorrect.
+* **Manual Hook Execution:** If you want to run the checks manually across all files without making a commit, you can run:
+```bash
+pre-commit run --all-files
+```
+* **Testing:** We use `pytest` for our test suite. All new features must include corresponding unit tests. Bug fixes must include a test that verifies the fix. Run the test suite locally using:
+```bash
+pytest
+```
+* **Documentation:** If you change the behavior of the API client or add new models, you must update the `README.md` and inline docstrings accordingly.
+
+## Commit Message Standards
+
+We follow the [Conventional Commits](https://www.conventionalcommits.org/) specification. This leads to more readable project history and allows us to automate release notes.
+
+Format: `<type>(<scope>): <subject>`
+
+**Examples:**
+* `feat(client): add async support for sending v2 cards`
+* `fix(auth): resolve environment variable loading error`
+* `docs(readme): update advanced usage examples`
+* `test(models): add unit tests for image widget`
+
+## Pull Request Process
+
+1. **Create a Branch:** Always branch off of `main`. Name your branch descriptively (e.g., `feature/async-client` or `bugfix/rate-limit-retry`).
+2. **Draft your PR:** Push your branch to your fork and open a Pull Request against the upstream `main` branch.
+3. **Fill out the PR Template:** Provide a clear summary of your changes, the rationale, and link to any related issues (e.g., "Closes #12").
+4. **Review:** A maintainer will review your code. Be prepared to make requested changes. Once approved, your PR will be merged.
+
+Thank you for helping make Chatapult the easiest way to integrate Google Chat notifications into Python!

chatapult-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Demetrios Lambropoulos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

chatapult-0.1.0/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: chatapult
+Version: 0.1.0
+Summary: A fast, Pythonic API wrapper for Google Chat webhooks.
+Author-email: Demetrios Lambropoulos <d.lambropoulos@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: api,async,google chat,notifications,webhook,wrapper
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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: Topic :: Communications :: Chat
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Requires-Dist: httpx>=0.24.0
+Provides-Extra: dev
+Requires-Dist: black>=24.0; extra == 'dev'
+Requires-Dist: mypy>=1.8; extra == 'dev'
+Requires-Dist: pre-commit>=3.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
+Requires-Dist: pytest-httpx>=0.22.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.3; extra == 'dev'
+Description-Content-Type: text/markdown
+
+![Chatapult Banner](images/banner.png)
+
+# Chatapult
+
+A fast, Pythonic API wrapper for Google Chat webhooks.
+
+Chatapult is designed to make sending automated notifications, CI/CD alerts, and rich UI cards to Google Workspace Spaces effortless. Whether you need a simple synchronous alert or a high-throughput async notification integration, Chatapult handles the boilerplate so you can focus on your application.
+
+![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen.svg)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+## Features
+
+* **Zero Boilerplate:** Send a message to a Google Chat Space in three lines of code.
+* **Async Ready:** First-class support for `asyncio`, making it perfect for FastAPI, Discord bots, and high-concurrency event loops.
+* **Rich V2 Cards (Coming Soon):** Construct complex Google Chat Cards and Widgets using clean Python objects instead of nested JSON.
+* **Threaded Replies:** Easily group related alerts by replying to specific message threads.
+* **Fully Typed:** Built with standard Python type hints for excellent IDE autocomplete and static checking.
+
+## Installation
+
+Install via pip:
+
+```bash
+pip install chatapult
+```
+
+## Quick Start
+
+**Security Note:** Never hardcode your webhook URLs. Always load them securely from environment variables or a secrets manager.
+
+### Synchronous Usage
+
+Perfect for simple scripts, cron jobs, or basic data pipelines.
+
+```python
+import os
+from chatapult import ChatClient, APIError
+
+webhook_url = os.environ.get("GOOGLE_CHAT_WEBHOOK_URL")
+
+try:
+    with ChatClient(webhook_url) as client:
+        response = client.send_message("Hello from Chatapult!")
+        print("Message sent successfully!")
+except APIError as e:
+    print(f"Failed to send message: {e}")
+```
+
+### Asynchronous Usage
+
+Ideal for web servers, async task queues, or applications where you cannot block the main thread.
+
+```python
+import asyncio
+import os
+from chatapult import AsyncChatClient, NetworkError
+
+async def main():
+    webhook_url = os.environ.get("GOOGLE_CHAT_WEBHOOK_URL")
+
+    try:
+        async with AsyncChatClient(webhook_url) as client:
+            await client.send_message("Hello from the async event loop!")
+            print("Async message sent successfully!")
+    except NetworkError as e:
+        print(f"Network issue encountered: {e}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+### Advanced Usage
+
+Documentation for sending V2 Cards, threaded replies, and handling rate-limit exceptions will be added here as features are released.
+
+## Contributing
+Contributions are welcome! If you'd like to help improve Chatapult, please review our [Contributing Guidelines](CONTRIBUTING.md) and open an issue or pull request.
+
+## License
+
+This project is licensed under the MIT License - see [LICENSE](LICENSE) for details.

chatapult-0.1.0/README.md

@@ -0,0 +1,83 @@
+![Chatapult Banner](images/banner.png)
+
+# Chatapult
+
+A fast, Pythonic API wrapper for Google Chat webhooks.
+
+Chatapult is designed to make sending automated notifications, CI/CD alerts, and rich UI cards to Google Workspace Spaces effortless. Whether you need a simple synchronous alert or a high-throughput async notification integration, Chatapult handles the boilerplate so you can focus on your application.
+
+![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen.svg)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+## Features
+
+* **Zero Boilerplate:** Send a message to a Google Chat Space in three lines of code.
+* **Async Ready:** First-class support for `asyncio`, making it perfect for FastAPI, Discord bots, and high-concurrency event loops.
+* **Rich V2 Cards (Coming Soon):** Construct complex Google Chat Cards and Widgets using clean Python objects instead of nested JSON.
+* **Threaded Replies:** Easily group related alerts by replying to specific message threads.
+* **Fully Typed:** Built with standard Python type hints for excellent IDE autocomplete and static checking.
+
+## Installation
+
+Install via pip:
+
+```bash
+pip install chatapult
+```
+
+## Quick Start
+
+**Security Note:** Never hardcode your webhook URLs. Always load them securely from environment variables or a secrets manager.
+
+### Synchronous Usage
+
+Perfect for simple scripts, cron jobs, or basic data pipelines.
+
+```python
+import os
+from chatapult import ChatClient, APIError
+
+webhook_url = os.environ.get("GOOGLE_CHAT_WEBHOOK_URL")
+
+try:
+    with ChatClient(webhook_url) as client:
+        response = client.send_message("Hello from Chatapult!")
+        print("Message sent successfully!")
+except APIError as e:
+    print(f"Failed to send message: {e}")
+```
+
+### Asynchronous Usage
+
+Ideal for web servers, async task queues, or applications where you cannot block the main thread.
+
+```python
+import asyncio
+import os
+from chatapult import AsyncChatClient, NetworkError
+
+async def main():
+    webhook_url = os.environ.get("GOOGLE_CHAT_WEBHOOK_URL")
+
+    try:
+        async with AsyncChatClient(webhook_url) as client:
+            await client.send_message("Hello from the async event loop!")
+            print("Async message sent successfully!")
+    except NetworkError as e:
+        print(f"Network issue encountered: {e}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+### Advanced Usage
+
+Documentation for sending V2 Cards, threaded replies, and handling rate-limit exceptions will be added here as features are released.
+
+## Contributing
+Contributions are welcome! If you'd like to help improve Chatapult, please review our [Contributing Guidelines](CONTRIBUTING.md) and open an issue or pull request.
+
+## License
+
+This project is licensed under the MIT License - see [LICENSE](LICENSE) for details.

chatapult-0.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "chatapult"
+version = "0.1.0"
+description = "A fast, Pythonic API wrapper for Google Chat webhooks."
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "MIT" }
+authors = [
+    { name = "Demetrios Lambropoulos", email = "d.lambropoulos@gmail.com" }
+]
+keywords = ["google chat", "webhook", "api", "wrapper", "notifications", "async"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Communications :: Chat",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+# httpx handles both sync and async requests, keeping our footprint small.
+dependencies = [
+    "httpx>=0.24.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-httpx>=0.22.0",
+    "pytest-asyncio>=0.21.0",
+    "pytest-cov>=4.1.0",
+    "black>=24.0",
+    "ruff>=0.3",
+    "mypy>=1.8",
+    "pre-commit>=3.0",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/chatapult"]

chatapult-0.1.0/src/chatapult/__init__.py

@@ -0,0 +1,28 @@
+"""
+Chatapult: A fast, Pythonic API wrapper for Google Chat webhooks.
+"""
+
+# Explicitly define the version so developers can check it programmatically
+__version__ = "0.1.0"
+
+# Import the core components to expose them at the top level of the package
+from .client import ChatClient
+from .async_client import AsyncChatClient
+from .exceptions import (
+    APIError,
+    ChatapultError,
+    ConfigurationError,
+    NetworkError,
+)
+
+# The __all__ list strictly defines the public API of your module.
+# It tells IDEs and linters exactly what is safe for end-users to import,
+# and hides internal modules (like 'logging' or 'httpx') from autocomplete.
+__all__ = [
+    "APIError",
+    "AsyncChatClient",
+    "ChatClient",
+    "ChatapultError",
+    "ConfigurationError",
+    "NetworkError",
+]

chatapult-0.1.0/src/chatapult/async_client.py

@@ -0,0 +1,82 @@
+import logging
+from typing import Any, Dict, Optional
+
+import httpx
+
+from .exceptions import APIError, ConfigurationError, NetworkError
+
+logger = logging.getLogger(__name__)
+
+
+class AsyncChatClient:
+    """
+    An asynchronous client for interacting with Google Chat Webhooks.
+    """
+
+    def __init__(self, webhook_url: str, timeout: float = 10.0) -> None:
+        """
+        Initialize the AsyncChatClient.
+
+        Args:
+            webhook_url (str): The full Google Chat webhook URL.
+            timeout (float): Connection timeout in seconds. Defaults to 10.0.
+
+        Raises:
+            ConfigurationError: If the webhook_url is empty.
+        """
+        if not webhook_url:
+            raise ConfigurationError("A valid webhook_url must be provided.")
+
+        self.webhook_url = webhook_url
+        self._client = httpx.AsyncClient(timeout=timeout)
+
+    async def send_message(
+        self, text: str, thread_name: Optional[str] = None
+    ) -> Dict[str, Any]:
+        """
+        Asynchronously send a simple text message to the Google Chat Space.
+
+        Args:
+            text (str): The markdown-formatted text to send.
+            thread_name (Optional[str]): The ID of an existing thread to reply to.
+
+        Returns:
+            Dict[str, Any]: The JSON response from the Google Chat API.
+
+        Raises:
+            APIError: If the Google API returns a non-200 status code.
+            NetworkError: If the connection times out or fails.
+        """
+        payload: Dict[str, Any] = {"text": text}
+
+        if thread_name:
+            payload["thread"] = {"name": thread_name}
+
+        try:
+            response = await self._client.post(self.webhook_url, json=payload)
+            response.raise_for_status()
+            return response.json()
+
+        except httpx.HTTPStatusError as e:
+            logger.error(
+                f"Google Chat API error: {e.response.status_code} - {e.response.text}"
+            )
+            raise APIError(
+                message=f"API request failed: {e.response.text}",
+                status_code=e.response.status_code,
+            ) from e
+        except httpx.RequestError as e:
+            logger.error(f"Network error while connecting to Google Chat: {e}")
+            raise NetworkError(f"Network request failed: {str(e)}") from e
+
+    async def aclose(self) -> None:
+        """Close the underlying asynchronous HTTP client connections."""
+        await self._client.aclose()
+
+    async def __aenter__(self) -> "AsyncChatClient":
+        """Enable usage as an asynchronous context manager."""
+        return self
+
+    async def __aexit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
+        """Ensure connections are closed when exiting the context manager."""
+        await self.aclose()

chatapult-0.1.0/src/chatapult/client.py

@@ -0,0 +1,85 @@
+import logging
+from typing import Any, Dict, Optional
+
+import httpx
+
+# Import our new custom exceptions
+from .exceptions import APIError, ConfigurationError, NetworkError
+
+logger = logging.getLogger(__name__)
+
+
+class ChatClient:
+    """
+    A synchronous client for interacting with Google Chat Webhooks.
+    """
+
+    def __init__(self, webhook_url: str, timeout: float = 10.0) -> None:
+        """
+        Initialize the ChatClient.
+
+        Args:
+            webhook_url (str): The full Google Chat webhook URL.
+            timeout (float): Connection timeout in seconds. Defaults to 10.0.
+
+        Raises:
+            ConfigurationError: If the webhook_url is empty or invalid.
+        """
+        if not webhook_url:
+            raise ConfigurationError("A valid webhook_url must be provided.")
+
+        self.webhook_url = webhook_url
+        self._client = httpx.Client(timeout=timeout)
+
+    def send_message(
+        self, text: str, thread_name: Optional[str] = None
+    ) -> Dict[str, Any]:
+        """
+        Send a simple text message to the configured Google Chat Space.
+
+        Args:
+            text (str): The markdown-formatted text to send.
+            thread_name (Optional[str]): The ID of an existing thread to reply to
+                                         (e.g., 'spaces/SPACE_ID/threads/THREAD_ID').
+
+        Returns:
+            Dict[str, Any]: The JSON response from the Google Chat API representing the message.
+
+        Raises:
+            APIError: If the Google API returns a non-200 status code.
+            NetworkError: If the network connection times out or fails.
+        """
+        payload: Dict[str, Any] = {"text": text}
+
+        if thread_name:
+            payload["thread"] = {"name": thread_name}
+
+        try:
+            response = self._client.post(self.webhook_url, json=payload)
+            response.raise_for_status()
+            return response.json()
+
+        except httpx.HTTPStatusError as e:
+            logger.error(
+                f"Google Chat API error: {e.response.status_code} - {e.response.text}"
+            )
+            raise APIError(
+                message=f"API request failed: {e.response.text}",
+                status_code=e.response.status_code,
+            ) from e
+
+        except httpx.RequestError as e:
+            logger.error(f"Network error while connecting to Google Chat: {e}")
+            raise NetworkError(f"Network request failed: {str(e)}") from e
+
+    def close(self) -> None:
+        """Close the underlying HTTP client connections."""
+        self._client.close()
+
+    def __enter__(self) -> "ChatClient":
+        """Enable usage as a context manager."""
+        return self
+
+    def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
+        """Ensure connections are closed when exiting the context manager."""
+        self.close()

chatapult-0.1.0/src/chatapult/exceptions.py

@@ -0,0 +1,39 @@
+"""
+Custom exceptions for the Chatapult library.
+"""
+
+
+class ChatapultError(Exception):
+    """
+    Base exception class for all Chatapult errors.
+    All other custom exceptions in this library inherit from this base class,
+    allowing users to catch any Chatapult-related error with a single except block.
+    """
+
+    pass
+
+
+class ConfigurationError(ChatapultError):
+    """
+    Raised when there is a configuration issue, such as an empty or invalid webhook URL.
+    """
+
+    pass
+
+
+class APIError(ChatapultError):
+    """
+    Raised when the Google Chat API returns an HTTP error response (e.g., 400 or 404).
+    """
+
+    def __init__(self, message: str, status_code: int) -> None:
+        super().__init__(message)
+        self.status_code = status_code
+
+
+class NetworkError(ChatapultError):
+    """
+    Raised when a network connection fails, times out, or the host is unreachable.
+    """
+
+    pass

chatapult-0.1.0/tests/test_clients.py

@@ -0,0 +1,142 @@
+import httpx
+import json
+import pytest
+from pytest_httpx import HTTPXMock
+
+from chatapult.client import ChatClient
+from chatapult.async_client import AsyncChatClient
+from chatapult.exceptions import APIError, ConfigurationError, NetworkError
+
+# Dummy webhook URL for testing
+WEBHOOK_URL = (
+    "https://chat.googleapis.com/v1/spaces/SPACE_ID/messages?key=KEY&token=TOKEN"
+)
+
+
+# ---------------------------------------------------------------------------
+# Synchronous Client Tests
+# ---------------------------------------------------------------------------
+
+
+def test_sync_client_init_empty_url() -> None:
+    """Ensure ChatClient raises ConfigurationError if webhook is empty."""
+    with pytest.raises(ConfigurationError):
+        ChatClient(webhook_url="")
+
+
+def test_sync_send_message_success(httpx_mock: HTTPXMock) -> None:
+    """Test sending a basic text message successfully."""
+    mock_response = {"name": "spaces/SPACE/messages/MSG", "text": "Hello World!"}
+    httpx_mock.add_response(json=mock_response, status_code=200)
+
+    with ChatClient(WEBHOOK_URL) as client:
+        response = client.send_message("Hello World!")
+
+    assert response == mock_response
+
+    # Verify the correct payload was sent by parsing the JSON
+    request = httpx_mock.get_request()
+    assert request is not None
+    request_data = json.loads(request.read())
+    assert request_data["text"] == "Hello World!"
+
+
+def test_sync_send_message_with_thread(httpx_mock: HTTPXMock) -> None:
+    """Test sending a message to a specific thread."""
+    httpx_mock.add_response(json={}, status_code=200)
+    thread_id = "spaces/SPACE_ID/threads/THREAD_ID"
+
+    with ChatClient(WEBHOOK_URL) as client:
+        client.send_message("Reply message", thread_name=thread_id)
+
+    request = httpx_mock.get_request()
+    assert request is not None
+
+    # Verify thread payload is included by parsing the JSON
+    request_data = json.loads(request.read())
+    assert request_data["thread"]["name"] == "spaces/SPACE_ID/threads/THREAD_ID"
+
+
+def test_sync_api_error(httpx_mock: HTTPXMock) -> None:
+    """Test that HTTP errors are cleanly wrapped in our custom APIError."""
+    httpx_mock.add_response(status_code=400, text="Bad Request")
+
+    with ChatClient(WEBHOOK_URL) as client:
+        with pytest.raises(APIError) as exc_info:
+            client.send_message("This will fail")
+
+    assert exc_info.value.status_code == 400
+    assert "Bad Request" in str(exc_info.value)
+
+
+def test_sync_network_error(httpx_mock: HTTPXMock) -> None:
+    """Test that httpx connection errors are wrapped in our NetworkError."""
+    httpx_mock.add_exception(httpx.ReadTimeout("Connection timed out"))
+
+    with ChatClient(WEBHOOK_URL) as client:
+        with pytest.raises(NetworkError) as exc_info:
+            client.send_message("This will timeout")
+
+    assert "Connection timed out" in str(exc_info.value)
+
+
+# ---------------------------------------------------------------------------
+# Asynchronous Client Tests
+# ---------------------------------------------------------------------------
+
+
+def test_async_client_init_empty_url() -> None:
+    """Ensure AsyncChatClient raises ConfigurationError if webhook is empty."""
+    with pytest.raises(ConfigurationError):
+        AsyncChatClient(webhook_url="")
+
+
+@pytest.mark.asyncio
+async def test_async_send_message_with_thread(httpx_mock: HTTPXMock) -> None:
+    """Test sending a message to a specific thread (async)."""
+    httpx_mock.add_response(json={}, status_code=200)
+    thread_id = "spaces/SPACE_ID/threads/THREAD_ID"
+
+    async with AsyncChatClient(WEBHOOK_URL) as client:
+        await client.send_message("Async reply message", thread_name=thread_id)
+
+    request = httpx_mock.get_request()
+    assert request is not None
+
+    # Verify thread payload is included by parsing the JSON
+    request_data = json.loads(request.read())
+    assert request_data["thread"]["name"] == thread_id
+
+
+@pytest.mark.asyncio
+async def test_async_send_message_success(httpx_mock: HTTPXMock) -> None:
+    """Test sending a basic text message successfully (async)."""
+    mock_response = {"name": "spaces/SPACE/messages/MSG", "text": "Async Hello!"}
+    httpx_mock.add_response(json=mock_response, status_code=200)
+
+    async with AsyncChatClient(WEBHOOK_URL) as client:
+        response = await client.send_message("Async Hello!")
+
+    assert response == mock_response
+
+
+@pytest.mark.asyncio
+async def test_async_api_error(httpx_mock: HTTPXMock) -> None:
+    """Test that HTTP errors are cleanly wrapped in our custom APIError (async)."""
+    httpx_mock.add_response(status_code=404, text="Space not found")
+
+    async with AsyncChatClient(WEBHOOK_URL) as client:
+        with pytest.raises(APIError) as exc_info:
+            await client.send_message("This will fail")
+
+    assert exc_info.value.status_code == 404
+
+
+@pytest.mark.asyncio
+async def test_async_network_error(httpx_mock: HTTPXMock) -> None:
+    """Test that network errors are wrapped in our NetworkError (async)."""
+    httpx_mock.add_exception(httpx.ConnectError("Network unreachable"))
+
+    async with AsyncChatClient(WEBHOOK_URL) as client:
+        with pytest.raises(NetworkError):
+            await client.send_message("This will fail")