Merge branch '0.9' into fix-multiple-h1-issue

Author: st-jay

.circleci/config_continue.yml

@@ -17,6 +17,8 @@ jobs:
     resource_class: large
     steps:
       - checkout
+      - run: update-alternatives --install "/usr/bin/java" "java" "/usr/java/jdk-15.0.1/bin/java" 2
+      - run: update-alternatives --install "/usr/bin/javac" "javac" "/usr/java/jdk-15.0.1/bin/javac" 2
       - run: echo "127.0.0.1 localhost.org" >> /etc/hosts
       - run: make dev-install
       - run: (cd .circleci/ && ./doUnitTests.sh)
@@ -27,6 +29,8 @@ jobs:
     resource_class: large
     steps:
       - checkout
+      - run: update-alternatives --install "/usr/bin/java" "java" "/usr/java/jdk-15.0.1/bin/java" 2
+      - run: update-alternatives --install "/usr/bin/javac" "javac" "/usr/java/jdk-15.0.1/bin/javac" 2
       - run: echo "127.0.0.1 localhost.org" >> /etc/hosts
       - run: make with-fastapi
       - run: (cd .circleci/ && ./websiteFastApi.sh)
@@ -37,6 +41,8 @@ jobs:
     resource_class: large
     steps:
       - checkout
+      - run: update-alternatives --install "/usr/bin/java" "java" "/usr/java/jdk-15.0.1/bin/java" 2
+      - run: update-alternatives --install "/usr/bin/javac" "javac" "/usr/java/jdk-15.0.1/bin/javac" 2
       - run: echo "127.0.0.1 localhost.org" >> /etc/hosts
       - run: make with-flask
       - run: (cd .circleci/ && ./websiteFlask.sh)
@@ -47,6 +53,8 @@ jobs:
     resource_class: large
     steps:
       - checkout
+      - run: update-alternatives --install "/usr/bin/java" "java" "/usr/java/jdk-15.0.1/bin/java" 2
+      - run: update-alternatives --install "/usr/bin/javac" "javac" "/usr/java/jdk-15.0.1/bin/javac" 2
       - run: echo "127.0.0.1 localhost.org" >> /etc/hosts
       - run: make with-django
       - run: (cd .circleci/ && ./websiteDjango.sh)
@@ -64,6 +72,8 @@ jobs:
       - checkout
       - attach_workspace:
           at: /
+      - run: update-alternatives --install "/usr/bin/java" "java" "/usr/java/jdk-15.0.1/bin/java" 2
+      - run: update-alternatives --install "/usr/bin/javac" "javac" "/usr/java/jdk-15.0.1/bin/javac" 2
       - run: n 16
       - run: node --version
       - run: echo "127.0.0.1 localhost.org" >> /etc/hosts
@@ -92,6 +102,8 @@ jobs:
       - checkout
       - attach_workspace:
           at: /
+      - run: update-alternatives --install "/usr/bin/java" "java" "/usr/java/jdk-15.0.1/bin/java" 2
+      - run: update-alternatives --install "/usr/bin/javac" "javac" "/usr/java/jdk-15.0.1/bin/javac" 2
       - run: n 16
       - run: node --version
       - run: echo "127.0.0.1 localhost.org" >> /etc/hosts
@@ -120,6 +132,8 @@ jobs:
       - checkout
       - attach_workspace:
           at: /
+      - run: update-alternatives --install "/usr/bin/java" "java" "/usr/java/jdk-15.0.1/bin/java" 2
+      - run: update-alternatives --install "/usr/bin/javac" "javac" "/usr/java/jdk-15.0.1/bin/javac" 2
       - run: n 16
       - run: node --version
       - run: echo "127.0.0.1 localhost.org" >> /etc/hosts

CHANGELOG.md

@@ -6,8 +6,44 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
-## [0.9.0] - 2022-06-23
+### Documentation
+
+- Add more details in the `CONTRIBUTING.md` to make it beginner friendly.
+
 
