uc-integration 0.1.0__tar.gz

uc_integration-0.1.0/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: uc-integration
+Version: 0.1.0
+Summary: GSS 用户中心 SSO / 主数据同步 Fred 模块（子系统可 pip 安装）
+Author: GSS
+License: Proprietary
+Project-URL: Homepage, https://github.com/renzhong/gss
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: flask>=2.0
+Requires-Dist: flask-smorest>=0.40
+Requires-Dist: flask-jwt-extended>=4.0
+Requires-Dist: flask-babelplus>=2.0
+Requires-Dist: marshmallow>=3.0
+Requires-Dist: sqlalchemy>=1.4
+Requires-Dist: pip==26.1.2
+Provides-Extra: fred
+Requires-Dist: fred-admin; extra == "fred"
+Dynamic: requires-python
+
+# GSS UC Integration — 用户中心 SSO / 主数据同步（Fred 子系统共享包）
+
+将各子系统里同构的 `modules/uc_integration` 抽成可安装包，避免复制粘贴分叉。
+
+## 能力
+
+| 接口 | 说明 |
+|------|------|
+| `GET  /{subsystem}/uc_integration/auth/sso/config` | 登录模式 |
+| `POST /{subsystem}/uc_integration/auth/sso/exchange` | UC code/accessToken → 本地 JWT |
+| `POST /{subsystem}/uc_integration/auth/sso/refresh` | UC refreshToken 续期 |
+| `POST /{subsystem}/uc_integration/internal/uc-sync` | UC 主数据推送（仅本机） |
+| `GET  /{subsystem}/uc_integration/internal/uc-sync` | 同步健康检查 |
+
+本地 JWT 的 `sub` 含：
+
+- 本地身份：`id` / `username` / `name` / `store_id` / `store_ids` / `role`
+- **`uc`：UC validate/exchange 原样透传**（不做字段白名单）
+
+## 安装
+
+```bash
+# 开发：可编辑安装
+pip install -e /path/to/uc-integration
+
+# 或从 git
+pip install "gss-uc-integration @ git+ssh://git@github.com/org/uc-integration.git"
+```
+
+Fred 只从项目 `modules/` 扫描蓝图，安装后必须链接：
+
+```bash
+# 在子系统根目录（含 modules/）
+python /path/to/uc-integration/scripts/link_to_project.py .
+# 或覆盖已有 symlink
+python /path/to/uc-integration/scripts/link_to_project.py . --force
+```
+
+等价手动操作：
+
+```bash
+ln -sfn "$(python -c 'import uc_integration,pathlib; print(pathlib.Path(uc_integration.__file__).parent)')" \
+  modules/uc_integration
+```
+
+## 宿主配置
+
+`common/config/Config.py`（或等价配置）：
+
+```python
+LOAD_CUSTOM_MODULES = [..., "uc_integration"]
+
+SSO_LOGIN_MODE = 'uc'                    # 或 'local'
+UC_SUBSYSTEM_CODE = 'ai_check'           # 路由前缀：/{code}/uc_integration
+USER_CENTER_BASE_URL = 'http://127.0.0.1:5001'
+USER_CENTER_INTERNAL_SECRET = '...'      # 与 UC OPEN_API_INTERNAL_SECRET 一致
+
+# 可选
+UC_INCLUDE_STORE_SCOPE = True            # JWT 写入 store_ids / role（默认 True）
+UC_STORE_FALLBACK_FIRST = True           # 无匹配门店时回退第一个（默认 True）
+```
+
+## 宿主前置条件
+
+- 本地库有 `uc_user` / `uc_store` 等镜像表（可由 sync DDL 自动建）
+- ORM：`model.model` 中存在 `UcUser`（以及门店 scope 需要的 `UcDept` 等）
+- 依赖：`fred_admin`、Flask、SQLAlchemy（由子系统环境提供）
+
+## 目录结构（Fred 兼容）
+
+```
+uc_integration/
+  __init__.py              # 导出蓝图
+  backend/
+    __init__.py            # Blueprint + url_prefix
+    deps.py                # 惰性解析 model.model
+    controller/
+    service/
+    schema/
+```
+
+## 从旧模块迁移
+
+1. `pip install -e ../uc-integration`
+2. 备份并删除子系统 `modules/uc_integration`
+3. `python ../uc-integration/scripts/link_to_project.py .`
+4. 确认 `UC_SUBSYSTEM_CODE` 与门户子系统编码一致
+5. 验证 `GET /{code}/uc_integration/auth/sso/config`
+
+## 版本
+
+当前 `0.1.0`，以 ai_check（UC 原样透传）+ todo（门店 scope / 动态前缀）合并为基准。

