invenio-app-ils 4.1.0__py2.py3-none-any.whl → 4.3.0__py2.py3-none-any.whl

invenio_app_ils/errors.py

@@ -98,11 +98,17 @@ class RecordHasReferencesError(IlsException):
         self.record_id = record_id
 
 
+class ItemCannotCirculateError(IlsException):
+    """The item cannot circulate."""
+
+    description = "This item cannot circulate."
+
+
 class ItemHasActiveLoanError(IlsException):
     """The item which we are trying to update has an active loan."""
 
     description = (
-        "Could not update item because it has an active loan with " "pid: {loan_pid}."
+        "Could not update item because it has an active loan with pid: {loan_pid}."
     )
 
     def __init__(self, loan_pid, **kwargs):
@@ -126,6 +132,7 @@ class PatronNotFoundError(IlsException):
 class PatronHasLoanOnItemError(IlsException):
     """A patron already has an active loan or a loan request on an item."""
 
+    code = 400
     description = "Patron '{0}' has already an active loan on item '{1}:{2}'"
 
     def __init__(self, patron_pid, item_pid, **kwargs):
@@ -135,6 +142,8 @@ class PatronHasLoanOnItemError(IlsException):
         :param prop: Missing property from loan request.
         """
         super().__init__(**kwargs)
+        self.patron_pid = patron_pid
+        self.item_pid = item_pid
         self.description = self.description.format(
             patron_pid, item_pid["type"], item_pid["value"]
         )
@@ -143,6 +152,7 @@ class PatronHasLoanOnItemError(IlsException):
 class PatronHasRequestOnDocumentError(IlsException):
     """A patron already has a loan request on a document."""
 
+    code = 400
     description = (
         "Patron '{patron_pid}' has already a loan "
         "request on document '{document_pid}'"
@@ -163,6 +173,7 @@ class PatronHasRequestOnDocumentError(IlsException):
 class PatronHasLoanOnDocumentError(IlsException):
     """A patron already has an active loan on a document."""
 
+    code = 400
     description = (
         "Patron '{patron_pid}' has already an active loan "
         "on document '{document_pid}'"
@@ -194,9 +205,54 @@ class LoanCheckoutByPatronForbidden(IlsException):
         )
 
 
+class LoanSelfCheckoutItemUnavailable(IlsException):
+    """A patron cannot self-checkout an item."""
+
+    code = 400
+    description = "This literature is not available for self-checkout. Please contact the library for more information."
+
+    def get_body(self, environ=None, scope=None):
+        """Get the request body."""
+        body = dict(
+            status=self.code,
+            message=self.get_description(environ),
+        )
+
+        if self.supportCode:
+            body["supportCode"] = self.supportCode
+
+        return json.dumps(body)
+
+
+class LoanSelfCheckoutItemInvalidStatus(LoanSelfCheckoutItemUnavailable):
+    """A patron cannot self-checkout an item that cannot circulate."""
+
+    supportCode = "SELF-CHECKOUT-001"
+
+
+class LoanSelfCheckoutDocumentOverbooked(LoanSelfCheckoutItemUnavailable):
+    """A patron cannot self-checkout an item for an overbooked document."""
+
+    supportCode = "SELF-CHECKOUT-002"
+
+
+class LoanSelfCheckoutItemActiveLoan(LoanSelfCheckoutItemUnavailable):
+    """A patron cannot self-checkout an item that cannot circulate."""
+
+    supportCode = "SELF-CHECKOUT-003"
+
+
+class LoanSelfCheckoutItemNotFound(LoanSelfCheckoutItemUnavailable):
+    """A patron cannot self-checkout an item because item with provided barcode doesn't exist."""
+
+    supportCode = "SELF-CHECKOUT-004"
+    description = "Literature not found. Please try again with another barcode or contact the library."
+
+
 class NotImplementedConfigurationError(IlsException):
     """Exception raised when function is not implemented."""
 