+## [0.9.1] - 2022-06-27
+### Features:
+
+- Introduce `userroles` recipe.
+```python
+from supertokens_python import InputAppInfo, SupertokensConfig, init
+from supertokens_python.recipe import userroles
+from supertokens_python.recipe.userroles.asyncio import create_new_role_or_add_permissions, add_role_to_user
+
+init(
+    supertokens_config=SupertokensConfig('http://localhost:3567'),
+    app_info=InputAppInfo(
+        app_name='SuperTokens Demo',
+        api_domain='https://api.supertokens.io',
+        website_domain='supertokens.io'
+    ),
+    framework='flask',
+    recipe_list=[userroles.init()]
+)
+
+user_id = "userId"
+role = "role"
+permissions = ["perm1", "perm2"]
+
+# Functions to use inside your views:
+# Create a new role with a few permissions:
+result = await create_new_role_or_add_permissions(role, permissions)
+# Add role to the user:
+result = await add_role_to_user(user_id, role)
+# Check documentation for more examples..
+```
+
+## [0.9.0] - 2022-06-23
 ### Fixes
 - Fixes Cookie same_site config validation.
 - Remove `<Recipe>(Email|SMS)TemplateVars` in favour of `(Email|SMS)TemplateVars` for better DX.

CONTRIBUTING.md

@@ -14,19 +14,19 @@ We're so excited you're interested in helping with SuperTokens! We are happy to
 
 ## Development Setup
 
