feat: Introduce synchronous OpenFgaClient (#40)

openfga · Oct 27, 2023 · c92b436 · c92b436
2 parents 1c0d545 + 2f313f4
commit c92b436
Show file tree

Hide file tree

Showing 17 changed files with 7,851 additions and 4 deletions.
diff --git a/.github/workflows/semgrep.yaml b/.github/workflows/semgrep.yaml
@@ -11,7 +11,7 @@ jobs:
       image: returntocorp/semgrep
     if: (github.actor != 'dependabot[bot]' && github.actor != 'snyk-bot')
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.2
     - run: semgrep ci
       env:
         SEMGREP_APP_TOKEN: ${{ secrets.SEMGREP_APP_TOKEN }}
diff --git a/.openapi-generator-ignore b/.openapi-generator-ignore
@@ -4,6 +4,11 @@ test/*
 !test/test_open_fga_api.py
 !test/test_credentials.py
 !test/test_client.py
+!test/test_client_sync.py
+!test/test_open_fga_api_sync.py
+!test/test_validation.py
+!test/test_credentials_sync.py
+.github/workflows/python.yml
 .gitlab-ci.yml
 .travis.yml
 tox.ini
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -70,6 +70,7 @@ docs/WriteRequest.md
 openfga_sdk/__init__.py
 openfga_sdk/api/__init__.py
 openfga_sdk/api/open_fga_api.py
+openfga_sdk/api/open_fga_api_sync.py
 openfga_sdk/api_client.py
 openfga_sdk/client/__init__.py
 openfga_sdk/client/client.py
@@ -146,12 +147,22 @@ openfga_sdk/models/write_authorization_model_request.py
 openfga_sdk/models/write_authorization_model_response.py
 openfga_sdk/models/write_request.py
 openfga_sdk/rest.py
+openfga_sdk/sync/__init__.py
+openfga_sdk/sync/api_client.py
+openfga_sdk/sync/client/__init__.py
+openfga_sdk/sync/client/client.py
+openfga_sdk/sync/credentials.py
+openfga_sdk/sync/rest.py
 openfga_sdk/validation.py
 requirements.txt
 setup.cfg
 setup.py
 test-requirements.txt
 test/__init__.py
 test/test_client.py
+test/test_client_sync.py
 test/test_credentials.py
+test/test_credentials_sync.py
 test/test_open_fga_api.py
+test/test_open_fga_api_sync.py
+test/test_validation.py
diff --git a/docs/OpenFgaApi.md b/docs/OpenFgaApi.md
@@ -419,7 +419,7 @@ No authorization required
 
 List all objects of the given type that the user has a relation with
 
-The ListObjects API returns a list of all the objects of the given type that the user has a relation with. To achieve this, both the store tuples and the authorization model are used. An `authorization_model_id` may be specified in the body. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. The response will contain the related objects in an array in the \"objects\" field of the response and they will be strings in the object format `<type>:<id>` (e.g. \"document:roadmap\"). The number of objects in the response array will be limited by the execution timeout specified in the flag OPENFGA_LIST_OBJECTS_DEADLINE and by the upper bound specified in the flag OPENFGA_LIST_OBJECTS_MAX_RESULTS, whichever is hit first.
+The ListObjects API returns a list of all the objects of the given type that the user has a relation with. To achieve this, both the store tuples and the authorization model are used. An `authorization_model_id` may be specified in the body. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. The response will contain the related objects in an array in the \"objects\" field of the response and they will be strings in the object format `<type>:<id>` (e.g. \"document:roadmap\"). The number of objects in the response array will be limited by the execution timeout specified in the flag OPENFGA_LIST_OBJECTS_DEADLINE and by the upper bound specified in the flag OPENFGA_LIST_OBJECTS_MAX_RESULTS, whichever is hit first. The objects given will not be sorted, and therefore two identical calls can give a given different set of objects.
 
 ### Example
 

diff --git a/openfga_sdk/api/open_fga_api.py b/openfga_sdk/api/open_fga_api.py
@@ -745,7 +745,7 @@ async def get_store_with_http_info(self, **kwargs):  # noqa: E501
     async def list_objects(self, body, **kwargs):  # noqa: E501
         """List all objects of the given type that the user has a relation with  # noqa: E501
 
-        The ListObjects API returns a list of all the objects of the given type that the user has a relation with. To achieve this, both the store tuples and the authorization model are used. An `authorization_model_id` may be specified in the body. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. The response will contain the related objects in an array in the \"objects\" field of the response and they will be strings in the object format `<type>:<id>` (e.g. \"document:roadmap\"). The number of objects in the response array will be limited by the execution timeout specified in the flag OPENFGA_LIST_OBJECTS_DEADLINE and by the upper bound specified in the flag OPENFGA_LIST_OBJECTS_MAX_RESULTS, whichever is hit first.  # noqa: E501
+        The ListObjects API returns a list of all the objects of the given type that the user has a relation with. To achieve this, both the store tuples and the authorization model are used. An `authorization_model_id` may be specified in the body. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. The response will contain the related objects in an array in the \"objects\" field of the response and they will be strings in the object format `<type>:<id>` (e.g. \"document:roadmap\"). The number of objects in the response array will be limited by the execution timeout specified in the flag OPENFGA_LIST_OBJECTS_DEADLINE and by the upper bound specified in the flag OPENFGA_LIST_OBJECTS_MAX_RESULTS, whichever is hit first. The objects given will not be sorted, and therefore two identical calls can give a given different set of objects.  # noqa: E501
 
         >>> thread = await api.list_objects(body)
 
@@ -772,7 +772,7 @@ async def list_objects(self, body, **kwargs):  # noqa: E501
     async def list_objects_with_http_info(self, body, **kwargs):  # noqa: E501
         """List all objects of the given type that the user has a relation with  # noqa: E501
 
-        The ListObjects API returns a list of all the objects of the given type that the user has a relation with. To achieve this, both the store tuples and the authorization model are used. An `authorization_model_id` may be specified in the body. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. The response will contain the related objects in an array in the \"objects\" field of the response and they will be strings in the object format `<type>:<id>` (e.g. \"document:roadmap\"). The number of objects in the response array will be limited by the execution timeout specified in the flag OPENFGA_LIST_OBJECTS_DEADLINE and by the upper bound specified in the flag OPENFGA_LIST_OBJECTS_MAX_RESULTS, whichever is hit first.  # noqa: E501
+        The ListObjects API returns a list of all the objects of the given type that the user has a relation with. To achieve this, both the store tuples and the authorization model are used. An `authorization_model_id` may be specified in the body. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. The response will contain the related objects in an array in the \"objects\" field of the response and they will be strings in the object format `<type>:<id>` (e.g. \"document:roadmap\"). The number of objects in the response array will be limited by the execution timeout specified in the flag OPENFGA_LIST_OBJECTS_DEADLINE and by the upper bound specified in the flag OPENFGA_LIST_OBJECTS_MAX_RESULTS, whichever is hit first. The objects given will not be sorted, and therefore two identical calls can give a given different set of objects.  # noqa: E501
 
         >>> thread = api.list_objects_with_http_info(body)
 

diff --git a/openfga_sdk/api_client.py b/openfga_sdk/api_client.py
@@ -216,6 +216,7 @@ async def __call_api(
             except RateLimitExceededError as e:
                 if x < max_retry:
                     await asyncio.sleep(random_time(x, min_wait_in_ms))
+
                     continue
                 e.body = e.body.decode('utf-8') if six.PY3 else e.body
                 response_type = response_types_map.get(e.status, None)

diff --git a/openfga_sdk/sync/__init__.py b/openfga_sdk/sync/__init__.py
@@ -0,0 +1,18 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+   Python SDK for OpenFGA
+
+   API version: 0.1
+   Website: https://openfga.dev
+   Documentation: https://openfga.dev/docs
+   Support: https://discord.gg/8naAwJfWN6
+   License: [Apache-2.0](https://github.com/openfga/python-sdk/blob/main/LICENSE)
+
+   NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
+"""
+
+from openfga_sdk.sync.client.client import OpenFgaClient
+from openfga_sdk.sync.api_client import ApiClient
+from openfga_sdk.sync.credentials import Credentials