11 adapt to reference implementation (#12)

* Add FAPI URL and BAPI URL to config.

* Adapt issuer validation

* Rename short-term session to session-token

* Bump release version to 2.0.0

* Rename get_and_validate_short_session_value to validate_token

* Change validate_token error handling, add new exception type for session service

* Adapt existing token validation tests to new error handling

* Add new tests to session service for issuer validation and false private key

* Add new test for issuer validation in session service

* Update README.md

* Remove session_token_cookie_name

* Reorder required fields for configuration

* Improved exception handling, renamed error codes

* Change CORBADO_FRONTEND_API  from variable to secret

* reduce public fields of session service

* update session token validation example

* adjust workflow to use var instead of secret

* return to public fields to make pydantic happy

* Enable CI/CD on changes on merge request

* Increase maximum line length on linting

* Run CI/CD on Github Issue naming pattern

* satisfy mypy

* update generated client and openapi specs

* enforce no trailing slashes in config urls

* remove last_session_token_validation_result from session_service.py

* satisfy flake8

* remove all usages of _set_validation_error

* adjust test_set_cname_expect_issuer_changed to new url validation expectations

* satisfy mypy

* remove unnecessary file

---------

Co-authored-by: Lukas Kratzel <lukas.kratzel2004@gmail.com>

Author: alexbalakirev

.github/workflows/python-package.yml

@@ -4,12 +4,12 @@ name: Python package
 
 on:
   push:
-    branches: [ "main","feature/**","development"]
+    branches: [ "main","feature/**","development", "[0-9]+-*"]
     tags:
       - v[0-9]+.[0-9]+.[0-9]+*
   pull_request:
     branches: [ "main","development"]
-    types: [opened, reopened]
+    types: [opened, reopened, edited]
 
 jobs:
   test-and-lint:
@@ -48,9 +48,11 @@ jobs:
       run: |
         tox run
       env:
-        CORBADO_BACKEND_API: ${{ vars.CORBADO_BACKEND_API }}
-        CORBADO_API_SECRET: ${{ secrets.CORBADO_API_SECRET }}
         CORBADO_PROJECT_ID: ${{ secrets.CORBADO_PROJECT_ID }}
+        CORBADO_API_SECRET: ${{ secrets.CORBADO_API_SECRET }}
+        CORBADO_FRONTEND_API: ${{ vars.CORBADO_FRONTEND_API }}
+        CORBADO_BACKEND_API: ${{ vars.CORBADO_BACKEND_API }}
+
 
 
   build:

README.md

@@ -57,19 +57,23 @@ user_service: UserService = sdk.users
 
 ### Error handling
 
-The Corbado Python SDK raises exceptions for all errors except those that occur in the session service during token validation (See example below on how to catch those errors). The following exceptions are thrown:
+The Corbado Python SDK raises exceptions for all errors. The following exceptions are thrown:
 
 - `ValidationError` for failed validations (client side)
 - `ServerException` for server errors (server side)
+- `TokenValidationException` for errors in session service (client side)
 - `StandardException` for everything else (client side)
 
-'SessionService' returns 'SessionValidationResult' as result of token validation. You can check whether any errors occurred and handle them if needed:
+`SessionService` returns a `UserEntity` as a result of token validation. If the token is invalid for any reason,
+a `TokenValidationException` is thrown. It provides detailed information on the error.
+If no error, is thrown, the `session_token` is valid and you can use the `UserEntity` object.
 
 ```Python
-result: SessionValidationResult = self.session_service.get_and_validate_short_session_value(short_session=token)
-            if result.error is not None:
-                print(result.error)
-                raise result.error
+try:
+  user: UserEntity = sdk.sessions.validate_token(session_token)
+except TokenValidationException:
+  # handle error..
+  pass
 ```
 
 If the Backend API returns a HTTP status code other than 200, the Corbado Python SDK throws a `ServerException`. The `ServerException`class provides convenient methods to access all important data:

VERSION

@@ -1 +1 @@
-1.1.3
+2.0.0