invenio-banners 3.0.0__py2.py3-none-any.whl → 3.0.2__py2.py3-none-any.whl

invenio_banners/__init__.py

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

invenio_banners/administration/banners.py

@@ -24,7 +24,7 @@ class BannerListView(AdminResourceListView):
     resource_config = "banners_resource"
     title = "Banners"
     menu_label = "Banners"
-    category = "Banners"
+    category = _("Site management")
     pid_path = "id"
     icon = "newspaper"
 
@@ -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/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/translations/af/LC_MESSAGES/messages.po

@@ -0,0 +1,160 @@
+# Translations template for invenio-banners.
+# Copyright (C) 2023 CERN
+# This file is distributed under the same license as the invenio-banners
+# project.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2023.
+# 
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: invenio-banners 2.1.0\n"
+"Report-Msgid-Bugs-To: info@inveniosoftware.org\n"
+"POT-Creation-Date: 2023-06-30 11:25+0200\n"
+"PO-Revision-Date: 2023-06-30 09:38+0000\n"
+"Language-Team: Afrikaans (https://app.transifex.com/inveniosoftware/teams/23537/af/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.12.1\n"
+"Language: af\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#: invenio_banners/administration/banners.py:42
+#: invenio_banners/administration/banners.py:96
+#: invenio_banners/administration/banners.py:179
+#: invenio_banners/administration/banners.py:236 invenio_banners/config.py:37
+msgid "URL path"
+msgstr ""
+
+#: invenio_banners/config.py:41
+msgid "Start DateTime"
+msgstr ""
+
+#: invenio_banners/config.py:45
+msgid "End DateTime"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:41
+#: invenio_banners/administration/banners.py:123
+#: invenio_banners/administration/banners.py:207
+#: invenio_banners/administration/banners.py:238 invenio_banners/config.py:49
+#: invenio_banners/services/config.py:60
+msgid "Active"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:37
+msgid "Id"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:38
+msgid "Start time (UTC)"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:39
+msgid "End time (UTC)"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:40
+#: invenio_banners/administration/banners.py:88
+#: invenio_banners/administration/banners.py:171
+#: invenio_banners/administration/banners.py:235
+msgid "Message"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:43
+#: invenio_banners/administration/banners.py:108
+#: invenio_banners/administration/banners.py:191
+#: invenio_banners/administration/banners.py:237
+msgid "Category"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:67
+#: invenio_banners/administration/banners.py:150
+#: invenio_banners/administration/banners.py:233
+#: invenio_banners/services/config.py:52
+msgid "Start time"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:68
+#: invenio_banners/administration/banners.py:151
+msgid ""
+"Input format: yyyy-mm-dd hh:mm:ss. Set to current or future date/time to "
+"delay the banner. Note: specify time in UTC time standard."
+msgstr ""
+
+#: invenio_banners/administration/banners.py:73
+#: invenio_banners/administration/banners.py:84
+#: invenio_banners/administration/banners.py:156
+#: invenio_banners/administration/banners.py:167
+msgid "YYYY-MM-DD hh:mm:ss"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:77
+#: invenio_banners/administration/banners.py:160
+#: invenio_banners/administration/banners.py:234
+#: invenio_banners/services/config.py:56
+msgid "End time"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:78
+#: invenio_banners/administration/banners.py:161
+msgid ""
+"Input format: yyyy-mm-dd hh:mm:ss. Date/time to make the banner inactive. "
+"Empty value will make the banner active until manually disabled via the "
+"active flag. Note: specify time in UTC time standard."
+msgstr ""
+
+#: invenio_banners/administration/banners.py:89
+#: invenio_banners/administration/banners.py:172
+msgid "Message to be displayed on the banner. HTML format is supported."
+msgstr ""
+
+#: invenio_banners/administration/banners.py:97
+#: invenio_banners/administration/banners.py:180
+msgid ""
+"Enter the URL path (including the first /) to define in which part of the "
+"site the message will be active. For example, if you enter `/records`, any "
+"URL starting with `/records` will return an active banner (/records, "
+"/records/1234, etc...). Empty value will make the banner active for any URL."
+msgstr ""
+
+#: invenio_banners/administration/banners.py:109
+msgid ""
+"Banner category. Info option displays the banner with information message in"
+" a blue color. Warning - a warning information in an orange color. Other - "
+"all the rest types of massages in a gray color."
+msgstr ""
+
+#: invenio_banners/administration/banners.py:124
+#: invenio_banners/administration/banners.py:208
+msgid ""
+"Tick it to activate the banner: banner will bedisplayed according to "
+"start/end times. If not activated, start/end times will be ignored."
+msgstr ""
+
+#: invenio_banners/administration/banners.py:192
+msgid ""
+"Banner category. Info option displays the banner with information message in"
+" a blue color. Warning - a warning information in an orange color. Other - "
+"all the rest types of messages in a gray color."
+msgstr ""
+
+#: invenio_banners/administration/banners.py:239
+msgid "Created"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:240
+msgid "Updated"
+msgstr ""
+
+#: invenio_banners/services/config.py:36
+msgid "Ascending"
+msgstr ""
+
+#: invenio_banners/services/config.py:40
+msgid "Descending"
+msgstr ""
+
+#: invenio_banners/services/config.py:48
+msgid "Url path"
+msgstr ""

