Add AuthBase class (#179)

Author: tebeka

descope/_auth_base.py

@@ -0,0 +1,9 @@
+# This is not part of the public API but a code helper
+from descope.auth import Auth
+
+
+class AuthBase:
+    """Base class for classes having auth"""
+
+    def __init__(self, auth: Auth):
+        self._auth = auth

descope/authmethod/enchantedlink.py

@@ -2,6 +2,7 @@
 
 import requests
 
+from descope._auth_base import AuthBase
 from descope.auth import Auth
 from descope.common import (
     REFRESH_SESSION_COOKIE_NAME,
@@ -13,12 +14,7 @@
 from descope.exceptions import ERROR_TYPE_INVALID_ARGUMENT, AuthException
 
 
-class EnchantedLink:
-    _auth: Auth
-
-    def __init__(self, auth: Auth):
-        self._auth = auth
-
+class EnchantedLink(AuthBase):
     def sign_in(
         self,
         login_id: str,

descope/authmethod/magiclink.py

@@ -1,5 +1,6 @@
 import string
 
+from descope._auth_base import AuthBase
 from descope.auth import Auth
 from descope.common import (
     REFRESH_SESSION_COOKIE_NAME,
@@ -11,12 +12,7 @@
 from descope.exceptions import ERROR_TYPE_INVALID_ARGUMENT, AuthException
 
 
-class MagicLink:
-    _auth: Auth
-
-    def __init__(self, auth: Auth):
-        self._auth = auth
-
+class MagicLink(AuthBase):
     def sign_in(
         self,
         method: DeliveryMethod,

descope/authmethod/oauth.py

@@ -1,14 +1,9 @@
-from descope.auth import Auth
+from descope._auth_base import AuthBase
 from descope.common import EndpointsV1, LoginOptions, validate_refresh_token_provided
 from descope.exceptions import ERROR_TYPE_INVALID_ARGUMENT, AuthException
 
 
-class OAuth:
-    _auth: Auth
-
-    def __init__(self, auth: Auth):
-        self._auth = auth
-
+class OAuth(AuthBase):
     def start(
         self,
         provider: str,

descope/authmethod/otp.py

@@ -1,3 +1,4 @@
+from descope._auth_base import AuthBase
 from descope.auth import Auth
 from descope.common import (
     REFRESH_SESSION_COOKIE_NAME,
@@ -9,12 +10,7 @@
 from descope.exceptions import ERROR_TYPE_INVALID_ARGUMENT, AuthException
 
 
-class OTP:
-    _auth: Auth
-
-    def __init__(self, auth: Auth):
-        self._auth = auth
-
+class OTP(AuthBase):
     def sign_in(
         self,
         method: DeliveryMethod,

descope/authmethod/password.py

@@ -1,14 +1,9 @@
-from descope.auth import Auth
+from descope._auth_base import AuthBase
 from descope.common import REFRESH_SESSION_COOKIE_NAME, EndpointsV1
 from descope.exceptions import ERROR_TYPE_INVALID_ARGUMENT, AuthException
 
 
-class Password:
-    _auth: Auth
-
-    def __init__(self, auth):
-        self._auth = auth
-
+class Password(AuthBase):
     def sign_up(self, login_id: str, password: str, user: dict = None) -> dict:
         """
         Sign up (create) a new user using a login ID and password.

descope/authmethod/saml.py

@@ -1,14 +1,9 @@
-from descope.auth import Auth
+from descope._auth_base import AuthBase
 from descope.common import EndpointsV1, LoginOptions, validate_refresh_token_provided
 from descope.exceptions import ERROR_TYPE_INVALID_ARGUMENT, AuthException
 
 
-class SAML:
-    _auth: Auth
-
-    def __init__(self, auth: Auth):
-        self._auth = auth
-
+class SAML(AuthBase):
     def start(
         self,
         tenant: str,

descope/authmethod/totp.py

@@ -1,4 +1,4 @@
-from descope.auth import Auth
+from descope._auth_base import AuthBase
 from descope.common import (
     REFRESH_SESSION_COOKIE_NAME,
     EndpointsV1,
@@ -8,20 +8,15 @@
 from descope.exceptions import ERROR_TYPE_INVALID_ARGUMENT, AuthException
 
 
-class TOTP:
-    _auth: Auth
-
-    def __init__(self, auth):
-        self._auth = auth
-
+class TOTP(AuthBase):
     def sign_up(self, login_id: str, user: dict = None) -> dict:
         """
         Sign up (create) a new user using their email or phone number.
             (optional) Include additional user metadata that you wish to save.
 
         Args:
         login_id (str): The login ID of the user being validated
-        user (dict) optional: Preserve additional user metadata in the form of
+        user (dict) optional: Preserve additional user metadata in the form of,
              {"name": "Desmond Copeland", "phone": "2125551212", "email": "[email protected]"}
 
         Return value (dict):

descope/authmethod/webauthn.py

@@ -1,4 +1,4 @@
-from descope.auth import Auth
+from descope._auth_base import AuthBase
 from descope.common import (
     REFRESH_SESSION_COOKIE_NAME,
     EndpointsV1,
@@ -8,12 +8,7 @@
 from descope.exceptions import ERROR_TYPE_INVALID_ARGUMENT, AuthException
 
 
-class WebAuthn:
-    _auth: Auth
-
-    def __init__(self, auth):
-        self._auth = auth
-
+class WebAuthn(AuthBase):
     def sign_up_start(self, login_id: str, origin: str, user: dict = None) -> dict:
         """
         Docs

descope/management/access_key.py

@@ -1,19 +1,14 @@
 from typing import List
 
-from descope.auth import Auth
+from descope._auth_base import AuthBase
 from descope.management.common import (
     AssociatedTenant,
     MgmtV1,
     associated_tenants_to_dict,
 )
 
 
-class AccessKey:
-    _auth: Auth
-
-    def __init__(self, auth: Auth):
-        self._auth = auth
-
+class AccessKey(AuthBase):
     def create(
         self,
         name: str,