uc_integration-0.1.0/README.md

@@ -0,0 +1,92 @@
+# GSS UC Integration — 用户中心 SSO / 主数据同步（Fred 子系统共享包）
+
+将各子系统里同构的 `modules/uc_integration` 抽成可安装包，避免复制粘贴分叉。
+
+## 能力
+
+| 接口 | 说明 |
+|------|------|
+| `GET  /{subsystem}/uc_integration/auth/sso/config` | 登录模式 |
+| `POST /{subsystem}/uc_integration/auth/sso/exchange` | UC code/accessToken → 本地 JWT |
+| `POST /{subsystem}/uc_integration/auth/sso/refresh` | UC refreshToken 续期 |
+| `POST /{subsystem}/uc_integration/internal/uc-sync` | UC 主数据推送（仅本机） |
+| `GET  /{subsystem}/uc_integration/internal/uc-sync` | 同步健康检查 |
+
+本地 JWT 的 `sub` 含：
+
+- 本地身份：`id` / `username` / `name` / `store_id` / `store_ids` / `role`
+- **`uc`：UC validate/exchange 原样透传**（不做字段白名单）
+
+## 安装
+
+```bash
+# 开发：可编辑安装
+pip install -e /path/to/uc-integration
+
+# 或从 git
+pip install "gss-uc-integration @ git+ssh://git@github.com/org/uc-integration.git"
+```
+
+Fred 只从项目 `modules/` 扫描蓝图，安装后必须链接：
+
+```bash
+# 在子系统根目录（含 modules/）
+python /path/to/uc-integration/scripts/link_to_project.py .
+# 或覆盖已有 symlink
+python /path/to/uc-integration/scripts/link_to_project.py . --force
+```
+
+等价手动操作：
+
+```bash
+ln -sfn "$(python -c 'import uc_integration,pathlib; print(pathlib.Path(uc_integration.__file__).parent)')" \
+  modules/uc_integration
+```
+
+## 宿主配置
+
+`common/config/Config.py`（或等价配置）：
+
+```python
+LOAD_CUSTOM_MODULES = [..., "uc_integration"]
+
+SSO_LOGIN_MODE = 'uc'                    # 或 'local'
+UC_SUBSYSTEM_CODE = 'ai_check'           # 路由前缀：/{code}/uc_integration
+USER_CENTER_BASE_URL = 'http://127.0.0.1:5001'
+USER_CENTER_INTERNAL_SECRET = '...'      # 与 UC OPEN_API_INTERNAL_SECRET 一致
+
+# 可选
+UC_INCLUDE_STORE_SCOPE = True            # JWT 写入 store_ids / role（默认 True）
+UC_STORE_FALLBACK_FIRST = True           # 无匹配门店时回退第一个（默认 True）
+```
+
+## 宿主前置条件
+
+- 本地库有 `uc_user` / `uc_store` 等镜像表（可由 sync DDL 自动建）
+- ORM：`model.model` 中存在 `UcUser`（以及门店 scope 需要的 `UcDept` 等）
+- 依赖：`fred_admin`、Flask、SQLAlchemy（由子系统环境提供）
+
+## 目录结构（Fred 兼容）
+
+```
+uc_integration/
+  __init__.py              # 导出蓝图
+  backend/
+    __init__.py            # Blueprint + url_prefix
+    deps.py                # 惰性解析 model.model
+    controller/
+    service/
+    schema/
+```
+
+## 从旧模块迁移
+
+1. `pip install -e ../uc-integration`
+2. 备份并删除子系统 `modules/uc_integration`
+3. `python ../uc-integration/scripts/link_to_project.py .`
+4. 确认 `UC_SUBSYSTEM_CODE` 与门户子系统编码一致
+5. 验证 `GET /{code}/uc_integration/auth/sso/config`
+
+## 版本
+
+当前 `0.1.0`，以 ai_check（UC 原样透传）+ todo（门店 scope / 动态前缀）合并为基准。

