ffid-python-sdk 0.1.0__py3-none-any.whl

ffid_python_sdk-0.1.0.dist-info/METADATA

@@ -0,0 +1,135 @@
+Metadata-Version: 2.4
+Name: ffid-python-sdk
+Version: 0.1.0
+Summary: FeelFlow ID Platform SDK for Python (FastAPI)
+Project-URL: Homepage, https://github.com/feel-flow/feelflow-id-platform/tree/develop/sdk/python
+Project-URL: Repository, https://github.com/feel-flow/feelflow-id-platform
+Project-URL: Documentation, https://github.com/feel-flow/feelflow-id-platform/tree/develop/sdk/python#readme
+Project-URL: Bug Tracker, https://github.com/feel-flow/feelflow-id-platform/issues
+Author-email: "FeelFlow Inc." <dev@feelflow.co.jp>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: authentication,fastapi,feelflow,ffid,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: fastapi>=0.100.0
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: typing-extensions>=4.0.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: respx>=0.20.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# ffid-python-sdk
+
+FeelFlow ID Platform SDK for Python (FastAPI).  
+FastAPI アプリケーション向けの認証・認可・契約管理 SDK です。
+
+**5行のコードでFFID認証を導入可能**（最小ボイラープレート）。
+
+- Python 3.11+
+- FastAPI / Pydantic v2 / httpx
+
+## インストール
+
+```bash
+pip install ffid-python-sdk
+```
+
+## クイックスタート（最小例）
+
+```python
+from fastapi import FastAPI, Depends
+from ffid_sdk import FFIDMiddleware, require_subscription, FFIDContext, get_ffid_context
+
+app = FastAPI()
+app.add_middleware(FFIDMiddleware, service_code="chatbot")
+
+@app.get("/api/chat")
+@require_subscription(plan=["basic", "pro", "enterprise"])
+async def chat(ffid: FFIDContext = Depends(get_ffid_context)):
+    return {"message": f"Hello, {ffid.user.email}"}
+```
+
+認証はミドルウェアが行い、`get_ffid_context` でコンテキストをエンドポイントに注入します。  
+`plan=` は `plans=` のエイリアスです（どちらも利用可能）。
+
+## 主要コンポーネント
+
+### FFIDMiddleware
+
+リクエストからアクセストークン（`Authorization: Bearer` または Cookie `ffid_session`）を取得し、FFID API でセッション検証後に `request.state.ffid_context` にコンテキストを格納します。
+
+```python
+app.add_middleware(
+    FFIDMiddleware,
+    service_code="chatbot",
+    exclude_paths=["/health", "/docs", "/openapi.json"],
+)
+```
+
+### FFIDContext
+
+ユーザー・組織・契約情報を保持するリクエストスコープのコンテキスト。  
+`Depends(get_ffid_context)` で取得（認証任意）、`Depends(require_ffid_auth)` で認証必須にできます。
+
+- `ctx.user` … 認証ユーザー
+- `ctx.organizations` … 所属組織一覧
+- `ctx.subscriptions` … 契約一覧
+- `ctx.active_subscription` … 有効な契約（1件）
+
+### @require_subscription
+
+契約チェック用デコレータ。指定プランまたは任意の有効契約が必要なエンドポイントに付けます。
+
+```python
+@require_subscription(plan=["basic", "pro", "enterprise"])  # または plans=
+async def premium(ctx: FFIDContext = Depends(get_ffid_context)):
+    ...
+```
+
+### FFIDClient
+
+FFID API を直接呼ぶクライアント（セッション取得・トークンリフレッシュ・サインアウト・契約確認など）。  
+ミドルウェアを使わないバックグラウンド処理やテストで利用します。
+
+```python
+from ffid_sdk import FFIDClient, FFIDConfig
+
+client = FFIDClient(FFIDConfig(service_code="chatbot"))
+response = await client.get_session(token="...")
+```
+
+## 環境変数
+
+| 変数 | 説明 |
+|------|------|
+| `FFID_SERVICE_CODE` | サービス識別コード（例: `chatbot`）。ミドルウェアの `service_code` に渡すか、クライアント設定で指定。 |
+| `FFID_API_BASE_URL` | FFID API のベースURL（省略時は本番 `https://id.feelflow.co.jp` 相当）。 |
+
+## 利用規約チェック・リダイレクト
+
+法的文書の同意確認と未同意時のリダイレクトは、Legal クライアント（Service API Key 認証）で実装済みです。  
+`check_pending_agreements_and_redirect_url` で未同意一覧を取得し、未同意時は返却される `redirect_url` へリダイレクトできます。戻り値の第4要素に API エラーが入るため、呼び出し元でエラーハンドリング可能です。
+
+## トークン自動リフレッシュ（オプション）
+
+JWT 期限切れ時に refresh トークンで自動再取得する機能をミドルウェアで利用できます。  
+`FFIDMiddleware(..., auto_refresh=True)` にし、Cookie `ffid_refresh` にリフレッシュトークンが含まれる構成で有効化します。
+
+## ライセンス
+
+MIT