invenio_banners/translations/ar/LC_MESSAGES/messages.po

@@ -0,0 +1,171 @@
+# Translations template for invenio-banners.
+# Copyright (C) 2023 CERN
+# This file is distributed under the same license as the invenio-banners
+# project.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2023.
+# 
+# Translators:
+# Bessem Aamira <bessemamira@gmail.com>, 2023
+# Salaheddine Ben Ali <salaheddine.benali@cnudst.tn>, 2023
+# 
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: invenio-banners 2.1.0\n"
+"Report-Msgid-Bugs-To: info@inveniosoftware.org\n"
+"POT-Creation-Date: 2023-06-30 11:25+0200\n"
+"PO-Revision-Date: 2023-06-30 09:38+0000\n"
+"Last-Translator: Salaheddine Ben Ali <salaheddine.benali@cnudst.tn>, 2023\n"
+"Language-Team: Arabic (https://app.transifex.com/inveniosoftware/teams/23537/ar/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.12.1\n"
+"Language: ar\n"
+"Plural-Forms: nplurals=6; plural=n==0 ? 0 : n==1 ? 1 : n==2 ? 2 : n%100>=3 && n%100<=10 ? 3 : n%100>=11 && n%100<=99 ? 4 : 5;\n"
+
+#: invenio_banners/administration/banners.py:42
+#: invenio_banners/administration/banners.py:96
+#: invenio_banners/administration/banners.py:179
+#: invenio_banners/administration/banners.py:236 invenio_banners/config.py:37
+msgid "URL path"
+msgstr "مسلك URL"
+
+#: invenio_banners/config.py:41
+msgid "Start DateTime"
+msgstr "تاريخ و توقيت البدء"
+
+#: invenio_banners/config.py:45
+msgid "End DateTime"
+msgstr "تاريخ و توقيت الإنتهاء"
+
+#: invenio_banners/administration/banners.py:41
+#: invenio_banners/administration/banners.py:123
+#: invenio_banners/administration/banners.py:207
+#: invenio_banners/administration/banners.py:238 invenio_banners/config.py:49
+#: invenio_banners/services/config.py:60
+msgid "Active"
+msgstr "مفعٌل"
+
+#: invenio_banners/administration/banners.py:37
+msgid "Id"
+msgstr "معرّف Id"
+
+#: invenio_banners/administration/banners.py:38
+msgid "Start time (UTC)"
+msgstr "توقيت البدء (ت ع م)"
+
+#: invenio_banners/administration/banners.py:39
+msgid "End time (UTC)"
+msgstr "توقيت الإنهاء (ت ع م)"
+
+#: invenio_banners/administration/banners.py:40
+#: invenio_banners/administration/banners.py:88
+#: invenio_banners/administration/banners.py:171
+#: invenio_banners/administration/banners.py:235
+msgid "Message"
+msgstr "رسالة"
+
+#: invenio_banners/administration/banners.py:43
+#: invenio_banners/administration/banners.py:108
+#: invenio_banners/administration/banners.py:191
+#: invenio_banners/administration/banners.py:237
+msgid "Category"
+msgstr "الفئة"
+
+#: invenio_banners/administration/banners.py:67
+#: invenio_banners/administration/banners.py:150
+#: invenio_banners/administration/banners.py:233
+#: invenio_banners/services/config.py:52
+msgid "Start time"
+msgstr "توقيت البدء"
+
+#: invenio_banners/administration/banners.py:68
+#: invenio_banners/administration/banners.py:151
+msgid ""
+"Input format: yyyy-mm-dd hh:mm:ss. Set to current or future date/time to "
+"delay the banner. Note: specify time in UTC time standard."
+msgstr ""
+"صيغة الرّقن : yyyy-mm-dd hh: mm: ss. إضبط على التاريخ / الوقت الحاليين أو "
+"المستقبليين لتأخير الشعار. ملاحظة: حدد الوقت بمعيار التوقيت العالمي الموحّد "
+"(UTC)."
+
+#: invenio_banners/administration/banners.py:73
+#: invenio_banners/administration/banners.py:84
+#: invenio_banners/administration/banners.py:156
+#: invenio_banners/administration/banners.py:167
+msgid "YYYY-MM-DD hh:mm:ss"
+msgstr "YYYY-MM-DD hh:mm:ss"
+
+#: invenio_banners/administration/banners.py:77
+#: invenio_banners/administration/banners.py:160
+#: invenio_banners/administration/banners.py:234
+#: invenio_banners/services/config.py:56
+msgid "End time"
+msgstr "توقيت الإنتهاء"
+
+#: invenio_banners/administration/banners.py:78
+#: invenio_banners/administration/banners.py:161
+msgid ""
+"Input format: yyyy-mm-dd hh:mm:ss. Date/time to make the banner inactive. "
+"Empty value will make the banner active until manually disabled via the "
+"active flag. Note: specify time in UTC time standard."
+msgstr ""
+"صيغة الرّقن : yyyy-mm-dd hh: mm: ss. التاريخ / الوقت لجعل الشعار غير نشط. "
+"القيمة الفارغة ستؤدي  إلى تنشيط الشعار حتى يتم تعطيله يدويًا عبر العلامة "
+"التّنشيط. ملاحظة: حدد الوقت بمعيار التوقيت العالمي الموحّد (UTC)."
+
+#: invenio_banners/administration/banners.py:89
+#: invenio_banners/administration/banners.py:172
+msgid "Message to be displayed on the banner. HTML format is supported."
+msgstr ""
+
+#: invenio_banners/administration/banners.py:97
+#: invenio_banners/administration/banners.py:180
+msgid ""
+"Enter the URL path (including the first /) to define in which part of the "
+"site the message will be active. For example, if you enter `/records`, any "
+"URL starting with `/records` will return an active banner (/records, "
+"/records/1234, etc...). Empty value will make the banner active for any URL."
+msgstr ""
+
+#: invenio_banners/administration/banners.py:109
+msgid ""
+"Banner category. Info option displays the banner with information message in"
+" a blue color. Warning - a warning information in an orange color. Other - "
+"all the rest types of massages in a gray color."
+msgstr ""
+
+#: invenio_banners/administration/banners.py:124
+#: invenio_banners/administration/banners.py:208
+msgid ""
+"Tick it to activate the banner: banner will bedisplayed according to "
+"start/end times. If not activated, start/end times will be ignored."
+msgstr ""
+
+#: invenio_banners/administration/banners.py:192
+msgid ""
+"Banner category. Info option displays the banner with information message in"
+" a blue color. Warning - a warning information in an orange color. Other - "
+"all the rest types of messages in a gray color."
+msgstr ""
+
+#: invenio_banners/administration/banners.py:239
+msgid "Created"
+msgstr "تمّ الإنشاء"
+
+#: invenio_banners/administration/banners.py:240
+msgid "Updated"
+msgstr "محينة"
+
+#: invenio_banners/services/config.py:36
+msgid "Ascending"
+msgstr "تصاعدي"
+
+#: invenio_banners/services/config.py:40
+msgid "Descending"
+msgstr "تنازلي"
+
+#: invenio_banners/services/config.py:48
+msgid "Url path"
+msgstr ""