+    code = 500
     description = (
         "Function is not implemented. Implement this function in your module "
         "and pass it to the config variable"
@@ -211,15 +267,20 @@ class NotImplementedConfigurationError(IlsException):
 class MissingRequiredParameterError(IlsException):
     """Exception raised when required parameter is missing."""
 
+    code = 400
+
 
 class InvalidParameterError(IlsException):
     """Exception raised when an invalid parameter is has been given."""
 
+    code = 400
+
 
 class DocumentNotFoundError(IlsException):
     """Raised when a document could not be found."""
 
-    description = "Document PID '{}' was not found"
+    code = 404
+    description = "Document PID '{}' was not found."
 
     def __init__(self, document_pid, **kwargs):
         """Initialize exception."""
@@ -227,10 +288,38 @@ class DocumentNotFoundError(IlsException):
         self.description = self.description.format(document_pid)
 
 
+class ItemNotFoundError(IlsException):
+    """Raised when an item could not be found."""
+
+    code = 404
+    description = "Item not found."
+
+    def __init__(self, pid=None, barcode=None, **kwargs):
+        """Initialize exception."""
+        super().__init__(**kwargs)
+        if pid:
+            self.description += " PID: {}".format(pid)
+        if barcode:
+            self.description += " Barcode: {}".format(barcode)
+
+
+class MultipleItemsBarcodeFoundError(IlsException):
+    """Raised when multiple items with the same barcode has been found."""
+
+    code = 500
+    description = "Multiple items with barcode {} found."
+
+    def __init__(self, barcode, **kwargs):
+        """Initialize exception."""
+        super().__init__(**kwargs)
+        self.description = self.description.format(barcode)
+
+
 class LocationNotFoundError(IlsException):
     """Raised when a location could not be found."""
 
-    description = "Location PID '{}' was not found"
+    code = 404
+    description = "Location PID '{}' was not found."
 
     def __init__(self, location_pid, **kwargs):
         """Initialize exception."""
@@ -241,7 +330,8 @@ class LocationNotFoundError(IlsException):
 class InternalLocationNotFoundError(IlsException):
     """Raised when an internal location could not be found."""
 
-    description = "Internal Location PID '{}' was not found"
+    code = 404
+    description = "Internal Location PID '{}' was not found."
 
     def __init__(self, internal_location_pid, **kwargs):
         """Initialize exception."""
@@ -252,6 +342,7 @@ class InternalLocationNotFoundError(IlsException):
 class UnknownItemPidTypeError(IlsException):
     """Raised when the given item PID type is unknown."""
 
+    code = 400
     description = "Unknown Item PID type '{}'"
 
     def __init__(self, pid_type, **kwargs):
@@ -293,6 +384,14 @@ class DocumentRequestError(IlsException):
         super().__init__(description=description)
 
 
+class DocumentOverbookedError(IlsException):
+    """Raised when a document is overbooked."""
+
+    def __init__(self, description):
+        """Initialize exception."""
+        super().__init__(description=description)
+
+
 class VocabularyError(IlsException):
     """Generic vocabulary exception."""
 

invenio_app_ils/items/api.py

@@ -160,15 +160,27 @@ class Item(IlsRecord):
             )
         }
 
+    @classmethod
+    def enforce_constraints(cls, data, **kwargs):
+        """Enforce constraints.
+
+        :param data (dict): dict that can be mutated to enforce constraints.
+        """
+        # barcode is a required field and it should be always uppercase
+        data["barcode"] = data["barcode"].upper()
+
     @classmethod
     def create(cls, data, id_=None, **kwargs):
         """Create Item record."""
         cls.build_resolver_fields(data)
-        return super().create(data, id_=id_, **kwargs)
+        cls.enforce_constraints(data, **kwargs)
+        created = super().create(data, id_=id_, **kwargs)
+        return created
 
     def update(self, *args, **kwargs):
         """Update Item record."""
         super().update(*args, **kwargs)
+        self.enforce_constraints(self)
         self.build_resolver_fields(self)
 
     def delete(self, **kwargs):

invenio_app_ils/items/loaders/jsonschemas/items.py

@@ -15,8 +15,8 @@ from invenio_app_ils.records.loaders.schemas.changed_by import (
     ChangedBySchema,
     set_changed_by,
 )
-from invenio_app_ils.records.loaders.schemas.price import PriceSchema
 from invenio_app_ils.records.loaders.schemas.identifiers import IdentifierSchema
+from invenio_app_ils.records.loaders.schemas.price import PriceSchema
 
 
 class ISBNSchema(Schema):