ffid_python_sdk-0.1.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+ffid_sdk/__init__.py,sha256=hTOc0zTeJ52THqvcHj89CQHR-zuMiZyG5XAmvQOec4U,4252
+ffid_sdk/client.py,sha256=bEGTVTlTA1WeiiG-JI-pi_xk1Pl1sxMV6zLn-s6Tpt4,14363
+ffid_sdk/constants.py,sha256=-P56fnO1QmcTAlbBA96fQ3xWK2gavDc1MGL2aRUi58E,2479
+ffid_sdk/context.py,sha256=wZ8aiaZwybo9WMOxaYZXKBwIHFrpFhM4DMPMBr6fm0w,2415
+ffid_sdk/decorators.py,sha256=WG1yFetF2s4FyOFfEBfSYQmN7ZUCWSo87voWxzqL_yg,5022
+ffid_sdk/errors.py,sha256=yWbhP5zpWFahS56BYt18I60OoZa2jejYhrfviDxv_gw,4417
+ffid_sdk/middleware.py,sha256=6iQdLJ_h11QuklX4u5QIt7J2F8tC9F6oRWz4Bm0SkgM,8938
+ffid_sdk/types.py,sha256=rN54UQHVzr6lwAGQVq_7PfXoIswMdkNZZ2nvw2Fkh7w,8396
+ffid_sdk/webhook_constants.py,sha256=CVv4kvVGyY4iAnhE4vuFNpx-2bzTiASmZyMOtxF44ZY,1104
+ffid_sdk/webhook_errors.py,sha256=lvsTFYkgMcWtAbUyTenssYctl6rOEONEnm9CBIk9SEM,1821
+ffid_sdk/webhook_handler.py,sha256=5W3QHgkhpAp5VHWIzChdzRC1ZBj5lI8jDJN9b_tkxzs,6760
+ffid_sdk/webhook_types.py,sha256=kzjFYVO-EV5m15075NhIGnMsW70aSXJFa-cUAcrZqtw,7693
+ffid_sdk/webhook_verify.py,sha256=R67Seb_j8flIkEGYTd_5VoYGZ8AqBz55YjWrFljSzMQ,4270
+ffid_sdk/legal/__init__.py,sha256=MpROcaPJDzo2T-MxEHfWUC23JNN_7ck6KTLDyCqLbEs,1368
+ffid_sdk/legal/client.py,sha256=Pk-yJLE8_7JECIfNV47PMp6W4wlbwClFuJRQ2keCYuE,8086
+ffid_sdk/legal/errors.py,sha256=goCT_tEbJz9FE9cLIAJAC8dZanszpr7EDOERliLvedI,1580
+ffid_sdk/legal/helpers.py,sha256=_WnbvxpYhboCdG4lkjMIhzcZVI-kTwYxy8xDMh9PyY0,2151
+ffid_sdk/legal/types.py,sha256=crJmdb0u2raJpJqOJkwr42bbpJp0lxkSELx7RTLnD08,4348
+ffid_python_sdk-0.1.0.dist-info/METADATA,sha256=lf6T4vr0HSTtez5A9fUGMRC6KPerrkKAIv7J3a1t-6M,5344
+ffid_python_sdk-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+ffid_python_sdk-0.1.0.dist-info/licenses/LICENSE,sha256=Ok6MPtGJMOAAbrmK0JLei7UFH6qSScICFVm7YhuIBNo,1070
+ffid_python_sdk-0.1.0.dist-info/RECORD,,

ffid_python_sdk-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

ffid_python_sdk-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 FeelFlow Inc.
+
+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.

ffid_sdk/__init__.py