uc_integration-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "uc-integration"
+version = "0.1.0"
+description = "GSS 用户中心 SSO / 主数据同步 Fred 模块（子系统可 pip 安装）"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "Proprietary" }
+authors = [{ name = "GSS" }]
+dependencies = [
+  "flask>=2.0",
+  "flask-smorest>=0.40",
+  "flask-jwt-extended>=4.0",
+  "flask-babelplus>=2.0",
+  "marshmallow>=3.0",
+  "sqlalchemy>=1.4",
+  "pip==26.1.2",
+]
+
+[project.optional-dependencies]
+fred = ["fred-admin"]
+
+[project.urls]
+Homepage = "https://github.com/renzhong/gss"
+
+[tool.setuptools.packages.find]
+include = ["uc_integration*"]
+
+[tool.setuptools.package-data]
+uc_integration = ["py.typed"]

uc_integration-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

uc_integration-0.1.0/setup.py

@@ -0,0 +1,18 @@
+from setuptools import setup, find_packages
+
+setup(
+	name='uc-integration',
+	version='0.1.0',
+	description='GSS 用户中心 SSO / 主数据同步 Fred 模块',
+	packages=find_packages(include=['uc_integration', 'uc_integration.*']),
+	python_requires='>=3.10',
+	install_requires=[
+		'flask>=2.0',
+		'flask-smorest>=0.40',
+		'flask-jwt-extended>=4.0',
+		'flask-babelplus>=2.0',
+		'marshmallow>=3.0',
+		'sqlalchemy>=1.4',
+	],
+	include_package_data=True,
+)

uc_integration-0.1.0/uc_integration/__init__.py

@@ -0,0 +1,64 @@
+# uc_integration — 用户中心 SSO / 主数据同步（Fred 子系统可安装模块）
+"""安装后可直接 import；在 Fred 下通过 modules/ symlink 自动注册蓝图。"""
+from __future__ import annotations
+
+import importlib.util
+import sys
+import types
+from pathlib import Path
+
+__version__ = '0.1.0'
+
+
+def _ensure_fred_style_aliases() -> None:
+	"""将 backend/{service,schema,...} 注册为 uc_integration.*，并预加载 .py 文件。
+
+	对齐 Fred `_register_backend_submodules`：仅建空包会导致
+	`from uc_integration.schema.X import Y` 在部分加载顺序下失败。
+	"""
+	backend = Path(__file__).resolve().parent / 'backend'
+	if not backend.is_dir():
+		return
+	for subdir in backend.iterdir():
+		if not subdir.is_dir() or subdir.name.startswith('_') or subdir.name == 'controller':
+			continue
+		pkg_name = f'uc_integration.{subdir.name}'
+		if pkg_name not in sys.modules:
+			mod = types.ModuleType(pkg_name)
+			mod.__path__ = [str(subdir)]
+			mod.__file__ = str(subdir / '__init__.py')
+			mod.__package__ = pkg_name
+			sys.modules[pkg_name] = mod
+			setattr(sys.modules[__name__], subdir.name, mod)
+		else:
+			mod = sys.modules[pkg_name]
+			if not getattr(mod, '__path__', None):
+				mod.__path__ = [str(subdir)]
+
+		init_file = subdir / '__init__.py'
+		if init_file.exists() and not getattr(mod, '__file__', None):
+			mod.__file__ = str(init_file)
+
+		for py_file in subdir.glob('*.py'):
+			if py_file.name.startswith('__'):
+				continue
+			file_mod_name = f'{pkg_name}.{py_file.stem}'
+			if file_mod_name in sys.modules:
+				continue
+			try:
+				spec = importlib.util.spec_from_file_location(file_mod_name, py_file)
+				if not spec or not spec.loader:
+					continue
+				file_mod = importlib.util.module_from_spec(spec)
+				sys.modules[file_mod_name] = file_mod
+				spec.loader.exec_module(file_mod)
+				setattr(mod, py_file.stem, file_mod)
+			except Exception:
+				sys.modules.pop(file_mod_name, None)
+
+
+_ensure_fred_style_aliases()
+
+from .backend import uc_integration, get_admin_role, get_subsystem_code  # noqa: E402
+
+__all__ = ['uc_integration', 'get_admin_role', 'get_subsystem_code', '__version__']

