sso general utility for services connected to sso
Project description
Awesome SSO
A library designed to host common components for a cluster of microservices sharing a single sign on.
Feature
- A common exception class, supporting both status code and custom error code to map to more detailed error message or serve as i18n key.
- A common FastAPI app for interaction with service, like login ,registration and unregistration.
- a connector for minio object store.
- a connector for beanie, a mongo odm compatible with pydantic.
Usage
Installation
pip install awesome-sso
Exceptions
Using fast API as example, we may simply throw exception with a proper status code, and an optional error code. We may also supply arbitrary key value in args dict, to help frontend render better error message.
from awesome_sso.exceptions import NotFound
from fastapi import APIRouter
router = APIRouter()
@router.get('/transactions')
def get(id: str):
try:
obj = find_by_id(id)
except Exception as e:
raise NotFound(message='transaction not found' % id, error_code='A0001', args={id: id})
...
And we may implement a common error handler to convert all these errors to proper response schema
from awesome_sso.exceptions import HTTPException
from fastapi.requests import Request
from fastapi.responses import JSONResponse
@app.exception_handler(HTTPException)
async def http_exception_handler(request: Request, exc: HTTPException):
return JSONResponse(
status_code=exc.status_code,
content={
'detail': exc.detail,
'error_code': exc.error_code,
}
)
This would result in a response with status code 404, and body
{
"status_code": 404,
"detail": {
"message": "transaction not found",
"id": "some_id"
},
"error_code": "A0001"
}
With this response, frontend can decide to simply render detail, or map it to detailed message. If error_code "A0001" correspond to the following i18 n entry
"error.A0001": {"en-US": "transaction can not be found with supplied {id}: {message}"}
we may format message accordingly with
errorMessage = formatMessage({ id: `error.${error.data.error_code}` }, error.data.detail);
Note that error code is not supplied, is default to status code. So it is always safe to simply use error_code in frontend to decide what to render.
Data Store
Minio
refer to tests/test_minio.py
Mongo
refer to tests/service/test_user.py
from beanie import init_beanie
from motor.motor_asyncio import AsyncIOMotorClient
from awesome_sso.service.user.schema import AwesomeUser
def init_mongo():
settings = YOUR_SETTINGS()
models = [AwesomeUser]
cli = AsyncIOMotorClient(settings.mongodb_dsn)
await init_beanie(
database=cli[settings.mongodb_db_name],
document_models=models,
)
for model in models:
await model.get_motor_collection().drop()
await model.get_motor_collection().drop_indexes()
Service
configure service settings
from awesome_sso.service.settings import Settings
settings = Settings()
settings.init_app(
symmetric_key='YOUR_SYMMETRIC_KEY', # to encode and decode service token
public_key='YOUR_PUBLIC_KEY', # to decode the token signed by sso
user_model=USER_MODEL, # user orm needs to inherit AwesomeUser from `awesome_sso.user.schema`
service_name='YOUR_SERVICE_NAME', # for service discovery, to recognize service
sso_domain='YOUR_SSO_DOMAIN', # for service registration and sync user
)
initial service and mount to your application
from awesome_sso.service import Service
from fastapi import FastAPI
app = FastAPI()
service = Service()
service.init_app(YOUR_FASTAPI_APP)
app.mount('/YOUR/PATH', YOUR_FASTAPI_APP)
then open the api doc, you will see the apis in awesome_sso.service.user.route
Development
Installing Poetry
- create your own environment for poetry, and simply run:
pip install poetry
- alternatively, you can refer to poetry's official page
- to be able to use
poe
directly,pip install poethepoet
Contributing
- project setup:
poetry install
- create your own branch to start developing new feature.
- before creating pr, make sure you pass
poe lint
and./run_test.sh
.- what happened inside
./run_test.sh
is that a minio server is setup for you temporarily, and teardown and unit test is finished. - notice that
poe test
would also work if you already have a minio up and running. You need the following env variable:MINIO_ACCESS_KEY
,MINIO_SECRET_KEY
,MINIO_ADDRESS
upon runningpoe test
.
- what happened inside
- for a list of available poe command,
poe
- after you submit a pr, you should check if pipeline is successful.
Releasing
poetry version [new_version]
git commit -m"Bump version"
git push origin develop
- create new release on github.
- Create release off develop branch, auto generate notes, and review release note.
- Publish release
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for awesome_sso-0.2.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76962faf9b258d92ea5a7b6205330e8d9d94402b4402a4cf89fffce6a9479e78 |
|
MD5 | e0e3809e2356aa39b32517a7baeb0b37 |
|
BLAKE2b-256 | fef71276cb0f8ac8e6bd064de9c6e71a04861ff68dfb8e61507211a9b371f6d9 |