@@ -0,0 +1,176 @@
+"""
+FFID SDK - FeelFlow ID Platform SDK for Python (FastAPI)
+
+FastAPI アプリケーション向けの認証・認可・契約管理 SDK。
+
+Quick Start:
+    ```python
+    from fastapi import FastAPI, Depends
+    from ffid_sdk import FFIDMiddleware, FFIDContext, get_ffid_context, require_subscription
+
+    app = FastAPI()
+    app.add_middleware(FFIDMiddleware, service_code="chatbot")
+
+    @app.get("/dashboard")
+    async def dashboard(ctx: FFIDContext = Depends(get_ffid_context)):
+        return {"user": ctx.user.email}
+
+    @app.get("/premium")
+    @require_subscription(plans=["pro", "enterprise"])
+    async def premium(ctx: FFIDContext = Depends(get_ffid_context)):
+        return {"plan": ctx.active_subscription.plan_code}
+    ```
+"""
+
+from __future__ import annotations
+
+# Client
+from ffid_sdk.client import FFIDClient
+
+# Constants
+from ffid_sdk.constants import DEFAULT_API_BASE_URL
+
+# Context & Dependencies
+from ffid_sdk.context import get_ffid_context, require_ffid_auth
+
+# Decorators
+from ffid_sdk.decorators import require_subscription
+
+# Errors
+from ffid_sdk.errors import (
+    FFIDAuthenticationError,
+    FFIDAuthorizationError,
+    FFIDErrorCode,
+    FFIDNetworkError,
+    FFIDSDKError,
+    FFIDSubscriptionError,
+    FFIDValidationError,
+)
+
+# Middleware
+from ffid_sdk.middleware import FFIDMiddleware
+
+# Types
+from ffid_sdk.types import (
+    FFIDApiResponse,
+    FFIDConfig,
+    FFIDContext,
+    FFIDError,
+    FFIDOrganization,
+    FFIDSessionResponse,
+    FFIDSubscription,
+    FFIDTokenResponse,
+    FFIDUser,
+    MembershipStatus,
+    OrganizationRole,
+    SubscriptionStatus,
+)
+
+# Webhook - Constants
+from ffid_sdk.webhook_constants import (
+    DEFAULT_TOLERANCE_SECONDS,
+    FFID_WEBHOOK_EVENT_ID_HEADER,
+    FFID_WEBHOOK_SIGNATURE_HEADER,
+    FFID_WEBHOOK_TIMESTAMP_HEADER,
+)
+
+# Webhook - Errors
+from ffid_sdk.webhook_errors import (
+    FFIDWebhookError,
+    FFIDWebhookPayloadError,
+    FFIDWebhookSignatureError,
+    FFIDWebhookTimestampError,
+)
+
+# Webhook - Handler
+from ffid_sdk.webhook_handler import WebhookHandler
+
+# Webhook - Types
+from ffid_sdk.webhook_types import (
+    EVENT_TYPE_PAYLOAD_MAP,
+    FFIDLegalDocumentPayload,
+    FFIDMaintenancePayload,
+    FFIDOrganizationMemberPayload,
+    FFIDOrganizationPayload,
+    FFIDSubscriptionPayload,
+    FFIDTestPingPayload,
+    FFIDUserPayload,
+    FFIDWebhookEvent,
+    WebhookEventType,
+)
+
+# Webhook - Verify
+from ffid_sdk.webhook_verify import verify_webhook_signature
+
+# Legal (Phase 2: 利用規約チェック・リダイレクト)
+from ffid_sdk.legal import (
+    FFIDLegalClient,
+    FFIDLegalClientConfig,
+    check_pending_agreements_and_redirect_url,
+)
+
+__all__ = [
+    # Client
+    "FFIDClient",
+    # Config & Constants
+    "FFIDConfig",
+    "DEFAULT_API_BASE_URL",
+    # Context & Dependencies
+    "FFIDContext",
+    "get_ffid_context",
+    "require_ffid_auth",
+    # Decorators
+    "require_subscription",
+    # Errors
+    "FFIDSDKError",
+    "FFIDAuthenticationError",
+    "FFIDAuthorizationError",
+    "FFIDSubscriptionError",
+    "FFIDNetworkError",
+    "FFIDValidationError",
+    "FFIDErrorCode",
+    # Middleware
+    "FFIDMiddleware",
+    # Types
+    "FFIDUser",
+    "FFIDOrganization",
+    "FFIDSubscription",
+    "FFIDSessionResponse",
+    "FFIDTokenResponse",
+    "FFIDError",
+    "FFIDApiResponse",
+    "OrganizationRole",
+    "MembershipStatus",
+    "SubscriptionStatus",
+    # Webhook - Constants
+    "FFID_WEBHOOK_SIGNATURE_HEADER",
+    "FFID_WEBHOOK_TIMESTAMP_HEADER",
+    "FFID_WEBHOOK_EVENT_ID_HEADER",
+    "DEFAULT_TOLERANCE_SECONDS",
+    # Webhook - Errors
+    "FFIDWebhookError",
+    "FFIDWebhookSignatureError",
+    "FFIDWebhookTimestampError",
+    "FFIDWebhookPayloadError",
+    # Webhook - Handler
+    "WebhookHandler",
+    # Webhook - Types
+    "FFIDWebhookEvent",
+    "WebhookEventType",
+    "FFIDSubscriptionPayload",
+    "FFIDUserPayload",
+    "FFIDOrganizationPayload",
+    "FFIDOrganizationMemberPayload",
+    "FFIDLegalDocumentPayload",
+    "FFIDMaintenancePayload",
+    "FFIDTestPingPayload",
+    "EVENT_TYPE_PAYLOAD_MAP",
+    # Webhook - Verify
+    "verify_webhook_signature",
+    # Legal
+    "FFIDLegalClient",
+    "FFIDLegalClientConfig",
+    "check_pending_agreements_and_redirect_url",
+]
+
+__version__ = "0.1.0"