invenio_app_ils/items/search.py

@@ -41,6 +41,19 @@ class ItemSearch(RecordsSearch):
 
         return search
 
+    def search_by_barcode(self, barcode, filter_states=None, exclude_states=None):
+        """Retrieve items matching the given barcode."""
+        search = self
+
+        search = search.filter("term", barcode=barcode)
+
+        if filter_states:
+            search = search.filter("terms", status=filter_states)
+        elif exclude_states:
+            search = search.exclude("terms", status=exclude_states)
+
+        return search
+
     def search_by_internal_location_pid(
         self,
         internal_location_pid=None,

invenio_app_ils/items/serializers/item.py

@@ -49,7 +49,7 @@ class ItemCSVSerializer(CSVSerializer):
             pid, record, links_factory=links_factory, **kwargs
         )
         filter_circulation(item)
-        field_cover_metadata(item.get('metadata', {}).get("document", {}))
+        field_cover_metadata(item.get("metadata", {}).get("document", {}))
         return item
 
     def transform_search_hit(self, pid, record_hit, links_factory=None, **kwargs):
@@ -58,7 +58,7 @@ class ItemCSVSerializer(CSVSerializer):
             pid, record_hit, links_factory=links_factory, **kwargs
         )
         filter_circulation(hit)
-        field_cover_metadata(hit.get('metadata', {}).get("document", {}))
+        field_cover_metadata(hit.get("metadata", {}).get("document", {}))
         return hit
 
 
@@ -71,7 +71,7 @@ class ItemJSONSerializer(JSONSerializer):
             pid, record, links_factory=links_factory, **kwargs
         )
         filter_circulation(item)
-        field_cover_metadata(item.get('metadata', {}).get("document", {}))
+        field_cover_metadata(item.get("metadata", {}).get("document", {}))
         return item
 
     def transform_search_hit(self, pid, record_hit, links_factory=None, **kwargs):
@@ -80,5 +80,5 @@ class ItemJSONSerializer(JSONSerializer):
             pid, record_hit, links_factory=links_factory, **kwargs
         )
         filter_circulation(hit)
-        field_cover_metadata(hit.get('metadata', {}).get("document", {}))
+        field_cover_metadata(hit.get("metadata", {}).get("document", {}))
         return hit

invenio_app_ils/patrons/anonymization.py

@@ -12,18 +12,22 @@ from copy import deepcopy
 
 from flask import current_app
 from invenio_accounts.models import LoginInformation, SessionActivity, User, userrole
+from invenio_circulation.pidstore.pids import CIRCULATION_LOAN_PID_TYPE
 from invenio_circulation.proxies import current_circulation
 from invenio_db import db
 from invenio_oauthclient.models import RemoteAccount, RemoteToken, UserIdentity
 from invenio_search.engine import search as inv_search
 from invenio_userprofiles.models import UserProfile
 
+from invenio_app_ils.acquisition.api import ORDER_PID_TYPE
 from invenio_app_ils.acquisition.proxies import current_ils_acq
 from invenio_app_ils.circulation.search import (
     get_active_loans_by_patron_pid,
     get_loans_by_patron_pid,
 )
+from invenio_app_ils.document_requests.api import DOCUMENT_REQUEST_PID_TYPE
 from invenio_app_ils.errors import AnonymizationActiveLoansError, PatronNotFoundError
+from invenio_app_ils.ill.api import BORROWING_REQUEST_PID_TYPE
 from invenio_app_ils.ill.proxies import current_ils_ill
 from invenio_app_ils.notifications.models import NotificationsLogs
 from invenio_app_ils.patrons.api import get_patron_or_unknown_dump
@@ -106,9 +110,32 @@ def anonymize_patron_data(patron_pid, force=False):
     cls = current_app.config["ILS_PATRON_ANONYMOUS_CLASS"]
     anonymous_patron_fields = cls().dumps_loader()
 
