apitally 0.4.1__tar.gz → 0.6.0__tar.gz

{apitally-0.4.1 → apitally-0.6.0}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.1
 Name: apitally
-Version: 0.4.1
-Summary: Simple API monitoring and API key management for REST APIs built with FastAPI, Flask, Django, and Starlette.
-Home-page: https://docs.apitally.io
+Version: 0.6.0
+Summary: API monitoring for REST APIs built with FastAPI, Flask, Django, and Starlette.
+Home-page: https://apitally.io
 License: MIT
 Author: Apitally
 Author-email: hello@apitally.io
@@ -21,19 +21,22 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware
 Classifier: Typing :: Typed
+Provides-Extra: django
 Provides-Extra: django-ninja
 Provides-Extra: django-rest-framework
 Provides-Extra: fastapi
 Provides-Extra: flask
+Provides-Extra: litestar
 Provides-Extra: starlette
 Requires-Dist: backoff (>=2.0.0)
-Requires-Dist: django (>=4.0) ; extra == "django-rest-framework" or extra == "django-ninja"
+Requires-Dist: django (>=4.0) ; extra == "django" or extra == "django-ninja" or extra == "django-rest-framework"
 Requires-Dist: django-ninja (>=0.18.0) ; extra == "django-ninja"
 Requires-Dist: djangorestframework (>=3.12.0) ; extra == "django-rest-framework"
 Requires-Dist: fastapi (>=0.87.0) ; extra == "fastapi"
 Requires-Dist: flask (>=2.0.0) ; extra == "flask"
-Requires-Dist: httpx (>=0.22.0) ; extra == "fastapi" or extra == "starlette"
-Requires-Dist: requests (>=2.26.0) ; extra == "django-rest-framework" or extra == "django-ninja" or extra == "flask"
+Requires-Dist: httpx (>=0.22.0) ; extra == "fastapi" or extra == "litestar" or extra == "starlette"
+Requires-Dist: litestar (>=2.0.0) ; extra == "litestar"
+Requires-Dist: requests (>=2.26.0) ; extra == "django" or extra == "django-ninja" or extra == "django-rest-framework" or extra == "flask"
 Requires-Dist: starlette (>=0.21.0,<1.0.0) ; extra == "fastapi" or extra == "starlette"
 Project-URL: Documentation, https://docs.apitally.io
 Project-URL: Repository, https://github.com/apitally/python-client
@@ -47,9 +50,9 @@ Description-Content-Type: text/markdown
   </picture>
 </p>
 
-<p align="center"><b>Your refreshingly simple REST API companion.</b></p>
+<p align="center"><b>API monitoring made easy.</b></p>
 
-<p align="center"><i>Apitally is a simple and affordable API monitoring and API key management solution with a focus on data privacy. It is easy to set up and use for new and existing API projects using Python or Node.js.</i></p>
+<p align="center"><i>Apitally is a simple and affordable API monitoring solution with a focus on data privacy. It is easy to set up and use for new and existing API projects using Python or Node.js.</i></p>
 
 <p align="center">🔗 <b><a href="https://apitally.io" target="_blank">apitally.io</a></b></p>
 
