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

invenio_banners-4.0.0/.github/workflows/pypi-publish.yml

@@ -0,0 +1,11 @@
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  build-n-publish:
+    uses: inveniosoftware/workflows/.github/workflows/pypi-publish.yml@master
+    secrets: inherit
+    with:
+      babel-compile-catalog: true

invenio_banners-4.0.0/.github/workflows/tests.yml

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Invenio.
+# Copyright (C) 2020-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.
+
+name: CI
+
+on:
+  push:
+    branches: master
+  pull_request:
+    branches: master
+  schedule:
+    # * is a special character in YAML so you have to quote this string
+    - cron:  "0 3 * * 6"
+  workflow_dispatch:
+    inputs:
+      reason:
+        description: "Reason"
+        required: false
+        default: "Manual trigger"
+
+jobs:
+  Python:
+    uses: inveniosoftware/workflows/.github/workflows/tests-python.yml@master

{invenio-banners-3.1.1 → invenio_banners-4.0.0}/CHANGES.rst

@@ -1,6 +1,6 @@
 ..
     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.
@@ -8,10 +8,16 @@
 Changes
 =======
 
-Version v3.1.1 (released 2024-09-18)
+Version v4.0.0 (released 2024-12-10)
 
-- admin: adjust + fix typos in descriptions of fields
-- i18n:push translations
+- setup: change to reusable workflows
+- setup: bump major dependencies
+
+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)
 

invenio_banners-4.0.0/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.1
+Name: invenio-banners
+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
+Author-email: info@inveniosoftware.org
+License: MIT
+Keywords: Invenio Banners
+Platform: any
+Classifier: Development Status :: 1 - Planning
+Requires-Python: >=3.7
+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]<4.0.0,>=3.0.0; extra == "opensearch1"
+Provides-Extra: opensearch2
+Requires-Dist: invenio-search[opensearch2]<4.0.0,>=3.0.0; extra == "opensearch2"
+
+..
+    Copyright (C) 2020 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-Banners
+=================
+
+.. image:: https://img.shields.io/travis/inveniosoftware/invenio-banners.svg
+        :target: https://travis-ci.org/inveniosoftware/invenio-banners
+
+.. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-banners.svg
+        :target: https://coveralls.io/r/inveniosoftware/invenio-banners
+
+.. image:: https://img.shields.io/github/tag/inveniosoftware/invenio-banners.svg
+        :target: https://github.com/inveniosoftware/invenio-banners/releases
+
+.. image:: https://img.shields.io/pypi/dm/invenio-banners.svg
+        :target: https://pypi.python.org/pypi/invenio-banners
+
+.. image:: https://img.shields.io/github/license/inveniosoftware/invenio-banners.svg
+        :target: https://github.com/inveniosoftware/invenio-banners/blob/master/LICENSE
+
+Create and show banners with useful messages to users.
+
+Further documentation is available on
+https://invenio-banners.readthedocs.io/
+
+..
+    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.
+
+Changes
+=======
+
+Version v4.0.0 (released 2024-12-10)
+
+- setup: change to reusable workflows
+- setup: bump major dependencies
+
+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)
+
+- 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
+
+Version 3.0.0 (released 2024-01-31)
+
+- installation: bump invenio-administration
+
+Version 2.1.1 (released 2023-07-24)
+
+- ui: remove bottom margin
+
+Version 2.1.0 (released 2023-03-02)
+
+- remove deprecated flask-babelex imports
+- install invenio-i18n explicitly
+
+Version 2.0.0 (released 2023-02-15)
+
+- global: refactor into resource/service pattern
+- global: implement CRUD operations
+- global: implement best practices for packaging (declarative cfg), code
+  linting (black) and testing
+- search: improve banners search by query params
+- administration: integrate banners view module
+
+
+Version 1.0.0a1 (release 2020-10-25)
+------------------------------------
+
+- Initial public release.

