invenio-banners 3.1.1__py2.py3-none-any.whl → 4.0.0__py2.py3-none-any.whl

invenio_banners/__init__.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (C) 2020-2024 CERN.
+# Copyright (C) 2024 Graz University of Technology.
 #
 # 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.
@@ -9,6 +10,6 @@
 
 from .ext import InvenioBanners
 
-__version__ = "3.1.1"
+__version__ = "4.0.0"
 
 __all__ = ("__version__", "InvenioBanners")

invenio_banners/records/models.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (C) 2020-2023 CERN.
+# Copyright (C) 2024 Graz University of Technology.
 #
 # 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.
@@ -13,7 +14,6 @@ import sqlalchemy as sa
 from flask import current_app
 from invenio_db import db
 from sqlalchemy import or_
-from sqlalchemy.orm.exc import NoResultFound
 from sqlalchemy.sql import text
 from sqlalchemy_utils.models import Timestamp
 
@@ -24,7 +24,6 @@ class BannerModel(db.Model, Timestamp):
     """Defines a message to show to users."""
 
     __tablename__ = "banners"
-    __versioned__ = {"versioning": False}
 
     id = db.Column(db.Integer, primary_key=True)
 
@@ -51,6 +50,7 @@ class BannerModel(db.Model, Timestamp):
         """Create a new banner."""
         _categories = [t[0] for t in current_app.config["BANNERS_CATEGORIES"]]
         assert data.get("category") in _categories
+
         with db.session.begin_nested():
             obj = cls(
                 message=data.get("message"),
@@ -62,24 +62,24 @@ class BannerModel(db.Model, Timestamp):
             )
             db.session.add(obj)
 
-        db.session.commit()
         return obj
 
     @classmethod
     def update(cls, data, id):
         """Update an existing banner."""
         with db.session.begin_nested():
-            cls.query.filter_by(id=id).update(data)
-
-        db.session.commit()
+            # NOTE:
+            # with db.session.get(cls, id) the model itself would be
+            # returned and this classmethod would be called
+            db.session.query(cls).filter_by(id=id).update(data)
 
     @classmethod
     def get(cls, id):
         """Get banner by its id."""
-        try:
-            return cls.query.filter_by(id=id).one()
-        except NoResultFound:
-            raise BannerNotExistsError(id)
+        if banner := db.session.get(cls, id):
+            return banner
+
+        raise BannerNotExistsError(id)
 
     @classmethod
     def delete(cls, banner):
@@ -87,15 +87,14 @@ class BannerModel(db.Model, Timestamp):
         with db.session.begin_nested():
             db.session.delete(banner)
 
-        db.session.commit()
-
     @classmethod
     def get_active(cls, url_path):
         """Return active banners."""
         now = datetime.utcnow()
 
         query = (
-            cls.query.filter(cls.active.is_(True))
+            db.session.query(cls)
+            .filter(cls.active.is_(True))
             .filter(cls.start_datetime <= now)
             .filter((cls.end_datetime.is_(None)) | (now <= cls.end_datetime))
         )
@@ -113,16 +112,17 @@ class BannerModel(db.Model, Timestamp):
     @classmethod
     def search(cls, search_params, filters):
         """Filter banners accordingly to query params."""