-You will need to setup the `supertokens-core` in order to run the `supertokens-python` tests, you can setup `supertokens-core` by following this [guide](https://github.com/supertokens/supertokens-core/blob/master/CONTRIBUTING.md#development-setup)  
+You will need to setup the [supertokens-core](https://github.com/supertokens/supertokens-core) in order to run the `supertokens-python` tests, you can setup `supertokens-core` by following this [guide](https://github.com/supertokens/supertokens-core/blob/master/CONTRIBUTING.md#development-setup)  
 **Note: If you are not contributing to the `supertokens-core` you can skip steps 1 & 4 under Project Setup of the `supertokens-core` contributing guide.**
 
 ### Prerequisites
 
 -   Python (version 3.7 or above)
--   IDE: [PyCharm](https://www.jetbrains.com/pycharm/download)(recommended) or equivalent IDE
+-   IDE: [PyCharm](https://www.jetbrains.com/pycharm/download)(recommended) OR [VS Code](https://code.visualstudio.com/) OR equivalent IDE
 
 ### Project Setup
 
-1. Fork the [supertokens-python](https://github.com/supertokens/supertokens-python) repository
+1. Fork the [supertokens-python](https://github.com/supertokens/supertokens-python) repository.
 2. Clone the forked repository in the parent directory of the previously setup `supertokens-root`.
-   `supertokens-python` and `supertokens-root` should exist side by side within the same parent directory
+   `supertokens-python` and `supertokens-root` should exist side by side within the same parent directory.
 3. Create a virtual environment for the `supertokens-python` project and activate it.
 4. Install the project dependencies
    `make dev-install`
@@ -35,23 +35,25 @@ You will need to setup the `supertokens-core` in order to run the `supertokens-p
 
 ## Modifying Code
 
-1. Open the `supertokens-python` project in your IDE and you can start modifying the code
+- Open the `supertokens-python` project in your IDE and you can start modifying the code.
+- Use `make check-lint` and `make format` to find lint/formatting errors before committing. (They will run anyways)
 
 ## Testing
 
-1. Navigate to the `supertokens-root` repository
+1. Navigate to the [supertokens-root](https://github.com/supertokens/supertokens-root) repository.
 2. Start the testing environment  
    `./startTestEnv --wait`   
-   and ensure the test environment is up and running
-3. Open a new terminal and navigate to the `supertokens-python` respositry   
-4. Run all tests, while ensuring the test environment is running on a different terminal   
-   `make test`
+   and ensure the test environment is up and running.
+3. Open a new terminal and navigate to the `supertokens-python` respositry.
+4. Use `export SUPERTOKENS_PATH=path/to/supertokens-root` (**MANDATORY**)
+4. To run all tests, while ensuring the test environment is running on a different terminal, use `make test`.
+5. To run individual tests, use `pytest ./tests/path/to/test/file.py  -k test_function_name` OR use your IDE's in-built UI for running python tests. You may read [VSCode Python Testing](https://code.visualstudio.com/docs/python/testing) and [PyCharm Testing](https://www.jetbrains.com/help/pycharm/testing-your-first-python-application.html#debug-test) for more info.
 
 ## Pull Request
 
-1. Before submitting a pull request make sure all tests have passed
-2. Reference the relevant issue or pull request and give a clear description of changes/features added when submitting a pull request
-3. Make sure the PR title follows [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) specification
+1. Before submitting a pull request make sure all tests have passed.
+2. Reference the relevant issue or pull request and give a clear description of changes/features added when submitting a pull request.
+3. Make sure the PR title follows [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
 
 ## SuperTokens Community
 
@@ -65,4 +67,18 @@ SuperTokens is made possible by a passionate team and a strong community of deve
 Additional resources you might find useful:
 
 -   [SuperTokens Docs](https://supertokens.io/docs/community/getting-started/installation)
--   [Blog Posts](https://supertokens.io/blog/)
+-   [Blog Posts](https://supertokens.io/blog/)
+
+## Implementing RecipeInterfaces
+
+- Make sure all CRUD operations are available via the `(a)?syncio` modules of that recipe.
+- Make sure the corresponding `RecipeImplementation` takes type imports from the `interfaces.py` file of that recipe. This is so that if a user wants to copy / paste that code into their project, they can do so via the normal import statement.
+
+## Implementing APIInterfaces
+- Make sure the corresonding `APIImplementation` takes type imports from the `interfaces.py` file of that recipe. This is so that if a user wants to copy / paste that code into their project, they can do so via the normal import statement.
+
+## Generating docs
+This will generate the API docs in a folder called docs
+```
+make build-docs
+```

coreDriverInterfaceSupported.json

@@ -5,6 +5,7 @@
         "2.10",
         "2.11",
         "2.12",
-        "2.13"
+        "2.13",
+        "2.14"
     ]
 }

html/supertokens_python/constants.html

@@ -39,8 +39,8 @@ <h1 class="title">Module <code>supertokens_python.constants</code></h1>
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations
 # under the License.
-SUPPORTED_CDI_VERSIONS = [&#39;2.9&#39;, &#39;2.10&#39;, &#39;2.11&#39;, &#39;2.12&#39;, &#39;2.13&#39;]
-VERSION = &#39;0.9.0&#39;
+SUPPORTED_CDI_VERSIONS = [&#39;2.9&#39;, &#39;2.10&#39;, &#39;2.11&#39;, &#39;2.12&#39;, &#39;2.13&#39;, &#39;2.14&#39;]
+VERSION = &#39;0.9.1&#39;
 TELEMETRY = &#39;/telemetry&#39;
 USER_COUNT = &#39;/users/count&#39;
 USER_DELETE = &#39;/user/remove&#39;

html/supertokens_python/exceptions.html

@@ -184,6 +184,7 @@ <h3>Subclasses</h3>
 <li><a title="supertokens_python.recipe.thirdpartyemailpassword.exceptions.SupertokensThirdPartyEmailPasswordError" href="recipe/thirdpartyemailpassword/exceptions.html#supertokens_python.recipe.thirdpartyemailpassword.exceptions.SupertokensThirdPartyEmailPasswordError">SupertokensThirdPartyEmailPasswordError</a></li>
 <li><a title="supertokens_python.recipe.thirdpartypasswordless.exceptions.SupertokensThirdPartyPasswordlessError" href="recipe/thirdpartypasswordless/exceptions.html#supertokens_python.recipe.thirdpartypasswordless.exceptions.SupertokensThirdPartyPasswordlessError">SupertokensThirdPartyPasswordlessError</a></li>
 <li><a title="supertokens_python.recipe.usermetadata.exceptions.SuperTokensUserMetadataError" href="recipe/usermetadata/exceptions.html#supertokens_python.recipe.usermetadata.exceptions.SuperTokensUserMetadataError">SuperTokensUserMetadataError</a></li>
+<li><a title="supertokens_python.recipe.userroles.exceptions.SuperTokensUserRolesError" href="recipe/userroles/exceptions.html#supertokens_python.recipe.userroles.exceptions.SuperTokensUserRolesError">SuperTokensUserRolesError</a></li>
 </ul>
 </dd>
 </dl>

html/supertokens_python/recipe/index.html

@@ -66,6 +66,10 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
 <dd>
 <div class="desc"></div>
 </dd>
+<dt><code class="name"><a title="supertokens_python.recipe.userroles" href="userroles/index.html">supertokens_python.recipe.userroles</a></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
 </dl>
 </section>
 <section>
@@ -98,6 +102,7 @@ <h1>Index</h1>
 <li><code><a title="supertokens_python.recipe.thirdpartyemailpassword" href="thirdpartyemailpassword/index.html">supertokens_python.recipe.thirdpartyemailpassword</a></code></li>
 <li><code><a title="supertokens_python.recipe.thirdpartypasswordless" href="thirdpartypasswordless/index.html">supertokens_python.recipe.thirdpartypasswordless</a></code></li>
 <li><code><a title="supertokens_python.recipe.usermetadata" href="usermetadata/index.html">supertokens_python.recipe.usermetadata</a></code></li>
+<li><code><a title="supertokens_python.recipe.userroles" href="userroles/index.html">supertokens_python.recipe.userroles</a></code></li>
 </ul>
 </li>
 </ul>