feat(async): Add asyncio and FastAPI support (#19)

* chore(test): Code cleaning.

* chore(client): Refactor using httpx client.

* feat(client): Add asyncio client support

* feat(framework): Add FastAPI framework support

* chore(test): Fixing tox configs

* feat(fastapi): Add error handlers for iam init

* fix(setup): Remove FastAPI version

* chore(docs): Cleaning docs

* chore(changelog): Update changelog.

* Bump version: 1.0.0 → 1.1.0

Author: NurFaizin

CHANGELOG.rst

@@ -2,6 +2,12 @@
 Changelog
 =========
 
+1.1.0 (2022-03-28)
+------------------
+
+* Add asyncio client support.
+* Add FastAPI frameworks support.
+
 1.0.0 (2021-11-25)
 ------------------
 

docs/asyncio.rst

@@ -0,0 +1,35 @@
+=======
+Asyncio
+=======
+
+iam-python-sdk support concurrency with asyncio client.
+All default client functions have asyncio coroutine versions.
+You can use async and await on the async functions.
+
+Here is sample of how you can use the iam-python-sdk asyncio client:
+
+.. code-block:: python
+
+    import asyncio
+
+    from iam_python_sdk import Config, NewAsyncClient
+    from iam_python_sdk.errors import ClientTokenGrantError
+
+    config = Config(
+        BaseURL="<Base IAM URL>",  # e.g.: https://demo.accelbyte.io/iam
+        ClientID="<Client ID>",
+        ClientSecret="<Client Secret>",
+    )
+    client = NewAsyncClient(config)
+
+    async def grant_token():
+        try:
+            await client.ClientTokenGrant()
+            # Client token grant success
+        except ClientTokenGrantError as e:
+            # Cant get access token from IAM
+            pass
+
+    loop = asyncio.get_event_loop()
+    coro = asyncio.ensure_future(main(), loop=loop)
+    loop.run_until_complete(coro)

docs/frameworks.rst

@@ -119,3 +119,98 @@ You can also set the default CORS headers for all endpoints with Flask applicati
 
 .. note::
     These default configs will be overridden by the decorator *cors_options* for specific endpoints.
+
+
+FastAPI
+=======
+
+Usage
+-----
+
+To use iam-python-sdk on FastAPI frameworks, you have to init the iam-python-sdk when FastAPI app started:
+
+.. code-block:: python
+
+    from fastapi import FastAPI
+    from iam_python_sdk.fastapi import IAM, Settings
+
+    app = FastAPI()
+
+    @app.on_event("startup")
+    async def startup_event():
+        config = Settings(
+            iam_base_url="<Base IAM URL>",
+            iam_client_id="<Client ID>",
+            iam_client_secret="<Client Secret>",
+        )
+        app.state.iam = IAM(app, config)
+
+Then you can protect your endpoint with *permission_required* dependency from unauthorized access:
+
+.. code-block:: python
+
+    from iam-python-sdk.fastapi import permission_required
+
+    @app.get('/protected', dependencies=[
+        Depends(
+            permission_required(
+                {"resource": "ADMIN:NAMESPACE:{namespace}:CLIENT", "action": 2},
+                {"{namespace}": "sdktest"},
+                csrf_protect=True
+            )
+        )
+    ])
+    def get_protected_endpoint():
+        return 'You have authorized access!'
+
+By default, *permission_required* dependency will check the access token on the Authorization header with Bearer type.
+You can customize these default configurations according to your service/apps needs:
+
+.. code-block:: python
+
+    settings.iam_base_url = ""
+    settings.iam_client_id = ""
+    settings.iam_client_secret = ""
+    settings.iam_token_locations = ["headers", "cookies"]
+    settings.iam_token_header_name = "Authorization"
+    settings.iam_token_header_type = "Bearer"
+    settings.iam_token_cookie_name = "access_token"
+    settings.iam_token_cookie_path = "/"
+    settings.iam_csrf_protection = True
+    settings.iam_strict_referer = True
+
+.. note::
+    This module has been tested with FastAPI default uvicorn server for development.
+    For production use, this module has been tested with *Gunicorn*.
+    You can use Gunicorn with ``uvicorn.workers.UvicornWorker`` class worker.
+    
+    For more information about FastAPI deployment, please read more information `here <https://fastapi.tiangolo.com/deployment/server-workers/>`_
+
+CORS Middleware
+---------------
+
+This module support CORS middleware to set CORS header response. You can set the CORS headers with these settings.
+
+.. code-block:: python
+
+    settings.iam_cors_enable = False
+    settings.iam_cors_origin = "*"
+    settings.iam_cors_headers = "*"
+    settings.iam_cors_methods = "*"
+    settings.iam_cors_credentials = True
+
+The sample response of this endpoint would be like:
+
+.. code-block:: console
+
+    HTTP/1.1 200 OK
+    Date: Fri, 12 Nov 2021 01:15:39 GMT
+    Server: Nginx
+    Access-Control-Allow-Origin: *
+    Access-Control-Allow-Methods: GET, POST, OPTIONS
+    Access-Control-Allow-Headers: Device-Id, Device-Os, Device-Type
+    Access-Control-Allow-Credentials: true
+    .......
+
+.. note::
+    You can read more about CORS specification `here <https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS>`_

docs/iam_python_sdk.rst

@@ -4,6 +4,14 @@ iam\_python\_sdk package
 Submodules
 ----------
 
+iam\_python\_sdk\.async\_client module
+--------------------------------------
+
+.. automodule:: iam_python_sdk.async_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 iam\_python\_sdk\.bloom module
 ------------------------------
 
@@ -52,6 +60,14 @@ iam\_python\_sdk\.errors module
     :undoc-members:
     :show-inheritance:
 
+iam\_python\_sdk\.fastapi module
+--------------------------------
+
+.. automodule:: iam_python_sdk.fastapi
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 iam\_python\_sdk\.flask module
 ------------------------------
 

docs/index.rst

@@ -6,6 +6,7 @@
 
    installation
    usage
+   asyncio
    frameworks
    modules
    contributing

docs/installation.rst

@@ -42,6 +42,14 @@ To install iam-python-sdk with *Flask* frameworks support, run this command in y
 
 This will install flask frameworks with the latest stable version.
 
+To install iam-python-sdk with *FastAPI* frameworks support, run this command in your terminal:
+
+.. code-block:: console
+
+    $ pip install 'iam-python-sdk[fastapi]'
+
+This will install fastapi frameworks with the latest stable version.
+
 
 From sources
 ------------

iam_python_sdk/__init__.py

@@ -13,12 +13,14 @@
 # limitations under the License.
 
 from iam_python_sdk.client import NewDefaultClient
+from iam_python_sdk.async_client import NewAsyncClient
 from iam_python_sdk.config import Config
 
 __author__ = """Analytics AccelByte"""
 __email__ = 'justice-analytics-team@accelbyte.net'
-__version__ = '1.0.0'
+__version__ = '1.1.0'
 __all__ = [
     'NewDefaultClient',
+    'NewAsyncClient',
     'Config'
 ]