sanic-security 1.16.8__tar.gz → 1.16.10__tar.gz

{sanic_security-1.16.8/sanic_security.egg-info → sanic_security-1.16.10}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: sanic-security
-Version: 1.16.8
+Version: 1.16.10
 Summary: An async security library for the Sanic framework.
 Author-email: Aidan Stewart <me@na-stewart.com>
 Project-URL: Documentation, https://security.na-stewart.com/
@@ -29,6 +29,7 @@ Requires-Dist: pdoc3; extra == "dev"
 Requires-Dist: cryptography; extra == "dev"
 Provides-Extra: crypto
 Requires-Dist: cryptography>=3.3.1; extra == "crypto"
+Dynamic: license-file
 
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Downloads](https://static.pepy.tech/badge/sanic-security)](https://pepy.tech/project/sanic-security)
@@ -121,19 +122,16 @@ pip3 install sanic-security --upgrade
 
 ### Configuration
 
-Sanic Security configuration is merely an object that can be modified either using dot-notation or like a dictionary.
-
+Sanic Security configuration is merely a `SimpleNamespace` that can be modified using dot-notation.
 For example: 
 
 ```python
 from sanic_security.configuration import config as security_config
 
 security_config.SECRET = "This is a big secret. Shhhhh"
-security_config["CAPTCHA_FONT"] = "resources/captcha-font.ttf"
+security_config.CAPTCHA_FONT = "resources/captcha-font.ttf"
 ```
 
-You can also use the update() method like on regular dictionaries.
-
 Any environment variables defined with the SANIC_SECURITY_ prefix will be applied to the config. For example, setting 
 SANIC_SECURITY_SECRET will be loaded by the application automatically and fed into the SECRET config variable.
 
@@ -294,9 +292,7 @@ Verifies the client's account via two-step session code.
 @app.put("api/security/verify")
 async def on_verify(request):
     two_step_session = await verify_account(request)
-    return json(
-        "You have verified your account and may login!", two_step_session.bearer.json
-    )
+    return json("You have verified your account and may login!", two_step_session.json)
 ```
 
 * Login (with two-factor authentication)
@@ -318,7 +314,7 @@ async def on_login(request):
     )  # Custom method for emailing verification code.
     response = json(
         "Login successful! Two-factor authentication required.",
-        authentication_session.bearer.json,
+        authentication_session.json,
     )
     authentication_session.encode(response)
     two_step_session.encode(response)
@@ -341,7 +337,7 @@ async def on_two_factor_authentication(request):
     authentication_session = await fulfill_second_factor(request)
     response = json(
         "Authentication session second-factor fulfilled! You are now authenticated.",
-        authentication_session.bearer.json,
+        authentication_session.json,
     )
     return response
 ```
@@ -367,7 +363,9 @@ async def on_anonymous_login(request):
 @app.post("api/security/logout")
 async def on_logout(request):
     authentication_session = await logout(request)
-    token_info = await oauth_revoke(request, google_oauth)  # Remove if not utilizing OAuth
+    token_info = await oauth_revoke(
+        request, google_oauth
+    )  # Remove if not utilizing OAuth
     response = json(
         "Logout successful!",
         {"token_info": token_info, "auth_session": authentication_session.json},

{sanic_security-1.16.8 → sanic_security-1.16.10}/README.md

@@ -89,19 +89,16 @@ pip3 install sanic-security --upgrade
 
 ### Configuration
 
-Sanic Security configuration is merely an object that can be modified either using dot-notation or like a dictionary.
-
+Sanic Security configuration is merely a `SimpleNamespace` that can be modified using dot-notation.
 For example: 
 
 ```python
 from sanic_security.configuration import config as security_config
 
 security_config.SECRET = "This is a big secret. Shhhhh"
-security_config["CAPTCHA_FONT"] = "resources/captcha-font.ttf"
+security_config.CAPTCHA_FONT = "resources/captcha-font.ttf"
 ```
 
-You can also use the update() method like on regular dictionaries.
-
 Any environment variables defined with the SANIC_SECURITY_ prefix will be applied to the config. For example, setting 
 SANIC_SECURITY_SECRET will be loaded by the application automatically and fed into the SECRET config variable.
 
@@ -262,9 +259,7 @@ Verifies the client's account via two-step session code.
 @app.put("api/security/verify")
 async def on_verify(request):
     two_step_session = await verify_account(request)
-    return json(
-        "You have verified your account and may login!", two_step_session.bearer.json
-    )
+    return json("You have verified your account and may login!", two_step_session.json)
 ```
 
 * Login (with two-factor authentication)
@@ -286,7 +281,7 @@ async def on_login(request):
     )  # Custom method for emailing verification code.
     response = json(
         "Login successful! Two-factor authentication required.",
-        authentication_session.bearer.json,
+        authentication_session.json,
     )
     authentication_session.encode(response)
     two_step_session.encode(response)
@@ -309,7 +304,7 @@ async def on_two_factor_authentication(request):
     authentication_session = await fulfill_second_factor(request)
     response = json(
         "Authentication session second-factor fulfilled! You are now authenticated.",
-        authentication_session.bearer.json,
+        authentication_session.json,
     )
     return response
 ```
@@ -335,7 +330,9 @@ async def on_anonymous_login(request):
 @app.post("api/security/logout")
 async def on_logout(request):
     authentication_session = await logout(request)
-    token_info = await oauth_revoke(request, google_oauth)  # Remove if not utilizing OAuth
+    token_info = await oauth_revoke(
+        request, google_oauth
+    )  # Remove if not utilizing OAuth
     response = json(
         "Logout successful!",
         {"token_info": token_info, "auth_session": authentication_session.json},

{sanic_security-1.16.8 → sanic_security-1.16.10}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "sanic-security"
-version = "1.16.8"
+version = "1.16.10"
 requires-python = ">=3.8"
 dependencies = [
     "tortoise-orm>=0.17.0",

{sanic_security-1.16.8 → sanic_security-1.16.10}/sanic_security/configuration.py

@@ -1,4 +1,5 @@
 from os import environ
+from types import SimpleNamespace
 
 from sanic.utils import str_to_bool
 
@@ -50,7 +51,7 @@ DEFAULT_CONFIG = {
 }
 
 
-class Config(dict):
+class Config(SimpleNamespace):
     """
     Sanic Security configuration.
 
@@ -102,30 +103,23 @@ class Config(dict):
     INITIAL_ADMIN_PASSWORD: str
     TEST_DATABASE_URL: str
 
-    def load_environment_variables(self, load_env="SANIC_SECURITY_") -> None:
-        """
-        Any environment variables defined with the prefix argument will be applied to the config.
+    def __init__(self, default_config: dict = None):
+        super().__init__(**(default_config or DEFAULT_CONFIG))
+        self.load_environment_variables()
 
-        Args:
-            load_env (str): Prefix being used to apply environment variables into the config.
-        """
+    def load_environment_variables(self, env_prefix: str = "SANIC_SECURITY_"):
         for key, value in environ.items():
-            if not key.startswith(load_env):
+            if not key.startswith(env_prefix):
                 continue
 
-            _, config_key = key.split(load_env, 1)
+            _, config_key = key.split(env_prefix, 1)
 
             for converter in (int, float, str_to_bool, str):
                 try:
-                    self[config_key] = converter(value)
+                    setattr(self, config_key, converter(value))
                     break
                 except ValueError:
                     pass
 
-    def __init__(self):
-        super().__init__(DEFAULT_CONFIG)
-        self.__dict__ = self
-        self.load_environment_variables()
-
 
-config = Config()
+config = Config(DEFAULT_CONFIG)

{sanic_security-1.16.8 → sanic_security-1.16.10}/sanic_security/models.py

@@ -369,8 +369,7 @@ class Session(BaseModel):
             samesite=config.SESSION_SAMESITE,
             secure=config.SESSION_SECURE,
             domain=config.SESSION_DOMAIN,
-            expires=getattr(self, "refresh_expiration_date", None)
-            or self.expiration_date,
+            expires=getattr(self, "refresh_expiration_date", self.expiration_date),
         )
 
     @property

{sanic_security-1.16.8 → sanic_security-1.16.10/sanic_security.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: sanic-security
-Version: 1.16.8
+Version: 1.16.10
 Summary: An async security library for the Sanic framework.
 Author-email: Aidan Stewart <me@na-stewart.com>
 Project-URL: Documentation, https://security.na-stewart.com/
@@ -29,6 +29,7 @@ Requires-Dist: pdoc3; extra == "dev"
 Requires-Dist: cryptography; extra == "dev"
 Provides-Extra: crypto
 Requires-Dist: cryptography>=3.3.1; extra == "crypto"
+Dynamic: license-file
 
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Downloads](https://static.pepy.tech/badge/sanic-security)](https://pepy.tech/project/sanic-security)
@@ -121,19 +122,16 @@ pip3 install sanic-security --upgrade
 
 ### Configuration
 
-Sanic Security configuration is merely an object that can be modified either using dot-notation or like a dictionary.
-
+Sanic Security configuration is merely a `SimpleNamespace` that can be modified using dot-notation.
 For example: 
 
 ```python
 from sanic_security.configuration import config as security_config
 
 security_config.SECRET = "This is a big secret. Shhhhh"
-security_config["CAPTCHA_FONT"] = "resources/captcha-font.ttf"
+security_config.CAPTCHA_FONT = "resources/captcha-font.ttf"
 ```
 
-You can also use the update() method like on regular dictionaries.
-
 Any environment variables defined with the SANIC_SECURITY_ prefix will be applied to the config. For example, setting 
 SANIC_SECURITY_SECRET will be loaded by the application automatically and fed into the SECRET config variable.
 
@@ -294,9 +292,7 @@ Verifies the client's account via two-step session code.
 @app.put("api/security/verify")
 async def on_verify(request):
     two_step_session = await verify_account(request)
-    return json(
-        "You have verified your account and may login!", two_step_session.bearer.json
-    )
+    return json("You have verified your account and may login!", two_step_session.json)
 ```
 
 * Login (with two-factor authentication)
@@ -318,7 +314,7 @@ async def on_login(request):
     )  # Custom method for emailing verification code.
     response = json(
         "Login successful! Two-factor authentication required.",
-        authentication_session.bearer.json,
+        authentication_session.json,
     )
     authentication_session.encode(response)
     two_step_session.encode(response)
@@ -341,7 +337,7 @@ async def on_two_factor_authentication(request):
     authentication_session = await fulfill_second_factor(request)
     response = json(
         "Authentication session second-factor fulfilled! You are now authenticated.",
-        authentication_session.bearer.json,
+        authentication_session.json,
     )
     return response
 ```
@@ -367,7 +363,9 @@ async def on_anonymous_login(request):
 @app.post("api/security/logout")
 async def on_logout(request):
     authentication_session = await logout(request)
-    token_info = await oauth_revoke(request, google_oauth)  # Remove if not utilizing OAuth
+    token_info = await oauth_revoke(
+        request, google_oauth
+    )  # Remove if not utilizing OAuth
     response = json(
         "Logout successful!",
         {"token_info": token_info, "auth_session": authentication_session.json},