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

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

@@ -1,5 +1,6 @@
 ..
     Copyright (C) 2020-2024 CERN.
+    Copyright (C) 2024 Northwestern University.
 
     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.
@@ -7,6 +8,15 @@
 Changes
 =======
 
+Version v3.1.1 (released 2024-09-18)
+
+- admin: adjust + fix typos in descriptions of fields
+- i18n:push translations
+
+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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: invenio-banners
-Version: 3.0.2
+Version: 3.1.1
 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
@@ -38,6 +38,7 @@ Description: ..
         
         ..
             Copyright (C) 2020-2024 CERN.
+            Copyright (C) 2024 Northwestern University.
         
             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,6 +46,15 @@ Description: ..
         Changes
         =======
         
+        Version v3.1.1 (released 2024-09-18)
+        
+        - admin: adjust + fix typos in descriptions of fields
+        - i18n:push translations
+        
+        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

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

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

invenio-banners-3.1.1/invenio_banners/administration/banners.py

@@ -0,0 +1,182 @@
+# -*- 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.
+
+"""Invenio administration banners view module."""
+
+from invenio_administration.views.base import (
+    AdminResourceCreateView,
+    AdminResourceDetailView,
+    AdminResourceEditView,
+    AdminResourceListView,
+)
+from invenio_i18n import lazy_gettext as _
+
+
+class BannerListView(AdminResourceListView):
+    """Search admin view."""
+
+    api_endpoint = "/banners"
+    name = "banners"
+    resource_config = "banners_resource"
+    title = "Banners"
+    menu_label = "Banners"
+    category = _("Site management")
+    pid_path = "id"
+    icon = "newspaper"
+
+    display_search = True
+    display_delete = True
+    display_create = True
+    display_edit = True
+
+    item_field_list = {
+        "id": {"text": _("Id"), "order": 1, "width": 1},
+        "start_datetime": {"text": _("Start time (UTC)"), "order": 2, "width": 2},
+        "end_datetime": {"text": _("End time (UTC)"), "order": 3, "width": 2},
+        "message": {"text": _("Message"), "order": 4, "width": 7},
+        "active": {"text": _("Active"), "order": 5, "width": 1},
+        "url_path": {"text": _("URL path"), "order": 6, "width": 2},
+        "category": {"text": _("Category"), "order": 7, "width": 1},
+    }
+
+    create_view_name = "banner_create"
+
+    search_config_name = "BANNERS_SEARCH"
+    search_sort_config_name = "BANNERS_SORT_OPTIONS"
+
+
+common_form_fields = {
+    "start_datetime": {
+        "order": 1,
+        "text": _("Start time"),
+        "description": _(
+            "Date/time to make the banner active. "
+            "Input format: yyyy-mm-dd hh:mm:ss. "
+            "Set to future date/time to delay the banner. "
+            "Note: specify time in UTC time standard."
+        ),
+        "placeholder": _("YYYY-MM-DD hh:mm:ss"),
+    },
+    "end_datetime": {
+        "order": 2,
+        "text": _("End time"),
+        "description": _(
+            "Date/time to make the banner inactive. "
+            "Input format: yyyy-mm-dd hh:mm:ss.  An empty value makes "
+            "the banner active until manually disabled via the active flag. "
+            "Note: specify time in UTC time standard."
+        ),
+        "placeholder": _("YYYY-MM-DD hh:mm:ss"),
+    },
+    "message": {
+        "order": 3,
+        "text": _("Message"),
+        "description": _(
+            "Message to be displayed on the banner. HTML format is supported."
+        ),
+        "rows": 10,
+    },
+    "url_path": {
+        "order": 4,
+        "text": _("URL path"),
+        "description": _(
+            "URL path prefix (including the first /) to define where "
+            "the message will be active on the site. For "
+            "example, if you enter `/records`, any URL starting with "
+            "`/records` will return an active banner (`/records`, "
+            "`/records/1234`, etc.). An empty value makes the banner "
+            "active for any URL."
+        ),
+    },
+    "category": {
+        "order": 5,
+        "text": _("Category"),
+        "description": _(
+            "Banner category. `Info` option displays a blue banner. "
+            "`Warning` option displays an orange banner. "
+            "`Other` option displays a gray banner."
+        ),
+        "options": [
+            {"title_l10n": "Info", "id": "info"},
+            {"title_l10n": "Warning", "id": "warning"},
+            {"title_l10n": "Other", "id": "other"},
+        ],
+        "placeholder": "Select a category",
+    },
+    "active": {
+        "order": 6,
+        "text": _("Active"),
+        "description": _(
+            "Tick it to activate the banner: banner will be "
+            "displayed according to start/end times. If not "
+            "activated, start/end times will be ignored."
+        ),
+    },
+}
+
+
+class BannerEditView(AdminResourceEditView):
+    """Configuration for Banner edit view."""
+
+    name = "banner_edit"
+    url = "/banners/<pid_value>/edit"
+    resource_config = "banners_resource"
+    pid_path = "id"
+    api_endpoint = "/banners"
+    title = "Edit Banner"
+
+    list_view_name = "banners"
+
+    form_fields = {
+        **common_form_fields,
+        "created": {"order": 7},
+        "updated": {"order": 8},
+    }
+
+
+class BannerCreateView(AdminResourceCreateView):
+    """Configuration for Banner create view."""
+
+    name = "banner_create"
+    url = "/banners/create"
+    resource_config = "banners_resource"
+    pid_path = "id"
+    api_endpoint = "/banners"
+    title = "Create Banner"
+
+    list_view_name = "banners"
+
+    form_fields = {
+        **common_form_fields,
+    }
+
+
+class BannerDetailView(AdminResourceDetailView):
+    """Admin banner detail view."""
+
+    url = "/banners/<pid_value>"
+    api_endpoint = "/banners"
+    name = "banner-details"
+    resource_config = "banners_resource"
+    title = "Banner Details"
+
+    display_delete = True
+    display_edit = True
+
+    list_view_name = "banners"
+    pid_path = "id"
+
+    item_field_list = {
+        "start_datetime": {"text": _("Start time"), "order": 1},
+        "end_datetime": {"text": _("End time"), "order": 2},
+        "message": {"text": _("Message"), "order": 3},
+        "url_path": {"text": _("URL path"), "order": 4},
+        "category": {"text": _("Category"), "order": 5},
+        "active": {"text": _("Active"), "order": 6},
+        "created": {"text": _("Created"), "order": 7},
+        "updated": {"text": _("Updated"), "order": 8},
+    }

