invenio-banners 3.0.1__tar.gz → 3.0.2__tar.gz

{invenio-banners-3.0.1 → invenio-banners-3.0.2}/CHANGES.rst

@@ -7,6 +7,10 @@
 Changes
 =======
 
+Version 3.0.2 (released 2024-07-17)
+
+- errors: implement REST validation error for banner loader
+
 Version 3.0.1 (released 2024-02-21)
 
 - Moved admin menu item for banners to site administration category

{invenio-banners-3.0.1 → invenio-banners-3.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: invenio-banners
-Version: 3.0.1
+Version: 3.0.2
 Summary: Invenio-Banners is a module used to create and show banners with useful messages to users.
 Home-page: https://github.com/inveniosoftware/invenio-banners
 Author: CERN
@@ -45,6 +45,10 @@ Description: ..
         Changes
         =======
         
+        Version 3.0.2 (released 2024-07-17)
+        
+        - errors: implement REST validation error for banner loader
+        
         Version 3.0.1 (released 2024-02-21)
         
         - Moved admin menu item for banners to site administration category

{invenio-banners-3.0.1 → invenio-banners-3.0.2}/invenio_banners/__init__.py

@@ -9,6 +9,6 @@
 
 from .ext import InvenioBanners
 
-__version__ = "3.0.1"
+__version__ = "3.0.2"
 
 __all__ = ("__version__", "InvenioBanners")

{invenio-banners-3.0.1 → invenio-banners-3.0.2}/invenio_banners/administration/banners.py

@@ -117,6 +117,7 @@ class BannerEditView(AdminResourceEditView):
                 {"title_l10n": "Warning", "id": "warning"},
                 {"title_l10n": "Other", "id": "other"},
             ],
+            "placeholder": "Select a category",
         },
         "active": {
             "order": 6,
@@ -200,7 +201,7 @@ class BannerCreateView(AdminResourceCreateView):
                 {"title_l10n": "Warning", "id": "warning"},
                 {"title_l10n": "Other", "id": "other"},
             ],
-            "placeholder": "Info",
+            "placeholder": "Select a category",
         },
         "active": {
             "order": 6,

invenio-banners-3.0.2/invenio_banners/resources/errors.py

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2023 CERN.
+#
+# Invenio-Banners is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Errors."""
+
+from flask_resources import HTTPJSONException, create_error_handler
+
+from ..services.errors import BannerNotExistsError
+import marshmallow as ma
+from flask_resources import HTTPJSONException, create_error_handler
+from invenio_records_resources.errors import validation_error_to_list_errors
+
+
+class HTTPJSONValidationException(HTTPJSONException):
+    """HTTP exception serializing to JSON and reflecting Marshmallow errors."""
+
+    description = "A validation error occurred."
+
+    def __init__(self, exception):
+        """Constructor."""
+        super().__init__(code=400, errors=validation_error_to_list_errors(exception))
+
+
+class ErrorHandlersMixin():
+    """Mixin to define error handlers."""
+
+    error_handlers = {
+        BannerNotExistsError: create_error_handler(
+            lambda e: HTTPJSONException(
+                code=404,
+                description=e.description,
+            )
+        ),
+        ma.ValidationError: create_error_handler(
+            lambda e: HTTPJSONValidationException(e)
+        ),
+    }

{invenio-banners-3.0.1 → invenio-banners-3.0.2}/invenio_banners/services/schemas.py

@@ -10,7 +10,7 @@
 from datetime import datetime, timezone
 
 from invenio_records_resources.services.records.schema import BaseRecordSchema
-from marshmallow import fields
+from marshmallow import fields, pre_load
 from marshmallow_utils.fields import TZDateTime
 
 
@@ -19,7 +19,7 @@ class BannerSchema(BaseRecordSchema):
 
     message = fields.String(required=True)
     url_path = fields.String(allow_none=True)
-    category = fields.String(required=True)
+    category = fields.String(required=True, metadata={"default": "info"})
     start_datetime = fields.DateTime(
         required=True,
         metadata={"default": datetime.utcnow().strftime("%Y-%m-%d %H:%M:%S")},
@@ -28,3 +28,12 @@ class BannerSchema(BaseRecordSchema):
     active = fields.Boolean(required=True, metadata={"default": True})
     created = TZDateTime(timezone=timezone.utc, format="iso", dump_only=True)
     updated = TZDateTime(timezone=timezone.utc, format="iso", dump_only=True)
+
+    @pre_load
+    def change_none_to_string(self, data, **kwargs):
+        """Fix for empty strings not in line with allow_none=True."""
+        for field in data:
+            if field == "end_datetime" or field == "category":
+                if data[field] == "":
+                    data[field] = None
+        return data

{invenio-banners-3.0.1 → invenio-banners-3.0.2}/invenio_banners/services/service.py

@@ -89,7 +89,7 @@ class BannerService(RecordService):
         valid_data, errors = self.schema.load(
             data,
             context={"identity": identity},
-            raise_errors=False,
+            raise_errors=raise_errors,
         )
 
         # create the banner with the specified data

{invenio-banners-3.0.1 → invenio-banners-3.0.2}/invenio_banners.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: invenio-banners
-Version: 3.0.1
+Version: 3.0.2
 Summary: Invenio-Banners is a module used to create and show banners with useful messages to users.
 Home-page: https://github.com/inveniosoftware/invenio-banners
 Author: CERN
@@ -45,6 +45,10 @@ Description: ..
         Changes
         =======
         
+        Version 3.0.2 (released 2024-07-17)
+        
+        - errors: implement REST validation error for banner loader
+        
         Version 3.0.1 (released 2024-02-21)
         
         - Moved admin menu item for banners to site administration category

invenio-banners-3.0.1/invenio_banners/resources/errors.py

@@ -1,25 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2023 CERN.
-#
-# Invenio-Banners is free software; you can redistribute it and/or modify it
-# under the terms of the MIT License; see LICENSE file for more details.
-
-"""Errors."""
-
-from flask_resources import HTTPJSONException, create_error_handler
-
-from ..services.errors import BannerNotExistsError
-
-
-class ErrorHandlersMixin:
-    """Mixin to define error handlers."""
-
-    error_handlers = {
-        BannerNotExistsError: create_error_handler(
-            lambda e: HTTPJSONException(
-                code=404,
-                description=e.description,
-            )
-        ),
-    }