Merge pull request #87 from smswithoutborders/staging

Staging

Author: PromiseFru

Dockerfile

@@ -1,20 +1,25 @@
-FROM python:3.13.4-slim 
+FROM python:3.13.5-slim 
 
 WORKDIR /publisher
 
-RUN apt-get update && apt-get install -y --no-install-recommends \
+RUN --mount=type=cache,sharing=locked,target=/var/cache/apt \
+    --mount=type=cache,sharing=locked,target=/var/lib/apt \
+    apt-get update && apt-get install -y --no-install-recommends \
     build-essential \
     python3-dev \
     default-libmysqlclient-dev \
     supervisor \
     curl \
     git \
+    vim \
     pkg-config && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/*
 
 COPY requirements.txt .
-RUN pip install --disable-pip-version-check --quiet --no-cache-dir -r requirements.txt
+
+RUN --mount=type=cache,sharing=locked,target=/root/.cache/pip \
+    pip install --disable-pip-version-check --quiet --no-cache-dir -r requirements.txt
 
 COPY . .
 

api_schemas.py

@@ -40,8 +40,21 @@ class PublicationsResponse(BaseModel):
 class PlatformManifest(BaseModel):
     name: str
     shortcode: str
-    protocol: str
+    protocol_type: str
     service_type: str
     icon_svg: Optional[str] = None
     icon_png: Optional[str] = None
     support_url_scheme: Optional[bool] = None
+
+
+class OAuthClientMetadata(BaseModel):
+    client_id: str
+    dpop_bound_access_tokens: bool
+    application_type: str
+    redirect_uris: list[str]
+    grant_types: list[str]
+    response_types: list[str]
+    scope: str
+    token_endpoint_auth_method: str
+    client_name: str
+    client_uri: str

api_v1.py

@@ -5,13 +5,17 @@
 """
 
 import datetime
+import json
+from pathlib import Path as PathLib
 from typing import Optional, List
-from fastapi import APIRouter, HTTPException, Query, Path
+from fastapi import APIRouter, HTTPException, Query, Path, Request
+from fastapi.responses import HTMLResponse
 from api_schemas import (
     PublicationsRead,
     PublicationsResponse,
     Pagination,
     PlatformManifest,
+    OAuthClientMetadata,
 )
 from publications import fetch_publication
 from platforms.adapter_manager import AdapterManager
@@ -24,12 +28,13 @@
 ALLOWED_PLATFORM_MANIFEST_KEYS = [
     "name",
     "shortcode",
-    "protocol",
+    "protocol_type",
     "service_type",
     "icon_svg",
     "icon_png",
     "support_url_scheme",
 ]
+ALLOWED_PLATFORMS_WITH_CLIENT_METADATA = ["bluesky"]
 
 
 @router.get("/metrics/publications", response_model=PublicationsResponse)
@@ -135,3 +140,95 @@ def get_platform_data(
         if key in ALLOWED_PLATFORM_MANIFEST_KEYS
     }
     return adapter_copy
+
+
+@router.get("/platforms/{platform_name}/oauth/client-metadata.json")
+def get_platform_oauth_client_metadata(
+    platform_name: str = Path(
+        ..., description="Platform name", pattern=r"^[a-zA-Z0-9_-]+$"
+    )
+) -> OAuthClientMetadata:
+    """Retrieve the OAuth client metadata for a platform adapter."""
+    AdapterManager._populate_registry()
+    adapter = next(
+        (
+            manifest
+            for manifest in AdapterManager._registry.values()
+            if manifest["name"].lower() == platform_name.lower()
+        ),
+        None,
+    )
+    if not adapter:
+        raise HTTPException(status_code=404, detail="Platform not found")
+
+    if not platform_name.lower() in ALLOWED_PLATFORMS_WITH_CLIENT_METADATA:
+        raise HTTPException(
+            status_code=404,
+            detail="OAuth client metadata not available for this platform",
+        )
+
+    adapter_credentials = PathLib(adapter.get("path")) / "credentials.json"
+
+    if not adapter_credentials.exists():
+        raise HTTPException(
+            status_code=404,
+            detail="OAuth client metadata file not found for this platform",
+        )
+
+    try:
+        with open(adapter_credentials, "r", encoding="utf-8") as file:
+            creds = file.read()
+            client_metadata = OAuthClientMetadata(**json.loads(creds))
+        return client_metadata
+    except FileNotFoundError as exc:
+        logger.error("OAuth client metadata file not found")
+        raise HTTPException(
+            status_code=404, detail="OAuth client metadata file not found"
+        ) from exc
+
+
+@router.get("/platforms/{platform_name}/oauth/callback")
+async def oauth_callback(
+    request: Request,
+    platform_name: str = Path(
+        ..., description="Platform name", pattern=r"^[a-zA-Z0-9_-]+$"
+    ),
+) -> HTMLResponse:
+    """
+    Handle the OAuth callback from the platform.
+    """
+    AdapterManager._populate_registry()
+    adapter = next(
+        (
+            manifest
+            for manifest in AdapterManager._registry.values()
+            if manifest["name"].lower() == platform_name.lower()
+        ),
+        None,
+    )
+    if not adapter:
+        raise HTTPException(status_code=404, detail="Platform not found")
+
+    if not platform_name.lower() in ALLOWED_PLATFORMS_WITH_CLIENT_METADATA:
+        raise HTTPException(
+            status_code=404,
+            detail="OAuth client metadata not available for this platform",
+        )
+
+    table_rows = ""
+    for key, value in request.query_params.items():
+        table_rows += f"<tr><td>{key}</td><td>{value}</td></tr>"
+
+    html_content = f"""
+    <html>
+        <head><title>{platform_name.capitalize()} OAuth Callback Params</title></head>
+        <body>
+            <h2>{platform_name.capitalize()}'s Callback Params</h2>
+            <table border="1">
+                <tr><th>Parameter</th><th>Value</th></tr>
+                {table_rows}
+            </table>
+        </body>
+    </html>
+    """
+    return HTMLResponse(content=html_content)

content_parser.py

@@ -258,6 +258,85 @@ def extract_content_v1(service_type: str, content: bytes) -> tuple:
         return None, e
 
 
+def extract_content_v2(service_type: str, content: bytes) -> tuple:
+    """
+    Extracts components from the packed content for v2 format based on the specified service_type.
+
+    Args:
+        service_type (str): The type of the platform (email, text, message).
+        content (bytes): The packed binary content to extract.
+
+    Returns:
+        tuple: A tuple containing:
+            - parts (tuple): A tuple with the parsed components based on the service_type.
+            - error (str): An error message if extraction fails, otherwise None.
+    """
+    parsers = [
+        FormatSpec(key="length_from", fmt="<B", decoding=None),
+        FormatSpec(key="length_to", fmt="<H", decoding=None),
+        FormatSpec(key="length_cc", fmt="<H", decoding=None),
+        FormatSpec(key="length_bcc", fmt="<H", decoding=None),
+        FormatSpec(key="length_subject", fmt="<B", decoding=None),
+        FormatSpec(key="length_body", fmt="<H", decoding=None),
+        FormatSpec(key="length_access_token", fmt="<H", decoding=None),
+        FormatSpec(key="length_refresh_token", fmt="<H", decoding=None),
+        FormatSpec(key="from", fmt=lambda d: d["length_from"], decoding="utf-8"),
+        FormatSpec(key="to", fmt=lambda d: d["length_to"], decoding="utf-8"),
+        FormatSpec(key="cc", fmt=lambda d: d["length_cc"], decoding="utf-8"),
+        FormatSpec(key="bcc", fmt=lambda d: d["length_bcc"], decoding="utf-8"),
+        FormatSpec(key="subject", fmt=lambda d: d["length_subject"], decoding="utf-8"),
+        FormatSpec(key="body", fmt=lambda d: d["length_body"], decoding="utf-8"),
+        FormatSpec(
+            key="access_token", fmt=lambda d: d["length_access_token"], decoding="utf-8"
+        ),
+        FormatSpec(
+            key="refresh_token",
+            fmt=lambda d: d["length_refresh_token"],
+            decoding="utf-8",
+        ),
+    ]
+
+    try:
+        result = parse_payload(content, parsers)
+
+        if service_type == "email":
+            return (
+                result["from"],
+                result["to"],
+                result["cc"],
+                result["bcc"],
+                result["subject"],
+                result["body"],
+                result.get("access_token"),
+                result.get("refresh_token"),
+            ), None
+
+        if service_type == "text":
+            return (
+                result["from"],
+                result["body"],
+                result.get("access_token"),
+                result.get("refresh_token"),
+            ), None
+
+        if service_type == "message":
+            return (
+                result["from"],
+                result["to"],
+                result["body"],
+            ), None
+
+        if service_type == "test":
+            return (result["from"],), None
+
+        return (
+            None,
+            "Invalid service_type. Must be 'email', 'text', 'message', or 'test'.",
+        )
+    except Exception as e:
+        return None, e
+
+
 def is_v0_payload(payload):
     """Determines if the given payload follows v0 format."""
     try:

docs/grpc.md

@@ -86,7 +86,9 @@ start the OAuth2 flow.
 > | ------------- | --------- | ------------ | -------- | -------- |
 > | Gmail         | g         | Email        | OAuth2   | Optional |
 > | Twitter       | t         | Text         | OAuth2   | Required |
+> | Telegram      | T         | Message      | PNBA     | N/A      |
 > | Reliability   | r         | Test         | event    | N/A      |
+> | Bluesky       | b         | Text         | OAuth2   | Required |
 
 ---
 
@@ -110,12 +112,8 @@ Optional fields:
 | state                      | string | An opaque value used to maintain state between the request and the callback. |
 | code_verifier              | string | A cryptographic random string used in the PKCE flow.                         |
 | autogenerate_code_verifier | bool   | If true, a code verifier will be auto-generated if not provided.             |
-
-Optional fields:
-
-| Field        | Type   | Description                                  |
-| ------------ | ------ | -------------------------------------------- |
-| redirect_url | string | The redirect URL for the OAuth2 application. |
+| redirect_url               | string | The redirect URL for the OAuth2 application.                                 |
+| request_identifier         | string | A request identifier for tracking the request                                |
 
 ---
 
@@ -167,7 +165,8 @@ localhost:6000 publisher.v1.Publisher/GetOAuth2AuthorizationUrl <payload.json
   "platform": "gmail",
   "state": "",
   "code_verifier": "",
-  "autogenerate_code_verifier": true
+  "autogenerate_code_verifier": true,
+  "request_identifier": ""
 }
 ```
 
@@ -269,11 +268,12 @@ tokens in the vault.
 
 Optional fields:
 
-| Field           | Type   | Description                                                                 |
-| --------------- | ------ | --------------------------------------------------------------------------- |
-| code_verifier   | string | A cryptographic random string used in the PKCE flow.                        |
-| redirect_url    | string | The redirect URL for the OAuth2 application.                                |
-| store_on_device | bool   | Indicates if the token should be stored on the device instead of the cloud. |
+| Field              | Type   | Description                                                                 |
+| ------------------ | ------ | --------------------------------------------------------------------------- |
+| code_verifier      | string | A cryptographic random string used in the PKCE flow.                        |
+| redirect_url       | string | The redirect URL for the OAuth2 application.                                |
+| store_on_device    | bool   | Indicates if the token should be stored on the device instead of the cloud. |
+| request_identifier | string | A request identifier for tracking the request                               |
 
 ---
 
@@ -322,7 +322,8 @@ localhost:6000 publisher.v1.Publisher/ExchangeOAuth2CodeAndStore <payload.json
   "platform": "gmail",
   "authorization_code": "auth_code",
   "code_verifier": "abcdef",
-  "store_on_device": false
+  "store_on_device": false,
+  "request_identifier": ""
 }
 ```
 
@@ -441,6 +442,12 @@ This method sends a one-time passcode (OTP) to the user's phone number for authe
 | phone_number | string | The phone number to which the OTP is sent.                                                 |
 | platform     | string | The platform identifier for which the authorization code is generated. (e.g., "telegram"). |
 
+Optional fields:
+
+| Field              | Type   | Description                                   |
+| ------------------ | ------ | --------------------------------------------- |
+| request_identifier | string | A request identifier for tracking the request |
+
 ---
 
 ##### Response
@@ -482,7 +489,8 @@ localhost:6000 publisher.v1.Publisher/GetPNBACode <payload.json
 ```json
 {
   "phone_number": "+1234567890",
-  "platform": "telegram"
+  "platform": "telegram",
+  "request_identifier": ""
 }
 ```
 
@@ -520,9 +528,10 @@ This method exchanges the one-time passcode (OTP) for an access token and stores
 
 Optional fields:
 
-| Field    | Type   | Description                             |
-| -------- | ------ | --------------------------------------- |
-| password | string | The password for two-step verification. |
+| Field              | Type   | Description                                   |
+| ------------------ | ------ | --------------------------------------------- |
+| password           | string | The password for two-step verification.       |
+| request_identifier | string | A request identifier for tracking the request |
 
 ---
 
@@ -569,7 +578,8 @@ localhost:6000 publisher.v1.Publisher/ExchangePNBACodeAndStore <payload.json
   "long_lived_token": "long_lived_token",
   "password": "",
   "phone_number": "+1234567890",
-  "platform": "telegram"
+  "platform": "telegram",
+  "request_identifier": ""
 }
 ```