invenio-banners 3.0.1__py2.py3-none-any.whl → 3.1.0__py2.py3-none-any.whl

invenio_banners/__init__.py

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

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/resources/config.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2022-2023 CERN.
+# Copyright (C) 2022-2024 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.
@@ -45,3 +45,10 @@ class BannerResourceConfig(RecordResourceConfig):
 
     request_body_parsers = {"application/json": RequestBodyParser(JSONDeserializer())}
     default_content_type = "application/json"
+
+    response_handlers = {
+        "application/vnd.inveniordm.v1+json": RecordResourceConfig.response_handlers[
+            "application/json"
+        ],
+        **RecordResourceConfig.response_handlers,
+    }

invenio_banners/resources/errors.py

@@ -10,9 +10,22 @@
 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."
 
-class ErrorHandlersMixin:
+    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 = {
@@ -22,4 +35,7 @@ class ErrorHandlersMixin:
                 description=e.description,
             )
         ),
+        ma.ValidationError: create_error_handler(
+            lambda e: HTTPJSONValidationException(e)
+        ),
     }

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/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.dist-info → invenio_banners-3.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: invenio-banners
-Version: 3.0.1
+Version: 3.1.0
 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
@@ -61,6 +61,14 @@ https://invenio-banners.readthedocs.io/
 Changes
 =======
 
+Version v3.1.0 (released 2024-08-07)
+
+- http headers: use and adjust vnd.inveniordm.v1+json http accept header
+
+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.dist-info → invenio_banners-3.1.0.dist-info}/RECORD

@@ -1,26 +1,26 @@
-invenio_banners/__init__.py,sha256=fnt_8eT-FKRXEIwAPKfxT-UwoVVKUd7Ogx8Il0PLSCU,373
+invenio_banners/__init__.py,sha256=JylemtnXfzx8PB-rlz9RMvBnjrx9p5gk3UB9jrdkYK0,373
 invenio_banners/config.py,sha256=xGHNLvXoJyQsJo7yKeOh-lDySTaX0bVH1mk7BMrE1NA,1299
 invenio_banners/ext.py,sha256=rRIgDgZIyGhm2M8WHWApMPRcBVe3eHkaHzTOt-YH6aw,1836
 invenio_banners/proxies.py,sha256=nfACfpSgfCHiixSy2cO4G9y_lHFQj6onOeBLifYY6IQ,638
 invenio_banners/utils.py,sha256=7jSiwsyfP7_mMwmA0exZTlyyppklApO9qG4E7MannA4,897
 invenio_banners/views.py,sha256=sya476lHzXnFERPK7LAgn21wzUVBywjhs5y56Lh7NtY,449
 invenio_banners/administration/__init__.py,sha256=QtT7HabGpMsOlT6xlFp4RNalseEH7ugsdn532bkR4Tk,243
-invenio_banners/administration/banners.py,sha256=KyWg3lZtfMP76ixDIMMDoD5lmnrIhb8yspDqYJTUS6M,8304
+invenio_banners/administration/banners.py,sha256=Vq4o4PDPgN7GwYHGXf65LfdXH35kXs6k88xDpBySm0I,8365
 invenio_banners/alembic/5e02314da32e_create_invenio_banners_db_table.py,sha256=FZ5Z8RsrbrlN8vr43LW0ukVRFTj2DV7B7JgVjnk0zp8,1446
 invenio_banners/alembic/e40d93d99040_create_invenio_banners_branch.py,sha256=KoEbAzpNneVNBwegW3FfMIW_XTH6im0GXz2DvIF6DwA,562
 invenio_banners/records/__init__.py,sha256=-A_Q-oZyJuV2lcgLfqXWeMuTlmv6IrEbcMqs_58PHuE,298
 invenio_banners/records/models.py,sha256=MS_nyrvJ0LkQJPx5BEqAJo0_P-w0TekNGWsSkg1ijNw,4318
 invenio_banners/resources/__init__.py,sha256=bQbqlVhQKjJXiiNmqsf_Z1R_4PqmmNTb-Kwj-2lEfQQ,402
-invenio_banners/resources/config.py,sha256=wi5YzfnMxgeTJ7V1nJCj-T_bjGmBrmUECTd4iksTLkI,1224
-invenio_banners/resources/errors.py,sha256=ZTiTgwy19PpVq1D-87u_mYOCD-l7UzN7ba2zpjFM2us,628
+invenio_banners/resources/config.py,sha256=Ng0TowZk3GCG1tOv0TKtUpeDwY8RIK6adEUYCVVnKZg,1435
+invenio_banners/resources/errors.py,sha256=eweK5tYYlscBBpXvQd6xZxXsHhl3jzZzKblBf4uiB08,1249
 invenio_banners/resources/resource.py,sha256=lHTqkX7coKG0gXkgCdL7MEcsutGZ5rYSOEidiXHOztE,2924
 invenio_banners/services/__init__.py,sha256=9URKgFgYq2yUgj-eTB6_jE_ifZNQR9_E9sLP-1UIB1s,484
 invenio_banners/services/config.py,sha256=uzKWmgPIGHAG00Zs5BHlp1Y6WzbNzfS_tkXA3l4OOhA,2197
 invenio_banners/services/errors.py,sha256=1suJcPwdLyK3hqK0gicgTMUX2OAk_Y8TaqancnkXyEA,542
 invenio_banners/services/permissions.py,sha256=EbC4oeFaBHCYTPnDMrtoS9Cgo4skhjz694qhGEnZYHs,830
 invenio_banners/services/results.py,sha256=1TTtq--8WQkoqkTzIrC0EFsXSRurQZWn5MNgKU5Viys,2885