-        banners = (
-            BannerModel.query.filter(or_(*filters))
-            .order_by(
-                search_params["sort_direction"](text(",".join(search_params["sort"])))
-            )
-            .paginate(
-                page=search_params["page"],
-                per_page=search_params["size"],
-                error_out=False,
-            )
+        if filters == []:
+            filtered = db.session.query(BannerModel).filter()
+        else:
+            filtered = db.session.query(BannerModel).filter(or_(*filters))
+
+        banners = filtered.order_by(
+            search_params["sort_direction"](text(",".join(search_params["sort"])))
+        ).paginate(
+            page=search_params["page"],
+            per_page=search_params["size"],
+            error_out=False,
         )
 
         return banners
@@ -133,12 +133,11 @@ class BannerModel(db.Model, Timestamp):
         now = datetime.utcnow()
 
         query = (
-            cls.query.filter(cls.active.is_(True))
+            db.session.query(cls)
+            .filter(cls.active.is_(True))
             .filter(cls.end_datetime.isnot(None))
             .filter(cls.end_datetime < now)
         )
 
         for old in query.all():
             old.active = False
-
-        db.session.commit()

invenio_banners/resources/errors.py

@@ -1,19 +1,19 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (C) 2023 CERN.
+# Copyright (C) 2024 Graz University of Technology.
 #
 # 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
 
+from ..services.errors import BannerNotExistsError
+
 
 class HTTPJSONValidationException(HTTPJSONException):
     """HTTP exception serializing to JSON and reflecting Marshmallow errors."""
@@ -25,7 +25,7 @@ class HTTPJSONValidationException(HTTPJSONException):
         super().__init__(code=400, errors=validation_error_to_list_errors(exception))
 
 
-class ErrorHandlersMixin():
+class ErrorHandlersMixin:
     """Mixin to define error handlers."""
 
     error_handlers = {

invenio_banners/services/results.py

@@ -1,14 +1,22 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (C) 2022-2023 CERN.
+# Copyright (C) 2024 Graz University of Technology.
 #
 # 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.
 
 """Service results."""
-from flask_sqlalchemy import Pagination
+
 from invenio_records_resources.services.records.results import RecordItem, RecordList
 
+try:
+    # flask_sqlalchemy<3.0.0
+    from flask_sqlalchemy import Pagination
+except ImportError:
+    # flask_sqlalchemy>=3.0.0
+    from flask_sqlalchemy.pagination import Pagination
+
 
 class BannerItem(RecordItem):
     """Single banner result."""

invenio_banners/services/schemas.py

@@ -11,13 +11,13 @@ from datetime import datetime, timezone
 
 from invenio_records_resources.services.records.schema import BaseRecordSchema
 from marshmallow import fields, pre_load
-from marshmallow_utils.fields import TZDateTime
+from marshmallow_utils.fields import SanitizedHTML, TZDateTime
 
 
 class BannerSchema(BaseRecordSchema):
     """Schema for banners."""
 
-    message = fields.String(required=True)
+    message = SanitizedHTML(required=True)
     url_path = fields.String(allow_none=True)
     category = fields.String(required=True, metadata={"default": "info"})
     start_datetime = fields.DateTime(

invenio_banners/services/service.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (C) 2022-2023 CERN.
+# Copyright (C) 2024 Graz University of Technology.
 #
 # 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.
@@ -10,6 +11,7 @@
 import distutils.util
 
 import arrow
+from invenio_db.uow import unit_of_work
 from invenio_records_resources.services import RecordService
 from invenio_records_resources.services.base import LinksTemplate
 from invenio_records_resources.services.base.utils import map_search_params
@@ -81,7 +83,8 @@ class BannerService(RecordService):
             links_item_tpl=self.links_item_tpl,
         )
 
-    def create(self, identity, data, raise_errors=True):
+    @unit_of_work()
+    def create(self, identity, data, raise_errors=True, uow=None):
         """Create a banner."""
         self.require_permission(identity, "create")
 
@@ -99,17 +102,18 @@ class BannerService(RecordService):
             self, identity, banner, links_tpl=self.links_item_tpl, errors=errors
         )
 
-    def delete(self, identity, id):
+    @unit_of_work()
+    def delete(self, identity, id, uow=None):
         """Delete a banner from database."""
         self.require_permission(identity, "delete")
 
         banner = self.record_cls.get(id)
-
         self.record_cls.delete(banner)
 
         return self.result_item(self, identity, banner, links_tpl=self.links_item_tpl)
 
-    def update(self, identity, id, data):
+    @unit_of_work()
+    def update(self, identity, id, data, uow=None):
         """Update a banner."""
         self.require_permission(identity, "update")
 
@@ -131,7 +135,8 @@ class BannerService(RecordService):
             links_tpl=self.links_item_tpl,
         )
 
-    def disable_expired(self, identity):
+    @unit_of_work()
+    def disable_expired(self, identity, uow=None):
         """Disable expired banners."""
         self.require_permission(identity, "disable")
         self.record_cls.disable_expired()

