apexauthlib 0.1.10__py3-none-any.whl → 0.1.11__py3-none-any.whl

apexauthlib-0.1.11.dist-info/METADATA

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: apexauthlib
+Version: 0.1.11
+Summary: Apex authorization library for services
+License-File: LICENSE
+Author: Apex Dev
+Author-email: dev@apex.ge
+Requires-Python: >=3.11
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: apexdevkit
+Requires-Dist: fastapi (==0.120.*)
+Requires-Dist: httpx
+Requires-Dist: uvicorn
+Description-Content-Type: text/markdown
+
+# apexauthlib
+
+Private Python library for integrating backend services with the company auth-service.
+
+This library provides:
+- **Entities** used across services (user, service, client, service metadata, permissions).
+- A **FastAPI router** (`auth_api`) with login endpoints and dependency helpers that inject the current user + metadata from JWT.
+- A small **HTTP client wrapper** (`AuthApiProvider` / `AuthApi`) for services to:
+  - obtain a token (password login or OAuth code exchange),
+  - fetch current user and service-scoped metadata,
+  - list users for a service,
+  - and register/update service permissions.
+
+> Notes
+> - This documentation is best used along with the documentation for auth-service.
+> - This is a **private library**. If you change it, you should push to GitHub and then update downstream usage by running `make install` wherever it’s consumed (per team workflow).
+
+---
+
+## Concepts at a glance
+
+### Users
+The `User` entity includes:
+- `hashed_password`: **must never expose an actual password** through APIs (except in create/update requests handled elsewhere).
+- `is_admin`: indicates whether the user is a “superadmin”.
+
+### Service-scoped auth model
+The auth model used by services is service-centric:
+- Services have a name (`service_name`) and service admins.
+- Each service can define **permissions** (schema) and **per-user metadata** values that should align with those permissions.
+
+See: [`docs/concepts.md`](docs/concepts.md)
+
+---
+
+## Usage pattern (high-level)
+
+### 1) Create an `AuthApiProvider`
+
+Example (from service code):
+
+```python
+provider = AuthApiProvider[HaccpPermissions](
+    http=FluentHttp(
+        Httpx.Builder().with_url(AUTH_SERVICE_API).build(),
+    ),
+    service_name=SERVICE_NAME,
+    formatter=DataclassFormatter(HaccpPermissions),
+)
+```
+
+### 2) Register permissions (service schema)
+
+Example:
+
+```python
+provider.for_token(
+    provider.login(ADMIN_USERNAME, ADMIN_PASSWORD)
+).update_permissions(
+    [
+        ServicePermission(
+            # ...
+        )
+    ]
+)
+```
+
+### 3) Add FastAPI auth routes + dependencies
+
+Example:
+
+```python
+FastApiBuilder()
+.with_title(TITLE)
+.with_description(DESCRIPTION)
+.with_version(VERSION)
+.with_route(auth_api)
+.with_dependency(
+    auth=provider,
+    auth_code=AuthCodeApi(
+        http=FluentHttp(
+            Httpx.Builder()
+            .with_url(AUTH_SERVICE_API)
+            .build(),
+        ),
+        client_id=CLIENT_ID,
+        client_secret=CLIENT_SECRET,
+    ),
+)
+.build()
+```
+
+See: [`docs/fastapi.md`](docs/fastapi.md)
+
+## Known Limitations
+
+### Permission sync is name-based only
+
+AuthApi.update_permissions() compares permissions by name and only creates/deletes.
+If a permission keeps the same name but changes type, default, label, etc., 
+it currently won’t be updated automatically.
+
+### Admin password dependency for permission registration
+
+The example uses provider.login(ADMIN_USERNAME, ADMIN_PASSWORD) to obtain a token for updating permissions.
+If the admin password changes, downstream services must update their configuration, or a more proper flow should
+be introduced (e.g., service-to-service auth or code-based admin auth).
+
+### Refresh tokens are not currently handled in this library
+
+Current flow assumes a bearer access token is provided/used. Supporting refresh tokens would enable
+longer-lived sessions with automatic token renewal.
+
+

{apexauthlib-0.1.10.dist-info → apexauthlib-0.1.11.dist-info}/RECORD

@@ -6,7 +6,7 @@ apexauthlib/fastapi/auth.py,sha256=hkvG2BougydElkYbEpwsuSgRoLOLANe6DbVSoa-zBRM,3
 apexauthlib/integration/__init__.py,sha256=f2lGbyoGct4kpZ2CUTExHhtQHs-1YR_xanvrj9Y4GiI,87
 apexauthlib/integration/api.py,sha256=iSjaq6FrLOvnC86Y4DtV8O2fNqy09Tt5HjyAp707C4I,6478
 apexauthlib/integration/formatter.py,sha256=DyVRMWYkZErZBeP_f4aYdSbe9g9zck-x2ONFPxwVNfY,2037
-apexauthlib-0.1.10.dist-info/METADATA,sha256=I_SRgou9OOCkcl2eKC1ENrw6pvXN7SR6GsMk_CrsmQA,604
-apexauthlib-0.1.10.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-apexauthlib-0.1.10.dist-info/licenses/LICENSE,sha256=iai0ILQTDgUXV1cIXl0UzSeOdFpMFK3shn5aqnz_Uro,1065
-apexauthlib-0.1.10.dist-info/RECORD,,
+apexauthlib-0.1.11.dist-info/METADATA,sha256=2iH1MMTn76woy7R_XuungNbggbxFuhkuBv8bBf00mik,3922
+apexauthlib-0.1.11.dist-info/WHEEL,sha256=kJCRJT_g0adfAJzTx2GUMmS80rTJIVHRCfG0DQgLq3o,88
+apexauthlib-0.1.11.dist-info/licenses/LICENSE,sha256=iai0ILQTDgUXV1cIXl0UzSeOdFpMFK3shn5aqnz_Uro,1065
+apexauthlib-0.1.11.dist-info/RECORD,,

{apexauthlib-0.1.10.dist-info → apexauthlib-0.1.11.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.2.1
+Generator: poetry-core 2.3.1
 Root-Is-Purelib: true
 Tag: py3-none-any

apexauthlib-0.1.10.dist-info/METADATA

@@ -1,21 +0,0 @@
-Metadata-Version: 2.4
-Name: apexauthlib
-Version: 0.1.10
-Summary: Apex authorization library for services
-License-File: LICENSE
-Author: Apex Dev
-Author-email: dev@apex.ge
-Requires-Python: >=3.11
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Requires-Dist: apexdevkit
-Requires-Dist: fastapi (==0.120.*)
-Requires-Dist: httpx
-Requires-Dist: uvicorn
-Description-Content-Type: text/markdown
-
-# apexauthlib
-Central authorization library for apex services
-