uc_integration-0.1.0/uc_integration/backend/__init__.py

@@ -0,0 +1,42 @@
+# -*- coding: utf-8
+"""蓝图入口：url_prefix 由 UC_SUBSYSTEM_CODE 动态推导。"""
+from flask_smorest import Blueprint
+
+
+def get_subsystem_code() -> str:
+	"""子系统编码：优先 Config.UC_SUBSYSTEM_CODE，否则 DEFAULT_MODULE。"""
+	try:
+		from flask import current_app, has_app_context
+		if has_app_context():
+			code = (current_app.config.get('UC_SUBSYSTEM_CODE') or '').strip()
+			if code:
+				return code
+			return (current_app.config.get('DEFAULT_MODULE') or 'app').strip()
+	except Exception:
+		pass
+	try:
+		from common.config.Config import Config
+		code = (getattr(Config, 'UC_SUBSYSTEM_CODE', None) or '').strip()
+		if code:
+			return code
+		return (getattr(Config, 'DEFAULT_MODULE', None) or 'app').strip()
+	except Exception:
+		return 'app'
+
+
+def get_admin_role() -> str:
+	"""从 DEFAULT_MODULE 推导管理员角色：{subsystem}_admin。"""
+	from flask import current_app
+	subsystem = (current_app.config.get('DEFAULT_MODULE') or get_subsystem_code()).strip()
+	return f'{subsystem}_admin'
+
+
+uc_integration = Blueprint(
+	'uc_integration',
+	__name__,
+	url_prefix=f'/{get_subsystem_code()}/uc_integration',
+)
+
+# SSO：/{UC_SUBSYSTEM_CODE}/uc_integration/auth/sso/*
+# 同步：/{UC_SUBSYSTEM_CODE}/uc_integration/internal/uc-sync
+# controller 由 Fred 扫描 modules/uc_integration/backend/controller/

uc_integration-0.1.0/uc_integration/backend/controller/SsoAuthController.py