invenio_banners/translations/bg/LC_MESSAGES/messages.po

@@ -0,0 +1,164 @@
+# Translations template for invenio-banners.
+# Copyright (C) 2023 CERN
+# This file is distributed under the same license as the invenio-banners
+# project.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2023.
+# 
+# Translators:
+# Tibor Simko <tibor.simko@cern.ch>, 2023
+# 
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: invenio-banners 2.1.0\n"
+"Report-Msgid-Bugs-To: info@inveniosoftware.org\n"
+"POT-Creation-Date: 2023-06-30 11:25+0200\n"
+"PO-Revision-Date: 2023-06-30 09:38+0000\n"
+"Last-Translator: Tibor Simko <tibor.simko@cern.ch>, 2023\n"
+"Language-Team: Bulgarian (https://app.transifex.com/inveniosoftware/teams/23537/bg/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.12.1\n"
+"Language: bg\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#: invenio_banners/administration/banners.py:42
+#: invenio_banners/administration/banners.py:96
+#: invenio_banners/administration/banners.py:179
+#: invenio_banners/administration/banners.py:236 invenio_banners/config.py:37
+msgid "URL path"
+msgstr ""
+
+#: invenio_banners/config.py:41
+msgid "Start DateTime"
+msgstr ""
+
+#: invenio_banners/config.py:45
+msgid "End DateTime"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:41
+#: invenio_banners/administration/banners.py:123
+#: invenio_banners/administration/banners.py:207
+#: invenio_banners/administration/banners.py:238 invenio_banners/config.py:49
+#: invenio_banners/services/config.py:60
+msgid "Active"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:37
+msgid "Id"
+msgstr "Id"
+
+#: invenio_banners/administration/banners.py:38
+msgid "Start time (UTC)"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:39
+msgid "End time (UTC)"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:40
+#: invenio_banners/administration/banners.py:88
+#: invenio_banners/administration/banners.py:171
+#: invenio_banners/administration/banners.py:235
+msgid "Message"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:43
+#: invenio_banners/administration/banners.py:108
+#: invenio_banners/administration/banners.py:191
+#: invenio_banners/administration/banners.py:237
+msgid "Category"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:67
+#: invenio_banners/administration/banners.py:150
+#: invenio_banners/administration/banners.py:233
+#: invenio_banners/services/config.py:52
+msgid "Start time"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:68
+#: invenio_banners/administration/banners.py:151
+msgid ""
+"Input format: yyyy-mm-dd hh:mm:ss. Set to current or future date/time to "
+"delay the banner. Note: specify time in UTC time standard."
+msgstr ""
+
+#: invenio_banners/administration/banners.py:73
+#: invenio_banners/administration/banners.py:84
+#: invenio_banners/administration/banners.py:156
+#: invenio_banners/administration/banners.py:167
+msgid "YYYY-MM-DD hh:mm:ss"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:77
+#: invenio_banners/administration/banners.py:160
+#: invenio_banners/administration/banners.py:234
+#: invenio_banners/services/config.py:56
+msgid "End time"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:78
+#: invenio_banners/administration/banners.py:161
+msgid ""
+"Input format: yyyy-mm-dd hh:mm:ss. Date/time to make the banner inactive. "
+"Empty value will make the banner active until manually disabled via the "
+"active flag. Note: specify time in UTC time standard."
+msgstr ""
+
+#: invenio_banners/administration/banners.py:89
+#: invenio_banners/administration/banners.py:172
+msgid "Message to be displayed on the banner. HTML format is supported."
+msgstr ""
+
+#: invenio_banners/administration/banners.py:97
+#: invenio_banners/administration/banners.py:180
+msgid ""
+"Enter the URL path (including the first /) to define in which part of the "
+"site the message will be active. For example, if you enter `/records`, any "
+"URL starting with `/records` will return an active banner (/records, "
+"/records/1234, etc...). Empty value will make the banner active for any URL."
+msgstr ""
+
+#: invenio_banners/administration/banners.py:109
+msgid ""
+"Banner category. Info option displays the banner with information message in"
+" a blue color. Warning - a warning information in an orange color. Other - "
+"all the rest types of massages in a gray color."
+msgstr ""
+
+#: invenio_banners/administration/banners.py:124
+#: invenio_banners/administration/banners.py:208
+msgid ""
+"Tick it to activate the banner: banner will bedisplayed according to "
+"start/end times. If not activated, start/end times will be ignored."
+msgstr ""
+
+#: invenio_banners/administration/banners.py:192
+msgid ""
+"Banner category. Info option displays the banner with information message in"
+" a blue color. Warning - a warning information in an orange color. Other - "
+"all the rest types of messages in a gray color."
+msgstr ""
+
+#: invenio_banners/administration/banners.py:239
+msgid "Created"
+msgstr ""
+
+#: invenio_banners/administration/banners.py:240
+msgid "Updated"
+msgstr ""
+
+#: invenio_banners/services/config.py:36
+msgid "Ascending"
+msgstr ""
+
+#: invenio_banners/services/config.py:40
+msgid "Descending"
+msgstr ""
+
+#: invenio_banners/services/config.py:48
+msgid "Url path"
+msgstr ""