{invenio-banners-3.1.1 → invenio_banners-4.0.0}/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-3.1.1 → invenio_banners-4.0.0}/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-3.1.1 → invenio_banners-4.0.0}/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-3.1.1 → invenio_banners-4.0.0}/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-3.1.1 → invenio_banners-4.0.0}/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-3.1.1 → invenio_banners-4.0.0}/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-4.0.0/invenio_banners.egg-info/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.1
+Name: invenio-banners
+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
+Author-email: info@inveniosoftware.org
+License: MIT
+Keywords: Invenio Banners
+Platform: any
+Classifier: Development Status :: 1 - Planning
+Requires-Python: >=3.7
+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]<4.0.0,>=3.0.0; extra == "opensearch1"
+Provides-Extra: opensearch2
+Requires-Dist: invenio-search[opensearch2]<4.0.0,>=3.0.0; extra == "opensearch2"
+
+..
+    Copyright (C) 2020 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-Banners
+=================
+
+.. image:: https://img.shields.io/travis/inveniosoftware/invenio-banners.svg
+        :target: https://travis-ci.org/inveniosoftware/invenio-banners
+
+.. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-banners.svg
+        :target: https://coveralls.io/r/inveniosoftware/invenio-banners
+
+.. image:: https://img.shields.io/github/tag/inveniosoftware/invenio-banners.svg
+        :target: https://github.com/inveniosoftware/invenio-banners/releases
+
+.. image:: https://img.shields.io/pypi/dm/invenio-banners.svg
+        :target: https://pypi.python.org/pypi/invenio-banners
+
+.. image:: https://img.shields.io/github/license/inveniosoftware/invenio-banners.svg
+        :target: https://github.com/inveniosoftware/invenio-banners/blob/master/LICENSE
+
+Create and show banners with useful messages to users.
+
+Further documentation is available on
+https://invenio-banners.readthedocs.io/
+
+..
+    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.
+
+Changes
+=======
+
+Version v4.0.0 (released 2024-12-10)
+
+- setup: change to reusable workflows
+- setup: bump major dependencies
+
+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)
+
+- 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
+
+Version 3.0.0 (released 2024-01-31)
+
+- installation: bump invenio-administration
+
+Version 2.1.1 (released 2023-07-24)
+
+- ui: remove bottom margin
+
+Version 2.1.0 (released 2023-03-02)
+
+- remove deprecated flask-babelex imports
+- install invenio-i18n explicitly
+
+Version 2.0.0 (released 2023-02-15)
+
+- global: refactor into resource/service pattern
+- global: implement CRUD operations
+- global: implement best practices for packaging (declarative cfg), code
+  linting (black) and testing
+- search: improve banners search by query params
+- administration: integrate banners view module
+
+
+Version 1.0.0a1 (release 2020-10-25)
+------------------------------------
+
+- Initial public release.

{invenio-banners-3.1.1 → invenio_banners-4.0.0}/invenio_banners.egg-info/entry_points.txt

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

invenio_banners-4.0.0/invenio_banners.egg-info/requires.txt

@@ -0,0 +1,15 @@
+invenio-i18n<4.0.0,>=3.0.0
+invenio-administration<4.0.0,>=3.0.0
+
+[opensearch1]
+invenio-search[opensearch1]<4.0.0,>=3.0.0
+
+[opensearch2]
+invenio-search[opensearch2]<4.0.0,>=3.0.0
+
+[tests]
+pytest-black-ng>=0.4.0
+pytest-invenio<4.0.0,>=3.0.0
+jsonresolver>=0.3.2
+invenio-app<3.0.0,>=2.0.0
+sphinx>=4.5

{invenio-banners-3.1.1 → invenio_banners-4.0.0}/setup.cfg

@@ -18,19 +18,20 @@ packages = find:
 python_requires = >=3.7
 zip_safe = False
 install_requires = 
-	invenio-i18n>=2.0.0,<3.0.0
-	invenio-administration>=2.0.0,<3.0.0
+	invenio-i18n>=3.0.0,<4.0.0
+	invenio-administration>=3.0.0,<4.0.0
 
 [options.extras_require]
 tests = 
-	pytest-invenio>=2.1.0,<3.0.0
-	invenio-app>=1.3.4,<2.0.0
-	pytest-black>=0.3.0
+	pytest-black-ng>=0.4.0
+	pytest-invenio>=3.0.0,<4.0.0
+	jsonresolver>=0.3.2
+	invenio-app>=2.0.0,<3.0.0
 	sphinx>=4.5
 opensearch1 = 
-	invenio-search[opensearch1]>=2.1.0,<3.0.0
+	invenio-search[opensearch1]>=3.0.0,<4.0.0
 opensearch2 = 
-	invenio-search[opensearch2]>=2.1.0,<3.0.0
+	invenio-search[opensearch2]>=3.0.0,<4.0.0
 
 [options.entry_points]
 invenio_base.apps =