@@ -0,0 +1,47 @@
+# -*- coding: utf-8
+"""SSO 换票接口：UC code / accessToken → 本地 JWT。"""
+from flask import abort, current_app
+from flask.views import MethodView
+from flask_babelplus import gettext
+
+from uc_integration import uc_integration
+from uc_integration.schema.SsoAuthSchema import (
+	SsoExchangeBodySchema,
+	SsoRefreshBodySchema,
+	SsoExchangeResponseSchema,
+)
+from uc_integration.service.SsoAuthService import SsoAuthService
+
+
+@uc_integration.route('/auth/sso/config')
+class SsoConfigController(MethodView):
+	def get(self):
+		"""子系统前端读取登录方式（无需登录）。"""
+		mode = (current_app.config.get('SSO_LOGIN_MODE') or 'local').strip().lower()
+		if mode not in ('uc', 'local'):
+			mode = 'local'
+		base_url = (current_app.config.get('USER_CENTER_BASE_URL') or '').strip().rstrip('/')
+		if not base_url:
+			abort(500, description=gettext('用户中心地址未配置（USER_CENTER_BASE_URL）'))
+		return {
+			'loginMode': mode,
+			'userCenterBaseUrl': base_url,
+		}
+
+
+@uc_integration.route('/auth/sso/exchange')
+class SsoExchangeController(MethodView):
+	@uc_integration.arguments(SsoExchangeBodySchema)
+	@uc_integration.response(200, SsoExchangeResponseSchema)
+	def post(self, args):
+		"""用 UC 授权码或 accessToken 兑换本子系统 JWT（服务端调 UC）。"""
+		return SsoAuthService().sso_exchange(args)
+
+
+@uc_integration.route('/auth/sso/refresh')
+class SsoRefreshController(MethodView):
+	@uc_integration.arguments(SsoRefreshBodySchema)
+	@uc_integration.response(200, SsoExchangeResponseSchema)
+	def post(self, args):
+		"""UC refreshToken 续期并重新签发本地 JWT。"""
+		return SsoAuthService().sso_refresh(args)

uc_integration-0.1.0/uc_integration/backend/controller/UcDataSyncController.py

@@ -0,0 +1,62 @@
+# coding: utf-8
+"""
+UC 主数据同步接口
+
+接收 user-center 推送的用户、组织架构、门店等主数据，保存到本地数据库。
+- POST /{subsystem}/uc_integration/internal/uc-sync  接收推送
+- GET  /{subsystem}/uc_integration/internal/uc-sync  健康检查
+
+安全策略：
+- 仅允许本机（127.0.0.1 / ::1）访问
+- 校验请求头 X-UC-Internal-Secret 与本地 USER_CENTER_INTERNAL_SECRET 一致
+"""
+from flask import abort, current_app, request
+from flask.views import MethodView
+from flask_babelplus import gettext
+from functools import wraps
+
+from uc_integration import uc_integration
+from uc_integration.service.UcDataSyncService import UcDataSyncService
+
+_LOCALHOST_ADDRS = frozenset({'127.0.0.1', '::1'})
+
+
+def _verify_local_internal_access() -> None:
+	"""校验请求来自本机且携带正确的内部密钥。"""
+	remote = (request.remote_addr or '').strip()
+	if remote not in _LOCALHOST_ADDRS:
+		abort(403, description=gettext('仅允许本机访问'))
+
+	expected = (current_app.config.get('USER_CENTER_INTERNAL_SECRET') or '').strip()
+	if not expected:
+		abort(501, description=gettext('内部同步密钥未配置（USER_CENTER_INTERNAL_SECRET）'))
+
+	provided = (request.headers.get('X-UC-Internal-Secret') or '').strip()
+	if provided != expected:
+		abort(403, description=gettext('无权访问同步接口'))
+
+
+def uc_sync_local_only(f):
+	"""装饰器：限制仅本机 + 正确密钥可访问。"""
+	@wraps(f)
+	def wrapper(*args, **kwargs):
+		_verify_local_internal_access()
+		return f(*args, **kwargs)
+	return wrapper
+
+
+@uc_integration.route('/internal/uc-sync')
+class UcDataSyncController(MethodView):
+
+	@uc_sync_local_only
+	@uc_integration.response(200)
+	def post(self):
+		"""接收 UC 推送的用户、组织、门店主数据（仅本机）。"""
+		payload = request.get_json(silent=True) or {}
+		return UcDataSyncService().sync(payload)
+
+	@uc_sync_local_only
+	@uc_integration.response(200)
+	def get(self):
+		"""同步接口健康检查（仅本机），返回各镜像表有效记录数。"""
+		return UcDataSyncService.health_check()

uc_integration-0.1.0/uc_integration/backend/controller/__init__.py