{invenio_banners-3.1.1.dist-info → invenio_banners-4.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: invenio-banners
-Version: 3.1.1
+Version: 4.0.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
@@ -10,17 +10,20 @@ Keywords: Invenio Banners
 Platform: any
 Classifier: Development Status :: 1 - Planning
 Requires-Python: >=3.7
-Requires-Dist: invenio-i18n <3.0.0,>=2.0.0
-Requires-Dist: invenio-administration <3.0.0,>=2.0.0
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: invenio-i18n<4.0.0,>=3.0.0
+Requires-Dist: invenio-administration<4.0.0,>=3.0.0
+Provides-Extra: tests
+Requires-Dist: pytest-black-ng>=0.4.0; extra == "tests"
+Requires-Dist: pytest-invenio<4.0.0,>=3.0.0; extra == "tests"
+Requires-Dist: jsonresolver>=0.3.2; extra == "tests"
+Requires-Dist: invenio-app<3.0.0,>=2.0.0; extra == "tests"
+Requires-Dist: sphinx>=4.5; extra == "tests"
 Provides-Extra: opensearch1
-Requires-Dist: invenio-search[opensearch1] <3.0.0,>=2.1.0 ; extra == 'opensearch1'
+Requires-Dist: invenio-search[opensearch1]<4.0.0,>=3.0.0; extra == "opensearch1"
 Provides-Extra: opensearch2
-Requires-Dist: invenio-search[opensearch2] <3.0.0,>=2.1.0 ; extra == 'opensearch2'
-Provides-Extra: tests
-Requires-Dist: pytest-invenio <3.0.0,>=2.1.0 ; extra == 'tests'
-Requires-Dist: invenio-app <2.0.0,>=1.3.4 ; extra == 'tests'
-Requires-Dist: pytest-black >=0.3.0 ; extra == 'tests'
-Requires-Dist: sphinx >=4.5 ; extra == 'tests'
+Requires-Dist: invenio-search[opensearch2]<4.0.0,>=3.0.0; extra == "opensearch2"
 
 ..
     Copyright (C) 2020 CERN.
@@ -54,7 +57,7 @@ https://invenio-banners.readthedocs.io/
 
 ..
     Copyright (C) 2020-2024 CERN.
-    Copyright (C) 2024 Northwestern University.
+    Copyright (C) 2024 Graz University of Technology.
 
     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.
@@ -62,10 +65,16 @@ https://invenio-banners.readthedocs.io/
 Changes
 =======
 
-Version v3.1.1 (released 2024-09-18)
+Version v4.0.0 (released 2024-12-10)
+
+- setup: change to reusable workflows
+- setup: bump major dependencies
 
-- admin: adjust + fix typos in descriptions of fields
-- i18n:push translations
+Version v3.2.0 (released 2024-11-05)
+
+- feat(administration): use html editor for message
+- global: change the code to be compatible with sqlalchemy >= 2.0
+- global: add compatibility layer to move to flask >= 3.0
 
 Version v3.1.0 (released 2024-08-07)
 
@@ -106,5 +115,3 @@ Version 1.0.0a1 (release 2020-10-25)
 ------------------------------------
 
 - Initial public release.
-
-

{invenio_banners-3.1.1.dist-info → invenio_banners-4.0.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-invenio_banners/__init__.py,sha256=can8AwpDeSf3drqZX0cxmgfkYOLSLXliyHRFKmFW2rU,373
+invenio_banners/__init__.py,sha256=x5l0XCEOf3v8LCTX-b5deFuWuCK2extpjhGlFHpa6W0,425
 invenio_banners/config.py,sha256=xGHNLvXoJyQsJo7yKeOh-lDySTaX0bVH1mk7BMrE1NA,1299
 invenio_banners/ext.py,sha256=rRIgDgZIyGhm2M8WHWApMPRcBVe3eHkaHzTOt-YH6aw,1836
 invenio_banners/proxies.py,sha256=nfACfpSgfCHiixSy2cO4G9y_lHFQj6onOeBLifYY6IQ,638
@@ -9,18 +9,18 @@ invenio_banners/administration/banners.py,sha256=ZlJgxiWxteQvhQa5_1_iq1FHWSG0bTm
 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/records/models.py,sha256=iKlk4dOMRJKVmr5BT1TpgSjXY2D8V16L92Sj3ggnOKA,4427
 invenio_banners/resources/__init__.py,sha256=bQbqlVhQKjJXiiNmqsf_Z1R_4PqmmNTb-Kwj-2lEfQQ,402
 invenio_banners/resources/config.py,sha256=Ng0TowZk3GCG1tOv0TKtUpeDwY8RIK6adEUYCVVnKZg,1435
-invenio_banners/resources/errors.py,sha256=eweK5tYYlscBBpXvQd6xZxXsHhl3jzZzKblBf4uiB08,1249
+invenio_banners/resources/errors.py,sha256=H-qs9L10KSFaGKq_yDLu7QEiD2WB4JCKV8Xp_jJ4yEM,1231
 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=vq8CuEDCyXSkCXSbcRBQDUe8dvvX_njBa9N6CMdE-5A,1427
-invenio_banners/services/service.py,sha256=DRg-GIyuvSD0w1jYC07u7nt2pybeE1Yi_7ugLW0bA4Q,4559
+invenio_banners/services/results.py,sha256=sg2z1zPKD8mWgUigwqdFWJqdnA7wOtmf6yKfa3AeUek,3082
+invenio_banners/services/schemas.py,sha256=rWh1WSQR4ps_Ii7RWd82FUMk4_aHbdwd5kYh5gCxlJU,1442
+invenio_banners/services/service.py,sha256=7KdwwrmqvtBsmEschL-i_ydPsijH7RjzLzMFogrKYeQ,4770
 invenio_banners/templates/semantic-ui/invenio_banners/banner.html,sha256=RdEjT_ay7UYwYNQjIQ_2Q-qonprBhVzoQq9OzHPzSKk,642
 invenio_banners/translations/messages.pot,sha256=SQpSVoZDsRHTihUdvEkq7HoNRwffdwhYPm2qITPRPYk,5090
 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.1.1.dist-info/AUTHORS.rst,sha256=fQsy2e1bLnwt_a89-kO6CwBwN7o58Ix9F9195b2iTJo,295
-invenio_banners-3.1.1.dist-info/LICENSE,sha256=UvI8pR8jGWqe0sTkb_hRG6eIrozzWwWzyCGEpuXX4KE,1062
-invenio_banners-3.1.1.dist-info/METADATA,sha256=fWJL4VVTYSJab3ybAJqutb_Hw25NZrHm9-9QSYQA9Vw,3481
-invenio_banners-3.1.1.dist-info/WHEEL,sha256=-G_t0oGuE7UD0DrSpVZnq1hHMBV9DD2XkS5v7XpmTnk,110
-invenio_banners-3.1.1.dist-info/entry_points.txt,sha256=jnZLi-_SEWCfUnqlIcj0tJmOnD33Z1GvmQMEejfhD20,720
-invenio_banners-3.1.1.dist-info/top_level.txt,sha256=ENJP1dEZ93e4ImCi7AHaVooTUV-6fQnRJ106wHitg5g,16
-invenio_banners-3.1.1.dist-info/RECORD,,
+invenio_banners-4.0.0.dist-info/AUTHORS.rst,sha256=fQsy2e1bLnwt_a89-kO6CwBwN7o58Ix9F9195b2iTJo,295
+invenio_banners-4.0.0.dist-info/LICENSE,sha256=UvI8pR8jGWqe0sTkb_hRG6eIrozzWwWzyCGEpuXX4KE,1062
+invenio_banners-4.0.0.dist-info/METADATA,sha256=ORbQF5YnaC5RUV38nBLusFKOa4RXzXgOEVG1HnH9hAg,3782
+invenio_banners-4.0.0.dist-info/WHEEL,sha256=pxeNX5JdtCe58PUSYP9upmc7jdRPgvT0Gm9kb1SHlVw,109
+invenio_banners-4.0.0.dist-info/entry_points.txt,sha256=3p4FMVuj9AZ1QGm6YdcdhzP9k4xsPfsUG10Ykc3CpxI,719
+invenio_banners-4.0.0.dist-info/top_level.txt,sha256=ENJP1dEZ93e4ImCi7AHaVooTUV-6fQnRJ106wHitg5g,16
+invenio_banners-4.0.0.dist-info/RECORD,,

{invenio_banners-3.1.1.dist-info → invenio_banners-4.0.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: setuptools (75.6.0)
 Root-Is-Purelib: true
 Tag: py2-none-any
 Tag: py3-none-any

{invenio_banners-3.1.1.dist-info → invenio_banners-4.0.0.dist-info}/entry_points.txt

@@ -18,4 +18,3 @@ invenio_banners = invenio_banners:alembic
 
 [invenio_db.models]
 invenio_banners = invenio_banners.records.models
-