-invenio_banners/services/schemas.py,sha256=gmWE5Dj6PFWCiUVI7DgWaQf9ajzzWFjYGyCzGBKYVi4,1062
-invenio_banners/services/service.py,sha256=hYNAo2QmmJ9d4HV768kBbeG-VJf48BI9eSte17a8NOc,4552
+invenio_banners/services/schemas.py,sha256=vq8CuEDCyXSkCXSbcRBQDUe8dvvX_njBa9N6CMdE-5A,1427
+invenio_banners/services/service.py,sha256=DRg-GIyuvSD0w1jYC07u7nt2pybeE1Yi_7ugLW0bA4Q,4559
 invenio_banners/templates/semantic-ui/invenio_banners/banner.html,sha256=RdEjT_ay7UYwYNQjIQ_2Q-qonprBhVzoQq9OzHPzSKk,642
 invenio_banners/translations/messages.pot,sha256=COiWqNZKe7rPc5qNua4RoxBQUVHaZ6bsW-9NzFv7skg,5007
 invenio_banners/translations/af/LC_MESSAGES/messages.po,sha256=kS4YofCdd6b6NCX5QXXKBZ1tpnu8dFWEdgQWsYPrYAk,5070
@@ -69,10 +69,10 @@ invenio_banners/translations/uk/LC_MESSAGES/messages.po,sha256=Z1ZM6O0bb8if1a82K
 invenio_banners/translations/uk_UA/LC_MESSAGES/messages.po,sha256=4KNAaMpzBYXmTLcH4NtmLKWpCZKEI9CbjfEH9tfa52c,5308
 invenio_banners/translations/zh_CN/LC_MESSAGES/messages.po,sha256=rBoibkyrfoi5WwZwI-C67fk_Gce7aGVg2595rJrrDi0,5265
 invenio_banners/translations/zh_TW/LC_MESSAGES/messages.po,sha256=2rOl1mvYBlJhThTyyQphuCVPl2apcJMew-tGl6WBO8I,5199
-invenio_banners-3.0.1.dist-info/AUTHORS.rst,sha256=fQsy2e1bLnwt_a89-kO6CwBwN7o58Ix9F9195b2iTJo,295
-invenio_banners-3.0.1.dist-info/LICENSE,sha256=UvI8pR8jGWqe0sTkb_hRG6eIrozzWwWzyCGEpuXX4KE,1062
-invenio_banners-3.0.1.dist-info/METADATA,sha256=-aJWjkIzliIu_h87g_Kps2tQ-AUxq2Y8kScj4N44muI,3105
-invenio_banners-3.0.1.dist-info/WHEEL,sha256=-G_t0oGuE7UD0DrSpVZnq1hHMBV9DD2XkS5v7XpmTnk,110
-invenio_banners-3.0.1.dist-info/entry_points.txt,sha256=jnZLi-_SEWCfUnqlIcj0tJmOnD33Z1GvmQMEejfhD20,720
-invenio_banners-3.0.1.dist-info/top_level.txt,sha256=ENJP1dEZ93e4ImCi7AHaVooTUV-6fQnRJ106wHitg5g,16
-invenio_banners-3.0.1.dist-info/RECORD,,
+invenio_banners-3.1.0.dist-info/AUTHORS.rst,sha256=fQsy2e1bLnwt_a89-kO6CwBwN7o58Ix9F9195b2iTJo,295
+invenio_banners-3.1.0.dist-info/LICENSE,sha256=UvI8pR8jGWqe0sTkb_hRG6eIrozzWwWzyCGEpuXX4KE,1062
+invenio_banners-3.1.0.dist-info/METADATA,sha256=rgsldgPwISim-2NJRvjvyyfiH8BZLDroAFdrsdipczA,3315
+invenio_banners-3.1.0.dist-info/WHEEL,sha256=-G_t0oGuE7UD0DrSpVZnq1hHMBV9DD2XkS5v7XpmTnk,110
+invenio_banners-3.1.0.dist-info/entry_points.txt,sha256=jnZLi-_SEWCfUnqlIcj0tJmOnD33Z1GvmQMEejfhD20,720
+invenio_banners-3.1.0.dist-info/top_level.txt,sha256=ENJP1dEZ93e4ImCi7AHaVooTUV-6fQnRJ106wHitg5g,16
+invenio_banners-3.1.0.dist-info/RECORD,,