{invenio-banners-3.0.2 → invenio-banners-3.1.1}/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-3.0.2 → invenio-banners-3.1.1}/invenio_banners/translations/messages.pot

@@ -1,27 +1,27 @@
 # Translations template for invenio-banners.
-# Copyright (C) 2023 CERN
+# Copyright (C) 2024 CERN
 # This file is distributed under the same license as the invenio-banners
 # project.
-# FIRST AUTHOR <EMAIL@ADDRESS>, 2023.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
 #
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: invenio-banners 2.1.0\n"
+"Project-Id-Version: invenio-banners 3.0.2\n"
 "Report-Msgid-Bugs-To: info@inveniosoftware.org\n"
-"POT-Creation-Date: 2023-06-30 11:25+0200\n"
+"POT-Creation-Date: 2024-08-06 08:46+0000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\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"
+"Generated-By: Babel 2.15.0\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
+#: invenio_banners/administration/banners.py:180
+#: invenio_banners/administration/banners.py:237 invenio_banners/config.py:37
 msgid "URL path"
 msgstr ""
 
@@ -34,13 +34,17 @@ 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/administration/banners.py:124
+#: invenio_banners/administration/banners.py:208
+#: invenio_banners/administration/banners.py:239 invenio_banners/config.py:49
 #: invenio_banners/services/config.py:60
 msgid "Active"
 msgstr ""
 
+#: invenio_banners/administration/banners.py:27
+msgid "Site management"
+msgstr ""
+
 #: invenio_banners/administration/banners.py:37
 msgid "Id"
 msgstr ""
@@ -55,27 +59,27 @@ 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
+#: invenio_banners/administration/banners.py:172
+#: invenio_banners/administration/banners.py:236
 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
+#: invenio_banners/administration/banners.py:192
+#: invenio_banners/administration/banners.py:238
 msgid "Category"
 msgstr ""
 
 #: invenio_banners/administration/banners.py:67