@@ -0,0 +1,49 @@
+# coding: utf-8
+"""业务 API 认证装饰器：仅认本地 JWT。"""
+from functools import wraps
+import json
+
+from flask import abort, g, request
+from flask_babelplus import gettext
+from flask_jwt_extended import decode_token
+
+
+def _extract_bearer_token() -> str:
+	auth = request.headers.get('Authorization') or ''
+	if auth.lower().startswith('bearer '):
+		return auth[7:].strip()
+	return ''
+
+
+def _try_admin_jwt(token: str) -> bool:
+	from uc_integration.backend import get_admin_role
+	try:
+		decoded = decode_token(token)
+	except Exception:
+		return False
+	roles = decoded.get('role')
+	admin_role = get_admin_role()
+	if isinstance(roles, list):
+		if 'uc_integration' not in roles and admin_role not in roles:
+			return False
+	elif roles not in ('uc_integration', admin_role):
+		return False
+	identity = json.loads(decoded['sub'])
+	g.uc_user_id = identity.get('username') or str(identity.get('id'))
+	g.uc_identity = identity
+	return True
+
+
+def public_api(f):
+	"""业务 API 仅认本地 JWT（uc_integration 或子系统管理员角色）。"""
+
+	@wraps(f)
+	def wrapper(*args, **kwargs):
+		token = _extract_bearer_token()
+		if not token:
+			abort(401, description=gettext('请先登录'))
+		if not _try_admin_jwt(token):
+			abort(401, description=gettext('请先登录'))
+		return f(*args, **kwargs)
+
+	return wrapper

uc_integration-0.1.0/uc_integration/backend/deps.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8
+"""宿主依赖惰性解析：避免包安装时强绑 model.model。"""
+from __future__ import annotations
+
+
+def get_db():
+	"""返回宿主 Flask-SQLAlchemy db 实例。"""
+	from model.model import db
+	return db
+
+
+def get_uc_user_model():
+	"""返回宿主 UcUser ORM 类。"""
+	from model.model import UcUser
+	return UcUser
+
+
+def get_uc_models():
+	"""返回门店 scope 所需的 UC 镜像表模型。"""
+	from model.model import UcDept, UcDeptUserRelation, UcStore, UcUser, db
+	return {
+		'UcDept': UcDept,
+		'UcDeptUserRelation': UcDeptUserRelation,
+		'UcStore': UcStore,
+		'UcUser': UcUser,
+		'db': db,
+	}

uc_integration-0.1.0/uc_integration/backend/schema/SsoAuthSchema.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8
+"""SSO 换票接口 Schema 定义。"""
+from marshmallow import Schema, fields
+
+
+class SsoExchangeBodySchema(Schema):
+	code = fields.Str(metadata={'description': 'UC 跨域回跳一次性授权码'})
+	accessToken = fields.Str(metadata={'description': 'UC accessToken（同域兜底）'})
+	refreshToken = fields.Str(metadata={'description': 'UC refreshToken（可选）'})
+
+
+class SsoRefreshBodySchema(Schema):
+	refreshToken = fields.Str(required=True, metadata={'description': 'UC refreshToken'})
+
+
+class SsoExchangeResponseSchema(Schema):
+	id = fields.Int()
+	username = fields.Str()
+	name = fields.Str()
+	role = fields.Str(metadata={'description': '业务角色 manager/employee'})
+	access_token = fields.Str()
+	refresh_token = fields.Str()
+	uc_access_token = fields.Str()
+	uc_refresh_token = fields.Str()
+	store_id = fields.Int(metadata={'description': '当前门店 ID'})
+	storeId = fields.Int(metadata={'description': '当前门店 ID（驼峰）'})
+	store_ids = fields.List(fields.Int(), metadata={'description': '可访问门店 ID 列表'})
+	storeIds = fields.List(fields.Int(), metadata={'description': '可访问门店 ID 列表（驼峰）'})
+	store_name = fields.Str(metadata={'description': '门店名称（来自 uc_store）'})
+	uc = fields.Dict(
+		metadata={'description': 'UC 换票/校验原样返回（完整透传，不做字段裁剪）'},
+	)