+    Loan = current_circulation.loan_record_cls
+    BorrowingRequest = current_ils_ill.borrowing_request_record_cls
+    DocumentRequest = current_app_ils.document_request_record_cls
+    Order = current_ils_acq.order_record_cls
+
+    anonymized_records = {
+        CIRCULATION_LOAN_PID_TYPE: {
+            "indexer": current_circulation.loan_indexer(),
+            "records": [],
+        },
+        BORROWING_REQUEST_PID_TYPE: {
+            "indexer": current_ils_ill.borrowing_request_indexer_cls(),
+            "records": [],
+        },
+        DOCUMENT_REQUEST_PID_TYPE: {
+            "indexer": current_app_ils.document_request_indexer,
+            "records": [],
+        },
+        ORDER_PID_TYPE: {
+            "indexer": current_ils_acq.order_indexer,
+            "records": [],
+        },
+    }
+
     patron_loans = get_loans_by_patron_pid(patron_pid).scan()
 
-    Loan = current_circulation.loan_record_cls
     indices = 0
     for hit in patron_loans:
         loan = Loan.get_record_by_pid(hit.pid)
@@ -131,7 +158,7 @@ def anonymize_patron_data(patron_pid, force=False):
         loan["patron_pid"] = anonymous_patron_fields["pid"]
         loan["patron"] = anonymous_patron_fields
         loan.commit()
-        current_circulation.loan_indexer().index(loan)
+        anonymized_records[CIRCULATION_LOAN_PID_TYPE]["records"].append(loan)
         indices += 1
 
     BorrowingRequestsSearch = current_ils_ill.borrowing_request_search_cls
@@ -139,14 +166,12 @@ def anonymize_patron_data(patron_pid, force=False):
         BorrowingRequestsSearch().search_by_patron_pid(patron_pid).scan()
     )
 
-    BorrowingRequest = current_ils_ill.borrowing_request_record_cls
-    indexer = current_ils_ill.borrowing_request_indexer_cls()
     for hit in patron_borrowing_requests:
         borrowing_request = BorrowingRequest.get_record_by_pid(hit.pid)
         borrowing_request["patron"] = anonymous_patron_fields
         borrowing_request["patron_pid"] = anonymous_patron_fields["pid"]
         borrowing_request.commit()
-        indexer.index(borrowing_request)
+        anonymized_records[BORROWING_REQUEST_PID_TYPE]["records"].append(borrowing_request)
         indices += 1
 
     DocumentRequestSearch = current_app_ils.document_request_search_cls
@@ -154,7 +179,6 @@ def anonymize_patron_data(patron_pid, force=False):
         DocumentRequestSearch().search_by_patron_pid(patron_pid).scan()
     )
 
-    DocumentRequest = current_app_ils.document_request_record_cls
     for hit in patron_document_requests:
         document_request = DocumentRequest.get_record_by_pid(hit.pid)
         if document_request["state"] == "PENDING":
@@ -163,19 +187,18 @@ def anonymize_patron_data(patron_pid, force=False):
         document_request["patron"] = anonymous_patron_fields
         document_request["patron_pid"] = anonymous_patron_fields["pid"]
         document_request.commit()
-        current_app_ils.document_request_indexer.index(document_request)
+        anonymized_records[ORDER_PID_TYPE]["records"].append(document_request)
         indices += 1
 
     patron_acquisitions = OrderSearch().search_by_patron_pid(patron_pid).scan()
 
-    Order = current_ils_acq.order_record_cls
     for hit in patron_acquisitions:
         acquisition = Order.get_record_by_pid(hit.pid)
         for line in acquisition["order_lines"]:
             if line.get("patron_pid") == patron_pid:
                 line["patron_pid"] = anonymous_patron_fields["pid"]
         acquisition.commit()
-        current_ils_acq.order_indexer.index(acquisition)
+        anonymized_records[Order._pid_type]["records"].append(acquisition)
         indices += 1
 
     # delete rows from db
@@ -185,6 +208,13 @@ def anonymize_patron_data(patron_pid, force=False):
     notifications = anonymize_patron_in_notification_logs(patron_pid)
 
     db.session.commit()
+
+    # index all after committing to DB, to ensure that no errors occurred.
+    for value in anonymized_records.values():
+        indexer, records = value["indexer"], value["records"]
+        for record in records:
+            indexer.index(record)
+
     if patron:
         try:
             patron_indexer = current_app_ils.patron_indexer

invenio_app_ils/permissions.py