@@ -71,6 +74,7 @@ frameworks:
 - [Flask](https://docs.apitally.io/frameworks/flask)
 - [Django Ninja](https://docs.apitally.io/frameworks/django-ninja)
 - [Django REST Framework](https://docs.apitally.io/frameworks/django-rest-framework)
+- [Litestar](https://docs.apitally.io/frameworks/litestar)
 
 Learn more about Apitally on our 🌎 [website](https://apitally.io) or check out
 the 📚 [documentation](https://docs.apitally.io).
@@ -79,10 +83,8 @@ the 📚 [documentation](https://docs.apitally.io).
 
 - Middleware for different frameworks to capture metadata about API endpoints,
   requests and responses (no sensitive data is captured)
-- Non-blocking clients that aggregate and send captured data to Apitally and
-  optionally synchronize API key hashes in 1 minute intervals
-- Functions to easily secure endpoints with API key authentication and
-  permission checks
+- Non-blocking clients that aggregate and send captured data to Apitally in
+  regular intervals
 
 ## Install
 
@@ -93,8 +95,8 @@ example:
 pip install apitally[fastapi]
 ```
 
-The available extras are: `fastapi`, `starlette`, `flask`, `django_ninja` and
-`django_rest_framework`.
+The available extras are: `fastapi`, `starlette`, `flask`, `django` and
+`litestar`.
 
 ## Usage
 
@@ -119,24 +121,6 @@ app.add_middleware(
 )
 ```
 
-### Starlette
-
-This is an example of how to add the Apitally middleware to a Starlette
-application. For further instructions, see our
-[setup guide for Starlette](https://docs.apitally.io/frameworks/starlette).
-
-```python
-from starlette.applications import Starlette
-from apitally.starlette import ApitallyMiddleware
-
-app = Starlette(routes=[...])
-app.add_middleware(
-    ApitallyMiddleware,
-    client_id="your-client-id",
-    env="dev",  # or "prod" etc.
-)
-```
-
 ### Flask
 
 This is an example of how to add the Apitally middleware to a Flask application.
@@ -155,17 +139,17 @@ app.wsgi_app = ApitallyMiddleware(
 )
 ```
 
-### Django Ninja
+### Django
 
-This is an example of how to add the Apitally middleware to a Django Ninja
-application. For further instructions, see our
-[setup guide for Django Ninja](https://docs.apitally.io/frameworks/django-ninja).
+This is an example of how to add the Apitally middleware to a Django Ninja or
+Django REST Framework application. For further instructions, see our
+[setup guide for Django](https://docs.apitally.io/frameworks/django).
 
 In your Django `settings.py` file:
 
 ```python
 MIDDLEWARE = [
-    "apitally.django_ninja.ApitallyMiddleware",
+    "apitally.django.ApitallyMiddleware",
     # Other middleware ...
 ]
 APITALLY_MIDDLEWARE = {
@@ -174,30 +158,33 @@ APITALLY_MIDDLEWARE = {
 }
 ```
 
-### Django REST Framework
-
-This is an example of how to add the Apitally middleware to a Django REST
-Framework application. For further instructions, see our
-[setup guide for Django REST Framework](https://docs.apitally.io/frameworks/django-rest-framework).
+### Litestar
 
-In your Django `settings.py` file:
+This is an example of how to add the Apitally plugin to a Litestar application.
+For further instructions, see our
+[setup guide for Litestar](https://docs.apitally.io/frameworks/litestar).
 
 ```python
-MIDDLEWARE = [
-    "apitally.django_rest_framework.ApitallyMiddleware",
-    # Other middleware ...
-]
-APITALLY_MIDDLEWARE = {
-    "client_id": "your-client-id",
-    "env": "dev",  # or "prod" etc.
-}
+from litestar import Litestar
+from apitally.litestar import ApitallyPlugin
+
+app = Litestar(
+    route_handlers=[...],
+    plugins=[
+        ApitallyPlugin(
+            client_id="your-client-id",
+            env="dev",  # or "prod" etc.
+        ),
+    ]
+)
 ```
 
 ## Getting help
 
 If you need help please
 [create a new discussion](https://github.com/orgs/apitally/discussions/categories/q-a)
-on GitHub.
+on GitHub or
+[join our Slack workspace](https://join.slack.com/t/apitally-community/shared_invite/zt-2b3xxqhdu-9RMq2HyZbR79wtzNLoGHrg).
 
 ## License
 

{apitally-0.4.1 → apitally-0.6.0}/README.md

@@ -6,9 +6,9 @@
   </picture>
 </p>
 
-<p align="center"><b>Your refreshingly simple REST API companion.</b></p>
+<p align="center"><b>API monitoring made easy.</b></p>
 
-<p align="center"><i>Apitally is a simple and affordable API monitoring and API key management solution with a focus on data privacy. It is easy to set up and use for new and existing API projects using Python or Node.js.</i></p>
+<p align="center"><i>Apitally is a simple and affordable API monitoring solution with a focus on data privacy. It is easy to set up and use for new and existing API projects using Python or Node.js.</i></p>
 
 <p align="center">🔗 <b><a href="https://apitally.io" target="_blank">apitally.io</a></b></p>
 
@@ -30,6 +30,7 @@ frameworks:
 - [Flask](https://docs.apitally.io/frameworks/flask)
 - [Django Ninja](https://docs.apitally.io/frameworks/django-ninja)
 - [Django REST Framework](https://docs.apitally.io/frameworks/django-rest-framework)
+- [Litestar](https://docs.apitally.io/frameworks/litestar)
 
 Learn more about Apitally on our 🌎 [website](https://apitally.io) or check out
 the 📚 [documentation](https://docs.apitally.io).
@@ -38,10 +39,8 @@ the 📚 [documentation](https://docs.apitally.io).
 
 - Middleware for different frameworks to capture metadata about API endpoints,
   requests and responses (no sensitive data is captured)
-- Non-blocking clients that aggregate and send captured data to Apitally and
-  optionally synchronize API key hashes in 1 minute intervals
-- Functions to easily secure endpoints with API key authentication and
-  permission checks
+- Non-blocking clients that aggregate and send captured data to Apitally in
+  regular intervals
 
 ## Install
 
@@ -52,8 +51,8 @@ example:
 pip install apitally[fastapi]
 ```
 
-The available extras are: `fastapi`, `starlette`, `flask`, `django_ninja` and
-`django_rest_framework`.
+The available extras are: `fastapi`, `starlette`, `flask`, `django` and
+`litestar`.
 
 ## Usage
 
@@ -78,24 +77,6 @@ app.add_middleware(
 )
 ```
 
-### Starlette
-
-This is an example of how to add the Apitally middleware to a Starlette
-application. For further instructions, see our
-[setup guide for Starlette](https://docs.apitally.io/frameworks/starlette).
-
-```python
-from starlette.applications import Starlette
-from apitally.starlette import ApitallyMiddleware
-
-app = Starlette(routes=[...])
-app.add_middleware(
-    ApitallyMiddleware,
-    client_id="your-client-id",
-    env="dev",  # or "prod" etc.
-)
-```
-
 ### Flask
 
 This is an example of how to add the Apitally middleware to a Flask application.
@@ -114,17 +95,17 @@ app.wsgi_app = ApitallyMiddleware(
 )
 ```
 
-### Django Ninja
+### Django
 
-This is an example of how to add the Apitally middleware to a Django Ninja
-application. For further instructions, see our
-[setup guide for Django Ninja](https://docs.apitally.io/frameworks/django-ninja).
+This is an example of how to add the Apitally middleware to a Django Ninja or
+Django REST Framework application. For further instructions, see our
+[setup guide for Django](https://docs.apitally.io/frameworks/django).
 
 In your Django `settings.py` file:
 
 ```python
 MIDDLEWARE = [
-    "apitally.django_ninja.ApitallyMiddleware",
+    "apitally.django.ApitallyMiddleware",
     # Other middleware ...
 ]
 APITALLY_MIDDLEWARE = {
@@ -133,30 +114,33 @@ APITALLY_MIDDLEWARE = {
 }
 ```
 
-### Django REST Framework
-
-This is an example of how to add the Apitally middleware to a Django REST
-Framework application. For further instructions, see our
-[setup guide for Django REST Framework](https://docs.apitally.io/frameworks/django-rest-framework).
+### Litestar
 
-In your Django `settings.py` file:
+This is an example of how to add the Apitally plugin to a Litestar application.
+For further instructions, see our
+[setup guide for Litestar](https://docs.apitally.io/frameworks/litestar).
 
 ```python
-MIDDLEWARE = [
-    "apitally.django_rest_framework.ApitallyMiddleware",
-    # Other middleware ...
-]
-APITALLY_MIDDLEWARE = {
-    "client_id": "your-client-id",
-    "env": "dev",  # or "prod" etc.
-}
+from litestar import Litestar
+from apitally.litestar import ApitallyPlugin
+
+app = Litestar(
+    route_handlers=[...],
+    plugins=[
+        ApitallyPlugin(
+            client_id="your-client-id",
+            env="dev",  # or "prod" etc.
+        ),
+    ]
+)
 ```
 
 ## Getting help
 
 If you need help please
 [create a new discussion](https://github.com/orgs/apitally/discussions/categories/q-a)
-on GitHub.
+on GitHub or
+[join our Slack workspace](https://join.slack.com/t/apitally-community/shared_invite/zt-2b3xxqhdu-9RMq2HyZbR79wtzNLoGHrg).
 
 ## License
 

apitally-0.6.0/apitally/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.0"

{apitally-0.4.1 → apitally-0.6.0}/apitally/client/asyncio.py

@@ -2,20 +2,14 @@ from __future__ import annotations
 
 import asyncio
 import logging
-import sys
 import time
 from functools import partial
-from typing import Any, Dict, Optional, Tuple, Type
+from typing import Any, Dict, Optional, Tuple
 
 import backoff
 import httpx
 
-from apitally.client.base import (
-    MAX_QUEUE_TIME,
-    REQUEST_TIMEOUT,
-    ApitallyClientBase,
-    ApitallyKeyCacheBase,
-)
+from apitally.client.base import MAX_QUEUE_TIME, REQUEST_TIMEOUT, ApitallyClientBase
 from apitally.client.logging import get_logger
 
 
@@ -31,19 +25,8 @@ retry = partial(
 
 
 class ApitallyClient(ApitallyClientBase):
-    def __init__(
-        self,
-        client_id: str,
-        env: str,
-        sync_api_keys: bool = False,
-        key_cache_class: Optional[Type[ApitallyKeyCacheBase]] = None,
-    ) -> None:
-        super().__init__(
-            client_id=client_id,
-            env=env,
-            sync_api_keys=sync_api_keys,
-            key_cache_class=key_cache_class,
-        )
+    def __init__(self, client_id: str, env: str) -> None:
+        super().__init__(client_id=client_id, env=env)
         self._stop_sync_loop = False
         self._sync_loop_task: Optional[asyncio.Task[Any]] = None
         self._requests_data_queue: asyncio.Queue[Tuple[float, Dict[str, Any]]] = asyncio.Queue()
@@ -62,8 +45,6 @@ class ApitallyClient(ApitallyClientBase):
                 time_start = time.perf_counter()
                 async with self.get_http_client() as client:
                     tasks = [self.send_requests_data(client)]
-                    if self.sync_api_keys:
-                        tasks.append(self.get_keys(client))
                     if not self._app_info_sent and not first_iteration:
                         tasks.append(self.send_app_info(client))
                     await asyncio.gather(*tasks)
@@ -113,24 +94,11 @@ class ApitallyClient(ApitallyClientBase):
         for item in failed_items:
             self._requests_data_queue.put_nowait(item)
 
-    async def get_keys(self, client: httpx.AsyncClient) -> None:
-        if response_data := await self._get_keys(client):  # Response data can be None if backoff gives up
-            self.handle_keys_response(response_data)
-            self._keys_updated_at = time.time()
-        elif self.key_registry.salt is None:  # pragma: no cover
-            logger.critical("Initial Apitally API key sync failed")
-            # Exit because the application will not be able to authenticate requests
-            sys.exit(1)
-        elif (self._keys_updated_at is not None and time.time() - self._keys_updated_at > MAX_QUEUE_TIME) or (
-            self._keys_updated_at is None and time.time() - self._started_at > MAX_QUEUE_TIME
-        ):
-            logger.error("Apitally API key sync has been failing for more than 1 hour")
-
     @retry(raise_on_giveup=False)
     async def _send_app_info(self, client: httpx.AsyncClient, payload: Dict[str, Any]) -> None:
         logger.debug("Sending app info")
         response = await client.post(url="/info", json=payload, timeout=REQUEST_TIMEOUT)
-        if response.status_code == 404 and "Client ID" in response.text:
+        if response.status_code == 404:
             self.stop_sync_loop()
             logger.error(f"Invalid Apitally client ID {self.client_id}")
         else:
@@ -143,10 +111,3 @@ class ApitallyClient(ApitallyClientBase):
         logger.debug("Sending requests data")
         response = await client.post(url="/requests", json=payload)
         response.raise_for_status()
-
-    @retry(raise_on_giveup=False)
-    async def _get_keys(self, client: httpx.AsyncClient) -> Dict[str, Any]:
-        logger.debug("Updating API keys")
-        response = await client.get(url="/keys")
-        response.raise_for_status()
-        return response.json()

{apitally-0.4.1 → apitally-0.6.0}/apitally/client/base.py

@@ -1,17 +1,14 @@
 from __future__ import annotations
 
-import json
 import os
 import re
 import threading
 import time
-from abc import ABC, abstractmethod
+from abc import ABC
 from collections import Counter
-from dataclasses import dataclass, field
-from datetime import datetime, timedelta
-from hashlib import scrypt
+from dataclasses import dataclass
 from math import floor
-from typing import Any, Dict, List, Optional, Tuple, Type, TypeVar, Union, cast
+from typing import Any, Dict, List, Optional, Tuple, Type, TypeVar, cast
 from uuid import UUID, uuid4
 
 from apitally.client.logging import get_logger
@@ -30,24 +27,18 @@ INITIAL_SYNC_INTERVAL_DURATION = 3600
 TApitallyClient = TypeVar("TApitallyClient", bound="ApitallyClientBase")
 
 
-class ApitallyClientBase:
+class ApitallyClientBase(ABC):
     _instance: Optional[ApitallyClientBase] = None
     _lock = threading.Lock()
 
-    def __new__(cls, *args, **kwargs) -> ApitallyClientBase:
+    def __new__(cls: Type[TApitallyClient], *args, **kwargs) -> TApitallyClient:
         if cls._instance is None:
             with cls._lock:
                 if cls._instance is None:
                     cls._instance = super().__new__(cls)
-        return cls._instance
+        return cast(TApitallyClient, cls._instance)
 
-    def __init__(
-        self,
-        client_id: str,
-        env: str,
-        sync_api_keys: bool = False,
-        key_cache_class: Optional[Type[ApitallyKeyCacheBase]] = None,
-    ) -> None:
+    def __init__(self, client_id: str, env: str) -> None:
         if hasattr(self, "client_id"):
             raise RuntimeError("Apitally client is already initialized")  # pragma: no cover
         try:
@@ -59,23 +50,13 @@ class ApitallyClientBase:
 
         self.client_id = client_id
         self.env = env
-        self.sync_api_keys = sync_api_keys
         self.instance_uuid = str(uuid4())
         self.request_counter = RequestCounter()
         self.validation_error_counter = ValidationErrorCounter()
-        self.key_registry = KeyRegistry()
-        self.key_cache = key_cache_class(client_id=client_id, env=env) if key_cache_class is not None else None
 
         self._app_info_payload: Optional[Dict[str, Any]] = None
         self._app_info_sent = False
         self._started_at = time.time()
-        self._keys_updated_at: Optional[float] = None
-
-        if self.key_cache is not None and (key_data := self.key_cache.retrieve()):
-            try:
-                self.handle_keys_response(json.loads(key_data), cache=False)
-            except (json.JSONDecodeError, TypeError, KeyError):  # pragma: no cover
-                logger.exception("Failed to load API keys from cache")
 
     @classmethod
     def get_instance(cls: Type[TApitallyClient]) -> TApitallyClient:
@@ -104,42 +85,13 @@ class ApitallyClientBase:
     def get_requests_payload(self) -> Dict[str, Any]:
         requests = self.request_counter.get_and_reset_requests()
         validation_errors = self.validation_error_counter.get_and_reset_validation_errors()
-        api_key_usage = self.key_registry.get_and_reset_usage_counts() if self.sync_api_keys else {}
         return {
             "instance_uuid": self.instance_uuid,
             "message_uuid": str(uuid4()),
             "requests": requests,
             "validation_errors": validation_errors,
-            "api_key_usage": api_key_usage,
         }
 
-    def handle_keys_response(self, response_data: Dict[str, Any], cache: bool = True) -> None:
-        self.key_registry.salt = response_data["salt"]
-        self.key_registry.update(response_data["keys"])
-
-        if cache and self.key_cache is not None:
-            self.key_cache.store(json.dumps(response_data, check_circular=False, allow_nan=False))
-
-
-class ApitallyKeyCacheBase(ABC):
-    def __init__(self, client_id: str, env: str) -> None:
-        self.client_id = client_id
-        self.env = env
-
-    @property
-    def cache_key(self) -> str:
-        return f"apitally:keys:{self.client_id}:{self.env}"
-
-    @abstractmethod
-    def store(self, data: str) -> None:
-        """Store the key data in cache as a JSON string."""
-        pass  # pragma: no cover
-
-    @abstractmethod
-    def retrieve(self) -> str | bytes | bytearray | None:
-        """Retrieve the stored key data from the cache as a JSON string."""
-        pass  # pragma: no cover
-
 
 @dataclass(frozen=True)
 class RequestInfo:
@@ -243,8 +195,8 @@ class ValidationErrorCounter:
                         method=method.upper(),
                         path=path,
                         loc=tuple(str(loc) for loc in error["loc"]),
-                        type=error["type"],
                         msg=error["msg"],
+                        type=error["type"],
                     )
                     self.error_counts[validation_error] += 1
                 except (KeyError, TypeError):  # pragma: no cover
@@ -267,69 +219,3 @@ class ValidationErrorCounter:
                 )
             self.error_counts.clear()
         return data
-
-
-@dataclass(frozen=True)
-class KeyInfo:
-    key_id: int
-    api_key_id: int
-    name: str = ""
-    scopes: List[str] = field(default_factory=list)
-    expires_at: Optional[datetime] = None
-
-    @property
-    def is_expired(self) -> bool:
-        return self.expires_at is not None and self.expires_at < datetime.now()
-
-    def has_scopes(self, scopes: Union[List[str], str]) -> bool:
-        if isinstance(scopes, str):
-            scopes = [scopes]
-        if not isinstance(scopes, list):
-            raise ValueError("scopes must be a string or a list of strings")
-        return all(scope in self.scopes for scope in scopes)
-
-    @classmethod
-    def from_dict(cls, data: Dict[str, Any]) -> KeyInfo:
-        return cls(
-            key_id=data["key_id"],
-            api_key_id=data["api_key_id"],
-            name=data.get("name", ""),
-            scopes=data.get("scopes", []),
-            expires_at=(
-                datetime.now() + timedelta(seconds=data["expires_in_seconds"])
-                if data["expires_in_seconds"] is not None
-                else None
-            ),
-        )
-
-
-class KeyRegistry:
-    def __init__(self) -> None:
-        self.salt: Optional[str] = None
-        self.keys: Dict[str, KeyInfo] = {}
-        self.usage_counts: Counter[int] = Counter()
-        self._lock = threading.Lock()
-
-    def get(self, api_key: str) -> Optional[KeyInfo]:
-        hash = self.hash_api_key(api_key.strip())
-        with self._lock:
-            key = self.keys.get(hash)
-            if key is None or key.is_expired:
-                return None
-            self.usage_counts[key.api_key_id] += 1
-        return key
-
-    def hash_api_key(self, api_key: str) -> str:
-        if self.salt is None:
-            raise RuntimeError("Apitally API keys not initialized")
-        return scrypt(api_key.encode(), salt=bytes.fromhex(self.salt), n=256, r=4, p=1, dklen=32).hex()
-
-    def update(self, keys: Dict[str, Dict[str, Any]]) -> None:
-        with self._lock:
-            self.keys = {hash: KeyInfo.from_dict(data) for hash, data in keys.items()}
-
-    def get_and_reset_usage_counts(self) -> Dict[int, int]:
-        with self._lock:
-            data = dict(self.usage_counts)
-            self.usage_counts.clear()
-        return data