-#: invenio_banners/administration/banners.py:150
-#: invenio_banners/administration/banners.py:233
+#: invenio_banners/administration/banners.py:151
+#: invenio_banners/administration/banners.py:234
 #: invenio_banners/services/config.py:52
 msgid "Start time"
 msgstr ""
 
 #: invenio_banners/administration/banners.py:68
-#: invenio_banners/administration/banners.py:151
+#: invenio_banners/administration/banners.py:152
 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."
@@ -83,20 +87,20 @@ 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
+#: invenio_banners/administration/banners.py:157
+#: invenio_banners/administration/banners.py:168
 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/administration/banners.py:161
+#: invenio_banners/administration/banners.py:235
 #: invenio_banners/services/config.py:56
 msgid "End time"
 msgstr ""
 
 #: invenio_banners/administration/banners.py:78
-#: invenio_banners/administration/banners.py:161
+#: invenio_banners/administration/banners.py:162
 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 "
@@ -104,12 +108,12 @@ msgid ""
 msgstr ""
 
 #: invenio_banners/administration/banners.py:89
-#: invenio_banners/administration/banners.py:172
+#: invenio_banners/administration/banners.py:173
 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
+#: invenio_banners/administration/banners.py:181
 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`, "
@@ -125,25 +129,25 @@ msgid ""
 "Other - all the rest types of massages in a gray color."
 msgstr ""
 
-#: invenio_banners/administration/banners.py:124
-#: invenio_banners/administration/banners.py:208
+#: invenio_banners/administration/banners.py:125
+#: invenio_banners/administration/banners.py:209
 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
+#: invenio_banners/administration/banners.py:193
 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
+#: invenio_banners/administration/banners.py:240
 msgid "Created"
 msgstr ""
 
-#: invenio_banners/administration/banners.py:240
+#: invenio_banners/administration/banners.py:241
 msgid "Updated"
 msgstr ""
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: invenio-banners
-Version: 3.0.2
+Version: 3.1.1
 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
@@ -38,6 +38,7 @@ Description: ..
         
         ..
             Copyright (C) 2020-2024 CERN.
+            Copyright (C) 2024 Northwestern University.
         
             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,6 +46,15 @@ Description: ..
         Changes
         =======
         
+        Version v3.1.1 (released 2024-09-18)
+        
+        - admin: adjust + fix typos in descriptions of fields
+        - i18n:push translations
+        
+        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

invenio-banners-3.0.2/invenio_banners/administration/banners.py

@@ -1,242 +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.
-
-"""Invenio administration banners view module."""
-
-from invenio_administration.views.base import (
-    AdminResourceCreateView,
-    AdminResourceDetailView,
-    AdminResourceEditView,
-    AdminResourceListView,
-)
-from invenio_i18n import lazy_gettext as _
-
-
-class BannerListView(AdminResourceListView):
-    """Search admin view."""
-
-    api_endpoint = "/banners"
-    name = "banners"
-    resource_config = "banners_resource"
-    title = "Banners"
-    menu_label = "Banners"
-    category = _("Site management")
-    pid_path = "id"
-    icon = "newspaper"
-
-    display_search = True
-    display_delete = True
-    display_create = True
-    display_edit = True
-
-    item_field_list = {
-        "id": {"text": _("Id"), "order": 1, "width": 1},
-        "start_datetime": {"text": _("Start time (UTC)"), "order": 2, "width": 2},
-        "end_datetime": {"text": _("End time (UTC)"), "order": 3, "width": 2},
-        "message": {"text": _("Message"), "order": 4, "width": 7},
-        "active": {"text": _("Active"), "order": 5, "width": 1},
-        "url_path": {"text": _("URL path"), "order": 6, "width": 2},
-        "category": {"text": _("Category"), "order": 7, "width": 1},
-    }
-
-    create_view_name = "banner_create"
-
-    search_config_name = "BANNERS_SEARCH"
-    search_sort_config_name = "BANNERS_SORT_OPTIONS"
-
-
-class BannerEditView(AdminResourceEditView):
-    """Configuration for Banner edit view."""
-
-    name = "banner_edit"
-    url = "/banners/<pid_value>/edit"
-    resource_config = "banners_resource"
-    pid_path = "id"
-    api_endpoint = "/banners"
-    title = "Edit Banner"
-
-    list_view_name = "banners"
-
-    form_fields = {
-        "start_datetime": {
-            "order": 1,
-            "text": _("Start time"),
-            "description": _(
-                "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."
-            ),
-            "placeholder": _("YYYY-MM-DD hh:mm:ss"),
-        },
-        "end_datetime": {
-            "order": 2,
-            "text": _("End time"),
-            "description": _(
-                "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."
-            ),
-            "placeholder": _("YYYY-MM-DD hh:mm:ss"),
-        },
-        "message": {
-            "order": 3,
-            "text": _("Message"),
-            "description": _(
-                "Message to be displayed on the banner. HTML format is supported."
-            ),
-            "rows": 10,
-        },
-        "url_path": {
-            "order": 4,
-            "text": _("URL path"),
-            "description": _(
-                "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."
-            ),
-        },
-        "category": {
-            "order": 5,
-            "text": _("Category"),
-            "description": _(
-                "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."
-            ),
-            "options": [
-                {"title_l10n": "Info", "id": "info"},
-                {"title_l10n": "Warning", "id": "warning"},
-                {"title_l10n": "Other", "id": "other"},
-            ],
-            "placeholder": "Select a category",
-        },
-        "active": {
-            "order": 6,
-            "text": _("Active"),
-            "description": _(
-                "Tick it to activate the banner: banner will be"
-                "displayed according to start/end times. If not "
-                "activated, start/end times will be ignored."
-            ),
-        },
-        "created": {"order": 7},
-        "updated": {"order": 8},
-    }
-
-
-class BannerCreateView(AdminResourceCreateView):
-    """Configuration for Banner create view."""
-
-    name = "banner_create"
-    url = "/banners/create"
-    resource_config = "banners_resource"
-    pid_path = "id"
-    api_endpoint = "/banners"
-    title = "Create Banner"
-
-    list_view_name = "banners"
-
-    form_fields = {
-        "start_datetime": {
-            "order": 1,
-            "text": _("Start time"),
-            "description": _(
-                "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."
-            ),
-            "placeholder": _("YYYY-MM-DD hh:mm:ss"),
-        },
-        "end_datetime": {
-            "order": 2,
-            "text": _("End time"),
-            "description": _(
-                "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."
-            ),
-            "placeholder": _("YYYY-MM-DD hh:mm:ss"),
-        },
-        "message": {
-            "order": 3,
-            "text": _("Message"),
-            "description": _(
-                "Message to be displayed on the banner. HTML format is supported."
-            ),
-            "rows": 10,
-        },
-        "url_path": {
-            "order": 4,
-            "text": _("URL path"),
-            "description": _(
-                "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."
-            ),
-        },
-        "category": {
-            "order": 5,
-            "text": _("Category"),
-            "description": _(
-                "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."
-            ),
-            "options": [
-                {"title_l10n": "Info", "id": "info"},
-                {"title_l10n": "Warning", "id": "warning"},
-                {"title_l10n": "Other", "id": "other"},
-            ],
-            "placeholder": "Select a category",
-        },
-        "active": {
-            "order": 6,
-            "text": _("Active"),
-            "description": _(
-                "Tick it to activate the banner: banner will be"
-                "displayed according to start/end times. If not "
-                "activated, start/end times will be ignored."
-            ),
-        },
-    }
-
-
-class BannerDetailView(AdminResourceDetailView):
-    """Admin banner detail view."""
-
-    url = "/banners/<pid_value>"
-    api_endpoint = "/banners"
-    name = "banner-details"
-    resource_config = "banners_resource"
-    title = "Banner Details"
-
-    display_delete = True
-    display_edit = True
-
-    list_view_name = "banners"
-    pid_path = "id"
-
-    item_field_list = {
-        "start_datetime": {"text": _("Start time"), "order": 1},
-        "end_datetime": {"text": _("End time"), "order": 2},
-        "message": {"text": _("Message"), "order": 3},
-        "url_path": {"text": _("URL path"), "order": 4},
-        "category": {"text": _("Category"), "order": 5},
-        "active": {"text": _("Active"), "order": 6},
-        "created": {"text": _("Created"), "order": 7},
-        "updated": {"text": _("Updated"), "order": 8},
-    }