@@ -132,27 +132,32 @@ def patron_owner_permission(record):
 
 
 def loan_checkout_permission(*args, **kwargs):
-    """Return permission to allow admins and librarians to checkout and patrons to self-checkout if enabled."""
+    """Loan checkout permissions checks.
+
+    Allow admins and librarians to checkout, patrons to self-checkout when enabled.
+    """
     if not has_request_context():
-        # If from CLI, don't allow self-checkout
+        # CLI or Celery task
         return backoffice_permission()
+
     if current_user.is_anonymous:
         abort(401)
 
     is_admin_or_librarian = backoffice_permission().allows(g.identity)
     if is_admin_or_librarian:
         return backoffice_permission()
+
+    # ensure that only the loan's patron can do operations on this loan
     if len(args):
         loan = args[0]
     else:
-        loan = kwargs.get("record", {})
-    is_patron_current_user = current_user.id == int(loan.get("patron_pid"))
-    if (
-        current_app.config.get("ILS_SELF_CHECKOUT_ENABLED", False)
-        and is_patron_current_user
-    ):
+        loan = kwargs["record"]
+    is_patron_current_user = current_user.id == int(loan["patron_pid"])
+
+    if current_app.config["ILS_SELF_CHECKOUT_ENABLED"] and is_patron_current_user:
         return authenticated_user_permission()
-    raise LoanCheckoutByPatronForbidden(int(loan.get("patron_pid")), current_user.id)
+
+    raise LoanCheckoutByPatronForbidden(int(loan["patron_pid"]), current_user.id)
 
 
 class PatronOwnerPermission(Permission):
@@ -163,36 +168,44 @@ class PatronOwnerPermission(Permission):
         super().__init__(UserNeed(int(record["patron_pid"])), backoffice_access_action)
 
 
+_is_authenticated_user = [
+    "circulation-loan-request",
+    "patron-loans",
+    "bulk-loan-extension",
+]
+_is_backoffice_permission = [
+    "circulation-loan-force-checkout",
+    "circulation-overdue-loan-notification",
+    "circulation-loan-update-dates",
+    "relations-create",
+    "relations-delete",
+    "stats-most-loaned",
+    "document-request-actions",
+    "bucket-create",
+    "ill-brwreq-patron-loan-create",
+    "ill-brwreq-patron-loan-extension-accept",
+    "ill-brwreq-patron-loan-extension-decline",
+    "send-notification-to-patron",
+]
+_is_patron_owner_permission = [
+    "document-request-decline",
+    "ill-brwreq-patron-loan-extension-request",
+]
+
+
 def views_permissions_factory(action):
     """Return ILS views permissions factory."""
-    is_authenticated_user = [
-        "circulation-loan-request",
-        "patron-loans",
-        "bulk-loan-extension",
-    ]
-    is_backoffice_permission = [
-        "circulation-loan-checkout",
-        "circulation-loan-force-checkout",
-        "circulation-overdue-loan-notification",
-        "circulation-loan-update-dates",
-        "relations-create",
-        "relations-delete",
-        "stats-most-loaned",
-        "document-request-actions",
-        "bucket-create",
-        "ill-brwreq-patron-loan-create",
-        "ill-brwreq-patron-loan-extension-accept",
-        "ill-brwreq-patron-loan-extension-decline",
-        "send-notification-to-patron",
-    ]
-    is_patron_owner_permission = [
-        "document-request-decline",
-        "ill-brwreq-patron-loan-extension-request",
-    ]
-    if action in is_authenticated_user:
+    if action in _is_authenticated_user:
         return authenticated_user_permission()
-    elif action in is_backoffice_permission:
+    elif action in _is_backoffice_permission:
         return backoffice_permission()
-    elif action in is_patron_owner_permission:
+    elif action in _is_patron_owner_permission:
         return PatronOwnerPermission
+    elif action == "circulation-loan-checkout":
+        return backoffice_permission()
+    elif (
+        action == "circulation-loan-self-checkout"
+        and current_app.config["ILS_SELF_CHECKOUT_ENABLED"]
+    ):
+        return authenticated_user_permission()
     return deny_all()

invenio_app_ils/records/views.py

