invenio-banners 5.1.1__tar.gz → 5.2.0__tar.gz

{invenio_banners-5.1.1 → invenio_banners-5.2.0}/CHANGES.rst

@@ -8,6 +8,11 @@
 Changes
 =======
 
+Version v5.2.0 (released 2025-08-06)
+
+- search: add query params active and url_path for search, add None as default value for filters
+- global: replace deprecated datetime utcnow() with now(timezone.utc)
+
 Version v5.1.1 (released 2025-07-22)
 
 - fix: mo files not included into build

{invenio_banners-5.1.1 → invenio_banners-5.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: invenio-banners
-Version: 5.1.1
+Version: 5.2.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
@@ -66,6 +66,11 @@ https://invenio-banners.readthedocs.io/
 Changes
 =======
 
+Version v5.2.0 (released 2025-08-06)
+
+- search: add query params active and url_path for search, add None as default value for filters
+- global: replace deprecated datetime utcnow() with now(timezone.utc)
+
 Version v5.1.1 (released 2025-07-22)
 
 - fix: mo files not included into build

{invenio_banners-5.1.1 → invenio_banners-5.2.0}/invenio_banners/__init__.py

@@ -10,6 +10,6 @@
 
 from .ext import InvenioBanners
 
-__version__ = "5.1.1"
+__version__ = "5.2.0"
 
 __all__ = ("__version__", "InvenioBanners")

{invenio_banners-5.1.1 → invenio_banners-5.2.0}/invenio_banners/records/models.py

@@ -8,7 +8,7 @@
 
 """Models."""
 
-from datetime import datetime
+from datetime import datetime, timezone
 
 import sqlalchemy as sa
 from flask import current_app
@@ -90,7 +90,7 @@ class BannerModel(db.Model, Timestamp):
     @classmethod
     def get_active(cls, url_path):
         """Return active banners."""
-        now = datetime.utcnow()
+        now = datetime.now(timezone.utc).replace(tzinfo=None)
 
         query = (
             db.session.query(cls)
@@ -110,12 +110,12 @@ class BannerModel(db.Model, Timestamp):
         return active_banners.all()
 
     @classmethod
-    def search(cls, search_params, filters):
+    def search(cls, search_params, filters=None):
         """Filter banners accordingly to query params."""
-        if filters == []:
-            filtered = db.session.query(BannerModel).filter()
-        else:
+        if filters:
             filtered = db.session.query(BannerModel).filter(or_(*filters))
+        else:
+            filtered = db.session.query(BannerModel).filter()
 
         banners = filtered.order_by(
             search_params["sort_direction"](text(",".join(search_params["sort"])))
@@ -130,7 +130,7 @@ class BannerModel(db.Model, Timestamp):
     @classmethod
     def disable_expired(cls):
         """Disable any old still active messages to keep everything clean."""
-        now = datetime.utcnow()
+        now = datetime.now(timezone.utc).replace(tzinfo=None)
 
         query = (
             db.session.query(cls)

{invenio_banners-5.1.1 → invenio_banners-5.2.0}/invenio_banners/resources/config.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2022-2024 CERN.
+# Copyright (C) 2022-2025 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.
@@ -19,6 +19,8 @@ class BannerServerSearchRequestArgsSchema(SearchRequestArgsSchema):
     """Banner request parameters."""
 
     sort_direction = ma.fields.Str()
+    active = ma.fields.Bool()
+    url_path = ma.fields.Str()
 
 
 class BannerResourceConfig(RecordResourceConfig):

{invenio_banners-5.1.1 → invenio_banners-5.2.0}/invenio_banners/services/schemas.py

@@ -22,7 +22,7 @@ class BannerSchema(BaseRecordSchema):
     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")},
+        metadata={"default": datetime.now(timezone.utc).strftime("%Y-%m-%d %H:%M:%S")},
     )
     end_datetime = fields.DateTime(allow_none=True)
     active = fields.Boolean(required=True, metadata={"default": True})

{invenio_banners-5.1.1 → invenio_banners-5.2.0}/invenio_banners/services/service.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2022-2023 CERN.
+# Copyright (C) 2022-2025 CERN.
 # Copyright (C) 2024 Graz University of Technology.
 #
 # Invenio-Banners is free software; you can redistribute it and/or modify it
@@ -15,7 +15,7 @@ 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
-from sqlalchemy import func
+from sqlalchemy import and_, func, literal, or_
 
 from ..records.models import BannerModel
 
@@ -37,14 +37,35 @@ class BannerService(RecordService):
         )
 
     def search(self, identity, params):
-        """Search for banners matching the querystring."""
+        """Search for banners with multiple filter options.
+
+        Supports filtering by:
+        - active: boolean filter
+        - url_path: prefix matching (empty paths match all, specific paths match as prefixes)
+        - q: text or date search across multiple fields
+
+        active and url_path filters are combined with AND logic, while OR is used while combining them with the q filters.
+        """
         self.require_permission(identity, "search")
 
+        active_filter_param = params.pop("active", None)
+        url_path_filter_param = params.pop("url_path", None)
         search_params = map_search_params(self.config.search, params)
 
-        query_param = search_params["q"]
-        filters = []
+        and_filters = []
+        if active_filter_param is not None:
+            and_filters.append(BannerModel.active.is_(active_filter_param))
+
+        if url_path_filter_param is not None:
+            and_filters.append(
+                or_(
+                    BannerModel.url_path == "",
+                    literal(url_path_filter_param).like(BannerModel.url_path + "%"),
+                )
+            )
 
+        filters = [and_(*and_filters)] if and_filters else []
+        query_param = search_params["q"]
         if query_param:
             filters.extend(
                 [
@@ -53,13 +74,6 @@ class BannerService(RecordService):
                     BannerModel.category.ilike(f"%{query_param}%"),
                 ]
             )
-            bool_value = self._validate_bool(query_param)
-            if bool_value is not None:
-                filters.extend(
-                    [
-                        BannerModel.active.is_(bool_value),
-                    ]
-                )
 
             datetime_value = self._validate_datetime(query_param)
             if datetime_value is not None:

{invenio_banners-5.1.1 → invenio_banners-5.2.0}/invenio_banners.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: invenio-banners
-Version: 5.1.1
+Version: 5.2.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
@@ -66,6 +66,11 @@ https://invenio-banners.readthedocs.io/
 Changes
 =======
 
+Version v5.2.0 (released 2025-08-06)
+
+- search: add query params active and url_path for search, add None as default value for filters
+- global: replace deprecated datetime utcnow() with now(timezone.utc)
+
 Version v5.1.1 (released 2025-07-22)
 
 - fix: mo files not included into build