@@ -20,7 +20,7 @@ from invenio_app_ils.errors import StatsError
 from invenio_app_ils.permissions import backoffice_permission
 from invenio_app_ils.records.permissions import RecordPermission
 from invenio_app_ils.series.api import SERIES_PID_TYPE
-from invenio_app_ils.signals import record_viewed, file_downloaded
+from invenio_app_ils.signals import file_downloaded, record_viewed
 
 
 def create_document_stats_blueprint(app):

invenio_app_ils/records_relations/api.py

@@ -425,6 +425,7 @@ class IlsRecordWithRelations(IlsRecord):
     def relations(self):
         """Get record relations."""
         from .retriever import get_relations
+
         return get_relations(self)
 
     def clear(self):

invenio_app_ils/relations/api.py

@@ -17,7 +17,12 @@ from sqlalchemy import and_, or_
 from invenio_app_ils.errors import RecordRelationsError
 
 ILS_RELATION_TYPE = namedtuple(
-    "IlsRelationType", RelationType._fields + ("relation_class", "sort_by",)
+    "IlsRelationType",
+    RelationType._fields
+    + (
+        "relation_class",
+        "sort_by",
+    ),
 )
 
 LANGUAGE_RELATION = ILS_RELATION_TYPE(

invenio_app_ils/series/loaders/jsonschemas/series.py

@@ -21,10 +21,10 @@ from invenio_app_ils.records.loaders.schemas.changed_by import (
     ChangedBySchema,
     set_changed_by,
 )
+from invenio_app_ils.records.loaders.schemas.identifiers import IdentifierSchema
 from invenio_app_ils.records.loaders.schemas.preserve_cover_metadata import (
     preserve_cover_metadata,
 )
-from invenio_app_ils.records.loaders.schemas.identifiers import IdentifierSchema
 from invenio_app_ils.series.api import Series
 
 

{invenio_app_ils-4.1.0.dist-info → invenio_app_ils-4.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: invenio-app-ils
-Version: 4.1.0
+Version: 4.3.0
 Summary: Invenio Integrated Library System.
 Home-page: https://github.com/inveniosoftware/invenio-app-ils
 Author: CERN
@@ -16,7 +16,7 @@ Requires-Dist: invenio-app<1.4.0,>=1.3.4
 Requires-Dist: invenio-db[mysql,postgresql]<2.0.0,>=1.0.14
 Requires-Dist: invenio-base<1.3.0,>=1.2.11
 Requires-Dist: invenio-cache<2.0.0,>=1.1.1
-Requires-Dist: invenio-celery<1.3.0,>=1.2.4
+Requires-Dist: invenio-celery<2.0.0,>=1.2.4
 Requires-Dist: invenio-config<1.1.0,>=1.0.3
 Requires-Dist: invenio-i18n<3.0.0,>=2.0.0
 Requires-Dist: invenio-admin<1.5.0,>=1.4.0
@@ -101,6 +101,19 @@ https://invenioils.docs.cern.ch
 Changes
 =======
 
+Version 4.3.0 (released 2024-11-19)
+
+- self-checkout: use dedicated endpoints for the entire workflow for better
+                 permissions check and error handling.
+                 Add a new loan transition and delivery method for self-checkout.
+- anonymization: ensure that re-indexing is happening after the commit to the db,
+                 to avoid premature re-indexing (and therefore index conflict version)
+                 when db rollback happens.
+
+Version 4.2.0 (released 2024-11-04)
+
+- self-checkout: barcode is now always uppercased to make searches case-insensitive
+
 Version 4.1.0 (released 2024-10-21)
 
 - search: apply the same search analyzers to the fields that needs to be searchable.
@@ -148,7 +161,7 @@ Version 2.0.0rc9 (released 2024-04-25)
 Version 2.0.0rc8 (released 2024-04-04)
 
 - records_relation: Simplify sorting
-- records_relations: Use sort_by paramemter from configs instead
+- records_relations: Use sort_by parameter from configs instead
 - relations: Add functionality to sort json refs by relation_type
 - tests: circulation: Add new location for testing closures
 - circulation: loan_request: Fix dates comparison in get_offset_duration
@@ -563,5 +576,3 @@ Version 1.0.0a4 (released 2020-06-19)
 Version 1.0.0a0 (released 2020-06-05)
 
 - Initial public release.
-
-